3x3 Matrix class. Warning, empty constructor returns an identity matrix. More...

#include <NCollection_Mat3.hxx>

Public Member Functions
	NCollection_Mat3 ()
	Empty constructor for identity matrix.

template<typename OtherElement_t>
	NCollection_Mat3 (const NCollection_Mat3< OtherElement_t > &theOtherMat3)
	Conversion constructor (explicitly converts some 3x3 matrix with other element type to a new 3x3 matrix with the element type Element_t, whose elements are static_cast'ed corresponding elements of theOtherMat3 matrix)

Element_t	GetValue (const size_t theRow, const size_t theCol) const
	Get element at the specified row and column.

Element_t &	ChangeValue (const size_t theRow, const size_t theCol)
	Access element at the specified row and column.

void	SetValue (const size_t theRow, const size_t theCol, const Element_t theValue)
	Set value for the element specified by row and columns.

Element_t &	operator() (const size_t theRow, const size_t theCol)
	Return value.

Element_t	operator() (const size_t theRow, const size_t theCol) const
	Return value.

NCollection_Vec3< Element_t >	GetRow (const size_t theRow) const
	Return the row.

void	SetRow (const size_t theRow, const NCollection_Vec3< Element_t > &theVec)
	Change first 3 row values by the passed vector.

NCollection_Vec3< Element_t >	GetColumn (const size_t theCol) const
	Return the column.

void	SetColumn (const size_t theCol, const NCollection_Vec3< Element_t > &theVec)
	Change first 3 column values by the passed vector.

NCollection_Vec3< Element_t >	GetDiagonal () const
	Get vector of diagonal elements.

void	SetDiagonal (const NCollection_Vec3< Element_t > &theVec)
	Change first 3 elements of the diagonal matrix.

void	InitZero ()
	Initialize the zero matrix.

bool	IsZero () const
	Checks the matrix for zero (without tolerance).

void	InitIdentity ()
	Initialize the identity matrix.

bool	IsIdentity () const
	Checks the matrix for identity (without tolerance).

bool	IsEqual (const NCollection_Mat3 &theOther) const
	Check this matrix for equality with another matrix (without tolerance!).

bool	operator== (const NCollection_Mat3 &theMat) const
	Comparison operator.

bool	operator!= (const NCollection_Mat3 &theOther) const
	Check this vector with another vector for non-equality (without tolerance!).

const Element_t *	GetData () const
	Raw access to the data (for OpenGL exchange). the data is returned in column-major order.

Element_t *	ChangeData ()

NCollection_Vec3< Element_t >	operator* (const NCollection_Vec3< Element_t > &theVec) const
	Multiply by the vector (M * V).

void	Multiply (const NCollection_Mat3 &theMat)
	Compute matrix multiplication.

NCollection_Mat3 &	operator*= (const NCollection_Mat3 &theMat)
	Multiply by the another matrix.

NCollection_Mat3	operator* (const NCollection_Mat3 &theMat) const
	Compute matrix multiplication product.

NCollection_Mat3	Multiplied (const NCollection_Mat3 &theMat) const
	Compute matrix multiplication product.

void	Multiply (const Element_t theFactor)
	Compute per-component multiplication.

NCollection_Mat3 &	operator*= (const Element_t theFactor)
	Compute per-element multiplication.

NCollection_Mat3	operator* (const Element_t theFactor) const
	Compute per-element multiplication.

NCollection_Mat3	Multiplied (const Element_t theFactor) const
	Compute per-element multiplication.

void	Divide (const Element_t theFactor)
	Compute per-component division.

NCollection_Mat3 &	operator/= (const Element_t theScalar)
	Per-component division.

NCollection_Mat3	Divided (const Element_t theScalar) const
	Divides all the coefficients of the matrix by scalar.

NCollection_Mat3	operator/ (const Element_t theScalar) const
	Divides all the coefficients of the matrix by scalar.

void	Add (const NCollection_Mat3 &theMat)
	Per-component addition of another matrix.

NCollection_Mat3 &	operator+= (const NCollection_Mat3 &theMat)
	Per-component addition of another matrix.

void	Subtract (const NCollection_Mat3 &theMat)
	Per-component subtraction of another matrix.

NCollection_Mat3 &	operator-= (const NCollection_Mat3 &theMat)
	Per-component subtraction of another matrix.

NCollection_Mat3	Added (const NCollection_Mat3 &theMat) const
	Per-component addition of another matrix.

NCollection_Mat3	operator+ (const NCollection_Mat3 &theMat) const
	Per-component addition of another matrix.

NCollection_Mat3	Subtracted (const NCollection_Mat3 &theMat) const
	Per-component subtraction of another matrix.

NCollection_Mat3	operator- (const NCollection_Mat3 &theMat) const
	Per-component subtraction of another matrix.

NCollection_Mat3	Negated () const
	Returns matrix with all components negated.

NCollection_Mat3	operator- () const
	Returns matrix with all components negated.

NCollection_Mat3	Transposed () const
	Transpose the matrix.

void	Transpose ()
	Transpose the matrix.

Element_t	Determinant () const
	Return determinant of the matrix.

NCollection_Mat3	Adjoint () const
	Return adjoint (adjugate matrix, e.g. conjugate transpose).

bool	Inverted (NCollection_Mat3 &theInv, Element_t &theDet) const
	Compute inverted matrix.

bool	Inverted (NCollection_Mat3 &theInv) const
	Compute inverted matrix.

NCollection_Mat3	Inverted () const
	Return inverted matrix.

template<typename Other_t>
void	ConvertFrom (const NCollection_Mat3< Other_t > &theFrom)
	Take values from NCollection_Mat3 with a different element type with type conversion.

void	DumpJson (Standard_OStream &theOStream, Standard_Integer) const
	Dumps the content of me into the stream.

Static Public Member Functions
static NCollection_Mat3	Identity ()
	Return identity matrix.

static NCollection_Mat3	Zero ()
	Return zero matrix.

static NCollection_Mat3	Multiply (const NCollection_Mat3 &theMatA, const NCollection_Mat3 &theMatB)
	Compute matrix multiplication product: A * B.

static NCollection_Mat3< Element_t > &	Map (Element_t *theData)
	Maps plain C array to matrix type.

static const NCollection_Mat3< Element_t > &	Map (const Element_t *theData)
	Maps plain C array to matrix type.

Detailed Description

template<typename Element_t>
class NCollection_Mat3< Element_t >

3x3 Matrix class. Warning, empty constructor returns an identity matrix.

Constructor & Destructor Documentation

◆ NCollection_Mat3() [1/2]

template<typename Element_t>

NCollection_Mat3< Element_t >::NCollection_Mat3 ( )

inline

Empty constructor for identity matrix.

◆ NCollection_Mat3() [2/2]

template<typename Element_t>

template<typename OtherElement_t>

NCollection_Mat3< Element_t >::NCollection_Mat3 ( const NCollection_Mat3< OtherElement_t > & theOtherMat3 )

inlineexplicit

Conversion constructor (explicitly converts some 3x3 matrix with other element type to a new 3x3 matrix with the element type Element_t, whose elements are static_cast'ed corresponding elements of theOtherMat3 matrix)

Template Parameters

OtherElement_t the element type of the other 3x3 matrix theOtherVec3

Parameters

theOtherMat3 the 3x3 matrix that needs to be converted

Member Function Documentation

◆ Add()

template<typename Element_t>

void NCollection_Mat3< Element_t >::Add ( const NCollection_Mat3< Element_t > & theMat )

inline

Per-component addition of another matrix.

◆ Added()

template<typename Element_t>

NCollection_Mat3 NCollection_Mat3< Element_t >::Added ( const NCollection_Mat3< Element_t > & theMat ) const

inline

Per-component addition of another matrix.

◆ Adjoint()

template<typename Element_t>

NCollection_Mat3 NCollection_Mat3< Element_t >::Adjoint ( ) const

inline

Return adjoint (adjugate matrix, e.g. conjugate transpose).

◆ ChangeData()

template<typename Element_t>

Element_t * NCollection_Mat3< Element_t >::ChangeData ( )

inline

◆ ChangeValue()

template<typename Element_t>

Element_t & NCollection_Mat3< Element_t >::ChangeValue	(	const size_t	theRow,
		const size_t	theCol )

inline

Access element at the specified row and column.

Parameters

[in]	theRow	the row.to access.
[in]	theCol	the column to access.

Returns: reference on the matrix element.

◆ ConvertFrom()

template<typename Element_t>

template<typename Other_t>

void NCollection_Mat3< Element_t >::ConvertFrom ( const NCollection_Mat3< Other_t > & theFrom )

inline

Take values from NCollection_Mat3 with a different element type with type conversion.

◆ Determinant()

template<typename Element_t>

Element_t NCollection_Mat3< Element_t >::Determinant ( ) const

inline

Return determinant of the matrix.

◆ Divide()

template<typename Element_t>

void NCollection_Mat3< Element_t >::Divide ( const Element_t theFactor )

inline

Compute per-component division.

Parameters

[in] theFactor the scale factor.

◆ Divided()

template<typename Element_t>

NCollection_Mat3 NCollection_Mat3< Element_t >::Divided ( const Element_t theScalar ) const

inline

Divides all the coefficients of the matrix by scalar.

◆ DumpJson()

template<typename Element_t>

void NCollection_Mat3< Element_t >::DumpJson	(	Standard_OStream &	theOStream,
		Standard_Integer	) const

inline

Dumps the content of me into the stream.

◆ GetColumn()

template<typename Element_t>

NCollection_Vec3< Element_t > NCollection_Mat3< Element_t >::GetColumn ( const size_t theCol ) const

inline

Return the column.

◆ GetData()

template<typename Element_t>

const Element_t * NCollection_Mat3< Element_t >::GetData ( ) const

inline

Raw access to the data (for OpenGL exchange). the data is returned in column-major order.

◆ GetDiagonal()

template<typename Element_t>

NCollection_Vec3< Element_t > NCollection_Mat3< Element_t >::GetDiagonal ( ) const

inline

Get vector of diagonal elements.

Returns: vector of diagonal elements.

◆ GetRow()

template<typename Element_t>

NCollection_Vec3< Element_t > NCollection_Mat3< Element_t >::GetRow ( const size_t theRow ) const

inline

Return the row.

◆ GetValue()

template<typename Element_t>

Element_t NCollection_Mat3< Element_t >::GetValue	(	const size_t	theRow,
		const size_t	theCol ) const

inline

Get element at the specified row and column.

Parameters

[in]	theRow	the row.to address.
[in]	theCol	the column to address.

Returns: the value of the addressed element.

◆ Identity()

template<typename Element_t>

static NCollection_Mat3 NCollection_Mat3< Element_t >::Identity ( )

inlinestatic

Return identity matrix.

◆ InitIdentity()

template<typename Element_t>

void NCollection_Mat3< Element_t >::InitIdentity ( )

inline

Initialize the identity matrix.

◆ InitZero()

template<typename Element_t>

void NCollection_Mat3< Element_t >::InitZero ( )

inline

Initialize the zero matrix.

◆ Inverted() [1/3]

template<typename Element_t>

NCollection_Mat3 NCollection_Mat3< Element_t >::Inverted ( ) const

inline

Return inverted matrix.

◆ Inverted() [2/3]

template<typename Element_t>

bool NCollection_Mat3< Element_t >::Inverted ( NCollection_Mat3< Element_t > & theInv ) const

inline

Compute inverted matrix.

Parameters

[out] theInv the inverted matrix

Returns: true if reversion success

◆ Inverted() [3/3]

template<typename Element_t>

bool NCollection_Mat3< Element_t >::Inverted	(	NCollection_Mat3< Element_t > &	theInv,
		Element_t &	theDet ) const

inline

Compute inverted matrix.

Parameters

[out]	theInv	the inverted matrix
[out]	theDet	determinant of matrix

Returns: true if reversion success

◆ IsEqual()

template<typename Element_t>

bool NCollection_Mat3< Element_t >::IsEqual ( const NCollection_Mat3< Element_t > & theOther ) const

inline

Check this matrix for equality with another matrix (without tolerance!).

◆ IsIdentity()

template<typename Element_t>

bool NCollection_Mat3< Element_t >::IsIdentity ( ) const

inline

Checks the matrix for identity (without tolerance).

◆ IsZero()

template<typename Element_t>

bool NCollection_Mat3< Element_t >::IsZero ( ) const

inline

Checks the matrix for zero (without tolerance).

◆ Map() [1/2]

template<typename Element_t>

static const NCollection_Mat3< Element_t > & NCollection_Mat3< Element_t >::Map ( const Element_t * theData )

inlinestatic

Maps plain C array to matrix type.

◆ Map() [2/2]

template<typename Element_t>

static NCollection_Mat3< Element_t > & NCollection_Mat3< Element_t >::Map ( Element_t * theData )

inlinestatic

Maps plain C array to matrix type.

◆ Multiplied() [1/2]

template<typename Element_t>

NCollection_Mat3 NCollection_Mat3< Element_t >::Multiplied ( const Element_t theFactor ) const

inline

Compute per-element multiplication.

Parameters

[in] theFactor the scale factor.

Returns: the result of multiplication.

◆ Multiplied() [2/2]

template<typename Element_t>

NCollection_Mat3 NCollection_Mat3< Element_t >::Multiplied ( const NCollection_Mat3< Element_t > & theMat ) const

inline

Compute matrix multiplication product.

Parameters

[in] theMat the other matrix.

Returns: result of multiplication.

◆ Multiply() [1/3]

template<typename Element_t>

void NCollection_Mat3< Element_t >::Multiply ( const Element_t theFactor )

inline

Compute per-component multiplication.

Parameters

[in] theFactor the scale factor.

◆ Multiply() [2/3]

template<typename Element_t>

void NCollection_Mat3< Element_t >::Multiply ( const NCollection_Mat3< Element_t > & theMat )

inline

Compute matrix multiplication.

Parameters

[in] theMat the matrix to multiply.

◆ Multiply() [3/3]

template<typename Element_t>

static NCollection_Mat3 NCollection_Mat3< Element_t >::Multiply	(	const NCollection_Mat3< Element_t > &	theMatA,
		const NCollection_Mat3< Element_t > &	theMatB )

inlinestatic

Compute matrix multiplication product: A * B.

Parameters

[in]	theMatA	the matrix "A".
[in]	theMatB	the matrix "B".

◆ Negated()

template<typename Element_t>

NCollection_Mat3 NCollection_Mat3< Element_t >::Negated ( ) const

inline

Returns matrix with all components negated.

◆ operator!=()

template<typename Element_t>

bool NCollection_Mat3< Element_t >::operator!= ( const NCollection_Mat3< Element_t > & theOther ) const

inline

Check this vector with another vector for non-equality (without tolerance!).

◆ operator()() [1/2]

template<typename Element_t>

Element_t & NCollection_Mat3< Element_t >::operator()	(	const size_t	theRow,
		const size_t	theCol )

inline

Return value.

◆ operator()() [2/2]

template<typename Element_t>

Element_t NCollection_Mat3< Element_t >::operator()	(	const size_t	theRow,
		const size_t	theCol ) const

inline

Return value.

◆ operator*() [1/3]

template<typename Element_t>

NCollection_Mat3 NCollection_Mat3< Element_t >::operator* ( const Element_t theFactor ) const

inline

Compute per-element multiplication.

Parameters

[in] theFactor the scale factor.

Returns: the result of multiplication.

◆ operator*() [2/3]

template<typename Element_t>

NCollection_Mat3 NCollection_Mat3< Element_t >::operator* ( const NCollection_Mat3< Element_t > & theMat ) const

inline

Compute matrix multiplication product.

Parameters

[in] theMat the other matrix.

Returns: result of multiplication.

◆ operator*() [3/3]

template<typename Element_t>

NCollection_Vec3< Element_t > NCollection_Mat3< Element_t >::operator* ( const NCollection_Vec3< Element_t > & theVec ) const

inline

Multiply by the vector (M * V).

Parameters

[in] theVec the vector to multiply.

◆ operator*=() [1/2]

template<typename Element_t>

NCollection_Mat3 & NCollection_Mat3< Element_t >::operator*= ( const Element_t theFactor )

inline

Compute per-element multiplication.

Parameters

[in] theFactor the scale factor.

◆ operator*=() [2/2]

template<typename Element_t>

NCollection_Mat3 & NCollection_Mat3< Element_t >::operator*= ( const NCollection_Mat3< Element_t > & theMat )

inline

Multiply by the another matrix.

Parameters

[in] theMat the other matrix.

◆ operator+()

template<typename Element_t>

NCollection_Mat3 NCollection_Mat3< Element_t >::operator+ ( const NCollection_Mat3< Element_t > & theMat ) const

inline

Per-component addition of another matrix.

◆ operator+=()

template<typename Element_t>

NCollection_Mat3 & NCollection_Mat3< Element_t >::operator+= ( const NCollection_Mat3< Element_t > & theMat )

inline

Per-component addition of another matrix.

◆ operator-() [1/2]

template<typename Element_t>

NCollection_Mat3 NCollection_Mat3< Element_t >::operator- ( ) const

inline

Returns matrix with all components negated.

◆ operator-() [2/2]

template<typename Element_t>

NCollection_Mat3 NCollection_Mat3< Element_t >::operator- ( const NCollection_Mat3< Element_t > & theMat ) const

inline

Per-component subtraction of another matrix.

◆ operator-=()

template<typename Element_t>

NCollection_Mat3 & NCollection_Mat3< Element_t >::operator-= ( const NCollection_Mat3< Element_t > & theMat )

inline

Per-component subtraction of another matrix.

◆ operator/()

template<typename Element_t>

NCollection_Mat3 NCollection_Mat3< Element_t >::operator/ ( const Element_t theScalar ) const

inline

Divides all the coefficients of the matrix by scalar.

◆ operator/=()

template<typename Element_t>

NCollection_Mat3 & NCollection_Mat3< Element_t >::operator/= ( const Element_t theScalar )

inline

Per-component division.

Parameters

[in] theScalar the scale factor.

◆ operator==()

template<typename Element_t>

bool NCollection_Mat3< Element_t >::operator== ( const NCollection_Mat3< Element_t > & theMat ) const

inline

Comparison operator.

◆ SetColumn()

template<typename Element_t>

void NCollection_Mat3< Element_t >::SetColumn	(	const size_t	theCol,
		const NCollection_Vec3< Element_t > &	theVec )

inline

Change first 3 column values by the passed vector.

Parameters

[in]	theCol	the column to change.
[in]	theVec	the vector of values.

◆ SetDiagonal()

template<typename Element_t>

void NCollection_Mat3< Element_t >::SetDiagonal ( const NCollection_Vec3< Element_t > & theVec )

inline

Change first 3 elements of the diagonal matrix.

Parameters

theVec the vector of values.

◆ SetRow()

template<typename Element_t>

void NCollection_Mat3< Element_t >::SetRow	(	const size_t	theRow,
		const NCollection_Vec3< Element_t > &	theVec )

inline

Change first 3 row values by the passed vector.

Parameters

[in]	theRow	the row to change.
[in]	theVec	the vector of values.

◆ SetValue()

template<typename Element_t>

void NCollection_Mat3< Element_t >::SetValue	(	const size_t	theRow,
		const size_t	theCol,
		const Element_t	theValue )

inline

Set value for the element specified by row and columns.

Parameters

[in]	theRow	the row to change.
[in]	theCol	the column to change.
[in]	theValue	the value to set.s

◆ Subtract()

template<typename Element_t>

void NCollection_Mat3< Element_t >::Subtract ( const NCollection_Mat3< Element_t > & theMat )

inline

Per-component subtraction of another matrix.

◆ Subtracted()

template<typename Element_t>

NCollection_Mat3 NCollection_Mat3< Element_t >::Subtracted ( const NCollection_Mat3< Element_t > & theMat ) const

inline

Per-component subtraction of another matrix.

◆ Transpose()

template<typename Element_t>

void NCollection_Mat3< Element_t >::Transpose ( )

inline

Transpose the matrix.

◆ Transposed()

template<typename Element_t>

NCollection_Mat3 NCollection_Mat3< Element_t >::Transposed ( ) const

inline

Transpose the matrix.

Returns: transposed copy of the matrix.

◆ Zero()

template<typename Element_t>

static NCollection_Mat3 NCollection_Mat3< Element_t >::Zero ( )

inlinestatic

Return zero matrix.

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

NCollection_Mat3.hxx

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ NCollection_Mat3() [1/2]

◆ NCollection_Mat3() [2/2]

Member Function Documentation

◆ Add()

◆ Added()

◆ Adjoint()

◆ ChangeData()

◆ ChangeValue()

◆ ConvertFrom()

◆ Determinant()

◆ Divide()

◆ Divided()

◆ DumpJson()

◆ GetColumn()

◆ GetData()

◆ GetDiagonal()

◆ GetRow()

◆ GetValue()

◆ Identity()

◆ InitIdentity()

◆ InitZero()

◆ Inverted() [1/3]

◆ Inverted() [2/3]

◆ Inverted() [3/3]

◆ IsEqual()

◆ IsIdentity()

◆ IsZero()

◆ Map() [1/2]

◆ Map() [2/2]

◆ Multiplied() [1/2]

◆ Multiplied() [2/2]

◆ Multiply() [1/3]

◆ Multiply() [2/3]

◆ Multiply() [3/3]

◆ Negated()

◆ operator!=()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ operator*() [1/3]

◆ operator*() [2/3]

◆ operator*() [3/3]

◆ operator*=() [1/2]

◆ operator*=() [2/2]

◆ operator+()

◆ operator+=()

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator-=()

◆ operator/()

◆ operator/=()

◆ operator==()

◆ SetColumn()

◆ SetDiagonal()

◆ SetRow()

◆ SetValue()

◆ Subtract()

◆ Subtracted()

◆ Transpose()

◆ Transposed()

◆ Zero()