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

#include "rmatnxn.hpp"

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

Public Types
using	type = T
	Alias for the data type of the matrix elements.

Public Member Functions
constexpr	rmat ()
	Default constructor.

template<size_t c, size_t d, Primitive P> requires (c >= a && d >= b)
constexpr	rmat (mat< c, d, P > &p)
	Constructs a reference matrix from another matrix.

template<size_t c, size_t d, Primitive P> requires (c >= a && d >= b)
constexpr	rmat (rmat< c, d, P > &p)
	Constructs a reference matrix from another reference matrix.

template<typename U >
constexpr rmat< a, b, T > &	operator= (mat< a, b, U > const &mat)
	Assigns values from a matrix of the same size.

template<typename U >
constexpr rmat< a, b, T > &	operator= (rmat< a, b, U > const &mat)
	Assigns values from a reference matrix of the same size.

constexpr void	reset () noexcept
	Resets all elements to zero.

constexpr _detail::rvec< b, T > &	operator[] (size_t i)
	Indexing operator to access rows.

constexpr _detail::rvec< b, T > const &	operator[] (size_t i) const
	Const version of indexing operator to access rows.

constexpr rmat< a, b, T > const &	operator+ () const noexcept
	Unary plus operator, returns the matrix itself.

constexpr mat< a, b, T >	operator- () const noexcept
	Unary minus operator, returns negated matrix.

template<Primitive U>
constexpr rmat< a, b, T > &	operator+= (rmat< a, b, U > const &other)
	Adds another reference matrix of the same size to this matrix.

template<Primitive U>
constexpr rmat< a, b, T > &	operator-= (rmat< a, b, U > const &other)
	Subtracts another reference matrix of the same size from this matrix.

template<size_t c, Primitive U>
constexpr rmat< a, c, T > &	operator*= (rmat< b, c, U > const &other)
	Matrix multiplication with another reference matrix.

template<Primitive U>
constexpr rmat< a, b, T > &	operator+= (mat< a, b, U > const &other)
	Adds another matrix of the same size to this matrix.

template<Primitive U>
constexpr rmat< a, b, T > &	operator-= (mat< a, b, U > const &other)
	Subtracts another matrix of the same size from this matrix.

template<size_t c, Primitive U>
constexpr rmat< a, c, T > &	operator*= (mat< b, c, U > const &other)
	Matrix multiplication with another matrix.

template<Primitive U>
constexpr rmat< a, b, T > &	operator+= (U const value)
	Adds a scalar to all elements of this matrix.

template<Primitive U>
constexpr rmat< a, b, T > &	operator-= (U const value)
	Subtracts a scalar from all elements of this matrix.

template<Primitive U>
constexpr rmat< a, b, T > &	operator*= (U const value)
	Multiplies all elements of this matrix with a scalar.

Public Attributes
union {

std::array< _detail::primitive_reference_wrapper< T >, size.x *size.y > arr
	Linear representation of the matrix. More...

std::array< _detail::rvec< size.y, T >, size.x > data
	2D representation of the matrix. More...

};
	Union to represent matrix data in different formats.

Static Public Attributes
static constexpr ivec2	size { a, b }
	Defines the size of the matrix.

Detailed Description

template<size_t a, size_t b, Primitive T>
struct mal_math::rmat< a, b, T >

Definition of a reference matrix with dimensions rows x columns and type T

Represents a matrix of references, allowing efficient interactions without actual copying.

Template Parameters

a	Number of rows in the matrix.
b	Number of columns in the matrix.
T	Primitive type of the matrix elements.

Definition at line 45 of file rmatnxn.hpp.

Member Typedef Documentation

◆ type

template<size_t a, size_t b, Primitive T>

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

Alias for the data type of the matrix elements.

Definition at line 46 of file rmatnxn.hpp.

Constructor & Destructor Documentation

◆ rmat() [1/3]

template<size_t a, size_t b, Primitive T>

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

inlineconstexpr

Default constructor.

Definition at line 51 of file rmatnxn.hpp.

◆ rmat() [2/3]

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

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

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

constexpr

Constructs a reference matrix from another matrix.

Template Parameters

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

Parameters

p	Source matrix to be copied from.

Definition at line 8 of file rmatnxn.inl.

◆ rmat() [3/3]

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

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

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

constexpr

Constructs a reference matrix from another reference matrix.

Template Parameters

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

Parameters

p	Source reference matrix to be copied from.

Definition at line 20 of file rmatnxn.inl.

Member Function Documentation

◆ operator*=() [1/3]

template<size_t a, size_t b, Primitive T>

template<size_t c, Primitive U>

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

constexpr

Matrix multiplication with another matrix.

Definition at line 146 of file rmatnxn.inl.

◆ operator*=() [2/3]

template<size_t a, size_t b, Primitive T>

template<size_t c, Primitive U>

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

constexpr

Matrix multiplication with another reference matrix.

Definition at line 119 of file rmatnxn.inl.

◆ operator*=() [3/3]

template<size_t a, size_t b, Primitive T>

template<Primitive U>

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

constexpr

Multiplies all elements of this matrix with a scalar.

Definition at line 173 of file rmatnxn.inl.

◆ operator+()

template<size_t a, size_t b, Primitive T>

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

nodiscardconstexprnoexcept

Unary plus operator, returns the matrix itself.

Definition at line 80 of file rmatnxn.inl.

◆ operator+=() [1/3]

template<size_t a, size_t b, Primitive T>

template<Primitive U>

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

constexpr

Adds another matrix of the same size to this matrix.

Definition at line 125 of file rmatnxn.inl.

◆ operator+=() [2/3]

template<size_t a, size_t b, Primitive T>

template<Primitive U>

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

constexpr

Adds another reference matrix of the same size to this matrix.

Definition at line 98 of file rmatnxn.inl.

◆ operator+=() [3/3]

template<size_t a, size_t b, Primitive T>

template<Primitive U>

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

constexpr

Adds a scalar to all elements of this matrix.

Definition at line 153 of file rmatnxn.inl.

◆ operator-()

template<size_t a, size_t b, Primitive T>

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

nodiscardconstexprnoexcept

Unary minus operator, returns negated matrix.

Definition at line 86 of file rmatnxn.inl.

◆ operator-=() [1/3]

template<size_t a, size_t b, Primitive T>

template<Primitive U>

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

constexpr

Subtracts another matrix of the same size from this matrix.

Definition at line 135 of file rmatnxn.inl.

◆ operator-=() [2/3]

template<size_t a, size_t b, Primitive T>

template<Primitive U>

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

constexpr

Subtracts another reference matrix of the same size from this matrix.

Definition at line 108 of file rmatnxn.inl.

◆ operator-=() [3/3]

template<size_t a, size_t b, Primitive T>

template<Primitive U>

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

constexpr

Subtracts a scalar from all elements of this matrix.

Definition at line 163 of file rmatnxn.inl.

◆ operator=() [1/2]

template<size_t a, size_t b, Primitive T>

template<typename U >

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

constexpr

Assigns values from a matrix of the same size.

Definition at line 33 of file rmatnxn.inl.

◆ operator=() [2/2]

template<size_t a, size_t b, Primitive T>

template<typename U >

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

constexpr

Assigns values from a reference matrix of the same size.

Definition at line 44 of file rmatnxn.inl.

◆ operator[]() [1/2]

template<size_t a, size_t b, Primitive T>

_detail::rvec< b, T > & mal_math::rmat< a, b, T >::operator[] ( size_t i )

nodiscardconstexpr

Indexing operator to access rows.

Definition at line 67 of file rmatnxn.inl.

◆ operator[]() [2/2]

template<size_t a, size_t b, Primitive T>

_detail::rvec< b, T > const & mal_math::rmat< a, b, T >::operator[] ( size_t i ) const

nodiscardconstexpr

Const version of indexing operator to access rows.

Definition at line 73 of file rmatnxn.inl.

◆ reset()

template<size_t a, size_t b, Primitive T>

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

constexprnoexcept

Resets all elements to zero.

Definition at line 54 of file rmatnxn.inl.

Member Data Documentation

◆ [union]

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

Union to represent matrix data in different formats.

◆ arr

template<size_t a, size_t b, Primitive T>

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

Linear representation of the matrix.

Definition at line 136 of file rmatnxn.hpp.

◆ data

template<size_t a, size_t b, Primitive T>

std::array<_detail::rvec<size.y, T>, size.x> mal_math::rmat< a, b, T >::data

2D representation of the matrix.

Definition at line 137 of file rmatnxn.hpp.

◆ size

template<size_t a, size_t b, Primitive T>

ivec2 mal_math::rmat< a, b, T >::size { a, b }

staticconstexpr

Defines the size of the matrix.

Definition at line 48 of file rmatnxn.hpp.

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

include/math/math-common.hpp
include/math/rmatnxn.hpp
include/math/rmatnxn.inl

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ type

Constructor & Destructor Documentation

◆ rmat() [1/3]

◆ rmat() [2/3]

◆ rmat() [3/3]

Member Function Documentation

◆ operator*=() [1/3]

◆ operator*=() [2/3]

◆ operator*=() [3/3]

◆ operator+()

◆ operator+=() [1/3]

◆ operator+=() [2/3]

◆ operator+=() [3/3]

◆ operator-()

◆ operator-=() [1/3]

◆ operator-=() [2/3]

◆ operator-=() [3/3]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ reset()

Member Data Documentation

◆ [union]

◆ arr

◆ data

◆ size