This class represents a threedimensional (numeric) Matrix as a template. More...

#include <matrix.h>

Public Member Functions
void	binRead (std::ifstream &is)
void	binWrite (std::ofstream &os)
void	clear ()
	Matrix ()
	Matrix (Vector< T > a, Vector< T > b, Vector< T > c)
	Main constructor for the template class Matrix. This constructor uses three vectors as parameters, which represents the three columns of the matrix.
bool	operator!= (const Matrix &M)
T &	operator() (int i, int j)
	This operator returns the value of the j-th element in the i-th column.
Matrix &	operator= (const Matrix &A)
bool	operator== (const Matrix &A)

Public Attributes
T	M [3][3]

Friends
Matrix	cutMatrix (const Matrix &M, int i, int j)
	This function returns a matrix where all elements of the i-th column and the j-th row set to zero.
T	det (const Matrix &A)
	Calculates the determinant of the matrix A.
Matrix	invert (const Matrix< T > &A)
	Calculates the inverse of a matrix, if possible.
Matrix	invert (const Matrix< T > &A, bool &invertable)
	Calculates the inverse of a matrix, if possible.
std::ostream &	operator<< (std::ostream &os, const Matrix &A)
	Output of the matrix into an ostream Output in the form: M00 M01 M02 M10 M11 M12 M20 M21 M22.
std::istream &	operator>> (std::istream &is, Matrix &A)
	Input of the matrix from an istream.
T	trace (const Matrix &A)
	Calculates the trace of matrix A, i.e. the sum over all diagonal elements.
Matrix	transpose (const Matrix &A)
	Calculates the transpose of the matrix A.

special operators
These operators are the common definitions of the corresponding matrix operations
Matrix	operator+ (const Matrix &A)
Matrix &	operator+= (const Matrix &A)
Matrix	operator- ()
Matrix &	operator-= (const Matrix &A)
Matrix &	operator*= (const Matrix &A)
Matrix &	operator/= (const T &x)
Matrix &	operator*= (const T &x)
Matrix	operator- (const Matrix &A, const Matrix &B)
Matrix	operator* (const Matrix &A, const Matrix &B)
Matrix	operator* (const Matrix &A, const T &x)
Matrix	operator* (const T &x, const Matrix &A)
Vector< T >	operator* (const Matrix &A, const Vector< T > &r)
Vector< T >	operator* (const Vector< T > &r, const Matrix &A)
Matrix	operator/ (const Matrix &A, const T &x)

Detailed Description

template<class T>
class GOAT::maths::Matrix< T >

This class represents a threedimensional (numeric) Matrix as a template.

The Matrix class represents a template class for 3x3 numeric matrices. Operators for standard matrix operation are provided. This class is intended to work with the Vector template class defined in this SDK.

Definition at line 22 of file matrix.h.

Constructor & Destructor Documentation

◆ Matrix() [1/2]

template<class T>

GOAT::maths::Matrix< T >::Matrix ( )

inline

Definition at line 25 of file matrix.h.

◆ Matrix() [2/2]

template<class T>

GOAT::maths::Matrix< T >::Matrix	(	Vector< T >	a,
		Vector< T >	b,
		Vector< T >	c )

inline

Main constructor for the template class Matrix. This constructor uses three vectors as parameters, which represents the three columns of the matrix.

Parameters

a	first column
b	second column
c	third column

Definition at line 54 of file matrix.h.

Member Function Documentation

◆ binRead()

template<class T>

void GOAT::maths::Matrix< T >::binRead ( std::ifstream & is )

inline

Parameters

is	reads the Matrix from a binary file, represented by is

Definition at line 39 of file matrix.h.

◆ binWrite()

template<class T>

void GOAT::maths::Matrix< T >::binWrite ( std::ofstream & os )

inline

Parameters

os	writes the Matrix into a binary file, represented by os

Definition at line 32 of file matrix.h.

◆ clear()

template<class T>

void GOAT::maths::Matrix< T >::clear ( )

inline

Definition at line 378 of file matrix.h.

◆ operator!=()

template<class T>

bool GOAT::maths::Matrix< T >::operator!= ( const Matrix< T > & M )

inline

Parameters

M	negative comparison operator, returns false, if at least one of the components are not equal

Definition at line 82 of file matrix.h.

◆ operator()()

template<class T>

T & GOAT::maths::Matrix< T >::operator()	(	int	i,
		int	j )

inline

This operator returns the value of the j-th element in the i-th column.

Parameters

i	index of the column
j	index of the row

Definition at line 96 of file matrix.h.

◆ operator*=() [1/2]

template<class T>

Matrix & GOAT::maths::Matrix< T >::operator*= ( const Matrix< T > & A )

inline

Parameters

A	multiplication with matrix A

Definition at line 136 of file matrix.h.

◆ operator*=() [2/2]

template<class T>

Matrix & GOAT::maths::Matrix< T >::operator*= ( const T & x )

inline

Parameters

x	multiplication with a scalar

Definition at line 160 of file matrix.h.

◆ operator+()

template<class T>

Matrix GOAT::maths::Matrix< T >::operator+ ( const Matrix< T > & A )

inline

Parameters

A	adding two matrices (same type)

Definition at line 102 of file matrix.h.

◆ operator+=()

template<class T>

Matrix & GOAT::maths::Matrix< T >::operator+= ( const Matrix< T > & A )

inline

Parameters

A	subtract one matrix from this matrix

Definition at line 111 of file matrix.h.

◆ operator-()

template<class T>

Matrix GOAT::maths::Matrix< T >::operator- ( )

inline

Definition at line 119 of file matrix.h.

◆ operator-=()

template<class T>

Matrix & GOAT::maths::Matrix< T >::operator-= ( const Matrix< T > & A )

inline

Parameters

A	subtraction operator

Definition at line 128 of file matrix.h.

◆ operator/=()

template<class T>

Matrix & GOAT::maths::Matrix< T >::operator/= ( const T & x )

inline

Parameters

x	division by a scalar

Definition at line 152 of file matrix.h.

◆ operator=()

template<class T>

Matrix & GOAT::maths::Matrix< T >::operator= ( const Matrix< T > & A )

inline

Parameters

A	assignment operator

Definition at line 64 of file matrix.h.

◆ operator==()

template<class T>

bool GOAT::maths::Matrix< T >::operator== ( const Matrix< T > & A )

inline

Parameters

A	comparison operator (two matrices are equal, if all components are exactly the same)

Definition at line 73 of file matrix.h.

◆ cutMatrix

template<class T>

Matrix cutMatrix	(	const Matrix< T > &	M,
		int	i,
		int	j )

friend

This function returns a matrix where all elements of the i-th column and the j-th row set to zero.

Parameters

M	Matrix
i	column
j	row

Returns: Exchanged matrix

Definition at line 319 of file matrix.h.

◆ det

template<class T>

T det ( const Matrix< T > & A )

friend

Calculates the determinant of the matrix A.

Parameters

A Matrix

Returns: Determinant of A

Definition at line 302 of file matrix.h.

◆ invert [1/2]

template<class T>

Matrix invert ( const Matrix< T > & A )

friend

Calculates the inverse of a matrix, if possible.

Parameters

A	Matrix to invert

Returns: Inverse of matrix A, if A is invertable, otherwise the function returns a zero matrix.

Definition at line 372 of file matrix.h.

◆ invert [2/2]

template<class T>

Matrix invert	(	const Matrix< T > &	A,
		bool &	invertable )

friend

Calculates the inverse of a matrix, if possible.

Parameters

[in]	A	Matrix to invert
[out]	invertable	true, if A is invertable otherwise false

Returns: Inverse of matrix A, if A is invertable, otherwise the function returns a zero matrix.

Definition at line 342 of file matrix.h.

◆ operator* [1/5]

template<class T>

Matrix operator*	(	const Matrix< T > &	A,
		const Matrix< T > &	B )

friend

Parameters

B	multiplication of two matrices (same type)

Definition at line 178 of file matrix.h.

◆ operator* [2/5]

template<class T>

Matrix operator*	(	const Matrix< T > &	A,
		const T &	x )

friend

Parameters

x	multiplication of matrix with a scalar

Definition at line 188 of file matrix.h.

◆ operator* [3/5]

template<class T>

Vector< T > operator*	(	const Matrix< T > &	A,
		const Vector< T > &	r )

friend

Parameters

r	multiplication of a matrix with a vector

Definition at line 206 of file matrix.h.

◆ operator* [4/5]

template<class T>

Matrix operator*	(	const T &	x,
		const Matrix< T > &	A )

friend

Parameters

A	multiplication of scalar with a matrix

Definition at line 197 of file matrix.h.

◆ operator* [5/5]

template<class T>

Vector< T > operator*	(	const Vector< T > &	r,
		const Matrix< T > &	A )

friend

Parameters

A	multiplication of a vector with a matrix

Definition at line 215 of file matrix.h.

◆ operator-

template<class T>

Matrix operator-	(	const Matrix< T > &	A,
		const Matrix< T > &	B )

friend

Parameters

B	subtraction of two matrices (same type)

Definition at line 169 of file matrix.h.

◆ operator/

template<class T>

Matrix operator/	(	const Matrix< T > &	A,
		const T &	x )

friend

Parameters

x	division of a matrix with a scalar

Definition at line 224 of file matrix.h.

◆ operator<<

template<class T>

std::ostream & operator<<	(	std::ostream &	os,
		const Matrix< T > &	A )

friend

Output of the matrix into an ostream Output in the form: M00 M01 M02 M10 M11 M12 M20 M21 M22.

Parameters

os	stream
A	matrix

Returns: changed stream

Definition at line 244 of file matrix.h.

◆ operator>>

template<class T>

std::istream & operator>>	(	std::istream &	is,
		Matrix< T > &	A )

friend

Input of the matrix from an istream.

Parameters

is	stream
A	matrix

Returns: changed stream

Definition at line 258 of file matrix.h.

◆ trace

template<class T>

T trace ( const Matrix< T > & A )

friend

Calculates the trace of matrix A, i.e. the sum over all diagonal elements.

Parameters

A Matrix

Returns: trace

Definition at line 288 of file matrix.h.

◆ transpose

template<class T>

Matrix transpose ( const Matrix< T > & A )

friend

Calculates the transpose of the matrix A.

Parameters

A	Matrix to be transposed (represented by Aij)

Returns: transposed matrix (=Aji)

Definition at line 273 of file matrix.h.

Member Data Documentation

◆ M

template<class T>

T GOAT::maths::Matrix< T >::M[3][3]

Definition at line 385 of file matrix.h.

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

maths/matrix.h

Public Member Functions

Public Attributes

Friends

special operators

Detailed Description

Constructor & Destructor Documentation

◆ Matrix() [1/2]

◆ Matrix() [2/2]

Member Function Documentation

◆ binRead()

◆ binWrite()

◆ clear()

◆ operator!=()

◆ operator()()

◆ operator*=() [1/2]

◆ operator*=() [2/2]

◆ operator+()

◆ operator+=()

◆ operator-()

◆ operator-=()

◆ operator/=()

◆ operator=()

◆ operator==()

Friends And Related Symbol Documentation

◆ cutMatrix

◆ det

◆ invert [1/2]

◆ invert [2/2]

◆ operator* [1/5]

◆ operator* [2/5]

◆ operator* [3/5]

◆ operator* [4/5]

◆ operator* [5/5]

◆ operator-

◆ operator/

◆ operator<<

◆ operator>>

◆ trace

◆ transpose

Member Data Documentation

◆ M