libRoadRunner C++ API  1.3
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Member Functions | List of all members
rr::Solver Class Referenceabstract

Base class for all integrators and steady state solvers. More...

#include <Solver.h>

Inherited by rr::Integrator, and rr::SteadyStateSolver.

Public Member Functions

virtual std::string getName () const =0
 Get the name of this solver. More...
 
virtual std::string getDescription () const =0
 Get the description of this solver. More...
 
virtual std::string getHint () const =0
 Get a (user-readable) hint for this solver. More...
 
std::vector< std::string > getSettings () const
 Get a list of all settings for this solver. More...
 
virtual void resetSettings ()
 Reset all settings to their respective default values. More...
 
virtual Variant getValue (std::string key) const
 Get the value of an integrator setting. More...
 
virtual Variant hasValue (std::string key) const
 Return true if this setting is supported by the integrator. More...
 
virtual unsigned long getNumParams () const
 Get the number of parameters. More...
 
virtual std::string getParamName (int n) const
 Get the name of the parameter at index n. More...
 
virtual std::string getParamDisplayName (int n) const
 Get the display name of the parameter at index n. More...
 
virtual std::string getParamHint (int n) const
 Get the hint of the parameter at index n. More...
 
virtual std::string getParamDesc (int n) const
 Get the description of the parameter at index n. More...
 
virtual int getValueAsInt (std::string key)
 Wrapper for getValue which converts output to a specific type. More...
 
virtual unsigned int getValueAsUInt (std::string key)
 Wrapper for getValue which converts output to a specific type. More...
 
virtual long getValueAsLong (std::string key)
 Wrapper for getValue which converts output to a specific type. More...
 
virtual unsigned long getValueAsULong (std::string key)
 Wrapper for getValue which converts output to a specific type. More...
 
virtual float getValueAsFloat (std::string key)
 Wrapper for getValue which converts output to a specific type. More...
 
virtual double getValueAsDouble (std::string key)
 Wrapper for getValue which converts output to a specific type. More...
 
virtual char getValueAsChar (std::string key)
 Wrapper for getValue which converts output to a specific type. More...
 
virtual unsigned char getValueAsUChar (std::string key)
 Wrapper for getValue which converts output to a specific type. More...
 
virtual std::string getValueAsString (std::string key)
 Wrapper for getValue which converts output to a specific type. More...
 
virtual bool getValueAsBool (std::string key)
 Wrapper for getValue which converts output to a specific type. More...
 
const std::string & getDisplayName (std::string key) const
 Gets the hint associated with a given key. More...
 
const std::string & getHint (std::string key) const
 Gets the hint associated with a given key. More...
 
const std::string & getDescription (std::string key) const
 Gets the description associated with a given key. More...
 
const Variant::TypeId getType (std::string key)
 Gets the type associated with a given key. More...
 
std::string getSettingsRepr () const
 Get the solver settings as a string. More...
 
std::string settingsPyDictRepr () const
 Python dictionary-style string representation of settings. More...
 
virtual std::string toString () const
 Return a string representation of the solver. More...
 
virtual std::string toRepr () const
 Return string representation a la Python repr method. More...
 

Detailed Description

Base class for all integrators and steady state solvers.

Author
JKM

Member Function Documentation

virtual std::string rr::Solver::getDescription ( ) const
pure virtual

Get the description of this solver.

Author
JKM

Implemented in rr::EulerIntegrator, rr::RK4Integrator, rr::RK45Integrator, and rr::CVODEIntegrator.

const std::string & rr::Solver::getDescription ( std::string  key) const

Gets the description associated with a given key.

Author
WBC
const std::string & rr::Solver::getDisplayName ( std::string  key) const

Gets the hint associated with a given key.

Author
WBC
virtual std::string rr::Solver::getHint ( ) const
pure virtual

Get a (user-readable) hint for this solver.

Author
JKM

Implemented in rr::EulerIntegrator, rr::RK4Integrator, rr::RK45Integrator, and rr::CVODEIntegrator.

const std::string & rr::Solver::getHint ( std::string  key) const

Gets the hint associated with a given key.

Author
WBC
virtual std::string rr::Solver::getName ( ) const
pure virtual

Get the name of this solver.

Author
JKM

Implemented in rr::EulerIntegrator, rr::RK4Integrator, rr::RK45Integrator, and rr::CVODEIntegrator.

unsigned long rr::Solver::getNumParams ( ) const
virtual

Get the number of parameters.

Author
JKM
std::string rr::Solver::getParamDesc ( int  n) const
virtual

Get the description of the parameter at index n.

Author
JKM
std::string rr::Solver::getParamDisplayName ( int  n) const
virtual

Get the display name of the parameter at index n.

Author
JKM
std::string rr::Solver::getParamHint ( int  n) const
virtual

Get the hint of the parameter at index n.

Author
JKM
std::string rr::Solver::getParamName ( int  n) const
virtual

Get the name of the parameter at index n.

Author
JKM
std::vector< string > rr::Solver::getSettings ( ) const

Get a list of all settings for this solver.

Author
JKM
std::string rr::Solver::getSettingsRepr ( ) const

Get the solver settings as a string.

Author
JKM
const Variant::TypeId rr::Solver::getType ( std::string  key)

Gets the type associated with a given key.

Author
WBC
Variant rr::Solver::getValue ( std::string  key) const
virtual

Get the value of an integrator setting.

Author
JKM, WBC
Note
Use one of the type-concrete versions like getValueAsInt to avoid type conversion gotchas
bool rr::Solver::getValueAsBool ( std::string  key)
virtual

Wrapper for getValue which converts output to a specific type.

Author
WBC, JKM
char rr::Solver::getValueAsChar ( std::string  key)
virtual

Wrapper for getValue which converts output to a specific type.

Author
WBC, JKM
double rr::Solver::getValueAsDouble ( std::string  key)
virtual

Wrapper for getValue which converts output to a specific type.

Author
WBC, JKM
float rr::Solver::getValueAsFloat ( std::string  key)
virtual

Wrapper for getValue which converts output to a specific type.

Author
WBC, JKM
int rr::Solver::getValueAsInt ( std::string  key)
virtual

Wrapper for getValue which converts output to a specific type.

Author
WBC, JKM
long rr::Solver::getValueAsLong ( std::string  key)
virtual

Wrapper for getValue which converts output to a specific type.

Author
WBC, JKM
std::string rr::Solver::getValueAsString ( std::string  key)
virtual

Wrapper for getValue which converts output to a specific type.

Author
WBC, JKM
unsigned char rr::Solver::getValueAsUChar ( std::string  key)
virtual

Wrapper for getValue which converts output to a specific type.

Author
WBC, JKM
unsigned int rr::Solver::getValueAsUInt ( std::string  key)
virtual

Wrapper for getValue which converts output to a specific type.

Author
WBC, JKM
unsigned long rr::Solver::getValueAsULong ( std::string  key)
virtual

Wrapper for getValue which converts output to a specific type.

Author
WBC, JKM
Variant rr::Solver::hasValue ( std::string  key) const
virtual

Return true if this setting is supported by the integrator.

Author
JKM
void rr::Solver::resetSettings ( )
virtual

Reset all settings to their respective default values.

Author
JKM

Reimplemented in rr::EulerIntegrator, rr::RK4Integrator, rr::RK45Integrator, and rr::CVODEIntegrator.

std::string rr::Solver::settingsPyDictRepr ( ) const

Python dictionary-style string representation of settings.

Author
JKM
std::string rr::Solver::toRepr ( ) const
virtual

Return string representation a la Python repr method.

Author
JKM

Reimplemented in rr::EulerIntegrator, rr::RK4Integrator, and rr::RK45Integrator.

std::string rr::Solver::toString ( ) const
virtual

Return a string representation of the solver.

Author
JKM

Reimplemented in rr::EulerIntegrator, rr::RK4Integrator, and rr::RK45Integrator.


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