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

ROL

#include <ROL_RieszVector.hpp>

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

virtual	~RieszDualVector ()

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	PrimalVector = RieszPrimalVector< Real >

using	OP = LinearOperator< Real >

Private Member Functions
void	initialize_primal (void) const

Private Attributes
const ROL::Ptr< V >	v_

ROL::Ptr< PrimalVector >	primal_

const ROL::Ptr< OP >	op_

Real	tol_

bool	isPrimalInitialized_

Detailed Description

template<class Real>
class ROL::RieszDualVector< Real >

Definition at line 163 of file ROL_RieszVector.hpp.

Member Typedef Documentation

◆ V

template<class Real >

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

private

Definition at line 165 of file ROL_RieszVector.hpp.

◆ PrimalVector

template<class Real >

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

private

Definition at line 166 of file ROL_RieszVector.hpp.

◆ OP

template<class Real >

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

private

Definition at line 167 of file ROL_RieszVector.hpp.

Constructor & Destructor Documentation

◆ RieszDualVector()

template<class Real >

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

inline

Definition at line 187 of file ROL_RieszVector.hpp.

◆ ~RieszDualVector()

template<class Real >

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

inlinevirtual

Definition at line 193 of file ROL_RieszVector.hpp.

Member Function Documentation

◆ initialize_primal()

template<class Real >

void ROL::RieszDualVector< Real >::initialize_primal ( void ) const

inlineprivate

Definition at line 178 of file ROL_RieszVector.hpp.

References ROL::RieszDualVector< Real >::isPrimalInitialized_, ROL::RieszDualVector< Real >::op_, ROL::RieszDualVector< Real >::primal_, ROL::RieszDualVector< Real >::tol_, and ROL::RieszDualVector< Real >::v_.

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

◆ dot()

template<class Real >

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

inlinevirtual

Definition at line 195 of file ROL_RieszVector.hpp.

References ROL::RieszDualVector< Real >::getVector(), ROL::RieszDualVector< Real >::initialize_primal(), ROL::RieszDualVector< Real >::isPrimalInitialized_, and ROL::RieszDualVector< Real >::primal_.

◆ clone()

template<class Real >

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

inlinevirtual

Definition at line 204 of file ROL_RieszVector.hpp.

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

◆ dual()

template<class Real >

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

inlinevirtual

Definition at line 208 of file ROL_RieszVector.hpp.

References ROL::RieszDualVector< Real >::initialize_primal(), ROL::RieszDualVector< Real >::isPrimalInitialized_, and ROL::RieszDualVector< Real >::primal_.

◆ applyUnary()

template<class Real >

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

inline

Definition at line 215 of file ROL_RieszVector.hpp.

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

◆ applyBinary()

template<class Real >

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

inline

Definition at line 219 of file ROL_RieszVector.hpp.

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

◆ reduce()

template<class Real >

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

inline

Definition at line 224 of file ROL_RieszVector.hpp.

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

◆ setScalar()

template<class Real >

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

inline

Definition at line 228 of file ROL_RieszVector.hpp.

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

◆ randomize()

template<class Real >

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

inline

Definition at line 232 of file ROL_RieszVector.hpp.

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

◆ getVector() [1/2]

template<class Real >

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

inline

Definition at line 236 of file ROL_RieszVector.hpp.

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

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

◆ getVector() [2/2]

template<class Real >

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

inline

Definition at line 240 of file ROL_RieszVector.hpp.

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

Member Data Documentation

◆ v_

template<class Real >

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

private

Definition at line 171 of file ROL_RieszVector.hpp.

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

◆ primal_

template<class Real >

ROL::Ptr<PrimalVector> ROL::RieszDualVector< Real >::primal_

mutableprivate

Definition at line 172 of file ROL_RieszVector.hpp.

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

◆ op_

template<class Real >

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

private

Definition at line 173 of file ROL_RieszVector.hpp.

Referenced by ROL::RieszDualVector< Real >::clone(), and ROL::RieszDualVector< Real >::initialize_primal().

◆ tol_

template<class Real >

Real ROL::RieszDualVector< Real >::tol_

mutableprivate

Definition at line 174 of file ROL_RieszVector.hpp.

Referenced by ROL::RieszDualVector< Real >::clone(), and ROL::RieszDualVector< Real >::initialize_primal().

◆ isPrimalInitialized_

template<class Real >

bool ROL::RieszDualVector< Real >::isPrimalInitialized_

mutableprivate

Definition at line 176 of file ROL_RieszVector.hpp.

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

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

ROL_RieszVector.hpp