cm::CellStateSpaceBase< CellType, IDType, StateVectorType > Class Template Reference

Base class for classes describing state space discretization. More...

#include <css.h>

Inheritance diagram for cm::CellStateSpaceBase< CellType, IDType, StateVectorType >:

Public Member Functions
virtual const CellType &	getCellAtState (const StateVectorType &state) const =0
	Returns the cell corresponding to a point in the state space (const) More...
virtual CellType &	getCellAtState (const StateVectorType &state)=0
	Returns the cell corresponding to a point in the state space. More...
virtual const CellType &	getCell (const IDType id) const =0
	Returns the cell with the given ID (const) More...
virtual CellType &	getCell (const IDType id)=0
	Returns the cell with the given ID. More...
virtual const StateVectorType &	getCenter () const =0
virtual const StateVectorType &	getWidth () const =0

Detailed Description

template<class CellType, class IDType, class StateVectorType>
class cm::CellStateSpaceBase< CellType, IDType, StateVectorType >

Base class for classes describing state space discretization.

This is an abstract class describing a simple interface for cell state spaces. Every derived CellStateSpace class should implement two query functions: getCell: to return a state space cell based on its unique ID getCellAtState: to return a state space cell which corresponds to a given point in the state space

Template Parameters

CellType	type of the used cell.
IDType	type of the ID of the cells (typically 32 or 64-bit unsigned integers).
StateVectorType	type of the state vector corresponding to the state space.

Member Function Documentation

getCell() [1/2]

template<class CellType , class IDType , class StateVectorType >

virtual const CellType& cm::CellStateSpaceBase< CellType, IDType, StateVectorType >::getCell ( const IDType  id ) const

pure virtual

Returns the cell with the given ID (const)

Implemented in cm::UniformCellStateSpace< CellType, IDType, StateVectorType >.

getCell() [2/2]

template<class CellType , class IDType , class StateVectorType >

virtual CellType& cm::CellStateSpaceBase< CellType, IDType, StateVectorType >::getCell ( const IDType  id )

pure virtual

Returns the cell with the given ID.

Implemented in cm::UniformCellStateSpace< CellType, IDType, StateVectorType >.

getCellAtState() [1/2]

template<class CellType , class IDType , class StateVectorType >

virtual const CellType& cm::CellStateSpaceBase< CellType, IDType, StateVectorType >::getCellAtState ( const StateVectorType &  state ) const

pure virtual

Returns the cell corresponding to a point in the state space (const)

Implemented in cm::UniformCellStateSpace< CellType, IDType, StateVectorType >.

getCellAtState() [2/2]

template<class CellType , class IDType , class StateVectorType >

virtual CellType& cm::CellStateSpaceBase< CellType, IDType, StateVectorType >::getCellAtState ( const StateVectorType &  state )

pure virtual

Returns the cell corresponding to a point in the state space.

Implemented in cm::UniformCellStateSpace< CellType, IDType, StateVectorType >.

getCenter()

template<class CellType , class IDType , class StateVectorType >

virtual const StateVectorType& cm::CellStateSpaceBase< CellType, IDType, StateVectorType >::getCenter ( ) const

pure virtual

Implemented in cm::UniformCellStateSpace< CellType, IDType, StateVectorType >.

getWidth()

template<class CellType , class IDType , class StateVectorType >

virtual const StateVectorType& cm::CellStateSpaceBase< CellType, IDType, StateVectorType >::getWidth ( ) const

pure virtual

Implemented in cm::UniformCellStateSpace< CellType, IDType, StateVectorType >.

---

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

• C:/Work/git/cell-mapping/cpp/cm/css.h