ROL
Public Member Functions | List of all members
ROL::ScalarController< Real, Key > Class Template Reference

#include <ROL_ScalarController.hpp>

+ Inheritance diagram for ROL::ScalarController< Real, Key >:

Public Member Functions

 ScalarController (void)
 
bool get (Real &x, const Key &param)
 
void set (Real x, const Key &param)
 
- Public Member Functions inherited from ROL::VectorController< Real, Key >
 VectorController (void)
 Constructor. More...
 
void reset (bool flag=true)
 
void objectiveUpdate (bool flag=true)
 Objective function update for VectorController storage. More...
 
void constraintUpdate (bool flag=true)
 Equality constraint update for VectorController storage. More...
 
void objectiveUpdate (UpdateType type)
 Objective function update for VectorController storage. More...
 
void constraintUpdate (UpdateType type)
 Constraint update for VectorController storage. More...
 
bool isNull (const Key &param) const
 Check if vector associated with provided key is allocated. More...
 
bool isComputed (const Key &param) const
 Check if vector has been computed. More...
 
void allocate (const Vector< Real > &x, const Key &param)
 Allocate the vector associated with provided key. More...
 
const Ptr< Vector< Real > > set (const Key &param)
 Set the vector associated with provided key. This assumes the vector data will be changed. More...
 
const Ptr< const Vector< Real > > get (const Key &param) const
 Return the vector associated with provided key. More...
 
bool get (Vector< Real > &x, const Key &param)
 Return vector corresponding to input parameter. More...
 
void set (const Vector< Real > &x, const Key &param)
 Set vector corresponding to input parameter. More...
 
void push (VectorController< Real, Key > &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 19 of file ROL_ScalarController.hpp.

Constructor & Destructor Documentation

template<class Real , class Key >
ROL::ScalarController< Real, Key >::ScalarController ( void  )

Definition at line 16 of file ROL_ScalarController_Def.hpp.

Member Function Documentation

template<class Real , class Key >
bool ROL::ScalarController< Real, Key >::get ( Real &  x,
const Key &  param 
)
template<class Real , class Key >
void ROL::ScalarController< Real, Key >::set ( Real  x,
const Key &  param 
)

The documentation for this class was generated from the following files: