ROL
ROL::SampledVector< Real, Key > Class Template Reference

#include <ROL_SampledVector.hpp>

Public Member Functions

 SampledVector (void)
 Constructor.
 
void update (const bool flag=true)
 Update for SampledVector storage.
 
bool get (Vector< Real > &x, const Key &param)
 Return vector corresponding to input parameter.
 
void set (const Vector< Real > &x, const Key &param)
 Set vector corresponding to input parameter.
 

Private Member Functions

void reset (const bool flag=true)
 

Private Attributes

std::map< Key, int > indices_
 
std::vector< bool > flags_
 
std::vector< ROL::Ptr< Vector< Real > > > vectors_
 
int maxIndex_
 
bool updated_
 

Detailed Description

template<class Real, class Key = std::vector<Real>>
class ROL::SampledVector< Real, Key >

Definition at line 51 of file ROL_SampledVector.hpp.

Constructor & Destructor Documentation

◆ SampledVector()

template<class Real, class Key = std::vector<Real>>
ROL::SampledVector< Real, Key >::SampledVector ( void )
inline

Constructor.

Definition at line 75 of file ROL_SampledVector.hpp.

References flags_, indices_, maxIndex_, updated_, and vectors_.

Member Function Documentation

◆ reset()

template<class Real, class Key = std::vector<Real>>
void ROL::SampledVector< Real, Key >::reset ( const bool flag = true)
inlineprivate

Definition at line 62 of file ROL_SampledVector.hpp.

References flags_.

Referenced by update().

◆ update()

template<class Real, class Key = std::vector<Real>>
void ROL::SampledVector< Real, Key >::update ( const bool flag = true)
inline

Update for SampledVector storage.

Definition at line 84 of file ROL_SampledVector.hpp.

References reset(), and updated_.

◆ get()

template<class Real, class Key = std::vector<Real>>
bool ROL::SampledVector< Real, Key >::get ( Vector< Real > & x,
const Key & param )
inline

Return vector corresponding to input parameter.

Definition at line 91 of file ROL_SampledVector.hpp.

References ROL::Vector< Real >::clone(), flags_, indices_, maxIndex_, ROL::Vector< Real >::set(), and vectors_.

◆ set()

template<class Real, class Key = std::vector<Real>>
void ROL::SampledVector< Real, Key >::set ( const Vector< Real > & x,
const Key & param )
inline

Set vector corresponding to input parameter.

Definition at line 114 of file ROL_SampledVector.hpp.

References ROL::Vector< Real >::clone(), flags_, indices_, maxIndex_, and vectors_.

Member Data Documentation

◆ indices_

template<class Real, class Key = std::vector<Real>>
std::map<Key, int> ROL::SampledVector< Real, Key >::indices_
private

Definition at line 54 of file ROL_SampledVector.hpp.

Referenced by get(), SampledVector(), and set().

◆ flags_

template<class Real, class Key = std::vector<Real>>
std::vector<bool> ROL::SampledVector< Real, Key >::flags_
private

Definition at line 55 of file ROL_SampledVector.hpp.

Referenced by get(), reset(), SampledVector(), and set().

◆ vectors_

template<class Real, class Key = std::vector<Real>>
std::vector<ROL::Ptr<Vector<Real> > > ROL::SampledVector< Real, Key >::vectors_
private

Definition at line 56 of file ROL_SampledVector.hpp.

Referenced by get(), SampledVector(), and set().

◆ maxIndex_

template<class Real, class Key = std::vector<Real>>
int ROL::SampledVector< Real, Key >::maxIndex_
private

Definition at line 57 of file ROL_SampledVector.hpp.

Referenced by get(), SampledVector(), and set().

◆ updated_

template<class Real, class Key = std::vector<Real>>
bool ROL::SampledVector< Real, Key >::updated_
private

Definition at line 60 of file ROL_SampledVector.hpp.

Referenced by SampledVector(), and update().


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