bitrl::dynamics::DynamicsMatrixDescriptor Class Reference

The DynamicsMatrixDescriptor class. Helper class to model the matrix representon of dynamical systems. More...

#include <dynamics_matrix_descriptor.h>

Public Types
typedef DynMat< real_t >	matrix_type
typedef DynVec< real_t >	vector_type
typedef std::map< std::string, matrix_type >::iterator	matrix_iterator
typedef std::map< std::string, matrix_type >::const_iterator	const_matrix_iterator
typedef std::map< std::string, vector_type >::iterator	vector_iterator
typedef std::map< std::string, vector_type >::const_iterator	const_vector_iterator

Public Member Functions
	DynamicsMatrixDescriptor ()
	Constructor.
	~DynamicsMatrixDescriptor ()
	Destructor.
matrix_iterator	find_matrix (const std::string &name)
	find the matrix with the given name
const_matrix_iterator	find_matrix (const std::string &name) const
	find the matrix with the given name
vector_iterator	find_vector (const std::string &name)
	find the matrix with the given name
const_vector_iterator	find_vector (const std::string &name) const
	find the matrix with the given name
matrix_type &	get_matrix (const std::string &name)
const matrix_type &	get_matrix (const std::string &name) const
void	set_matrix (const std::string &name, const matrix_type &mat)
bool	has_matrix (const std::string &name) const
vector_type &	get_vector (const std::string &name)
const vector_type &	get_vector (const std::string &name) const
void	set_vector (const std::string &name, const vector_type &vec)
matrix_iterator	matrix_begin ()
	iterators
matrix_iterator	matrix_end ()
const_matrix_iterator	matrix_begin () const
const_matrix_iterator	matrix_end () const
vector_iterator	vector_begin ()
	iterators
vector_iterator	vector_end ()
const_vector_iterator	vector_begin () const
const_vector_iterator	vector_end () const

Protected Attributes
std::map< std::string, matrix_type >	matrices_
std::map< std::string, vector_type >	vectors_

Detailed Description

The DynamicsMatrixDescriptor class. Helper class to model the matrix representon of dynamical systems.

Member Typedef Documentation

const_matrix_iterator

typedef std::map<std::string,matrix_type>::const_iterator bitrl::dynamics::DynamicsMatrixDescriptor::const_matrix_iterator

const_vector_iterator

typedef std::map<std::string,vector_type>::const_iterator bitrl::dynamics::DynamicsMatrixDescriptor::const_vector_iterator

matrix_iterator

typedef std::map<std::string,matrix_type>::iterator bitrl::dynamics::DynamicsMatrixDescriptor::matrix_iterator

matrix_type

typedef DynMat<real_t> bitrl::dynamics::DynamicsMatrixDescriptor::matrix_type

vector_iterator

typedef std::map<std::string,vector_type>::iterator bitrl::dynamics::DynamicsMatrixDescriptor::vector_iterator

vector_type

typedef DynVec<real_t> bitrl::dynamics::DynamicsMatrixDescriptor::vector_type

Constructor & Destructor Documentation

DynamicsMatrixDescriptor()

bitrl::dynamics::DynamicsMatrixDescriptor::DynamicsMatrixDescriptor

(

)

Constructor.

~DynamicsMatrixDescriptor()

bitrl::dynamics::DynamicsMatrixDescriptor::~DynamicsMatrixDescriptor ( )

inline

Destructor.

Member Function Documentation

find_matrix() [1/2]

DynamicsMatrixDescriptor::matrix_iterator bitrl::dynamics::DynamicsMatrixDescriptor::find_matrix

(

const std::string &

name

)

find the matrix with the given name

find_matrix() [2/2]

DynamicsMatrixDescriptor::const_matrix_iterator bitrl::dynamics::DynamicsMatrixDescriptor::find_matrix

(

const std::string &

name

)

const

find the matrix with the given name

find_vector() [1/2]

DynamicsMatrixDescriptor::vector_iterator bitrl::dynamics::DynamicsMatrixDescriptor::find_vector

(

const std::string &

name

)

find the matrix with the given name

find_vector() [2/2]

DynamicsMatrixDescriptor::const_vector_iterator bitrl::dynamics::DynamicsMatrixDescriptor::find_vector

(

const std::string &

name

)

const

find the matrix with the given name

get_matrix() [1/2]

DynamicsMatrixDescriptor::matrix_type & bitrl::dynamics::DynamicsMatrixDescriptor::get_matrix

(

const std::string &

name

)

get_matrix() [2/2]

const DynamicsMatrixDescriptor::matrix_type & bitrl::dynamics::DynamicsMatrixDescriptor::get_matrix

(

const std::string &

name

)

const

get_vector() [1/2]

DynamicsMatrixDescriptor::vector_type & bitrl::dynamics::DynamicsMatrixDescriptor::get_vector

(

const std::string &

name

)

get_vector() [2/2]

const DynamicsMatrixDescriptor::vector_type & bitrl::dynamics::DynamicsMatrixDescriptor::get_vector

(

const std::string &

name

)

const

has_matrix()

bool bitrl::dynamics::DynamicsMatrixDescriptor::has_matrix

(

const std::string &

name

)

const

matrix_begin() [1/2]

matrix_iterator bitrl::dynamics::DynamicsMatrixDescriptor::matrix_begin ( )

inline

iterators

matrix_begin() [2/2]

const_matrix_iterator bitrl::dynamics::DynamicsMatrixDescriptor::matrix_begin ( ) const

inline

matrix_end() [1/2]

matrix_iterator bitrl::dynamics::DynamicsMatrixDescriptor::matrix_end ( )

inline

matrix_end() [2/2]

const_matrix_iterator bitrl::dynamics::DynamicsMatrixDescriptor::matrix_end ( ) const

inline

set_matrix()

void bitrl::dynamics::DynamicsMatrixDescriptor::set_matrix ( const std::string &  name, const matrix_type &  mat  )

inline

set_vector()

void bitrl::dynamics::DynamicsMatrixDescriptor::set_vector ( const std::string &  name, const vector_type &  vec  )

inline

vector_begin() [1/2]

vector_iterator bitrl::dynamics::DynamicsMatrixDescriptor::vector_begin ( )

inline

iterators

vector_begin() [2/2]

const_vector_iterator bitrl::dynamics::DynamicsMatrixDescriptor::vector_begin ( ) const

inline

vector_end() [1/2]

vector_iterator bitrl::dynamics::DynamicsMatrixDescriptor::vector_end ( )

inline

vector_end() [2/2]

const_vector_iterator bitrl::dynamics::DynamicsMatrixDescriptor::vector_end ( ) const

inline

Member Data Documentation

matrices_

std::map<std::string, matrix_type> bitrl::dynamics::DynamicsMatrixDescriptor::matrices_

protected

vectors_

std::map<std::string, vector_type> bitrl::dynamics::DynamicsMatrixDescriptor::vectors_

protected

---

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

• libs/bitrl/src/bitrl/dynamics/dynamics_matrix_descriptor.h
• libs/bitrl/src/bitrl/dynamics/dynamics_matrix_descriptor.cpp