Gamedev Framework (gf)  0.8.0
A C++14 framework for 2D games
Public Types | Public Member Functions | Public Attributes | Static Public Attributes | Related Functions | List of all members
gf::Matrix< T, ROWS, COLS > Struct Template Reference
Core classes and functions

General purpose math matrix. More...

#include <gf/Matrix.h>

Public Types

using value_type = T
 The value type of the elements of the matrix. More...
 

Public Member Functions

 Matrix ()=default
 Default constructor. More...
 
constexpr Matrix (ZeroType) noexcept
 
 Matrix (T val) noexcept
 Constructor that fills the matrix with a value. More...
 
 Matrix (const T *array)
 
T operator() (std::size_t row, std::size_t col) const
 
T & operator() (std::size_t row, std::size_t col)
 
constexpr void zero () noexcept
 Zero out the matrix. More...
 

Public Attributes

union {
   T   grid [ROWS][COLS]
 Grid representation. More...
 
   T   data [ROWS *COLS]
 Array representation. More...
 
}; 
 

Static Public Attributes

static constexpr std::size_t Rows = ROWS
 The number of rows in the matrix. More...
 
static constexpr std::size_t Cols = COLS
 The number of columns in the matrix. More...
 

Related Functions

(Note that these are not member functions.)

template<typename T , std::size_t ROWS, std::size_t COLS>
constexpr bool operator== (const Matrix< T, ROWS, COLS > &lhs, const Matrix< T, ROWS, COLS > &rhs)
 Equality operator between two matrices. More...
 
template<typename T , std::size_t ROWS, std::size_t COLS>
constexpr bool operator!= (const Matrix< T, ROWS, COLS > &lhs, const Matrix< T, ROWS, COLS > &rhs)
 Inequality operator between two matrices. More...
 
template<typename T , std::size_t ROWS, std::size_t COLS>
constexpr Matrix< T, ROWS, COLS > operator- (const Matrix< T, ROWS, COLS > &val)
 Component-wise unary minus. More...
 
template<typename T , std::size_t ROWS, std::size_t COLS>
constexpr Matrix< T, ROWS, COLS > operator+ (const Matrix< T, ROWS, COLS > &lhs, const Matrix< T, ROWS, COLS > &rhs)
 Component-wise addition. More...
 
template<typename T , std::size_t ROWS, std::size_t COLS>
constexpr Matrix< T, ROWS, COLS > & operator+= (Matrix< T, ROWS, COLS > &lhs, const Matrix< T, ROWS, COLS > &rhs)
 Component-wise addition and assignment. More...
 
template<typename T , std::size_t ROWS, std::size_t COLS>
constexpr Matrix< T, ROWS, COLS > operator- (const Matrix< T, ROWS, COLS > &lhs, const Matrix< T, ROWS, COLS > &rhs)
 Component-wise substraction. More...
 
template<typename T , std::size_t ROWS, std::size_t COLS>
constexpr Matrix< T, ROWS, COLS > & operator-= (Matrix< T, ROWS, COLS > &lhs, const Matrix< T, ROWS, COLS > &rhs)
 Component-wise substraction and assignment. More...
 
template<typename T , std::size_t ROWS, std::size_t COLS>
constexpr Matrix< T, ROWS, COLS > operator* (const Matrix< T, ROWS, COLS > &lhs, T rhs)
 Right scalar multiplication. More...
 
template<typename T , std::size_t ROWS, std::size_t COLS>
constexpr Matrix< T, ROWS, COLS > & operator*= (Matrix< T, ROWS, COLS > &lhs, T rhs)
 Right scalar multiplication and assignment. More...
 
template<typename T , std::size_t ROWS, std::size_t COLS>
constexpr Matrix< T, ROWS, COLS > operator* (T lhs, const Matrix< T, ROWS, COLS > &rhs)
 Left scalar multiplication. More...
 
template<typename T , std::size_t ROWS, std::size_t COLS>
constexpr Matrix< T, ROWS, COLS > operator/ (const Matrix< T, ROWS, COLS > &lhs, T rhs)
 Right scalar division. More...
 
template<typename T , std::size_t ROWS, std::size_t COLS>
constexpr Matrix< T, ROWS, COLS > & operator/= (Matrix< T, ROWS, COLS > &lhs, T rhs)
 Right scalar division and assignment. More...
 
template<typename T , std::size_t S1, std::size_t S2>
constexpr Vector< T, S1 > operator* (const Matrix< T, S1, S2 > &lhs, const Vector< T, S2 > &rhs)
 Matrix-vector multiplication. More...
 
template<typename T , std::size_t S1, std::size_t S2>
constexpr Vector< T, S2 > operator* (const Vector< T, S1 > &lhs, const Matrix< T, S1, S2 > &rhs)
 Vector-matrix multiplication. More...
 
template<typename T , std::size_t S1, std::size_t S2, std::size_t S3>
constexpr Matrix< T, S1, S3 > operator* (const Matrix< T, S1, S2 > &lhs, const Matrix< T, S2, S3 > &rhs)
 Matrix-matrix multiplication. More...
 
template<typename T , std::size_t N>
constexpr Matrix< T, N, N > & operator*= (Matrix< T, N, N > &lhs, const Matrix< T, N, N > &rhs)
 Matrix-matrix multiplication and assignment. More...
 
template<typename MatrixType >
constexpr MatrixType identity ()
 Identity matrix. More...
 
template<typename T , std::size_t S1, std::size_t S2>
constexpr Matrix< T, S2, S1 > transpose (const Matrix< T, S1, S2 > &mat)
 Transposition of a matrix. More...
 
template<typename T >
constexpr Matrix< T, 2, 2 > invert (const Matrix< T, 2, 2 > &mat)
 Inversion of a 2x2 matrix. More...
 
template<typename T >
constexpr Matrix< T, 3, 3 > invert (const Matrix< T, 3, 3 > &mat)
 Inversion of a 3x3 matrix. More...
 

Detailed Description

template<typename T, std::size_t ROWS, std::size_t COLS>
struct gf::Matrix< T, ROWS, COLS >

General purpose math matrix.

gf::Matrix represents a matrix with ROWS rows and COLS columns. The internal representation uses a row-major order.

The template parameter T is the type of coordinates. It can be any type that supports arithmetic operations (+, -, *, /).

Several specializations are defined for common use cases, especially for square matrices:

This class was designed according to the article On Vector Math Libraries by Nathan Reed.

See also
gf::Array2D

Member Typedef Documentation

◆ value_type

template<typename T, std::size_t ROWS, std::size_t COLS>
using gf::Matrix< T, ROWS, COLS >::value_type = T

The value type of the elements of the matrix.

Constructor & Destructor Documentation

◆ Matrix() [1/4]

template<typename T, std::size_t ROWS, std::size_t COLS>
gf::Matrix< T, ROWS, COLS >::Matrix ( )
default

Default constructor.

◆ Matrix() [2/4]

template<typename T, std::size_t ROWS, std::size_t COLS>
constexpr gf::Matrix< T, ROWS, COLS >::Matrix ( ZeroType  )
inlinenoexcept

◆ Matrix() [3/4]

template<typename T, std::size_t ROWS, std::size_t COLS>
gf::Matrix< T, ROWS, COLS >::Matrix ( T  val)
inlineexplicitnoexcept

Constructor that fills the matrix with a value.

◆ Matrix() [4/4]

template<typename T, std::size_t ROWS, std::size_t COLS>
gf::Matrix< T, ROWS, COLS >::Matrix ( const T *  array)
inlineexplicit

Member Function Documentation

◆ operator()() [1/2]

template<typename T, std::size_t ROWS, std::size_t COLS>
T gf::Matrix< T, ROWS, COLS >::operator() ( std::size_t  row,
std::size_t  col 
) const
inline

◆ operator()() [2/2]

template<typename T, std::size_t ROWS, std::size_t COLS>
T& gf::Matrix< T, ROWS, COLS >::operator() ( std::size_t  row,
std::size_t  col 
)
inline

◆ zero()

template<typename T, std::size_t ROWS, std::size_t COLS>
constexpr void gf::Matrix< T, ROWS, COLS >::zero ( )
inlinenoexcept

Zero out the matrix.

Friends And Related Function Documentation

◆ identity()

template<typename MatrixType >
constexpr MatrixType identity ( )
related

Identity matrix.

See also
gf::identityTransform()

◆ invert() [1/2]

template<typename T >
constexpr Matrix< T, 2, 2 > invert ( const Matrix< T, 2, 2 > &  mat)
related

Inversion of a 2x2 matrix.

◆ invert() [2/2]

template<typename T >
constexpr Matrix< T, 3, 3 > invert ( const Matrix< T, 3, 3 > &  mat)
related

Inversion of a 3x3 matrix.

◆ operator!=()

template<typename T , std::size_t ROWS, std::size_t COLS>
constexpr bool operator!= ( const Matrix< T, ROWS, COLS > &  lhs,
const Matrix< T, ROWS, COLS > &  rhs 
)
related

Inequality operator between two matrices.

◆ operator*() [1/5]

template<typename T , std::size_t ROWS, std::size_t COLS>
constexpr Matrix< T, ROWS, COLS > operator* ( const Matrix< T, ROWS, COLS > &  lhs,
T  rhs 
)
related

Right scalar multiplication.

◆ operator*() [2/5]

template<typename T , std::size_t ROWS, std::size_t COLS>
constexpr Matrix< T, ROWS, COLS > operator* ( T  lhs,
const Matrix< T, ROWS, COLS > &  rhs 
)
related

Left scalar multiplication.

◆ operator*() [3/5]

template<typename T , std::size_t S1, std::size_t S2>
constexpr Vector< T, S1 > operator* ( const Matrix< T, S1, S2 > &  lhs,
const Vector< T, S2 > &  rhs 
)
related

Matrix-vector multiplication.

◆ operator*() [4/5]

template<typename T , std::size_t S1, std::size_t S2>
constexpr Vector< T, S2 > operator* ( const Vector< T, S1 > &  lhs,
const Matrix< T, S1, S2 > &  rhs 
)
related

Vector-matrix multiplication.

◆ operator*() [5/5]

template<typename T , std::size_t S1, std::size_t S2, std::size_t S3>
constexpr Matrix< T, S1, S3 > operator* ( const Matrix< T, S1, S2 > &  lhs,
const Matrix< T, S2, S3 > &  rhs 
)
related

Matrix-matrix multiplication.

◆ operator*=() [1/2]

template<typename T , std::size_t ROWS, std::size_t COLS>
constexpr Matrix< T, ROWS, COLS > & operator*= ( Matrix< T, ROWS, COLS > &  lhs,
T  rhs 
)
related

Right scalar multiplication and assignment.

◆ operator*=() [2/2]

template<typename T , std::size_t N>
constexpr Matrix< T, N, N > & operator*= ( Matrix< T, N, N > &  lhs,
const Matrix< T, N, N > &  rhs 
)
related

Matrix-matrix multiplication and assignment.

This operation is only available for square matrices.

◆ operator+()

template<typename T , std::size_t ROWS, std::size_t COLS>
constexpr Matrix< T, ROWS, COLS > operator+ ( const Matrix< T, ROWS, COLS > &  lhs,
const Matrix< T, ROWS, COLS > &  rhs 
)
related

Component-wise addition.

◆ operator+=()

template<typename T , std::size_t ROWS, std::size_t COLS>
constexpr Matrix< T, ROWS, COLS > & operator+= ( Matrix< T, ROWS, COLS > &  lhs,
const Matrix< T, ROWS, COLS > &  rhs 
)
related

Component-wise addition and assignment.

◆ operator-() [1/2]

template<typename T , std::size_t ROWS, std::size_t COLS>
constexpr Matrix< T, ROWS, COLS > operator- ( const Matrix< T, ROWS, COLS > &  val)
related

Component-wise unary minus.

◆ operator-() [2/2]

template<typename T , std::size_t ROWS, std::size_t COLS>
constexpr Matrix< T, ROWS, COLS > operator- ( const Matrix< T, ROWS, COLS > &  lhs,
const Matrix< T, ROWS, COLS > &  rhs 
)
related

Component-wise substraction.

◆ operator-=()

template<typename T , std::size_t ROWS, std::size_t COLS>
constexpr Matrix< T, ROWS, COLS > & operator-= ( Matrix< T, ROWS, COLS > &  lhs,
const Matrix< T, ROWS, COLS > &  rhs 
)
related

Component-wise substraction and assignment.

◆ operator/()

template<typename T , std::size_t ROWS, std::size_t COLS>
constexpr Matrix< T, ROWS, COLS > operator/ ( const Matrix< T, ROWS, COLS > &  lhs,
T  rhs 
)
related

Right scalar division.

◆ operator/=()

template<typename T , std::size_t ROWS, std::size_t COLS>
constexpr Matrix< T, ROWS, COLS > & operator/= ( Matrix< T, ROWS, COLS > &  lhs,
T  rhs 
)
related

Right scalar division and assignment.

◆ operator==()

template<typename T , std::size_t ROWS, std::size_t COLS>
constexpr bool operator== ( const Matrix< T, ROWS, COLS > &  lhs,
const Matrix< T, ROWS, COLS > &  rhs 
)
related

Equality operator between two matrices.

◆ transpose()

template<typename T , std::size_t S1, std::size_t S2>
constexpr Matrix< T, S2, S1 > transpose ( const Matrix< T, S1, S2 > &  mat)
related

Transposition of a matrix.

Member Data Documentation

◆ @7

union { ... }

An anonymous union to handle the various representations

◆ Cols

template<typename T, std::size_t ROWS, std::size_t COLS>
constexpr std::size_t gf::Matrix< T, ROWS, COLS >::Cols = COLS
static

The number of columns in the matrix.

◆ data

template<typename T, std::size_t ROWS, std::size_t COLS>
T gf::Matrix< T, ROWS, COLS >::data[ROWS *COLS]

Array representation.

◆ grid

template<typename T, std::size_t ROWS, std::size_t COLS>
T gf::Matrix< T, ROWS, COLS >::grid[ROWS][COLS]

Grid representation.

◆ Rows

template<typename T, std::size_t ROWS, std::size_t COLS>
constexpr std::size_t gf::Matrix< T, ROWS, COLS >::Rows = ROWS
static

The number of rows in the matrix.

Generated by   doxygen 1.8.13