CMlib
Cell mapping algorithms in C++
Public Member Functions | List of all members
cm::SCM< CellType, IDType, StateVectorType > Class Template Reference

#include <scm.h>

Public Member Functions

 SCM (StateVectorType center, StateVectorType width, const std::vector< IDType > &cellCounts, DynamicalSystemBase< StateVectorType > *systemPointer)
 
void solve (IDType max_steps=1)
 
void printSummary ()
 
void generateImage (std::string filepath, SCMColoringMethod< CellType, IDType > *coloringMethod=nullptr, IDType x0=0, IDType y0=0, IDType xw=0, IDType yw=0)
 
DynamicalSystemBase< StateVectorType > * getSystemPointer () const
 
const SCMUniformCellStateSpace< CellType, IDType, StateVectorType > & getCss () const
 
SCMUniformCellStateSpace< CellType, IDType, StateVectorType > & getCss ()
 
IDType getPeriodicGroups () const
 
void setPeriodicGroups (IDType periodicGroups)
 

Constructor & Destructor Documentation

◆ SCM()

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

Member Function Documentation

◆ generateImage()

template<class CellType, class IDType, class StateVectorType>
void cm::SCM< CellType, IDType, StateVectorType >::generateImage ( std::string  filepath,
SCMColoringMethod< CellType, IDType > *  coloringMethod = nullptr,
IDType  x0 = 0,
IDType  y0 = 0,
IDType  xw = 0,
IDType  yw = 0 
)
inline

◆ getCss() [1/2]

template<class CellType, class IDType, class StateVectorType>
const SCMUniformCellStateSpace<CellType, IDType, StateVectorType>& cm::SCM< CellType, IDType, StateVectorType >::getCss ( ) const
inline

◆ getCss() [2/2]

template<class CellType, class IDType, class StateVectorType>
SCMUniformCellStateSpace<CellType, IDType, StateVectorType>& cm::SCM< CellType, IDType, StateVectorType >::getCss ( )
inline

◆ getPeriodicGroups()

template<class CellType, class IDType, class StateVectorType>
IDType cm::SCM< CellType, IDType, StateVectorType >::getPeriodicGroups ( ) const
inline

◆ getSystemPointer()

template<class CellType, class IDType, class StateVectorType>
DynamicalSystemBase<StateVectorType>* cm::SCM< CellType, IDType, StateVectorType >::getSystemPointer ( ) const
inline

◆ printSummary()

template<class CellType, class IDType, class StateVectorType>
void cm::SCM< CellType, IDType, StateVectorType >::printSummary ( )

◆ setPeriodicGroups()

template<class CellType, class IDType, class StateVectorType>
void cm::SCM< CellType, IDType, StateVectorType >::setPeriodicGroups ( IDType  periodicGroups)
inline

◆ solve()

template<class CellType, class IDType, class StateVectorType>
void cm::SCM< CellType, IDType, StateVectorType >::solve ( IDType  max_steps = 1)
inline
The documentation for this class was generated from the following file: