Open CASCADE Technology  7.7.0.dev
Public Member Functions | Static Public Member Functions

NCollection_Mat3< Element_t > Class Template Reference

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. More...
 
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) More...
 
Element_t GetValue (const size_t theRow, const size_t theCol) const
 Get element at the specified row and column. More...
 
Element_t & ChangeValue (const size_t theRow, const size_t theCol)
 Access element at the specified row and column. More...
 
void SetValue (const size_t theRow, const size_t theCol, const Element_t theValue)
 Set value for the element specified by row and columns. More...
 
Element_t & operator() (const size_t theRow, const size_t theCol)
 Return value. More...
 
Element_t operator() (const size_t theRow, const size_t theCol) const
 Return value. More...
 
NCollection_Vec3< Element_t > GetRow (const size_t theRow) const
 Return the row. More...
 
void SetRow (const size_t theRow, const NCollection_Vec3< Element_t > &theVec)
 Change first 3 row values by the passed vector. More...
 
NCollection_Vec3< Element_t > GetColumn (const size_t theCol) const
 Return the column. More...
 
void SetColumn (const size_t theCol, const NCollection_Vec3< Element_t > &theVec)
 Change first 3 column values by the passed vector. More...
 
NCollection_Vec3< Element_t > GetDiagonal () const
 Get vector of diagonal elements. More...
 
void SetDiagonal (const NCollection_Vec3< Element_t > &theVec)
 Change first 3 elements of the diagonal matrix. More...
 
void InitZero ()
 Initialize the zero matrix. More...
 
bool IsZero () const
 Checks the matrix for zero (without tolerance). More...
 
void InitIdentity ()
 Initialize the identity matrix. More...
 
bool IsIdentity () const
 Checks the matrix for identity (without tolerance). More...
 
bool IsEqual (const NCollection_Mat3 &theOther) const
 Check this matrix for equality with another matrix (without tolerance!). More...
 
bool operator== (const NCollection_Mat3 &theMat) const
 Comparison operator. More...
 
bool operator!= (const NCollection_Mat3 &theOther) const
 Check this vector with another vector for non-equality (without tolerance!). More...
 
const Element_t * GetData () const
 Raw access to the data (for OpenGL exchange). the data is returned in column-major order. More...
 
Element_t * ChangeData ()
 
NCollection_Vec3< Element_t > operator* (const NCollection_Vec3< Element_t > &theVec) const
 Multiply by the vector (M * V). More...
 
void Multiply (const NCollection_Mat3 &theMat)
 Compute matrix multiplication. More...
 
NCollection_Mat3operator*= (const NCollection_Mat3 &theMat)
 Multiply by the another matrix. More...
 
NCollection_Mat3 operator* (const NCollection_Mat3 &theMat) const
 Compute matrix multiplication product. More...
 
NCollection_Mat3 Multiplied (const NCollection_Mat3 &theMat) const
 Compute matrix multiplication product. More...
 
void Multiply (const Element_t theFactor)
 Compute per-component multiplication. More...
 
NCollection_Mat3operator*= (const Element_t theFactor)
 Compute per-element multiplication. More...
 
NCollection_Mat3 operator* (const Element_t theFactor) const
 Compute per-element multiplication. More...
 
NCollection_Mat3 Multiplied (const Element_t theFactor) const
 Compute per-element multiplication. More...
 
void Divide (const Element_t theFactor)
 Compute per-component division. More...
 
NCollection_Mat3operator/= (const Element_t theScalar)
 Per-component division. More...
 
NCollection_Mat3 Divided (const Element_t theScalar) const
 Divides all the coefficients of the matrix by scalar. More...
 
NCollection_Mat3 operator/ (const Element_t theScalar) const
 Divides all the coefficients of the matrix by scalar. More...
 
void Add (const NCollection_Mat3 &theMat)
 Per-component addition of another matrix. More...
 
NCollection_Mat3operator+= (const NCollection_Mat3 &theMat)
 Per-component addition of another matrix. More...
 
void Subtract (const NCollection_Mat3 &theMat)
 Per-component subtraction of another matrix. More...
 
NCollection_Mat3operator-= (const NCollection_Mat3 &theMat)
 Per-component subtraction of another matrix. More...
 
NCollection_Mat3 Added (const NCollection_Mat3 &theMat) const
 Per-component addition of another matrix. More...
 
NCollection_Mat3 operator+ (const NCollection_Mat3 &theMat) const
 Per-component addition of another matrix. More...
 
NCollection_Mat3 Subtracted (const NCollection_Mat3 &theMat) const
 Per-component subtraction of another matrix. More...
 
NCollection_Mat3 operator- (const NCollection_Mat3 &theMat) const
 Per-component subtraction of another matrix. More...
 
NCollection_Mat3 Negated () const
 Returns matrix with all components negated. More...
 
NCollection_Mat3 operator- () const
 Returns matrix with all components negated. More...
 
NCollection_Mat3 Transposed () const
 Transpose the matrix. More...
 
void Transpose ()
 Transpose the matrix. More...
 
Element_t Determinant () const
 Return determinant of the matrix. More...
 
NCollection_Mat3 Adjoint () const
 Return adjoint (adjugate matrix, e.g. conjugate transpose). More...
 
bool Inverted (NCollection_Mat3 &theInv, Element_t &theDet) const
 Compute inverted matrix. More...
 
bool Inverted (NCollection_Mat3 &theInv) const
 Compute inverted matrix. More...
 
NCollection_Mat3 Inverted () const
 Return inverted matrix. More...
 
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. More...
 
void DumpJson (Standard_OStream &theOStream, Standard_Integer) const
 Dumps the content of me into the stream. More...
 

Static Public Member Functions

static NCollection_Mat3 Identity ()
 Return identity matrix. More...
 
static NCollection_Mat3 Zero ()
 Return zero matrix. More...
 
static NCollection_Mat3 Multiply (const NCollection_Mat3 &theMatA, const NCollection_Mat3 &theMatB)
 Compute matrix multiplication product: A * B. More...
 
static NCollection_Mat3< Element_t > & Map (Element_t *theData)
 Maps plain C array to matrix type. More...
 
static const NCollection_Mat3< Element_t > & Map (const Element_t *theData)
 Maps plain C array to matrix type. More...
 

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_tthe element type of the other 3x3 matrix theOtherVec3
Parameters
theOtherMat3the 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
theRow[in] the row.to access.
theCol[in] 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
theFactor[in] 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
theRow[in] the row.to address.
theCol[in] 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]theInvthe 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]theInvthe inverted matrix
[out]theDetdeterminant 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
theFactor[in] 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
theMat[in] 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
theFactor[in] 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
theMat[in] 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
theMatA[in] the matrix "A".
theMatB[in] 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
theFactor[in] 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
theMat[in] 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
theVec[in] 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
theFactor[in] 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
theMat[in] 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
theScalar[in] 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
theCol[in] the column to change.
theVec[in] 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
theVecthe 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
theRow[in] the row to change.
theVec[in] 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
theRow[in] the row to change.
theCol[in] the column to change.
theValue[in] 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: