Fixed-size math matrix. Stores matrix data inline and performs dimension checks at compile time where possible. More...

#include <pimathmatrix.h>

Public Member Functions
	PIMathMatrixT (const Type &new_value=Type())
	Constructs PIMathMatrixT that is filled by new_value.
	PIMathMatrixT (const PIVector< Type > &val)
	Contructs PIMathMatrixT from PIVector.
	PIMathMatrixT (std::initializer_list< Type > init_list)
	Contructs PIMathMatrixT from C++11 initializer list.
constexpr uint	cols () const
	Method which returns number of columns in matrix.
constexpr uint	rows () const
	Method which returns number of rows in matrix.
PIMathVectorT< Rows, Type >	col (uint index)
	Method which returns the selected column in PIMathVectorT format.
PIMathVectorT< Cols, Type >	row (uint index)
	Method which returns the selected row in PIMathVectorT format.
PIMathMatrixT< Rows, Cols, Type > &	setCol (uint index, const PIMathVectorT< Rows, Type > &v)
	Set the selected column in matrix.
PIMathMatrixT< Rows, Cols, Type > &	setRow (uint index, const PIMathVectorT< Cols, Type > &v)
	Set the selected row in matrix.
PIMathMatrixT< Rows, Cols, Type > &	swapRows (uint rf, uint rs)
	Method which swaps the selected rows in a matrix.
PIMathMatrixT< Rows, Cols, Type > &	swapCols (uint cf, uint cs)
	Method which swaps the selected columns in a matrix.
PIMathMatrixT< Rows, Cols, Type > &	fill (const Type &v)
	Method which fills the matrix with selected value.
constexpr bool	isSquare () const
	Method which checks if matrix is square.
bool	isIdentity () const
	Method which checks if main diagonal of matrix consists of ones and another elements are zeros.
bool	isNull () const
	Method which checks if every elements of matrix are zeros.
Type	at (uint row, uint col) const
	Read-only access to element by row number and col number.
Type &	element (uint row, uint col)
	Full access to element by row number and col number.
const Type &	element (uint row, uint col) const
	Read-only access to element by row number and col number.
Type *	operator[] (uint row)
	Full access to the matrix row pointer.
const Type *	operator[] (uint row) const
	Read-only access to the matrix row pointer.
bool	operator== (const PIMathMatrixT< Rows, Cols, Type > &sm) const
	Matrix compare.
bool	operator!= (const PIMathMatrixT< Rows, Cols, Type > &sm) const
	Matrix negative compare.
void	operator+= (const PIMathMatrixT< Rows, Cols, Type > &sm)
	Addition assignment with matrix sm.
void	operator-= (const PIMathMatrixT< Rows, Cols, Type > &sm)
	Subtraction assignment with matrix sm.
void	operator*= (const Type &v)
	Multiplication assignment with value v.
void	operator/= (const Type &v)
	Division assignment with value v.
PIMathMatrixT< Rows, Cols, Type >	operator- () const
	Negation operation.
PIMathMatrixT< Rows, Cols, Type >	operator+ (const PIMathMatrixT< Rows, Cols, Type > &sm) const
	Matrix addition.
PIMathMatrixT< Rows, Cols, Type >	operator- (const PIMathMatrixT< Rows, Cols, Type > &sm) const
	Matrix substraction.
PIMathMatrixT< Rows, Cols, Type >	operator* (const Type &v) const
	Matrix multiplication by a constant.
PIMathMatrixT< Rows, Cols, Type >	operator/ (const Type &v) const
	Division a matrix by a constant.
Type	determinant (bool *ok=0) const
	Calculate Determinant of the matrix.
Type	trace () const
	Calculate the trace of a matrix.
PIMathMatrixT< Rows, Cols, Type > &	toUpperTriangular (bool *ok=0)
	Transforming matrix to upper triangular.
PIMathMatrixT< Rows, Cols, Type > &	invert (bool *ok=0)
	Matrix inversion operation.
PIMathMatrixT< Rows, Cols, Type >	inverted (bool *ok=0) const
	Matrix inversion operation.
PIMathMatrixT< Cols, Rows, Type >	transposed () const
	Matrix transposition operation.
PIMathMatrixT< Rows, Cols, Type > &	rotate (Type angle)
	Matrix rotation operation.
PIMathMatrixT< Rows, Cols, Type >	rotated (Type angle)
	Matrix rotation operation.
template<typename T>
PIMathMatrixT< Rows, Cols, T >	toType () const
	Returns this matrix with another element type.
template<uint SubRows, uint SubCols = SubRows>
PIMathMatrixT< SubRows, SubCols, Type >	submatrix (int row_offset=0, int col_offset=0) const
	Returns the submatrix with size SubRows x SubCols. Elements takes from coordinates "row_offset" and "col_offset".
template<uint SubRows, uint SubCols = SubRows>
PIMathMatrixT< Rows, Cols, Type > &	setSubmatrix (int row_index, int col_index, const PIMathMatrixT< SubRows, SubCols, Type > &m)
	Set the submatrix "m" in coordinates "row_index" and "col_index".

Static Public Member Functions
static PIMathMatrixT< Rows, Cols, Type >	identity ()
	Сreates a matrix whose main diagonal is filled with ones and the remaining elements are zeros.

Detailed Description

template<uint Rows, uint Cols = Rows, typename Type = double>
class PIMathMatrixT< Rows, Cols, Type >

Fixed-size math matrix. Stores matrix data inline and performs dimension checks at compile time where possible.

A class for fixed size and type matrix.

Template Parameters

`Rows`	rows number of matrix.
`Сols`	columns number of matrix.
`Type`	is the data type of the matrix. There are can be basic C++ language data and different classes where the arithmetic operators(=, +=, -=, =, /=, ==, !=, +, -, , /) of the C++ language are implemented

Member Function Documentation

◆ identity()

template<uint Rows, uint Cols = Rows, typename Type = double>

PIMathMatrixT< Rows, Cols, Type > PIMathMatrixT< Rows, Cols, Type >::identity ( )

inlinestatic

Сreates a matrix whose main diagonal is filled with ones and the remaining elements are zeros.

Returns: identity matrix of type PIMathMatrixT.

◆ cols()

template<uint Rows, uint Cols = Rows, typename Type = double>

uint PIMathMatrixT< Rows, Cols, Type >::cols ( ) const

inlineconstexpr

Method which returns number of columns in matrix.

Returns: type uint shows number of columns.

◆ rows()

template<uint Rows, uint Cols = Rows, typename Type = double>

uint PIMathMatrixT< Rows, Cols, Type >::rows ( ) const

inlineconstexpr

Method which returns number of rows in matrix.

Returns: type uint shows number of rows.

◆ col()

template<uint Rows, uint Cols = Rows, typename Type = double>

PIMathVectorT< Rows, Type > PIMathMatrixT< Rows, Cols, Type >::col ( uint index )

inline

Method which returns the selected column in PIMathVectorT format.

If you enter an index out of the border of the matrix there will be "undefined behavior".

Parameters

index is the number of the selected column.

Returns: column in PIMathVectorT format.

◆ row()

template<uint Rows, uint Cols = Rows, typename Type = double>

PIMathVectorT< Cols, Type > PIMathMatrixT< Rows, Cols, Type >::row ( uint index )

inline

Method which returns the selected row in PIMathVectorT format.

If you enter an index out of the border of the matrix there will be "undefined behavior".

Parameters

index is the number of the selected row.

Returns: row in PIMathVectorT format.

◆ setCol()

template<uint Rows, uint Cols = Rows, typename Type = double>

PIMathMatrixT< Rows, Cols, Type > & PIMathMatrixT< Rows, Cols, Type >::setCol	(	uint	index,
		const PIMathVectorT< Rows, Type > &	v )

inline

Set the selected column in matrix.

If you enter an index out of the border of the matrix there will be "undefined behavior".

Parameters

index	is the number of the selected column.
v	is a vector of the type PIMathVectorT<Rows, Type> that needs to fill the column.

Returns: matrix type PIMathMatrixT<Rows, Cols, Type>.

◆ setRow()

template<uint Rows, uint Cols = Rows, typename Type = double>

PIMathMatrixT< Rows, Cols, Type > & PIMathMatrixT< Rows, Cols, Type >::setRow	(	uint	index,
		const PIMathVectorT< Cols, Type > &	v )

inline

Set the selected row in matrix.

If you enter an index out of the border of the matrix there will be "undefined behavior".

Parameters

index	is the number of the selected row.
v	is a vector of the type PIMathVectorT<Cols, Type> that needs to fill the row.

Returns: matrix type PIMathMatrixT<Rows, Cols, Type>

◆ swapRows()

template<uint Rows, uint Cols = Rows, typename Type = double>

PIMathMatrixT< Rows, Cols, Type > & PIMathMatrixT< Rows, Cols, Type >::swapRows	(	uint	rf,
		uint	rs )

inline

Method which swaps the selected rows in a matrix.

If you enter an index out of the border of the matrix there will be "undefined behavior"

Parameters

rf	is the number of the first selected row
rs	is the number of the second selected row

Returns: matrix type PIMathMatrixT<Rows, Cols, Type>

◆ swapCols()

template<uint Rows, uint Cols = Rows, typename Type = double>

PIMathMatrixT< Rows, Cols, Type > & PIMathMatrixT< Rows, Cols, Type >::swapCols	(	uint	cf,
		uint	cs )

inline

Method which swaps the selected columns in a matrix.

If you enter an index out of the border of the matrix there will be "undefined behavior"

Parameters

cf	is the number of the first selected column
cs	is the number of the second selected column

Returns: matrix type PIMathMatrixT<Rows, Cols, Type>

◆ fill()

template<uint Rows, uint Cols = Rows, typename Type = double>

PIMathMatrixT< Rows, Cols, Type > & PIMathMatrixT< Rows, Cols, Type >::fill ( const Type & v )

inline

Method which fills the matrix with selected value.

Parameters

v	is a parameter the type and value of which is selected and later filled into the matrix.

Returns: filled matrix type PIMathMatrixT<Rows, Cols, Type>.

◆ isSquare()

template<uint Rows, uint Cols = Rows, typename Type = double>

bool PIMathMatrixT< Rows, Cols, Type >::isSquare ( ) const

inlineconstexpr

Method which checks if matrix is square.

Returns: true if matrix is square, else false.

◆ isIdentity()

template<uint Rows, uint Cols = Rows, typename Type = double>

bool PIMathMatrixT< Rows, Cols, Type >::isIdentity ( ) const

inline

Method which checks if main diagonal of matrix consists of ones and another elements are zeros.

Returns: true if matrix is identitied, else false.

◆ isNull()

template<uint Rows, uint Cols = Rows, typename Type = double>

bool PIMathMatrixT< Rows, Cols, Type >::isNull ( ) const

inline

Method which checks if every elements of matrix are zeros.

Returns: true if matrix is null, else false.

◆ at()

template<uint Rows, uint Cols = Rows, typename Type = double>

Type PIMathMatrixT< Rows, Cols, Type >::at	(	uint	row,
		uint	col ) const

inline

Read-only access to element by row number and col number.

If you enter an index out of the border of the matrix there will be "undefined behavior".

Parameters

row	matrix row number.
col	matrix column number.

Returns: copy of element of matrix.

◆ element() [1/2]

template<uint Rows, uint Cols = Rows, typename Type = double>

Type & PIMathMatrixT< Rows, Cols, Type >::element	(	uint	row,
		uint	col )

inline

Full access to element by row number and col number.

If you enter an index out of the border of the matrix there will be "undefined behavior"

Parameters

row	matrix row number.
col	matrix column number.

Returns: element of matrix

◆ element() [2/2]

template<uint Rows, uint Cols = Rows, typename Type = double>

const Type & PIMathMatrixT< Rows, Cols, Type >::element	(	uint	row,
		uint	col ) const

inline

Read-only access to element by row number and col number.

If you enter an index out of the border of the matrix there will be "undefined behavior".

Parameters

row	matrix row number.
col	matrix column number.

Returns: copy of element of matrix.

◆ operator[]() [1/2]

template<uint Rows, uint Cols = Rows, typename Type = double>

Type * PIMathMatrixT< Rows, Cols, Type >::operator[] ( uint row )

inline

Full access to the matrix row pointer.

If you enter an index out of the border of the matrix there will be "undefined behavior".

Parameters

row	matrix row number.

Returns: matrix row pointer

◆ operator[]() [2/2]

template<uint Rows, uint Cols = Rows, typename Type = double>

const Type * PIMathMatrixT< Rows, Cols, Type >::operator[] ( uint row ) const

inline

Read-only access to the matrix row pointer.

If you enter an index out of the border of the matrix there will be "undefined behavior".

Parameters

row	matrix row number.

Returns: matrix row pointer

◆ operator==()

template<uint Rows, uint Cols = Rows, typename Type = double>

bool PIMathMatrixT< Rows, Cols, Type >::operator== ( const PIMathMatrixT< Rows, Cols, Type > & sm ) const

inline

Matrix compare.

Parameters

sm	matrix for compare.

Returns: if matrices are equal true, else false.

◆ operator!=()

template<uint Rows, uint Cols = Rows, typename Type = double>

bool PIMathMatrixT< Rows, Cols, Type >::operator!= ( const PIMathMatrixT< Rows, Cols, Type > & sm ) const

inline

Matrix negative compare.

Parameters

sm	matrix for compare.

Returns: if matrices are not equal true, else false.

◆ operator+=()

template<uint Rows, uint Cols = Rows, typename Type = double>

void PIMathMatrixT< Rows, Cols, Type >::operator+= ( const PIMathMatrixT< Rows, Cols, Type > & sm )

inline

Addition assignment with matrix sm.

Parameters

sm	matrix for the addition assigment.

◆ operator-=()

template<uint Rows, uint Cols = Rows, typename Type = double>

void PIMathMatrixT< Rows, Cols, Type >::operator-= ( const PIMathMatrixT< Rows, Cols, Type > & sm )

inline

Subtraction assignment with matrix sm.

Parameters

sm	matrix for the subtraction assigment.

◆ operator*=()

template<uint Rows, uint Cols = Rows, typename Type = double>

void PIMathMatrixT< Rows, Cols, Type >::operator*= ( const Type & v )

inline

Multiplication assignment with value v.

Parameters

v	value for the multiplication assigment.

◆ operator/=()

template<uint Rows, uint Cols = Rows, typename Type = double>

void PIMathMatrixT< Rows, Cols, Type >::operator/= ( const Type & v )

inline

Division assignment with value v.

Parameters

v	value for the division assigment.

◆ operator-() [1/2]

template<uint Rows, uint Cols = Rows, typename Type = double>

PIMathMatrixT< Rows, Cols, Type > PIMathMatrixT< Rows, Cols, Type >::operator- ( ) const

inline

Negation operation.

Returns: copy of the negative matrix

◆ operator+()

template<uint Rows, uint Cols = Rows, typename Type = double>

PIMathMatrixT< Rows, Cols, Type > PIMathMatrixT< Rows, Cols, Type >::operator+ ( const PIMathMatrixT< Rows, Cols, Type > & sm ) const

inline

Matrix addition.

Parameters

sm	is matrix term.

Returns: the result of matrix addition.

◆ operator-() [2/2]

template<uint Rows, uint Cols = Rows, typename Type = double>

PIMathMatrixT< Rows, Cols, Type > PIMathMatrixT< Rows, Cols, Type >::operator- ( const PIMathMatrixT< Rows, Cols, Type > & sm ) const

inline

Matrix substraction.

Parameters

sm	is matrix subtrahend.

Returns: the result of matrix substraction.

◆ operator*()

template<uint Rows, uint Cols = Rows, typename Type = double>

PIMathMatrixT< Rows, Cols, Type > PIMathMatrixT< Rows, Cols, Type >::operator* ( const Type & v ) const

inline

Matrix multiplication by a constant.

Parameters

v	is value factor.

Returns: the result of matrix multiplication.

◆ operator/()

template<uint Rows, uint Cols = Rows, typename Type = double>

PIMathMatrixT< Rows, Cols, Type > PIMathMatrixT< Rows, Cols, Type >::operator/ ( const Type & v ) const

inline

Division a matrix by a constant.

Parameters

v	is value divider.

Returns: the result of matrix division.

◆ determinant()

template<uint Rows, uint Cols = Rows, typename Type = double>

Type PIMathMatrixT< Rows, Cols, Type >::determinant ( bool * ok = 0 ) const

inline

Calculate Determinant of the matrix.

Works only with square matrix, nonzero matrices and invertible matrix.

Parameters

ok	is a parameter with which we can find out if the method worked correctly.

Returns: matrix determinant.

◆ trace()

template<uint Rows, uint Cols = Rows, typename Type = double>

Type PIMathMatrixT< Rows, Cols, Type >::trace ( ) const

inline

Calculate the trace of a matrix.

Works only with square matrix.

Returns: matrix trace.

◆ toUpperTriangular()

template<uint Rows, uint Cols = Rows, typename Type = double>

PIMathMatrixT< Rows, Cols, Type > & PIMathMatrixT< Rows, Cols, Type >::toUpperTriangular ( bool * ok = 0 )

inline

Transforming matrix to upper triangular.

Works only with square matrix, nonzero matrices and invertible matrix.

Parameters

ok	is a parameter with which we can find out if the method worked correctly.

Returns: a transformed upper triangular matrix.

◆ invert()

template<uint Rows, uint Cols = Rows, typename Type = double>

PIMathMatrixT< Rows, Cols, Type > & PIMathMatrixT< Rows, Cols, Type >::invert ( bool * ok = 0 )

inline

Matrix inversion operation.

Works only with square matrix, nonzero matrices and invertible matrix.

Parameters

ok	is a parameter with which we can find out if the method worked correctly.

Returns: inverted matrix.

◆ inverted()

template<uint Rows, uint Cols = Rows, typename Type = double>

PIMathMatrixT< Rows, Cols, Type > PIMathMatrixT< Rows, Cols, Type >::inverted ( bool * ok = 0 ) const

inline

Matrix inversion operation.

Works only with square matrix, nonzero matrices and invertible matrix.

Parameters

ok	is a parameter with which we can find out if the method worked correctly.

Returns: copy of inverted matrix.

◆ transposed()

template<uint Rows, uint Cols = Rows, typename Type = double>

PIMathMatrixT< Cols, Rows, Type > PIMathMatrixT< Rows, Cols, Type >::transposed ( ) const

inline

Matrix transposition operation.

Works only with square matrix.

Returns: copy of transposed matrix

◆ rotate()

template<uint Rows, uint Cols = Rows, typename Type = double>

PIMathMatrixT< Rows, Cols, Type > & PIMathMatrixT< Rows, Cols, Type >::rotate ( Type angle )

inline

Matrix rotation operation.

Works only with 2x2 matrix.

Returns: rotated matrix.

◆ rotated()

template<uint Rows, uint Cols = Rows, typename Type = double>

PIMathMatrixT< Rows, Cols, Type > PIMathMatrixT< Rows, Cols, Type >::rotated ( Type angle )

inline

Matrix rotation operation.

Works only with 2x2 matrix.

Returns: copy of rotated matrix.

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ identity()

◆ cols()

◆ rows()

◆ col()

◆ row()

◆ setCol()

◆ setRow()

◆ swapRows()

◆ swapCols()

◆ fill()

◆ isSquare()

◆ isIdentity()

◆ isNull()

◆ at()

◆ element() [1/2]

◆ element() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ operator==()

◆ operator!=()

◆ operator+=()

◆ operator-=()

◆ operator*=()

◆ operator/=()

◆ operator-() [1/2]

◆ operator+()

◆ operator-() [2/2]

◆ operator*()

◆ operator/()

◆ determinant()

◆ trace()

◆ toUpperTriangular()

◆ invert()

◆ inverted()

◆ transposed()

◆ rotate()

◆ rotated()