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

#include <ROL_SampledScalar.hpp>

Public Member Functions
	SampledScalar (void)
	Constructor.
void	update (const bool flag=true)
	Update for SampledScalar storage.
bool	get (Real &x, const Key &param)
	Return vector corresponding to input parameter.
void	set (const 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< 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

SampledScalar()

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 flags_, indices_, maxIndex_, scalars_, and updated_.

Member Function Documentation

reset()

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 flags_, and indices_.

Referenced by update().

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 reset(), and updated_.

get()

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 flags_, indices_, maxIndex_, and scalars_.

set()

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 flags_, indices_, maxIndex_, and scalars_.

Member Data Documentation

indices_

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 get(), reset(), SampledScalar(), and set().

flags_

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 get(), reset(), SampledScalar(), and set().

scalars_

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 get(), SampledScalar(), and set().

maxIndex_

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 get(), SampledScalar(), and set().

updated_

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 SampledScalar(), and update().

---

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

• ROL_SampledScalar.hpp