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

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

#include <mlFloatingPointMatrix.h>

List of all members.

Public Types

enum  { RowCount = size }
 This enum grants access to the row count during compile time, e.g. More...
enum  { ColumnCount = VectorT::Size }
 This enum grants access to the row count during compile time, e.g. More...
enum  { ComponentCount = RowCount*ColumnCount }
 This enum grants access to the number of values in the matrix, e.g. More...
typedef VectorT::ComponentType ComponentType
 A typedef to "export" the type of sub-components.
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)
 Copy contents from array mat into *this, row by row; type and size must match.
void getValuesToPtr (ComponentType *values) const
 Copy contents of *this into array mat, 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 which holds the data buffer and provides some general access methods.

Definition at line 29 of file mlFloatingPointMatrix.h.

Member Typedef Documentation

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

A typedef to "export" the type of sub-components.

Reimplemented in ml::Tmat2< DT >, ml::Tmat3< DT >, ml::Tmat4< DT >, ml::Tmat5< DT >, ml::Tmat6< DT >, ml::Tmat2< MLdouble >, ml::Tmat3< MLdouble >, ml::Tmat4< MLdouble >, ml::Tmat5< MLdouble >, and ml::Tmat6< MLdouble >.

Definition at line 33 of file mlFloatingPointMatrix.h.

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 36 of file mlFloatingPointMatrix.h.

Member Enumeration Documentation

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 44 of file mlFloatingPointMatrix.h.

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 48 of file mlFloatingPointMatrix.h.

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 40 of file mlFloatingPointMatrix.h.

Member Function Documentation

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

Definition at line 160 of file mlFloatingPointMatrix.h.

References ML_TRACE_IN_TIME_CRITICAL, and MLAbs().

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

Copy contents of *this into array mat, 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 194 of file mlFloatingPointMatrix.h.

References ML_CATCH_RETHROW, ML_TRACE_IN_TIME_CRITICAL, and ML_TRY.

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

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

Definition at line 122 of file mlFloatingPointMatrix.h.

References ML_BAD_INDEX, ML_CATCH_RETHROW, ML_PRINT_ERROR, ML_TRACE_IN_TIME_CRITICAL, and ML_TRY.

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

Definition at line 140 of file mlFloatingPointMatrix.h.

References ML_BAD_INDEX, ML_CATCH_RETHROW, ML_PRINT_ERROR, ML_TRACE_IN_TIME_CRITICAL, and ML_TRY.

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

Definition at line 108 of file mlFloatingPointMatrix.h.

References ML_BAD_INDEX, ML_PRINT_ERROR, and ML_TRACE_IN_TIME_CRITICAL.

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

Definition at line 94 of file mlFloatingPointMatrix.h.

References ML_BAD_INDEX, ML_PRINT_ERROR, and ML_TRACE_IN_TIME_CRITICAL.

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

Copy contents from array mat 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 176 of file mlFloatingPointMatrix.h.

References ML_CATCH_RETHROW, ML_TRACE_IN_TIME_CRITICAL, and ML_TRY.

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

Member Data Documentation

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

The rows constituting the matrix.

Definition at line 88 of file mlFloatingPointMatrix.h.

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