- 3.0.2 rigid body dynamics module.
iit::rbd::StateDependentMatrix< State, Rows, Cols, ActualMatrix > Class Template Reference

#include <StateDependentMatrix.h>

Inheritance diagram for iit::rbd::StateDependentMatrix< State, Rows, Cols, ActualMatrix >:
iit::rbd::StateDependentBase< State, ActualMatrix >

Public Types

typedef Base::Index Index
 
typedef Base MatrixType
 

Public Member Functions

 StateDependentMatrix ()
 
 ~StateDependentMatrix ()
 
template<typename OtherDerived >
StateDependentMatrixoperator= (const MatrixBase< OtherDerived > &other)
 
- Public Member Functions inherited from iit::rbd::StateDependentBase< State, ActualMatrix >
EIGEN_MAKE_ALIGNED_OPERATOR_NEW const ActualMatrix & operator() (State const &state)
 
const ActualMatrix & update (State const &state)
 

Public Attributes

EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef Base::Scalar Scalar
 

Detailed Description

template<class State, int Rows, int Cols, class ActualMatrix>
class iit::rbd::StateDependentMatrix< State, Rows, Cols, ActualMatrix >

A matrix that exposes a dependency on some kind of state variable. The type of such a variable is the first template parameter. The second and third parameters are the number of rows and columns.

The last parameter must be a class inheriting from this class, i.e., we are using here the curiously recurring template pattern. Such a sub-class shall implement the update() function. See the documentation of StateDependentBase.

This class was created explicitly to support code generation e.g. of coordinate transforms.

Member Typedef Documentation

◆ Index

template<class State, int Rows, int Cols, class ActualMatrix>
typedef Base::Index iit::rbd::StateDependentMatrix< State, Rows, Cols, ActualMatrix >::Index

The type of row/column indices of this matrix

◆ MatrixType

template<class State, int Rows, int Cols, class ActualMatrix>
typedef Base iit::rbd::StateDependentMatrix< State, Rows, Cols, ActualMatrix >::MatrixType

The regular matrix type this class inherits from

Constructor & Destructor Documentation

◆ StateDependentMatrix()

template<class State, int Rows, int Cols, class ActualMatrix>
iit::rbd::StateDependentMatrix< State, Rows, Cols, ActualMatrix >::StateDependentMatrix ( )
inline

◆ ~StateDependentMatrix()

template<class State, int Rows, int Cols, class ActualMatrix>
iit::rbd::StateDependentMatrix< State, Rows, Cols, ActualMatrix >::~StateDependentMatrix ( )
inline

Member Function Documentation

◆ operator=()

template<class State, int Rows, int Cols, class ActualMatrix>
template<typename OtherDerived >
StateDependentMatrix& iit::rbd::StateDependentMatrix< State, Rows, Cols, ActualMatrix >::operator= ( const MatrixBase< OtherDerived > &  other)
inline

Member Data Documentation

◆ Scalar

template<class State, int Rows, int Cols, class ActualMatrix>
EIGEN_MAKE_ALIGNED_OPERATOR_NEW typedef Base::Scalar iit::rbd::StateDependentMatrix< State, Rows, Cols, ActualMatrix >::Scalar

The type of the coefficients of this matrix


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