ROL::MeanDeviation< Real > Class Template Reference

#include <ROL_MeanDeviation.hpp>

Inheritance diagram for ROL::MeanDeviation< Real >:

Public Member Functions
	MeanDeviation (Real order, Real coeff, Teuchos::RCP< PositiveFunction< Real > > &pf)
	MeanDeviation (std::vector< Real > &order, std::vector< Real > &coeff, Teuchos::RCP< PositiveFunction< Real > > &pf)
void	reset (Teuchos::RCP< Vector< Real > > &x0, const Vector< Real > &x)
void	reset (Teuchos::RCP< Vector< Real > > &x0, const Vector< Real > &x, Teuchos::RCP< Vector< Real > > &v0, const Vector< Real > &v)
void	update (const Real val, const Real weight)
void	update (const Real val, const Vector< Real > &g, const Real weight)
void	update (const Real val, const Vector< Real > &g, const Real gv, const Vector< Real > &hv, const Real weight)
Real	getValue (SampleGenerator< Real > &sampler)
void	getGradient (Vector< Real > &g, SampleGenerator< Real > &sampler)
void	getHessVec (Vector< Real > &hv, SampleGenerator< Real > &sampler)
Public Member Functions inherited from ROL::RiskMeasure< Real >
virtual	~RiskMeasure ()
	RiskMeasure (void)

Private Attributes
Teuchos::RCP< PositiveFunction< Real > >	positiveFunction_
std::vector< Real >	order_
std::vector< Real >	coeff_
std::vector< Real >	weights_
std::vector< Real >	value_storage_
std::vector< Real >	gradvec_storage_
std::vector< Teuchos::RCP< Vector< Real > > >	gradient_storage_
std::vector< Teuchos::RCP< Vector< Real > > >	hessvec_storage_

Additional Inherited Members
Protected Attributes inherited from ROL::RiskMeasure< Real >
Real	val_
Real	gv_
Teuchos::RCP< Vector< Real > >	g_
Teuchos::RCP< Vector< Real > >	hv_
bool	firstReset_

Detailed Description

template<class Real>
class ROL::MeanDeviation< Real >

Definition at line 53 of file ROL_MeanDeviation.hpp.

Constructor & Destructor Documentation

template<class Real >

ROL::MeanDeviation< Real >::MeanDeviation ( Real  order, Real  coeff, Teuchos::RCP< PositiveFunction< Real > > &  pf  )

inline

Definition at line 69 of file ROL_MeanDeviation.hpp.

template<class Real >

ROL::MeanDeviation< Real >::MeanDeviation ( std::vector< Real > &  order, std::vector< Real > &  coeff, Teuchos::RCP< PositiveFunction< Real > > &  pf  )

inline

Definition at line 77 of file ROL_MeanDeviation.hpp.

Member Function Documentation

template<class Real >

void ROL::MeanDeviation< Real >::reset ( Teuchos::RCP< Vector< Real > > &  x0, const Vector< Real > &  x  )

inlinevirtual

Reimplemented from ROL::RiskMeasure< Real >.

Definition at line 90 of file ROL_MeanDeviation.hpp.

References ROL::RiskMeasure< Real >::reset().

template<class Real >

void ROL::MeanDeviation< Real >::reset ( Teuchos::RCP< Vector< Real > > &  x0, const Vector< Real > &  x, Teuchos::RCP< Vector< Real > > &  v0, const Vector< Real > &  v  )

inlinevirtual

Reimplemented from ROL::RiskMeasure< Real >.

Definition at line 99 of file ROL_MeanDeviation.hpp.

References ROL::RiskMeasure< Real >::reset().

template<class Real >

void ROL::MeanDeviation< Real >::update ( const Real  val, const Real  weight  )

inlinevirtual

Reimplemented from ROL::RiskMeasure< Real >.

Definition at line 109 of file ROL_MeanDeviation.hpp.

template<class Real >

void ROL::MeanDeviation< Real >::update ( const Real  val, const Vector< Real > &  g, const Real  weight  )

inlinevirtual

Reimplemented from ROL::RiskMeasure< Real >.

Definition at line 115 of file ROL_MeanDeviation.hpp.

References ROL::Vector< Real >::clone().

template<class Real >

void ROL::MeanDeviation< Real >::update ( const Real  val, const Vector< Real > &  g, const Real  gv, const Vector< Real > &  hv, const Real  weight  )

inlinevirtual

Reimplemented from ROL::RiskMeasure< Real >.

Definition at line 126 of file ROL_MeanDeviation.hpp.

References ROL::Vector< Real >::clone().

template<class Real >

Real ROL::MeanDeviation< Real >::getValue ( SampleGenerator< Real > &  sampler )

inlinevirtual

Reimplemented from ROL::RiskMeasure< Real >.

Definition at line 145 of file ROL_MeanDeviation.hpp.

References ROL::SampleGenerator< Real >::sumAll().

template<class Real >

void ROL::MeanDeviation< Real >::getGradient ( Vector< Real > &  g, SampleGenerator< Real > &  sampler  )

inlinevirtual

Reimplemented from ROL::RiskMeasure< Real >.

Definition at line 169 of file ROL_MeanDeviation.hpp.

References ROL::Vector< Real >::clone(), ROL::SampleGenerator< Real >::sumAll(), and ROL::Vector< Real >::zero().

template<class Real >

void ROL::MeanDeviation< Real >::getHessVec ( Vector< Real > &  hv, SampleGenerator< Real > &  sampler  )

inlinevirtual

Reimplemented from ROL::RiskMeasure< Real >.

Definition at line 214 of file ROL_MeanDeviation.hpp.

References ROL::Vector< Real >::clone(), ROL::SampleGenerator< Real >::sumAll(), and ROL::Vector< Real >::zero().

Member Data Documentation

template<class Real >

Teuchos::RCP<PositiveFunction<Real> > ROL::MeanDeviation< Real >::positiveFunction_

private

Definition at line 56 of file ROL_MeanDeviation.hpp.

template<class Real >

std::vector<Real> ROL::MeanDeviation< Real >::order_

private

Definition at line 58 of file ROL_MeanDeviation.hpp.

template<class Real >

std::vector<Real> ROL::MeanDeviation< Real >::coeff_

private

Definition at line 59 of file ROL_MeanDeviation.hpp.

template<class Real >

std::vector<Real> ROL::MeanDeviation< Real >::weights_

private

Definition at line 61 of file ROL_MeanDeviation.hpp.

template<class Real >

std::vector<Real> ROL::MeanDeviation< Real >::value_storage_

private

Definition at line 62 of file ROL_MeanDeviation.hpp.

template<class Real >

std::vector<Real> ROL::MeanDeviation< Real >::gradvec_storage_

private

Definition at line 63 of file ROL_MeanDeviation.hpp.

template<class Real >

std::vector<Teuchos::RCP<Vector<Real> > > ROL::MeanDeviation< Real >::gradient_storage_

private

Definition at line 64 of file ROL_MeanDeviation.hpp.

template<class Real >

std::vector<Teuchos::RCP<Vector<Real> > > ROL::MeanDeviation< Real >::hessvec_storage_

private

Definition at line 65 of file ROL_MeanDeviation.hpp.

---

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

• ROL_MeanDeviation.hpp