Param Class Reference
A type used to represent the value of a parameter and its lower and upper bounds. More...
#include <Param.hpp>
Public Member Functions | |
Param () | |
Construct a default Param object. | |
Param (const real &val) | |
Construct a Param object with given value. | |
Param (double val) | |
Construct a Param object with given value. | |
Param (const String &id, const real &val) | |
Construct a Param object with identifier id and value val . | |
auto | clone () const -> Param |
Return a deep copy of this Param object. | |
auto | assign (const Param &other) -> Param & |
Assign the attributes of another Param object to this. | |
auto | value (const real &val) -> Param & |
Set the value of the parameter. | |
auto | value () const -> const real & |
Return the value of the parameter. | |
auto | value () -> real & |
Return the value of the parameter. | |
auto | id (String id) -> Param & |
Set the unique identifier of the parameter. | |
auto | id () const -> const String & |
Return the unique identifier of the parameter. | |
auto | lowerbound (double val) -> Param & |
Set the lower bound of the parameter. | |
auto | lowerbound () const -> double |
Return the lower bound of the parameter. | |
auto | upperbound (double val) -> Param & |
Set the upper bound of the parameter. | |
auto | upperbound () const -> double |
Return the upper bound of the parameter. | |
auto | isconst (bool val) -> Param & |
Set the parameter to constant or non-constant modes. | |
auto | isconst () const -> bool |
Return true if the parameter is constant. | |
auto | operator= (double val) -> Param & |
Assign a value to this Param object. | |
auto | operator= (const real &val) -> Param & |
Assign a value to this Param object. | |
operator const real & () const | |
Convert this Param object into its value type. | |
operator real & () | |
Convert this Param object into its value type. | |
operator double () const | |
Convert this Param object into its value type. | |
Static Public Member Functions | |
static auto | Constant (const real &val) -> Param |
Return a Param object that represents a constant parameter. | |
Detailed Description
A type used to represent the value of a parameter and its lower and upper bounds.
The documentation for this class was generated from the following file:
- Reaktoro/Core/Param.hpp