#include <ROL_ScalarController.hpp>
Inheritance diagram for ROL::ScalarController< Real, Key >:
Public Member Functions | |
| ScalarController (void) | |
| bool | get (Real &x, const Key ¶m) |
| void | set (Real x, const Key ¶m) |
| Public Member Functions inherited from ROL::VectorController< Real, std::vector< Real > > | |
| VectorController (void) | |
| Constructor. More... | |
| void | reset (bool flag=true) |
| void | objectiveUpdate (bool flag=true) |
| Objective function update for VectorController storage. More... | |
| void | objectiveUpdate (UpdateType type) |
| Objective function update for VectorController storage. More... | |
| void | constraintUpdate (bool flag=true) |
| Equality constraint update for VectorController storage. More... | |
| void | constraintUpdate (UpdateType type) |
| Constraint update for VectorController storage. More... | |
| bool | isNull (const std::vector< Real > ¶m) const |
| Check if vector associated with provided key is allocated. More... | |
| bool | isComputed (const std::vector< Real > ¶m) const |
| Check if vector has been computed. More... | |
| void | allocate (const Vector< Real > &x, const std::vector< Real > ¶m) |
| Allocate the vector associated with provided key. More... | |
| const Ptr< Vector< Real > > | set (const std::vector< Real > ¶m) |
| Set the vector associated with provided key. This assumes the vector data will be changed. More... | |
| void | set (const Vector< Real > &x, const std::vector< Real > ¶m) |
| Set vector corresponding to input parameter. More... | |
| const Ptr< const Vector< Real > > | get (const std::vector< Real > ¶m) const |
| Return the vector associated with provided key. More... | |
| bool | get (Vector< Real > &x, const std::vector< Real > ¶m) |
| Return vector corresponding to input parameter. More... | |
| void | push (VectorController< Real, std::vector< Real > > &to) const |
| Push the contents of *this into another VectorController. More... | |
Detailed Description
template<class Real, class Key = std::vector<Real>>
class ROL::ScalarController< Real, Key >
Definition at line 54 of file ROL_ScalarController.hpp.
Constructor & Destructor Documentation
◆ ScalarController()
template<class Real , class Key >
| ROL::ScalarController< Real, Key >::ScalarController | ( | void | ) |
Definition at line 51 of file ROL_ScalarController_Def.hpp.
Member Function Documentation
◆ get()
template<class Real , class Key >
| bool ROL::ScalarController< Real, Key >::get | ( | Real & | x, |
| const Key & | param | ||
| ) |
Definition at line 54 of file ROL_ScalarController_Def.hpp.
References ROL::VectorController< Real, Key >::get(), and ROL::SingletonVector< Real >::getValue().
◆ set()
template<class Real , class Key >
| void ROL::ScalarController< Real, Key >::set | ( | Real | x, |
| const Key & | param | ||
| ) |
Definition at line 62 of file ROL_ScalarController_Def.hpp.
References ROL::VectorController< Real, Key >::set().
The documentation for this class was generated from the following files:
