ROL::PrimalScaledVector< Real > Class Template Reference

Provides the implementation of the ROL::Vector interface that handles scalings in the inner product. A more generic version of ROL::PrimalScaledStdVector. More...

#include <ROL_ScaledVector.hpp>

Inheritance diagram for ROL::PrimalScaledVector< Real >:

Public Member Functions
	PrimalScaledVector (const Ptr< V > &vec, const Ptr< V > &scaling_vec)
virtual	~PrimalScaledVector ()
virtual Real	dot (const V &x) const override
virtual Ptr< V >	clone () const override
virtual Ptr< V >	basis (const int i) const override
virtual void const V &	dual () const override
const Ptr< V > &	getScalingVector ()
const Ptr< const V > &	getScalingVector () const
void	setScalingVector (const Ptr< const V & > &scaling_vec) const
	WrappedVector (const Ptr< V > &vec)
virtual	~WrappedVector ()
virtual void	plus (const V &x) override
virtual void	scale (const Real alpha) override
virtual Real	dot (const V &x) const override
virtual Real	norm () const override
virtual Ptr< V >	clone () const override
virtual void	axpy (const Real alpha, const V &x) override
virtual Ptr< V >	basis (const int i) const override
virtual int	dimension () const override
virtual void	set (const V &x) override
virtual void const V &	dual () const override
virtual Real	apply (const V &x) const override
virtual void	applyUnary (const Elementwise::UnaryFunction< Real > &f) override
virtual void	applyBinary (const Elementwise::BinaryFunction< Real > &f, const V &x) override
virtual Real	reduce (const Elementwise::ReductionOp< Real > &r) const override
virtual void	setScalar (const Real C) override
virtual void	randomize (const Real l=0.0, const Real u=1.0) override
virtual void	print (std::ostream &os) override
const Ptr< V > &	getVector ()
const Ptr< const V > &	getVector () const
virtual void	setVector (const Ptr< const V > &vec) const

Protected Member Functions
VectorWorkspace< Real > &	getWorkspace () const
void	multiply_scaling (const Ptr< V > &y) const

Private Types
using	V = Vector< Real >
using	VPrim = PrimalScaledVector< Real >
using	VDual = DualScaledVector< Real >
using	V = Vector< Real >
using	VPrim = PrimalScaledVector< Real >
using	VDual = DualScaledVector< Real >

Private Attributes
Ptv< V >	scaling_vec_
VectorWorkspace< Real >	workspace_
Elementwise::Multiply< Real >	mult_
Ptr< V >	vec_

Detailed Description

template<typename Real>
class ROL::PrimalScaledVector< Real >

Provides the implementation of the ROL::Vector interface that handles scalings in the inner product. A more generic version of ROL::PrimalScaledStdVector.

Definition at line 34 of file ROL_ScaledVector.hpp.

Member Typedef Documentation

template<typename Real >

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

private

Definition at line 40 of file ROL_ScaledVector.hpp.

template<typename Real >

using ROL::PrimalScaledVector< Real >::VPrim = PrimalScaledVector<Real>

private

Definition at line 41 of file ROL_ScaledVector.hpp.

template<typename Real >

using ROL::PrimalScaledVector< Real >::VDual = DualScaledVector<Real>

private

Definition at line 42 of file ROL_ScaledVector.hpp.

template<typename Real >

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

private

Definition at line 34 of file ROL_WrappedVector.hpp.

template<typename Real >

using ROL::PrimalScaledVector< Real >::VPrim = PrimalScaledVector<Real>

private

Definition at line 35 of file ROL_WrappedVector.hpp.

template<typename Real >

using ROL::PrimalScaledVector< Real >::VDual = DualScaledVector<Real>

private

Definition at line 36 of file ROL_WrappedVector.hpp.

Constructor & Destructor Documentation

template<typename Real >

ROL::PrimalScaledVector< Real >::PrimalScaledVector ( const Ptr< V > &  vec, const Ptr< V > &  scaling_vec  )

inline

Definition at line 62 of file ROL_ScaledVector.hpp.

template<typename Real >

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

inlinevirtual

Definition at line 65 of file ROL_ScaledVector.hpp.

template<typename Real >

virtual ROL::PrimalScaledVector< Real >::~WrappedVector ( )

inlinevirtual

Definition at line 47 of file ROL_WrappedVector.hpp.

Member Function Documentation

template<typename Real >

VectorWorkspace<Real>& ROL::PrimalScaledVector< Real >::getWorkspace ( ) const

inlineprotected

Definition at line 53 of file ROL_ScaledVector.hpp.

References ROL::PrimalScaledVector< Real >::workspace_.

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

template<typename Real >

void ROL::PrimalScaledVector< Real >::multiply_scaling ( const Ptr< V > &  y ) const

inlineprotected

Definition at line 56 of file ROL_ScaledVector.hpp.

References ROL::PrimalScaledVector< Real >::mult_, and ROL::PrimalScaledVector< Real >::scaling_vec_.

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

template<typename Real >

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

inlineoverridevirtual

Reimplemented in ROL::InactiveSet_PrimalVector< Real >.

Definition at line 67 of file ROL_ScaledVector.hpp.

References ROL::PrimalScaledVector< Real >::getVector(), ROL::PrimalScaledVector< Real >::multiply_scaling(), and ROL::PrimalScaledVector< Real >::workspace_.

Referenced by ROL::PrimalScaledVector< Real >::norm().

template<typename Real >

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

inlineoverridevirtual

Reimplemented in ROL::InactiveSet_PrimalVector< Real >.

Definition at line 73 of file ROL_ScaledVector.hpp.

References ROL::PrimalScaledVector< Real >::getVector(), and ROL::PrimalScaledVector< Real >::scaling_vec_.

template<typename Real >

virtual Ptr<V> ROL::PrimalScaledVector< Real >::basis ( const int  i ) const

inlineoverridevirtual

Reimplemented in ROL::InactiveSet_PrimalVector< Real >.

Definition at line 77 of file ROL_ScaledVector.hpp.

References ROL::PrimalScaledVector< Real >::getVector(), and ROL::PrimalScaledVector< Real >::scaling_vec_.

template<typename Real >

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

inlineoverridevirtual

Reimplemented in ROL::InactiveSet_PrimalVector< Real >.

Definition at line 81 of file ROL_ScaledVector.hpp.

References ROL::PrimalScaledVector< Real >::getVector(), ROL::PrimalScaledVector< Real >::multiply_scaling(), and ROL::PrimalScaledVector< Real >::workspace_.

template<typename Real >

const Ptr<V>& ROL::PrimalScaledVector< Real >::getScalingVector ( )

inline

Definition at line 87 of file ROL_ScaledVector.hpp.

References ROL::PrimalScaledVector< Real >::scaling_vec_.

Referenced by ROL::InactiveSet_PrimalVector< Real >::basis(), ROL::InactiveSet_PrimalVector< Real >::clone(), and ROL::InactiveSet_PrimalVector< Real >::dual().

template<typename Real >

const Ptr<const V>& ROL::PrimalScaledVector< Real >::getScalingVector ( ) const

inline

Definition at line 88 of file ROL_ScaledVector.hpp.

References ROL::PrimalScaledVector< Real >::scaling_vec_.

template<typename Real >

void ROL::PrimalScaledVector< Real >::setScalingVector ( const Ptr< const V & > &  scaling_vec ) const

inline

Definition at line 90 of file ROL_ScaledVector.hpp.

References ROL::PrimalScaledVector< Real >::scaling_vec_.

template<typename Real >

ROL::PrimalScaledVector< Real >::WrappedVector ( const Ptr< V > &  vec )

inline

Definition at line 45 of file ROL_WrappedVector.hpp.

template<typename Real >

virtual void ROL::PrimalScaledVector< Real >::plus ( const V &  x )

inlineoverridevirtual

Definition at line 49 of file ROL_WrappedVector.hpp.

References ROL::PrimalScaledVector< Real >::vec_.

template<typename Real >

virtual void ROL::PrimalScaledVector< Real >::scale ( const Real  alpha )

inlineoverridevirtual

Definition at line 50 of file ROL_WrappedVector.hpp.

References ROL::PrimalScaledVector< Real >::vec_.

template<typename Real >

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

inlineoverridevirtual

Reimplemented in ROL::InactiveSet_PrimalVector< Real >.

Definition at line 52 of file ROL_WrappedVector.hpp.

References ROL::PrimalScaledVector< Real >::vec_.

template<typename Real >

virtual Real ROL::PrimalScaledVector< Real >::norm ( void  ) const

inlineoverridevirtual

Definition at line 54 of file ROL_WrappedVector.hpp.

References ROL::PrimalScaledVector< Real >::dot().

template<typename Real >

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

inlineoverridevirtual

Reimplemented in ROL::InactiveSet_PrimalVector< Real >.

Definition at line 56 of file ROL_WrappedVector.hpp.

References ROL::PrimalScaledVector< Real >::vec_.

template<typename Real >

virtual void ROL::PrimalScaledVector< Real >::axpy ( const Real  alpha, const V &  x  )

inlineoverridevirtual

Definition at line 60 of file ROL_WrappedVector.hpp.

References ROL::PrimalScaledVector< Real >::vec_.

template<typename Real >

virtual Ptr<V> ROL::PrimalScaledVector< Real >::basis ( const int  i ) const

inlineoverridevirtual

Reimplemented in ROL::InactiveSet_PrimalVector< Real >.

Definition at line 64 of file ROL_WrappedVector.hpp.

References ROL::PrimalScaledVector< Real >::vec_.

template<typename Real >

virtual int ROL::PrimalScaledVector< Real >::dimension ( void  ) const

inlineoverridevirtual

Definition at line 68 of file ROL_WrappedVector.hpp.

References ROL::PrimalScaledVector< Real >::vec_.

template<typename Real >

virtual void ROL::PrimalScaledVector< Real >::set ( const V &  x )

inlineoverridevirtual

Definition at line 70 of file ROL_WrappedVector.hpp.

References ROL::PrimalScaledVector< Real >::vec_.

template<typename Real >

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

inlineoverridevirtual

Reimplemented in ROL::InactiveSet_PrimalVector< Real >.

Definition at line 72 of file ROL_WrappedVector.hpp.

References ROL::PrimalScaledVector< Real >::vec_.

template<typename Real >

virtual Real ROL::PrimalScaledVector< Real >::apply ( const V &  x ) const

inlineoverridevirtual

Definition at line 74 of file ROL_WrappedVector.hpp.

References ROL::PrimalScaledVector< Real >::vec_.

template<typename Real >

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

inlineoverridevirtual

Definition at line 76 of file ROL_WrappedVector.hpp.

References ROL::PrimalScaledVector< Real >::vec_.

template<typename Real >

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

inlineoverridevirtual

Definition at line 80 of file ROL_WrappedVector.hpp.

References ROL::PrimalScaledVector< Real >::vec_.

template<typename Real >

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

inlineoverridevirtual

Definition at line 85 of file ROL_WrappedVector.hpp.

References ROL::PrimalScaledVector< Real >::vec_.

template<typename Real >

virtual void ROL::PrimalScaledVector< Real >::setScalar ( const Real  C )

inlineoverridevirtual

Definition at line 89 of file ROL_WrappedVector.hpp.

References ROL::PrimalScaledVector< Real >::vec_.

template<typename Real >

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

inlineoverridevirtual

Definition at line 91 of file ROL_WrappedVector.hpp.

References ROL::PrimalScaledVector< Real >::vec_.

template<typename Real >

virtual void ROL::PrimalScaledVector< Real >::print ( std::ostream &  os )

inlineoverridevirtual

Definition at line 95 of file ROL_WrappedVector.hpp.

References ROL::PrimalScaledVector< Real >::vec_.

template<typename Real >

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

inline

Definition at line 97 of file ROL_WrappedVector.hpp.

References ROL::PrimalScaledVector< Real >::vec_.

Referenced by ROL::InactiveSet_PrimalVector< Real >::basis(), ROL::PrimalScaledVector< Real >::basis(), ROL::InactiveSet_PrimalVector< Real >::clone(), ROL::PrimalScaledVector< Real >::clone(), ROL::InactiveSet_PrimalVector< Real >::dot(), ROL::PrimalScaledVector< Real >::dot(), ROL::PrimalScaledVector< Real >::dual(), and ROL::InactiveSet_PrimalVector< Real >::dual().

template<typename Real >

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

inline

Definition at line 98 of file ROL_WrappedVector.hpp.

References ROL::PrimalScaledVector< Real >::vec_.

template<typename Real >

virtual void ROL::PrimalScaledVector< Real >::setVector ( const Ptr< const V > &  vec ) const

inlinevirtual

Definition at line 100 of file ROL_WrappedVector.hpp.

References ROL::PrimalScaledVector< Real >::vec_.

Member Data Documentation

template<typename Real >

Ptv<V> ROL::PrimalScaledVector< Real >::scaling_vec_

mutableprivate

Definition at line 46 of file ROL_ScaledVector.hpp.

Referenced by ROL::PrimalScaledVector< Real >::basis(), ROL::PrimalScaledVector< Real >::clone(), ROL::PrimalScaledVector< Real >::getScalingVector(), ROL::PrimalScaledVector< Real >::multiply_scaling(), and ROL::PrimalScaledVector< Real >::setScalingVector().

template<typename Real >

VectorWorkspace<Real> ROL::PrimalScaledVector< Real >::workspace_

mutableprivate

Definition at line 47 of file ROL_ScaledVector.hpp.

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

template<typename Real >

Elementwise::Multiply<Real> ROL::PrimalScaledVector< Real >::mult_

private

Definition at line 49 of file ROL_ScaledVector.hpp.

Referenced by ROL::PrimalScaledVector< Real >::multiply_scaling().

template<typename Real >

Ptr<V> ROL::PrimalScaledVector< Real >::vec_

mutableprivate

Definition at line 40 of file ROL_WrappedVector.hpp.

Referenced by ROL::PrimalScaledVector< Real >::apply(), ROL::PrimalScaledVector< Real >::applyBinary(), ROL::PrimalScaledVector< Real >::applyUnary(), ROL::PrimalScaledVector< Real >::axpy(), ROL::PrimalScaledVector< Real >::basis(), ROL::PrimalScaledVector< Real >::clone(), ROL::PrimalScaledVector< Real >::dimension(), ROL::PrimalScaledVector< Real >::dot(), ROL::PrimalScaledVector< Real >::dual(), ROL::PrimalScaledVector< Real >::getVector(), ROL::PrimalScaledVector< Real >::plus(), ROL::PrimalScaledVector< Real >::print(), ROL::PrimalScaledVector< Real >::randomize(), ROL::PrimalScaledVector< Real >::reduce(), ROL::PrimalScaledVector< Real >::scale(), ROL::PrimalScaledVector< Real >::set(), ROL::PrimalScaledVector< Real >::setScalar(), and ROL::PrimalScaledVector< Real >::setVector().

---

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

• ROL_ScaledVector.hpp
• ROL_WrappedVector.hpp