C API Documentation
|
Base class for all integrators and steady state solvers. More...
#include <Solver.h>
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 size_t | getNumParams () const |
Get the number of parameters. More... | |
virtual std::string | getParamName (size_t 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 std::vector< double > | getValueAsDoubleVector (std::string key) |
Wrapper for getValue which converts output to a specific type. | |
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... | |
virtual void | setValue (std::string key, const Variant &value) |
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... | |
Protected Types | |
typedef std::vector< std::string > | SettingsList |
typedef RR_UNORDERED_MAP< std::string, Variant > | SettingsMap |
typedef RR_UNORDERED_MAP< std::string, std::string > | DisplayNameMap |
typedef RR_UNORDERED_MAP< std::string, std::string > | HintMap |
typedef RR_UNORDERED_MAP< std::string, std::string > | DescriptionMap |
Protected Member Functions | |
void | addSetting (std::string name, Variant val, string display_name, std::string hint, std::string description) |
Protected Attributes | |
SettingsList | sorted_settings |
SettingsMap | settings |
DisplayNameMap | display_names_ |
HintMap | hints |
DescriptionMap | descriptions |
Base class for all integrators and steady state solvers.
|
pure virtual |
Get the description of this solver.
Implemented in rr::CVODEIntegrator, rr::RK4Integrator, rr::RK45Integrator, rr::NLEQ2Solver, rr::NLEQ1Solver, and rr::GillespieIntegrator.
const std::string& rr::Solver::getDescription | ( | std::string | key | ) | const |
Gets the description associated with a given key.
const std::string& rr::Solver::getDisplayName | ( | std::string | key | ) | const |
Gets the hint associated with a given key.
|
pure virtual |
Get a (user-readable) hint for this solver.
Implemented in rr::CVODEIntegrator, rr::RK4Integrator, rr::RK45Integrator, rr::NLEQ2Solver, rr::NLEQ1Solver, and rr::GillespieIntegrator.
const std::string& rr::Solver::getHint | ( | std::string | key | ) | const |
Gets the hint associated with a given key.
|
pure virtual |
Get the name of this solver.
Implemented in rr::CVODEIntegrator, rr::RK4Integrator, rr::RK45Integrator, rr::NLEQ2Solver, rr::NLEQ1Solver, and rr::GillespieIntegrator.
|
virtual |
Get the number of parameters.
|
virtual |
Get the description of the parameter at index n.
|
virtual |
Get the display name of the parameter at index n.
|
virtual |
Get the hint of the parameter at index n.
|
virtual |
Get the name of the parameter at index n.
std::vector<std::string> rr::Solver::getSettings | ( | ) | const |
Get a list of all settings for this solver.
std::string rr::Solver::getSettingsRepr | ( | ) | const |
Get the solver settings as a string.
const Variant::TypeId rr::Solver::getType | ( | std::string | key | ) |
Gets the type associated with a given key.
|
virtual |
Get the value of an integrator setting.
|
virtual |
Wrapper for getValue which converts output to a specific type.
|
virtual |
Wrapper for getValue which converts output to a specific type.
|
virtual |
Wrapper for getValue which converts output to a specific type.
|
virtual |
Wrapper for getValue which converts output to a specific type.
|
virtual |
Wrapper for getValue which converts output to a specific type.
|
virtual |
Wrapper for getValue which converts output to a specific type.
|
virtual |
Wrapper for getValue which converts output to a specific type.
|
virtual |
Wrapper for getValue which converts output to a specific type.
|
virtual |
Wrapper for getValue which converts output to a specific type.
|
virtual |
Wrapper for getValue which converts output to a specific type.
|
virtual |
Return true if this setting is supported by the integrator.
|
virtual |
Reset all settings to their respective default values.
Reimplemented in rr::CVODEIntegrator, rr::RK4Integrator, rr::RK45Integrator, rr::NLEQ2Solver, rr::NLEQ1Solver, and rr::GillespieIntegrator.
std::string rr::Solver::settingsPyDictRepr | ( | ) | const |
Python dictionary-style string representation of settings.
|
virtual |
Return string representation a la Python repr method.
Reimplemented in rr::SteadyStateSolver, and rr::Integrator.
|
virtual |
Return a string representation of the solver.
Reimplemented in rr::SteadyStateSolver, and rr::Integrator.