ROL: ROL::RieszPrimalVector< Real > Class Template Reference

ROL

#include <ROL_RieszVector.hpp>

Public Member Functions
	RieszPrimalVector (const ROL::Ptr< V > &v, const ROL::Ptr< OP > &op, Real tol=std::sqrt(ROL_EPSILON< Real >()))

virtual	~RieszPrimalVector ()

virtual Real	dot (const V &x) const

virtual ROL::Ptr< V >	clone () const

virtual const V &	dual () const

void	applyUnary (const Elementwise::UnaryFunction< Real > &f)

void	applyBinary (const Elementwise::BinaryFunction< Real > &f, const V &x)

Real	reduce (const Elementwise::ReductionOp< Real > &r) const

void	setScalar (const Real C)

void	randomize (const Real l=0.0, const Real u=1.0)

ROL::Ptr< V >	getVector (void)

ROL::Ptr< const V >	getVector (void) const

Private Types
using	V = Vector< Real >

using	DualVector = RieszDualVector< Real >

using	OP = LinearOperator< Real >

Private Member Functions
void	initialize_dual (void) const

Private Attributes
const ROL::Ptr< V >	v_

ROL::Ptr< DualVector >	dual_

const ROL::Ptr< OP >	op_

Real	tol_

bool	isDualInitialized_

Detailed Description

template<class Real>
class ROL::RieszPrimalVector< Real >

Definition at line 77 of file ROL_RieszVector.hpp.

Member Typedef Documentation

◆ V

template<class Real >

using ROL::RieszPrimalVector< Real >::V = Vector<Real>

private

Definition at line 79 of file ROL_RieszVector.hpp.

◆ DualVector

template<class Real >

using ROL::RieszPrimalVector< Real >::DualVector = RieszDualVector<Real>

private

Definition at line 80 of file ROL_RieszVector.hpp.

◆ OP

template<class Real >

using ROL::RieszPrimalVector< Real >::OP = LinearOperator<Real>

private

Definition at line 81 of file ROL_RieszVector.hpp.

Constructor & Destructor Documentation

◆ RieszPrimalVector()

template<class Real >

ROL::RieszPrimalVector< Real >::RieszPrimalVector	(	const ROL::Ptr< V > &	v,
		const ROL::Ptr< OP > &	op,
		Real	tol = `std::sqrt(ROL_EPSILON<Real>())`
	)

inline

Definition at line 101 of file ROL_RieszVector.hpp.

◆ ~RieszPrimalVector()

template<class Real >

virtual ROL::RieszPrimalVector< Real >::~RieszPrimalVector ( )

inlinevirtual

Definition at line 107 of file ROL_RieszVector.hpp.

Member Function Documentation

◆ initialize_dual()

template<class Real >

void ROL::RieszPrimalVector< Real >::initialize_dual ( void ) const

inlineprivate

Definition at line 92 of file ROL_RieszVector.hpp.

References ROL::RieszPrimalVector< Real >::dual_, ROL::RieszPrimalVector< Real >::isDualInitialized_, ROL::RieszPrimalVector< Real >::op_, ROL::RieszPrimalVector< Real >::tol_, and ROL::RieszPrimalVector< Real >::v_.

Referenced by ROL::RieszPrimalVector< Real >::dot(), and ROL::RieszPrimalVector< Real >::dual().

◆ dot()

template<class Real >

virtual Real ROL::RieszPrimalVector< Real >::dot ( const V & x ) const

inlinevirtual

Definition at line 109 of file ROL_RieszVector.hpp.

References ROL::RieszPrimalVector< Real >::dual_, ROL::RieszPrimalVector< Real >::getVector(), ROL::RieszPrimalVector< Real >::initialize_dual(), and ROL::RieszPrimalVector< Real >::isDualInitialized_.

◆ clone()

template<class Real >

virtual ROL::Ptr<V> ROL::RieszPrimalVector< Real >::clone ( void ) const

inlinevirtual

Definition at line 118 of file ROL_RieszVector.hpp.

References ROL::RieszPrimalVector< Real >::op_, ROL::RieszPrimalVector< Real >::tol_, and ROL::RieszPrimalVector< Real >::v_.

◆ dual()

template<class Real >

virtual const V& ROL::RieszPrimalVector< Real >::dual ( void ) const

inlinevirtual

Definition at line 122 of file ROL_RieszVector.hpp.

References ROL::RieszPrimalVector< Real >::dual_, ROL::RieszPrimalVector< Real >::initialize_dual(), and ROL::RieszPrimalVector< Real >::isDualInitialized_.

◆ applyUnary()

template<class Real >

void ROL::RieszPrimalVector< Real >::applyUnary ( const Elementwise::UnaryFunction< Real > & f )

inline

Definition at line 129 of file ROL_RieszVector.hpp.

References ROL::RieszPrimalVector< Real >::v_.

◆ applyBinary()

template<class Real >

void ROL::RieszPrimalVector< Real >::applyBinary	(	const Elementwise::BinaryFunction< Real > &	f,
		const V &	x
	)

inline

Definition at line 133 of file ROL_RieszVector.hpp.

References ROL::RieszPrimalVector< Real >::getVector(), and ROL::RieszPrimalVector< Real >::v_.

◆ reduce()

template<class Real >

Real ROL::RieszPrimalVector< Real >::reduce ( const Elementwise::ReductionOp< Real > & r ) const

inline

Definition at line 138 of file ROL_RieszVector.hpp.

References ROL::RieszPrimalVector< Real >::v_.

◆ setScalar()

template<class Real >

void ROL::RieszPrimalVector< Real >::setScalar ( const Real C )

inline

Definition at line 142 of file ROL_RieszVector.hpp.

References ROL::RieszPrimalVector< Real >::v_.

◆ randomize()

template<class Real >

void ROL::RieszPrimalVector< Real >::randomize	(	const Real	l = `0.0`,
		const Real	u = `1.0`
	)

inline

Definition at line 146 of file ROL_RieszVector.hpp.

References ROL::RieszPrimalVector< Real >::v_.

◆ getVector() [1/2]

template<class Real >

ROL::Ptr<V> ROL::RieszPrimalVector< Real >::getVector ( void )

inline

Definition at line 150 of file ROL_RieszVector.hpp.

References ROL::RieszPrimalVector< Real >::v_.

Referenced by ROL::RieszPrimalVector< Real >::applyBinary(), and ROL::RieszPrimalVector< Real >::dot().

◆ getVector() [2/2]

template<class Real >

ROL::Ptr<const V> ROL::RieszPrimalVector< Real >::getVector ( void ) const

inline

Definition at line 154 of file ROL_RieszVector.hpp.

References ROL::RieszPrimalVector< Real >::v_.

Member Data Documentation

◆ v_

template<class Real >

const ROL::Ptr<V> ROL::RieszPrimalVector< Real >::v_

private

Definition at line 85 of file ROL_RieszVector.hpp.

Referenced by ROL::RieszPrimalVector< Real >::applyBinary(), ROL::RieszPrimalVector< Real >::applyUnary(), ROL::RieszPrimalVector< Real >::clone(), ROL::RieszPrimalVector< Real >::getVector(), ROL::RieszPrimalVector< Real >::initialize_dual(), ROL::RieszPrimalVector< Real >::randomize(), ROL::RieszPrimalVector< Real >::reduce(), and ROL::RieszPrimalVector< Real >::setScalar().

◆ dual_

template<class Real >

ROL::Ptr<DualVector> ROL::RieszPrimalVector< Real >::dual_

mutableprivate

Definition at line 86 of file ROL_RieszVector.hpp.

Referenced by ROL::RieszPrimalVector< Real >::dot(), ROL::RieszPrimalVector< Real >::dual(), and ROL::RieszPrimalVector< Real >::initialize_dual().

◆ op_

template<class Real >

const ROL::Ptr<OP> ROL::RieszPrimalVector< Real >::op_

private

Definition at line 87 of file ROL_RieszVector.hpp.

Referenced by ROL::RieszPrimalVector< Real >::clone(), and ROL::RieszPrimalVector< Real >::initialize_dual().

◆ tol_

template<class Real >

Real ROL::RieszPrimalVector< Real >::tol_

mutableprivate

Definition at line 88 of file ROL_RieszVector.hpp.

Referenced by ROL::RieszPrimalVector< Real >::clone(), and ROL::RieszPrimalVector< Real >::initialize_dual().

◆ isDualInitialized_

template<class Real >

bool ROL::RieszPrimalVector< Real >::isDualInitialized_

mutableprivate

Definition at line 90 of file ROL_RieszVector.hpp.

Referenced by ROL::RieszPrimalVector< Real >::dot(), ROL::RieszPrimalVector< Real >::dual(), and ROL::RieszPrimalVector< Real >::initialize_dual().

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

ROL_RieszVector.hpp