#include <ROL_MomentObjective.hpp>

Inheritance diagram for ROL::MomentObjective< Real >:

Public Member Functions
	MomentObjective (const std::vector< std::vector< std::pair< int, Real > > > &moments, const ROL::Ptr< BatchManager< Real > > &bman, const bool optProb=true, const bool optAtom=true)

	MomentObjective (const std::vector< ROL::Ptr< Distribution< Real > > > &dist, const std::vector< int > &order, const ROL::Ptr< BatchManager< Real > > &bman, const bool optProb=true, const bool optAtom=true)

Real	value (const Vector< Real > &x, Real &tol)
	Compute value. More...

void	gradient (Vector< Real > &g, const Vector< Real > &x, Real &tol)
	Compute gradient. More...

void	hessVec (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
	Apply Hessian approximation to vector. More...

Public Member Functions inherited from ROL::Objective< Real >
virtual	~Objective ()

virtual void	update (const Vector< Real > &x, bool flag=true, int iter=-1)
	Update objective function. More...

virtual Real	dirDeriv (const Vector< Real > &x, const Vector< Real > &d, Real &tol)
	Compute directional derivative. More...

virtual void	invHessVec (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
	Apply inverse Hessian approximation to vector. More...

virtual void	precond (Vector< Real > &Pv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
	Apply preconditioner to vector. More...

virtual std::vector < std::vector< Real > >	checkGradient (const Vector< Real > &x, const Vector< Real > &d, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
	Finite-difference gradient check. More...

virtual std::vector < std::vector< Real > >	checkGradient (const Vector< Real > &x, const Vector< Real > &g, const Vector< Real > &d, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
	Finite-difference gradient check. More...

virtual std::vector < std::vector< Real > >	checkGradient (const Vector< Real > &x, const Vector< Real > &d, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)
	Finite-difference gradient check with specified step sizes. More...

virtual std::vector < std::vector< Real > >	checkGradient (const Vector< Real > &x, const Vector< Real > &g, const Vector< Real > &d, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)
	Finite-difference gradient check with specified step sizes. More...

virtual std::vector < std::vector< Real > >	checkHessVec (const Vector< Real > &x, const Vector< Real > &v, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
	Finite-difference Hessian-applied-to-vector check. More...

virtual std::vector < std::vector< Real > >	checkHessVec (const Vector< Real > &x, const Vector< Real > &hv, const Vector< Real > &v, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
	Finite-difference Hessian-applied-to-vector check. More...

virtual std::vector < std::vector< Real > >	checkHessVec (const Vector< Real > &x, const Vector< Real > &v, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)
	Finite-difference Hessian-applied-to-vector check with specified step sizes. More...

virtual std::vector < std::vector< Real > >	checkHessVec (const Vector< Real > &x, const Vector< Real > &hv, const Vector< Real > &v, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)
	Finite-difference Hessian-applied-to-vector check with specified step sizes. More...

virtual std::vector< Real >	checkHessSym (const Vector< Real > &x, const Vector< Real > &v, const Vector< Real > &w, const bool printToStream=true, std::ostream &outStream=std::cout)
	Hessian symmetry check. More...

virtual std::vector< Real >	checkHessSym (const Vector< Real > &x, const Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &w, const bool printToStream=true, std::ostream &outStream=std::cout)
	Hessian symmetry check. More...

virtual void	setParameter (const std::vector< Real > &param)

Private Member Functions
Real	momentValue (const int dim, const Real power, const Real moment, const ProbabilityVector< Real > &prob, const AtomVector< Real > &atom) const

void	momentGradient (std::vector< Real > &gradx, std::vector< Real > &gradp, Real &scale, const int dim, const Real power, const Real moment, const ProbabilityVector< Real > &prob, const AtomVector< Real > &atom) const

void	momentHessVec (std::vector< Real > &hvx1, std::vector< Real > &hvx2, std::vector< Real > &hvx3, std::vector< Real > &hvp1, std::vector< Real > &hvp2, Real &scale1, Real &scale2, Real &scale3, const int dim, const Real power, const Real moment, const ProbabilityVector< Real > &prob, const AtomVector< Real > &atom, const ProbabilityVector< Real > &vprob, const AtomVector< Real > &vatom) const

Private Attributes
std::vector< std::vector < std::pair< int, Real > > >	moments_

ROL::Ptr< BatchManager< Real > >	bman_

int	dimension_

int	numMoments_

const bool	optProb_

const bool	optAtom_

Additional Inherited Members
Protected Member Functions inherited from ROL::Objective< Real >
const std::vector< Real >	getParameter (void) const

Detailed Description

template<class Real>
class ROL::MomentObjective< Real >

Definition at line 57 of file ROL_MomentObjective.hpp.

Constructor & Destructor Documentation

template<class Real >

ROL::MomentObjective< Real >::MomentObjective	(	const std::vector< std::vector< std::pair< int, Real > > > &	moments,
		const ROL::Ptr< BatchManager< Real > > &	bman,
		const bool	optProb = `true`,
		const bool	optAtom = `true`
	)

inline

Definition at line 142 of file ROL_MomentObjective.hpp.

References ROL::MomentObjective< Real >::dimension_, ROL::MomentObjective< Real >::moments_, and ROL::MomentObjective< Real >::numMoments_.

template<class Real >

ROL::MomentObjective< Real >::MomentObjective	(	const std::vector< ROL::Ptr< Distribution< Real > > > &	dist,
		const std::vector< int > &	order,
		const ROL::Ptr< BatchManager< Real > > &	bman,
		const bool	optProb = `true`,
		const bool	optAtom = `true`
	)

inline

Definition at line 151 of file ROL_MomentObjective.hpp.

References ROL::MomentObjective< Real >::dimension_, ROL::MomentObjective< Real >::moments_, and ROL::MomentObjective< Real >::numMoments_.

Member Function Documentation

template<class Real >

Real ROL::MomentObjective< Real >::momentValue	(	const int	dim,
		const Real	power,
		const Real	moment,
		const ProbabilityVector< Real > &	prob,
		const AtomVector< Real > &	atom
	)		const

inlineprivate

Definition at line 66 of file ROL_MomentObjective.hpp.

References ROL::MomentObjective< Real >::bman_, ROL::AtomVector< Real >::getAtom(), ROL::ProbabilityVector< Real >::getNumMyAtoms(), and ROL::ProbabilityVector< Real >::getProbability().

Referenced by ROL::MomentObjective< Real >::value().

template<class Real >

void ROL::MomentObjective< Real >::momentGradient	(	std::vector< Real > &	gradx,
		std::vector< Real > &	gradp,
		Real &	scale,
		const int	dim,
		const Real	power,
		const Real	moment,
		const ProbabilityVector< Real > &	prob,
		const AtomVector< Real > &	atom
	)		const

inlineprivate

Definition at line 80 of file ROL_MomentObjective.hpp.

References ROL::MomentObjective< Real >::bman_, ROL::AtomVector< Real >::getAtom(), ROL::ProbabilityVector< Real >::getNumMyAtoms(), and ROL::ProbabilityVector< Real >::getProbability().

Referenced by ROL::MomentObjective< Real >::gradient().

template<class Real >

void ROL::MomentObjective< Real >::momentHessVec	(	std::vector< Real > &	hvx1,
		std::vector< Real > &	hvx2,
		std::vector< Real > &	hvx3,
		std::vector< Real > &	hvp1,
		std::vector< Real > &	hvp2,
		Real &	scale1,
		Real &	scale2,
		Real &	scale3,
		const int	dim,
		const Real	power,
		const Real	moment,
		const ProbabilityVector< Real > &	prob,
		const AtomVector< Real > &	atom,
		const ProbabilityVector< Real > &	vprob,
		const AtomVector< Real > &	vatom
	)		const

inlineprivate

Definition at line 101 of file ROL_MomentObjective.hpp.

References ROL::MomentObjective< Real >::bman_, ROL::AtomVector< Real >::getAtom(), ROL::ProbabilityVector< Real >::getNumMyAtoms(), ROL::ProbabilityVector< Real >::getProbability(), and zero.

Referenced by ROL::MomentObjective< Real >::hessVec().

template<class Real >

Real ROL::MomentObjective< Real >::value	(	const Vector< Real > &	x,
		Real &	tol
	)

inlinevirtual

Compute value.

This function returns the objective function value.

Parameters

[in]	x	is the current iterate.
[in]	tol	is a tolerance for inexact objective function computation.

Implements ROL::Objective< Real >.

Definition at line 168 of file ROL_MomentObjective.hpp.

References ROL::MomentObjective< Real >::dimension_, ROL::SROMVector< Real >::getAtomVector(), ROL::SROMVector< Real >::getProbabilityVector(), ROL::MomentObjective< Real >::moments_, ROL::MomentObjective< Real >::momentValue(), and ROL::MomentObjective< Real >::numMoments_.

template<class Real >

void ROL::MomentObjective< Real >::gradient	(	Vector< Real > &	g,
		const Vector< Real > &	x,
		Real &	tol
	)

inlinevirtual

Compute gradient.

This function returns the objective function gradient.

Parameters

[out]	g	is the gradient.
[in]	x	is the current iterate.
[in]	tol	is a tolerance for inexact objective function computation.

The default implementation is a finite-difference approximation based on the function value. This requires the definition of a basis \(\{\phi_i\}\) for the optimization vectors x and the definition of a basis \(\{\psi_j\}\) for the dual optimization vectors (gradient vectors g). The bases must be related through the Riesz map, i.e., \( R \{\phi_i\} = \{\psi_j\}\), and this must be reflected in the implementation of the ROL::Vector::dual() method.

Reimplemented from ROL::Objective< Real >.

Definition at line 183 of file ROL_MomentObjective.hpp.

References ROL::MomentObjective< Real >::dimension_, ROL::SROMVector< Real >::getAtomVector(), ROL::SROMVector< Real >::getProbabilityVector(), ROL::MomentObjective< Real >::momentGradient(), ROL::MomentObjective< Real >::moments_, ROL::MomentObjective< Real >::numMoments_, ROL::MomentObjective< Real >::optAtom_, ROL::MomentObjective< Real >::optProb_, ROL::AtomVector< Real >::setAtom(), and ROL::Vector< Real >::zero().

template<class Real >

void ROL::MomentObjective< Real >::hessVec	(	Vector< Real > &	hv,
		const Vector< Real > &	v,
		const Vector< Real > &	x,
		Real &	tol
	)

inlinevirtual

Apply Hessian approximation to vector.

This function applies the Hessian of the objective function to the vector \(v\).

Parameters

[out]	hv	is the the action of the Hessian on \(v\).
[in]	v	is the direction vector.
[in]	x	is the current iterate.
[in]	tol	is a tolerance for inexact objective function computation.