ML Reference
Public Types | Public Member Functions | Protected Attributes | List of all members
ml::FloatingPointMatrix< VectorT, size > Class Template Reference

Base class of all matrix classes that holds the data buffer and provides some general access methods. More...

#include <mlFloatingPointMatrix.h>

Inheritance diagram for ml::FloatingPointMatrix< VectorT, size >:
ml::Tmat2< MLdouble > ml::Tmat3< MLdouble > ml::Tmat4< MLdouble > ml::Tmat5< MLdouble > ml::Tmat6< MLdouble >

Public Types

enum  { RowCount = size }
 This enum grants access to the row count during compile time, e.g., it can be used as a template argument. More...
 
enum  { ColumnCount = VectorT::Size }
 This enum grants access to the row count during compile time, e.g., it can be used as a template argument. More...
 
enum  { ComponentCount = static_cast<int>(RowCount)*ColumnCount }
 This enum grants access to the number of values in the matrix, e.g., it can be used as a template argument. More...
 
typedef VectorT::ComponentType ComponentType
 A typedef to 'export' the type of subcomponents.
 
typedef VectorT VectorType
 A typedef to 'export' the type of component vector.
 

Public Member Functions

const VectorT & operator[] (const size_t i) const
 
VectorT & operator[] (const size_t i)
 
ComponentType & linearIndexed (const size_t idx)
 
ComponentType linearIndexedConst (const size_t idx) const
 
ComponentType compAbsSum () const
 
void setValuesFromPtr (const ComponentType *const values)
 Copies the contents from an array matrix into *this, row by row; type and size must match.
 
void getValuesToPtr (ComponentType *values) const
 Copies contents of *this into an array matrix, row by row; type and size must match.
 

Protected Attributes

VectorT v [size]
 The rows constituting the matrix.
 

Detailed Description

template<class VectorT, size_t size>
class ml::FloatingPointMatrix< VectorT, size >

Base class of all matrix classes that holds the data buffer and provides some general access methods.

Definition at line 34 of file mlFloatingPointMatrix.h.

Member Typedef Documentation

◆ ComponentType

template<class VectorT , size_t size>
typedef VectorT::ComponentType ml::FloatingPointMatrix< VectorT, size >::ComponentType

A typedef to 'export' the type of subcomponents.

Definition at line 38 of file mlFloatingPointMatrix.h.

◆ VectorType

template<class VectorT , size_t size>
typedef VectorT ml::FloatingPointMatrix< VectorT, size >::VectorType

A typedef to 'export' the type of component vector.

Definition at line 41 of file mlFloatingPointMatrix.h.

Member Enumeration Documentation

◆ anonymous enum

template<class VectorT , size_t size>
anonymous enum

This enum grants access to the row count during compile time, e.g., it can be used as a template argument.

Enumerator
RowCount 

Definition at line 45 of file mlFloatingPointMatrix.h.

◆ anonymous enum

template<class VectorT , size_t size>
anonymous enum

This enum grants access to the row count during compile time, e.g., it can be used as a template argument.

Enumerator
ColumnCount 

Definition at line 49 of file mlFloatingPointMatrix.h.

◆ anonymous enum

template<class VectorT , size_t size>
anonymous enum

This enum grants access to the number of values in the matrix, e.g., it can be used as a template argument.

Enumerator
ComponentCount 

Definition at line 53 of file mlFloatingPointMatrix.h.

Member Function Documentation

◆ compAbsSum()

template<class VectorT , size_t size>
VectorT::ComponentType ml::FloatingPointMatrix< VectorT, size >::compAbsSum ( ) const
inline

Definition at line 150 of file mlFloatingPointMatrix.h.

References MLAbs().

◆ getValuesToPtr()

template<class VectorT , size_t size>
void ml::FloatingPointMatrix< VectorT, size >::getValuesToPtr ( ComponentType * values) const

Copies contents of *this into an array matrix, row by row; type and size must match.

Note: This might be not as fast as the setValues methods of the template instances, depending on compiler optimizations (loop unrolling)

Definition at line 177 of file mlFloatingPointMatrix.h.

Referenced by ml::AbstractPersistenceOutputStream::write().

◆ linearIndexed()

template<class VectorT , size_t size>
VectorT::ComponentType & ml::FloatingPointMatrix< VectorT, size >::linearIndexed ( const size_t idx)
inline

Definition at line 123 of file mlFloatingPointMatrix.h.

References ML_BAD_INDEX, and ml::printTemplateError().

◆ linearIndexedConst()

template<class VectorT , size_t size>
VectorT::ComponentType ml::FloatingPointMatrix< VectorT, size >::linearIndexedConst ( const size_t idx) const
inline

Definition at line 136 of file mlFloatingPointMatrix.h.

References ML_BAD_INDEX, and ml::printTemplateError().

◆ operator[]() [1/2]

template<class VectorT , size_t size>
VectorT & ml::FloatingPointMatrix< VectorT, size >::operator[] ( const size_t i)

Definition at line 111 of file mlFloatingPointMatrix.h.

References ML_BAD_INDEX, and ml::printTemplateError().

◆ operator[]() [2/2]

template<class VectorT , size_t size>
const VectorT & ml::FloatingPointMatrix< VectorT, size >::operator[] ( const size_t i) const

Definition at line 99 of file mlFloatingPointMatrix.h.

References ML_BAD_INDEX, and ml::printTemplateError().

◆ setValuesFromPtr()

template<class VectorT , size_t size>
void ml::FloatingPointMatrix< VectorT, size >::setValuesFromPtr ( const ComponentType *const values)

Copies the contents from an array matrix into *this, row by row; type and size must match.

Note: This might be not as fast as the setValues methods of the template instances, depending on compiler optimizations (loop unrolling)

Definition at line 164 of file mlFloatingPointMatrix.h.

Referenced by ml::AbstractPersistenceInputStream::read().

Member Data Documentation

◆ v

template<class VectorT , size_t size>
VectorT ml::FloatingPointMatrix< VectorT, size >::v[size]
protected

The rows constituting the matrix.

Definition at line 93 of file mlFloatingPointMatrix.h.

Referenced by ml::Tmat3< DT >::jacobi(), ml::Tmat2< DT >::operator+=(), ml::Tmat3< DT >::operator+=(), ml::Tmat4< DT >::operator+=(), ml::Tmat5< DT >::operator+=(), ml::Tmat6< DT >::operator+=(), ml::Tmat2< DT >::operator-=(), ml::Tmat3< DT >::operator-=(), ml::Tmat4< DT >::operator-=(), ml::Tmat5< DT >::operator-=(), ml::Tmat6< DT >::operator-=(), ml::Tmat2< DT >::operator=(), ml::Tmat3< DT >::operator=(), ml::Tmat4< DT >::operator=(), ml::Tmat5< DT >::operator=(), ml::Tmat6< DT >::operator=(), ml::Tmat2< DT >::Tmat2(), ml::Tmat3< DT >::Tmat3(), ml::Tmat4< DT >::Tmat4(), ml::Tmat5< DT >::Tmat5(), and ml::Tmat6< DT >::Tmat6().

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