Provides the mix-in interface for making objects parametrized. More...
#include <ROL_Parametrize.hpp>
Inheritance diagram for ROL::Parametrize< Real >:
Public Member Functions | |
| virtual | ~Parametrize (void) |
| virtual void | setParameter (const std::vector< Real > ¶m) |
| Set the parameter. More... | |
Protected Member Functions | |
| const std::vector< Real > | getParameter (void) const |
| Return the parameter. More... | |
Private Attributes | |
| std::vector< Real > | param_ |
Detailed Description
template<class Real>
class ROL::Parametrize< Real >
Provides the mix-in interface for making objects parametrized.
ROL::Parametrize is used to make ROL::Objective's and ROL::EqualityConstraint's parametrized. ROL::Parametrize contains a single parameter (std::vector) and has methods for setting and getting the parameter. By using a mix-in (multiple inheritence) to define class such as ROL::ParametrizedObjective_SimOpt and ROL::ParametrizedEqualityConstraint_SimOpt we avoid diamond interitance.
Definition at line 62 of file ROL_Parametrize.hpp.
Constructor & Destructor Documentation
|
inlinevirtual |
Definition at line 74 of file ROL_Parametrize.hpp.
Member Function Documentation
|
inlineprotected |
Return the parameter.
Definition at line 69 of file ROL_Parametrize.hpp.
References ROL::Parametrize< Real >::param_.
|
inlinevirtual |
Set the parameter.
- Parameters
-
[in] param is a user-provided parameter
The internal storage copies the input.
Reimplemented in ROL::Reduced_ParametrizedObjective_SimOpt< Real >, ROL::ParametrizedCompositeObjective_SimOpt< Real >, and ROL::ParametrizedCompositeObjective< Real >.
Definition at line 81 of file ROL_Parametrize.hpp.
References ROL::Parametrize< Real >::param_.
Member Data Documentation
|
private |
Definition at line 64 of file ROL_Parametrize.hpp.
Referenced by ROL::Parametrize< Real >::getParameter(), and ROL::Parametrize< Real >::setParameter().
The documentation for this class was generated from the following file:
