mal_math::mat< a, b, T > Class Template Reference

Definition of matrix with dimensions rows x columns and type T More...

#include "matnxn.hpp"

Collaboration diagram for mal_math::mat< a, b, T >:

Public Types
using	type = T
	Alias for the primitive data type used in the matrix.

Public Member Functions
constexpr	mat ()=default
	Default constructor.
template<Primitive P> requires (a == b)
constexpr	mat (P p)
	Constructor that initializes a square matrix with a single value.
template<size_t c, size_t d, Primitive P> requires (a >= c && b >= d)
constexpr	mat (mat< c, d, P > p)
	Constructor that initializes the matrix from another matrix.
template<size_t c, size_t d, Primitive P> requires (a >= c && b >= d)
constexpr	mat (rmat< c, d, P > p)
	Constructor that initializes the matrix from another matrix.
template<Primitive P>
constexpr	mat (mat< a, b, P > p)
	Constructor that initializes the matrix from another matrix with the same dimensions.
template<Primitive P>
constexpr	mat (rmat< a, b, P > p)
	Constructor that initializes the matrix from another matrix with the same dimensions.
template<typename... U>
constexpr	mat (U... data)
	Constructor that initializes the matrix from any data (such as floats, vectors, integers etc.). It doesn't care if primitive type is the same, it can eat basically anything. For example:
constexpr void	reset () noexcept
	Resets the matrix to have all zero values.
constexpr vec< b, T > &	operator[] (size_t i)
	Accesses a row of the matrix.
constexpr vec< b, T > const &	operator[] (size_t i) const
	Accesses a row of the matrix (const version).
constexpr mat< a, b, T > const &	operator+ () const noexcept
	Unary plus operator.
constexpr mat< a, b, T >	operator- () const noexcept
	Unary minus operator.
template<Primitive U>
constexpr mat< a, b, T > &	operator+= (mat< a, b, U > const &other)
	Adds another matrix to the current matrix.
template<Primitive U>
constexpr mat< a, b, T > &	operator-= (mat< a, b, U > const &other)
	Subtracts another matrix from the current matrix.
template<size_t c, Primitive U>
constexpr mat< a, c, T > &	operator*= (mat< b, c, U > const &other)
	Multiplies the current matrix with another matrix.
template<Primitive U>
constexpr mat< a, b, T > &	operator+= (rmat< a, b, U > const &other)
	Adds another row-major matrix to the current matrix.
template<Primitive U>
constexpr mat< a, b, T > &	operator-= (rmat< a, b, U > const &other)
	Subtracts another row-major matrix from the current matrix.
template<size_t c, Primitive U>
constexpr mat< a, c, T > &	operator*= (rmat< b, c, U > const &other)
	Multiplies the current matrix with another row-major matrix.
template<Primitive U>
constexpr mat< a, b, T > &	operator+= (U const value)
	Adds a scalar value to each element of the current matrix.
template<Primitive U>
constexpr mat< a, b, T > &	operator-= (U const value)
	Subtracts a scalar value from each element of the current matrix.
template<Primitive U>
constexpr mat< a, b, T > &	operator*= (U const value)
	Multiplies each element of the current matrix by a scalar value.
template<size_t c = a, size_t d = b>
constexpr rmat< c, d, T >	as_rmat () noexcept
	Converts the matrix to an rmat type.

Static Public Member Functions
static constexpr mat< a, b, T >	identity () noexcept
	Returns the identity matrix of size a x b.

Public Attributes
union {
std::array< T, size.x *size.y >   arr
	Linear array representation of matrix data. More...
std::array< vec< size.y, T >, size.x >   data
	2D array (rows x columns) representation of matrix data. More...
};
	Union containing two ways to represent matrix data.

Static Public Attributes
static constexpr vec< 2, size_t >	size { a, b }
	Represents the dimensions of the matrix.

Private Member Functions
template<Primitive U>
constexpr void	unpack_data (size_t offset, U u)
	Unpacks a single primitive value into the matrix data.
template<class V >
constexpr void	unpack_data (size_t offset, V vec)
	Unpacks a vector into the matrix data.
template<typename A , typename B , typename... C>
constexpr void	unpack_data (size_t offset, A, B, C...)
	Recursively unpacks multiple values into the matrix data.

Static Private Member Functions
template<Primitive _>
static constexpr size_t	get_parameter_pack_size ()
	Determines the size of a parameter pack for primitive types.
template<class V >
static constexpr size_t	get_parameter_pack_size ()
	Determines the size of a parameter pack for vector types.
template<typename A , typename B , typename... C>
static constexpr size_t	get_parameter_pack_size ()
	Determines the size of a parameter pack for a mixed set of types.

Detailed Description

template<size_t a, size_t b, Primitive T>
class mal_math::mat< a, b, T >

Definition of matrix with dimensions rows x columns and type T

Represents a matrix of dimensions a x b.

Template Parameters

a	Number of rows of the matrix.
b	Number of columns of the matrix.
T	Data type of the matrix elements (must be a primitive type).

Definition at line 38 of file matnxn.hpp.

Member Typedef Documentation

type

template<size_t a, size_t b, Primitive T>

using mal_math::mat< a, b, T >::type = T

Alias for the primitive data type used in the matrix.

Definition at line 41 of file matnxn.hpp.

Constructor & Destructor Documentation

mat() [1/7]

template<size_t a, size_t b, Primitive T>

mal_math::mat< a, b, T >::mat ( )

constexprdefault

Default constructor.

mat() [2/7]

template<size_t a, size_t b, Primitive T>
requires (a == b)

template<Primitive P>
requires (a == b)

mal_math::mat< a, b, T >::mat ( P p )

explicitconstexpr

Constructor that initializes a square matrix with a single value.

Template Parameters

P	Primitive type for the initialization value.

Parameters

p	The value to initialize the matrix with.

Definition at line 8 of file matnxn.inl.

mat() [3/7]

template<size_t a, size_t b, Primitive T>
requires (a >= c && b >= d)

template<size_t c, size_t d, Primitive P>
requires (a >= c && b >= d)

mal_math::mat< a, b, T >::mat ( mat< c, d, P > p )

explicitconstexpr

Constructor that initializes the matrix from another matrix.

Template Parameters

c	Number of rows of the source matrix.
d	Number of columns of the source matrix.
P	Primitive type of the source matrix.

Parameters

p	Source matrix to copy from.

Definition at line 18 of file matnxn.inl.

mat() [4/7]

template<size_t a, size_t b, Primitive T>
requires (a >= c && b >= d)

template<size_t c, size_t d, Primitive P>
requires (a >= c && b >= d)

mal_math::mat< a, b, T >::mat ( rmat< c, d, P > p )

explicitconstexpr

Constructor that initializes the matrix from another matrix.

Template Parameters

c	Number of rows of the source matrix.
d	Number of columns of the source matrix.
P	Primitive type of the source matrix.

Parameters

p	Source matrix to copy from.

Definition at line 31 of file matnxn.inl.

mat() [5/7]

template<size_t a, size_t b, Primitive T>

template<Primitive P>

mal_math::mat< a, b, T >::mat ( mat< a, b, P > p )

explicitconstexpr

Constructor that initializes the matrix from another matrix with the same dimensions.

Parameters

p	Source matrix to copy from.

Definition at line 44 of file matnxn.inl.

mat() [6/7]

template<size_t a, size_t b, Primitive T>

template<Primitive P>

mal_math::mat< a, b, T >::mat ( rmat< a, b, P > p )

explicitconstexpr

Constructor that initializes the matrix from another matrix with the same dimensions.

Parameters

p	Source matrix to copy from.

Definition at line 53 of file matnxn.inl.

mat() [7/7]

template<size_t a, size_t b, Primitive T>

template<typename... U>

mal_math::mat< a, b, T >::mat ( U... data )

explicitconstexpr

Constructor that initializes the matrix from any data (such as floats, vectors, integers etc.). It doesn't care if primitive type is the same, it can eat basically anything. For example:

mat3x3<float> m(1, 2, 3, 4, 5, 6, 7, 8, 9);
mat3x3<float> m(1, 2, 3, 4, 5, 6, vec3{7, 8, 9});
mat3 m2(vec3{1, vec2{2, 3}}, vec<4, int>{4,5,6,7], uivec2{8, 9});

Definition at line 62 of file matnxn.inl.

Member Function Documentation

as_rmat()

template<size_t a, size_t b, Primitive T>

template<size_t c = a, size_t d = b>

rmat< c, d, T > mal_math::mat< a, b, T >::as_rmat ( )

inlineconstexprnoexcept

Converts the matrix to an rmat type.

Template Parameters

c	Number of rows for the rmat (default is a).
d	Number of columns for the rmat (default is b).

Returns

rmat<c, d, T> The matrix in rmat form.

Definition at line 243 of file matnxn.hpp.

get_parameter_pack_size() [1/3]

template<size_t a, size_t b, Primitive T>

template<class V >

size_t mal_math::mat< a, b, T >::get_parameter_pack_size ( )

staticconstexprprivate

Determines the size of a parameter pack for primitive types.

Returns

size_t Always returns 1 for primitive types.

Definition at line 201 of file matnxn.inl.

get_parameter_pack_size() [2/3]

template<size_t a, size_t b, Primitive T>

template<class V >

static constexpr size_t mal_math::mat< a, b, T >::get_parameter_pack_size ( )

staticconstexprprivate

Determines the size of a parameter pack for vector types.

Returns

size_t Returns the size attribute of the vector type.

get_parameter_pack_size() [3/3]

template<size_t a, size_t b, Primitive T>

template<typename A , typename B , typename... C>

size_t mal_math::mat< a, b, T >::get_parameter_pack_size ( )

staticconstexprprivate

Determines the size of a parameter pack for a mixed set of types.

Returns

size_t Returns the cumulative size of the parameter pack types.

Definition at line 217 of file matnxn.inl.

identity()

template<size_t a, size_t b, Primitive T>

static constexpr mat< a, b, T > mal_math::mat< a, b, T >::identity ( )

inlinestaticconstexprnoexcept

Returns the identity matrix of size a x b.

Returns

mat<a, b, T> Identity matrix.

Definition at line 49 of file matnxn.hpp.

operator*=() [1/3]

template<size_t a, size_t b, Primitive T>

template<size_t c, Primitive U>

mat< a, c, T > & mal_math::mat< a, b, T >::operator*= ( mat< b, c, U > const & other )

constexpr

Multiplies the current matrix with another matrix.

Template Parameters

c	Number of columns in the resulting matrix.
U	Type of the elements in the other matrix.

Parameters

other

Matrix to multiply with the current matrix.

Returns

mat<a, c, T>& Returns a reference to the modified current matrix.

Definition at line 135 of file matnxn.inl.

operator*=() [2/3]

template<size_t a, size_t b, Primitive T>

template<size_t c, Primitive U>

mat< a, c, T > & mal_math::mat< a, b, T >::operator*= ( rmat< b, c, U > const & other )

constexpr

Multiplies the current matrix with another row-major matrix.

Template Parameters

c	Number of columns in the resulting matrix.
U	Type of the elements in the other row-major matrix.

Parameters

other

Row-major matrix to multiply with the current matrix.

Returns

mat<a, c, T>& Returns a reference to the modified current matrix.

Definition at line 163 of file matnxn.inl.

operator*=() [3/3]

template<size_t a, size_t b, Primitive T>

template<Primitive U>

mat< a, b, T > & mal_math::mat< a, b, T >::operator*= ( U const value )

constexpr

Multiplies each element of the current matrix by a scalar value.

Template Parameters

U	Type of the scalar value.

Parameters

value

Scalar value to multiply each element with.

Returns

mat<a, b, T>& Returns a reference to the modified current matrix.

Definition at line 190 of file matnxn.inl.

operator+()

template<size_t a, size_t b, Primitive T>

mat< a, b, T > const & mal_math::mat< a, b, T >::operator+ ( ) const

nodiscardconstexprnoexcept

Unary plus operator.

Returns

const mat<a, b, T>& Returns a reference to the current matrix without any changes.

Definition at line 96 of file matnxn.inl.

operator+=() [1/3]

template<size_t a, size_t b, Primitive T>

template<Primitive U>

mat< a, b, T > & mal_math::mat< a, b, T >::operator+= ( mat< a, b, U > const & other )

constexpr

Adds another matrix to the current matrix.

Template Parameters

U	Type of the elements in the other matrix.

Parameters

other

Matrix to add to the current matrix.

Returns

mat<a, b, T>& Returns a reference to the modified current matrix.

Definition at line 114 of file matnxn.inl.

operator+=() [2/3]

template<size_t a, size_t b, Primitive T>

template<Primitive U>

mat< a, b, T > & mal_math::mat< a, b, T >::operator+= ( rmat< a, b, U > const & other )

constexpr

Adds another row-major matrix to the current matrix.

Template Parameters

U	Type of the elements in the other row-major matrix.

Parameters

other

Row-major matrix to add to the current matrix.

Returns

mat<a, b, T>& Returns a reference to the modified current matrix.

Definition at line 142 of file matnxn.inl.

operator+=() [3/3]

template<size_t a, size_t b, Primitive T>

template<Primitive U>

mat< a, b, T > & mal_math::mat< a, b, T >::operator+= ( U const value )

constexpr

Adds a scalar value to each element of the current matrix.

Template Parameters

U	Type of the scalar value.

Parameters

value

Scalar value to add to each element.

Returns

mat<a, b, T>& Returns a reference to the modified current matrix.

Definition at line 170 of file matnxn.inl.

operator-()

template<size_t a, size_t b, Primitive T>

mat< a, b, T > mal_math::mat< a, b, T >::operator- ( ) const

nodiscardconstexprnoexcept

Unary minus operator.

Returns

mat<a, b, T> Returns a new matrix with all elements negated.

Definition at line 102 of file matnxn.inl.

operator-=() [1/3]

template<size_t a, size_t b, Primitive T>

template<Primitive U>

mat< a, b, T > & mal_math::mat< a, b, T >::operator-= ( mat< a, b, U > const & other )

constexpr

Subtracts another matrix from the current matrix.

Template Parameters

U	Type of the elements in the other matrix.

Parameters

other

Matrix to subtract from the current matrix.

Returns

mat<a, b, T>& Returns a reference to the modified current matrix.

Definition at line 124 of file matnxn.inl.

operator-=() [2/3]

template<size_t a, size_t b, Primitive T>

template<Primitive U>

mat< a, b, T > & mal_math::mat< a, b, T >::operator-= ( rmat< a, b, U > const & other )

constexpr

Subtracts another row-major matrix from the current matrix.

Template Parameters

U	Type of the elements in the other row-major matrix.

Parameters

other

Row-major matrix to subtract from the current matrix.

Returns

mat<a, b, T>& Returns a reference to the modified current matrix.

Definition at line 152 of file matnxn.inl.

operator-=() [3/3]

template<size_t a, size_t b, Primitive T>

template<Primitive U>

mat< a, b, T > & mal_math::mat< a, b, T >::operator-= ( U const value )

constexpr

Subtracts a scalar value from each element of the current matrix.

Template Parameters

U	Type of the scalar value.

Parameters

value

Scalar value to subtract from each element.

Returns

mat<a, b, T>& Returns a reference to the modified current matrix.

Definition at line 180 of file matnxn.inl.

operator[]() [1/2]

template<size_t a, size_t b, Primitive T>

vec< b, T > & mal_math::mat< a, b, T >::operator[] ( size_t i )

nodiscardconstexpr

Accesses a row of the matrix.

Parameters

i	Index of the row.

Returns

A reference to the row at the given index.

Definition at line 83 of file matnxn.inl.

operator[]() [2/2]

template<size_t a, size_t b, Primitive T>

vec< b, T > const & mal_math::mat< a, b, T >::operator[] ( size_t i ) const

nodiscardconstexpr

Accesses a row of the matrix (const version).

Parameters

i	Index of the row.

Returns

A const reference to the row at the given index.

Definition at line 89 of file matnxn.inl.

reset()

template<size_t a, size_t b, Primitive T>

void mal_math::mat< a, b, T >::reset ( )

constexprnoexcept

Resets the matrix to have all zero values.

Definition at line 70 of file matnxn.inl.

unpack_data() [1/3]

template<size_t a, size_t b, Primitive T>

template<typename A , typename B , typename... C>

void mal_math::mat< a, b, T >::unpack_data ( size_t offset, A first, B second, C... rest )

constexprprivate

Recursively unpacks multiple values into the matrix data.

Parameters

offset	The position to start unpacking in the matrix data.
first	The first value to unpack.
second	The second value to unpack.
rest	The remaining values to unpack.

Definition at line 245 of file matnxn.inl.

unpack_data() [2/3]

template<size_t a, size_t b, Primitive T>

template<class V >

void mal_math::mat< a, b, T >::unpack_data ( size_t offset, V u )

constexprprivate

Unpacks a single primitive value into the matrix data.

Parameters

offset	The position to start unpacking in the matrix data.
u	The primitive value to unpack.

Definition at line 226 of file matnxn.inl.

unpack_data() [3/3]

template<size_t a, size_t b, Primitive T>

template<class V >

void mal_math::mat< a, b, T >::unpack_data ( size_t offset, V vec )

constexprprivate

Unpacks a vector into the matrix data.

Parameters

offset	The position to start unpacking in the matrix data.
vec	The vector to unpack.

Member Data Documentation

[union]

union { ... } mal_math::mat< a, b, T >

Union containing two ways to represent matrix data.

arr

template<size_t a, size_t b, Primitive T>

std::array<T, size.x *size.y> mal_math::mat< a, b, T >::arr

Linear array representation of matrix data.

Definition at line 248 of file matnxn.hpp.

data

template<size_t a, size_t b, Primitive T>

std::array<vec<size.y, T>, size.x> mal_math::mat< a, b, T >::data

2D array (rows x columns) representation of matrix data.

Definition at line 249 of file matnxn.hpp.

size

template<size_t a, size_t b, Primitive T>

vec<2, size_t> mal_math::mat< a, b, T >::size { a, b }

staticconstexpr

Represents the dimensions of the matrix.

Definition at line 43 of file matnxn.hpp.

---

The documentation for this class was generated from the following files:

• include/math/math-common.hpp
• include/math/matnxn.hpp
• include/math/matnxn.inl