roadrunner
2.6.0
Fast simulator for SBML models
|
Base class for all integrators and steady state solvers. More...
#include <Solver.h>
Public Types | |
using | SettingsList = std::vector< std::string > |
using | SettingsMap = std::unordered_map< std::string, Setting > |
using | DisplayNameMap = std::unordered_map< std::string, std::string > |
using | HintMap = std::unordered_map< std::string, std::string > |
using | DescriptionMap = std::unordered_map< std::string, std::string > |
Public Member Functions | |
Solver (ExecutableModel *model) | |
void | updateSettings (Dictionary *inputSettings) |
Update settings values. More... | |
std::vector< std::string > | getSettings () const |
Get a list of all settings for this solver. More... | |
std::unordered_map< std::string, Setting > & | getSettingsMap () |
get settings for this solver More... | |
virtual void | resetSettings () |
Reset all settings to their respective default values. | |
virtual Setting | getValue (const std::string &key) const |
Get the value of an integrator setting. More... | |
virtual Setting | hasValue (const 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 std::string | getValueAsString (const std::string &key) |
Wrapper for getValue which converts output to a specific type. More... | |
virtual void | setValue (const std::string &key, Setting value) |
virtual std::string | getSettingsRepr () const |
Get the solver settings as a std::string. More... | |
virtual std::string | settingsPyDictRepr () const |
Python dictionary-style std::string representation of settings. More... | |
virtual std::string | toString () const |
Return a std::string representation of the solver. More... | |
virtual std::string | toRepr () const |
Return std::string representation a la Python repr method. More... | |
const std::string & | getDisplayName (const std::string &key) const |
Gets the hint associated with a given key. More... | |
const std::string & | getHint (const std::string &key) const |
Gets the hint associated with a given key. More... | |
const std::string & | getDescription (const std::string &key) const |
Gets the description associated with a given key. More... | |
Setting::TypeId | getType (const std::string &key) const |
Gets the type associated with a given key. More... | |
virtual void | syncWithModel (ExecutableModel *m)=0 |
Called whenever a new model is loaded to allow integrator to reset internal state. More... | |
virtual ExecutableModel * | getModel () const |
returns the pointer to the ExecutableModel | |
virtual std::string | getName () const=0 |
Gets the name associated with this Solver type. More... | |
virtual std::string | getHint () const=0 |
Gets the hint associated with this Solver type. More... | |
virtual std::string | getDescription () const=0 |
Gets the description associated with this Solver type. More... | |
![]() | |
virtual std::string | getName () const =0 |
Gets the name associated with this Solver type. More... | |
virtual std::string | getDescription () const =0 |
Gets the description associated with this Solver type. More... | |
virtual std::string | getHint () const =0 |
Gets the hint associated with this Solver type. More... | |
virtual Solver * | construct (ExecutableModel *model) const =0 |
Constructs a new Solver of a given type. More... | |
Public Attributes | |
SettingsList | sorted_settings |
SettingsMap | settings |
DisplayNameMap | display_names_ |
HintMap | hints |
DescriptionMap | descriptions |
Protected Member Functions | |
void | addSetting (const std::string &name, const Setting &val, const std::string &display_name, const std::string &hint, const std::string &description) |
Protected Attributes | |
ExecutableModel * | mModel = nullptr |
non-owning pointer to model | |
Base class for all integrators and steady state solvers.
virtual std::string rr::Registrable::getDescription |
Gets the description associated with this Solver type.
const std::string & rr::Solver::getDescription | ( | const std::string & | key | ) | const |
Gets the description associated with a given key.
const std::string & rr::Solver::getDisplayName | ( | const std::string & | key | ) | const |
Gets the hint associated with a given key.
virtual std::string rr::Registrable::getHint |
Gets the hint associated with this Solver type.
const std::string & rr::Solver::getHint | ( | const std::string & | key | ) | const |
Gets the hint associated with a given key.
virtual std::string rr::Registrable::getName |
Gets the name associated with this Solver type.
|
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::unordered_map< std::string, Setting > & rr::Solver::getSettingsMap | ( | ) |
get settings for this solver
|
virtual |
Get the solver settings as a std::string.
Setting::TypeId rr::Solver::getType | ( | const std::string & | key | ) | const |
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 |
Return true if this setting is supported by the integrator.
|
virtual |
Python dictionary-style std::string representation of settings.
|
pure virtual |
Called whenever a new model is loaded to allow integrator to reset internal state.
Implemented in rr::SteadyStateSolverDecorator, rr::RK4Integrator, rr::NLEQSolver, rr::KinsolSteadyStateSolver, rr::GillespieIntegrator, rr::CVODEIntegrator, rr::RK45Integrator, rr::Integrator, and rr::ForwardSensitivitySolver.
|
virtual |
Return std::string representation a la Python repr method.
Reimplemented in rr::SteadyStateSolver, rr::ForwardSensitivitySolver, rr::EulerIntegrator, and rr::Integrator.
|
virtual |
Return a std::string representation of the solver.
Reimplemented in rr::SteadyStateSolver, rr::ForwardSensitivitySolver, rr::EulerIntegrator, and rr::Integrator.
void rr::Solver::updateSettings | ( | Dictionary * | inputSettings | ) |
Update settings values.
update the values of keys in
inputSettings | with the values. Keys that are not in Solver are ignored |