CMlib
Cell mapping algorithms in C++
cm::SCMUniformCellStateSpace< CellType, IDType, StateVectorType > Class Template Reference

#include <css.h>

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

Public Member Functions

 SCMUniformCellStateSpace (StateVectorType center, StateVectorType width, const std::vector< IDType > &cellCounts)
 
const IDType getImage (const IDType ID) const
 
const IDType getGroup (const IDType ID) const
 
const IDType getStep (const IDType ID) const
 
void setImage (const IDType ID, const IDType image)
 
void setGroup (const IDType ID, const IDType group)
 
void setStep (const IDType ID, const IDType step)
 
- Public Member Functions inherited from cm::UniformCellStateSpace< CellType, IDType, StateVectorType >
 UniformCellStateSpace (StateVectorType center, StateVectorType width, const std::vector< IDType > &cellCounts)
 The width of all cells. More...
 
const StateVectorType & getWidth () const
 
const StateVectorType & getCenter () const
 
IDType getIDFromCellCoord (std::vector< IDType > cellCoord)
 
IDType getID (const StateVectorType &state) const
 
CellType & getCellAtState (const StateVectorType &state)
 Returns the cell corresponding to a point in the state space. More...
 
const CellType & getCellAtState (const StateVectorType &state) const
 Returns the cell corresponding to a point in the state space (const) More...
 
CellType & getCell (const IDType ID)
 Returns the cell with the given ID. More...
 
const CellType & getCell (const IDType ID) const
 Returns the cell with the given ID (const) More...
 
const StateVectorType getCenter (const IDType ID) const
 
IDType getCellSum () const
 
const std::vector< IDType > & getCellCounts () const
 

Additional Inherited Members

- Protected Attributes inherited from cm::UniformCellStateSpace< CellType, IDType, StateVectorType >
std::vector< CellType > cells
 
StateVectorType center
 Directly accessible container for cell objects. More...
 
StateVectorType width
 The center of the state space. More...
 
std::vector< IDType > cellCounts
 The width of the state space. More...
 
std::vector< IDType > cellBase
 Number of cells along each dimension. More...
 
IDType cellSum
 Base for addressing the 1D array for multi dimensional cases. More...
 
IDType dimension
 The total number of cells within the state space. More...
 
StateVectorType cellWidth
 The dimension of the state space. More...
 

Detailed Description

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

Template Parameters
CellType
StateVectorTypeSCM needs three attributes for every cell: image, group, step

Constructor & Destructor Documentation

◆ SCMUniformCellStateSpace()

template<class CellType, class IDType, class StateVectorType>
cm::SCMUniformCellStateSpace< CellType, IDType, StateVectorType >::SCMUniformCellStateSpace ( StateVectorType  center,
StateVectorType  width,
const std::vector< IDType > &  cellCounts 
)
inline

Member Function Documentation

◆ getGroup()

template<class CellType, class IDType, class StateVectorType>
const IDType cm::SCMUniformCellStateSpace< CellType, IDType, StateVectorType >::getGroup ( const IDType  ID) const
inline

◆ getImage()

template<class CellType, class IDType, class StateVectorType>
const IDType cm::SCMUniformCellStateSpace< CellType, IDType, StateVectorType >::getImage ( const IDType  ID) const
inline

◆ getStep()

template<class CellType, class IDType, class StateVectorType>
const IDType cm::SCMUniformCellStateSpace< CellType, IDType, StateVectorType >::getStep ( const IDType  ID) const
inline

◆ setGroup()

template<class CellType, class IDType, class StateVectorType>
void cm::SCMUniformCellStateSpace< CellType, IDType, StateVectorType >::setGroup ( const IDType  ID,
const IDType  group 
)
inline

◆ setImage()

template<class CellType, class IDType, class StateVectorType>
void cm::SCMUniformCellStateSpace< CellType, IDType, StateVectorType >::setImage ( const IDType  ID,
const IDType  image 
)
inline

◆ setStep()

template<class CellType, class IDType, class StateVectorType>
void cm::SCMUniformCellStateSpace< CellType, IDType, StateVectorType >::setStep ( const IDType  ID,
const IDType  step 
)
inline

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