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

#include <ROL_SampledScalar.hpp>

Public Member Functions
	SampledScalar (void)
	Constructor. More...
void	update (const bool flag=true)
	Update for SampledScalar storage. More...
bool	get (Real &x, const Key &param)
	Return vector corresponding to input parameter. More...
void	set (const Real &x, const Key &param)
	Set vector corresponding to input parameter. More...

Private Member Functions
void	reset (const bool flag=true)

Private Attributes
std::map< Key, int >	indices_
std::vector< bool >	flags_
std::vector< Real >	scalars_
int	maxIndex_
bool	updated_

Detailed Description

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

Definition at line 16 of file ROL_SampledScalar.hpp.

Constructor & Destructor Documentation

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

ROL::SampledScalar< Real, Key >::SampledScalar ( void  )

inline

Constructor.

Definition at line 39 of file ROL_SampledScalar.hpp.

References ROL::SampledScalar< Real, Key >::flags_, ROL::SampledScalar< Real, Key >::indices_, and ROL::SampledScalar< Real, Key >::scalars_.

Member Function Documentation

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

void ROL::SampledScalar< Real, Key >::reset ( const bool  flag = true )

inlineprivate

Definition at line 27 of file ROL_SampledScalar.hpp.

References ROL::SampledScalar< Real, Key >::flags_, and ROL::SampledScalar< Real, Key >::indices_.

Referenced by ROL::SampledScalar< Real, Key >::update().

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

void ROL::SampledScalar< Real, Key >::update ( const bool  flag = true )

inline

Update for SampledScalar storage.

Definition at line 48 of file ROL_SampledScalar.hpp.

References ROL::SampledScalar< Real, Key >::reset(), and ROL::SampledScalar< Real, Key >::updated_.

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

bool ROL::SampledScalar< Real, Key >::get ( Real &  x, const Key &  param  )

inline

Return vector corresponding to input parameter.

Definition at line 55 of file ROL_SampledScalar.hpp.

References ROL::SampledScalar< Real, Key >::flags_, ROL::SampledScalar< Real, Key >::indices_, ROL::SampledScalar< Real, Key >::maxIndex_, and ROL::SampledScalar< Real, Key >::scalars_.

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

void ROL::SampledScalar< Real, Key >::set ( const Real &  x, const Key &  param  )

inline

Set vector corresponding to input parameter.

Definition at line 78 of file ROL_SampledScalar.hpp.

References ROL::SampledScalar< Real, Key >::flags_, ROL::SampledScalar< Real, Key >::indices_, ROL::SampledScalar< Real, Key >::maxIndex_, and ROL::SampledScalar< Real, Key >::scalars_.

Member Data Documentation

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

std::map<Key, int> ROL::SampledScalar< Real, Key >::indices_

private

Definition at line 19 of file ROL_SampledScalar.hpp.

Referenced by ROL::SampledScalar< Real, Key >::get(), ROL::SampledScalar< Real, Key >::reset(), ROL::SampledScalar< Real, Key >::SampledScalar(), and ROL::SampledScalar< Real, Key >::set().

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

std::vector<bool> ROL::SampledScalar< Real, Key >::flags_

private

Definition at line 20 of file ROL_SampledScalar.hpp.

Referenced by ROL::SampledScalar< Real, Key >::get(), ROL::SampledScalar< Real, Key >::reset(), ROL::SampledScalar< Real, Key >::SampledScalar(), and ROL::SampledScalar< Real, Key >::set().

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

std::vector<Real> ROL::SampledScalar< Real, Key >::scalars_

private

Definition at line 21 of file ROL_SampledScalar.hpp.

Referenced by ROL::SampledScalar< Real, Key >::get(), ROL::SampledScalar< Real, Key >::SampledScalar(), and ROL::SampledScalar< Real, Key >::set().

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

int ROL::SampledScalar< Real, Key >::maxIndex_

private

Definition at line 22 of file ROL_SampledScalar.hpp.

Referenced by ROL::SampledScalar< Real, Key >::get(), and ROL::SampledScalar< Real, Key >::set().

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

bool ROL::SampledScalar< Real, Key >::updated_

private

Definition at line 25 of file ROL_SampledScalar.hpp.

Referenced by ROL::SampledScalar< Real, Key >::update().

---

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

• ROL_SampledScalar.hpp