ROL
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
ROL::DynamicFunction< Real > Class Template Reference

Provides update interface, casting and vector management to DynamicConstraint and DynamicObjective. More...

#include <ROL_DynamicFunction.hpp>

+ Inheritance diagram for ROL::DynamicFunction< Real >:

Public Types

using V = Vector< Real >
 
using PV = PartitionedVector< Real >
 

Public Member Functions

virtual ~DynamicFunction ()
 
virtual void update_uo (const V &x)
 
virtual void update_un (const V &x)
 
virtual void update_z (const V &x)
 

Protected Member Functions

VectorWorkspace< Real > & getVectorWorkspace () const
 
PVpartition (V &x) const
 
const PVpartition (const V &x) const
 
VgetNew (V &x) const
 
const VgetNew (const V &x) const
 
VgetOld (V &x) const
 
const VgetOld (const V &x) const
 

Private Attributes

VectorWorkspace< Real > workspace_
 

Detailed Description

template<typename Real>
class ROL::DynamicFunction< Real >

Provides update interface, casting and vector management to DynamicConstraint and DynamicObjective.

Definition at line 61 of file ROL_DynamicFunction.hpp.

Member Typedef Documentation

template<typename Real >
using ROL::DynamicFunction< Real >::V = Vector<Real>

Definition at line 64 of file ROL_DynamicFunction.hpp.

template<typename Real >
using ROL::DynamicFunction< Real >::PV = PartitionedVector<Real>

Definition at line 65 of file ROL_DynamicFunction.hpp.

Constructor & Destructor Documentation

template<typename Real >
virtual ROL::DynamicFunction< Real >::~DynamicFunction ( )
inlinevirtual

Definition at line 67 of file ROL_DynamicFunction.hpp.

Member Function Documentation

template<typename Real >
virtual void ROL::DynamicFunction< Real >::update_uo ( const V x)
inlinevirtual

Definition at line 70 of file ROL_DynamicFunction.hpp.

template<typename Real >
virtual void ROL::DynamicFunction< Real >::update_un ( const V x)
inlinevirtual

Definition at line 73 of file ROL_DynamicFunction.hpp.

template<typename Real >
virtual void ROL::DynamicFunction< Real >::update_z ( const V x)
inlinevirtual

Definition at line 76 of file ROL_DynamicFunction.hpp.

template<typename Real >
VectorWorkspace< Real > & ROL::DynamicFunction< Real >::getVectorWorkspace ( ) const
protected

Definition at line 54 of file ROL_DynamicFunctionDef.hpp.

References workspace_.

template<typename Real >
PartitionedVector< Real > & ROL::DynamicFunction< Real >::partition ( V x) const
protected

Definition at line 58 of file ROL_DynamicFunctionDef.hpp.

template<typename Real >
const PartitionedVector< Real > & ROL::DynamicFunction< Real >::partition ( const V x) const
protected

Definition at line 64 of file ROL_DynamicFunctionDef.hpp.

template<typename Real >
Vector< Real > & ROL::DynamicFunction< Real >::getNew ( V x) const
protected

Definition at line 70 of file ROL_DynamicFunctionDef.hpp.

References partition().

template<typename Real >
const Vector< Real > & ROL::DynamicFunction< Real >::getNew ( const V x) const
protected

Definition at line 76 of file ROL_DynamicFunctionDef.hpp.

References partition().

template<typename Real >
Vector< Real > & ROL::DynamicFunction< Real >::getOld ( V x) const
protected

Definition at line 82 of file ROL_DynamicFunctionDef.hpp.

References partition().

template<typename Real >
const Vector< Real > & ROL::DynamicFunction< Real >::getOld ( const V x) const
protected

Definition at line 88 of file ROL_DynamicFunctionDef.hpp.

References partition().

Member Data Documentation

template<typename Real >
VectorWorkspace<Real> ROL::DynamicFunction< Real >::workspace_
mutableprivate

Definition at line 93 of file ROL_DynamicFunction.hpp.


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