Provides the std::vector implementation of the ROL::Vector interface that handles scalings in the inner product. Also see ROL::PrimalScaledStdVector. More...

#include <ROL_ScaledStdVector.hpp>

Inheritance diagram for ROL::DualScaledStdVector< Real, Element >:

Public Member Functions
	DualScaledStdVector (const Ptr< std::vector< Element > > &std_vec, const Ptr< std::vector< Element > > &scaling_vec)
Real	dot (const Vector< Real > &x) const
Ptr< Vector< Real > >	clone () const
	Clone to make a new (uninitialized) vector.
const Vector< Real > &	dual () const
	Return dual representation of \(\mathtt{*this}\), for example, the result of applying a Riesz map, or change of basis, or change of memory layout.
Real	apply (const Vector< Real > &x) const
Public Member Functions inherited from ROL::StdVector< Real, Element >
	StdVector (const Ptr< std::vector< Element > > &std_vec)
	StdVector (const int dim, const Element val=0.0)
	StdVector (std::initializer_list< Element > ilist)
Real &	operator[] (int i)
const Real &	operator[] (int i) const
void	set (const Vector< Real > &x)
void	plus (const Vector< Real > &x)
void	axpy (const Real alpha, const Vector< Real > &x)
void	scale (const Real alpha)
	Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\).
Real	norm () const
	Returns \( \\| y \\| \) where \(y = \mathtt{*this}\).
Ptr< const std::vector< Element > >	getVector () const
Ptr< std::vector< Element > >	getVector ()
Ptr< Vector< Real > >	basis (const int i) const
	Return i-th basis vector.
int	dimension () const
	Return dimension of the vector space.
void	applyUnary (const Elementwise::UnaryFunction< Real > &f)
void	applyBinary (const Elementwise::BinaryFunction< Real > &f, const Vector< Real > &x)
Real	reduce (const Elementwise::ReductionOp< Real > &r) const
void	setScalar (const Real C)
	Set \(y \leftarrow C\) where \(C\in\mathbb{R}\).
void	randomize (const Real l=0.0, const Real u=1.0)
	Set vector to be uniform random between [l,u].
virtual void	print (std::ostream &outStream) const
Public Member Functions inherited from ROL::ROL::Vector< Real >
virtual	~Vector ()
virtual void	plus (const Vector &x)=0
	Compute \(y \leftarrow y + x\), where \(y = \mathtt{*this}\).
virtual Real	dot (const Vector &x) const =0
	Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\).
virtual void	axpy (const Real alpha, const Vector &x)
	Compute \(y \leftarrow \alpha x + y\) where \(y = \mathtt{*this}\).
virtual void	zero ()
	Set to zero vector.
virtual void	set (const Vector &x)
	Set \(y \leftarrow x\) where \(y = \mathtt{*this}\).
virtual Real	apply (const Vector< Real > &x) const
	Apply \(\mathtt{*this}\) to a dual vector. This is equivalent to the call \(\mathtt{this->dot(x.dual())}\).
virtual void	applyBinary (const Elementwise::BinaryFunction< Real > &f, const Vector &x)
virtual std::vector< Real >	checkVector (const Vector< Real > &x, const Vector< Real > &y, const bool printToStream=true, std::ostream &outStream=std::cout) const
	Verify vector-space methods.

Private Types
typedef std::vector< Element >::size_type	uint

Private Attributes
Ptr< std::vector< Element > >	scaling_vec_
Ptr< PrimalScaledStdVector< Real > >	primal_vec_
bool	isDualInitialized_

Detailed Description

template<class Real, class Element>
class ROL::DualScaledStdVector< Real, Element >

Provides the std::vector implementation of the ROL::Vector interface that handles scalings in the inner product. Also see ROL::PrimalScaledStdVector.

Definition at line 102 of file ROL_ScaledStdVector.hpp.

Member Typedef Documentation

◆ uint

template<class Real, class Element>

typedef std::vector<Element>::size_type ROL::DualScaledStdVector< Real, Element >::uint

private

Definition at line 104 of file ROL_ScaledStdVector.hpp.

Constructor & Destructor Documentation

◆ DualScaledStdVector()

template<class Real, class Element>

ROL::DualScaledStdVector< Real, Element >::DualScaledStdVector	(	const Ptr< std::vector< Element > > &	std_vec,
		const Ptr< std::vector< Element > > &	scaling_vec )

inline

Definition at line 114 of file ROL_ScaledStdVector.hpp.

Member Function Documentation

◆ dot()

template<class Real, class Element>

Real ROL::DualScaledStdVector< Real, Element >::dot ( const Vector< Real > & x ) const

inlinevirtual

Reimplemented from ROL::StdVector< Real, Element >.

Definition at line 119 of file ROL_ScaledStdVector.hpp.

Referenced by main().

◆ clone()

template<class Real, class Element>

Ptr< Vector< Real > > ROL::DualScaledStdVector< Real, Element >::clone ( ) const

inlinevirtual

Clone to make a new (uninitialized) vector.

  @return         A reference-counted pointer to the cloned vector.

  Provides the means of allocating temporary memory in ROL.

  ---

Reimplemented from ROL::StdVector< Real, Element >.

Definition at line 131 of file ROL_ScaledStdVector.hpp.

Referenced by main().

◆ dual()

template<class Real, class Element>

const Vector< Real > & ROL::DualScaledStdVector< Real, Element >::dual ( void ) const

inlinevirtual

Return dual representation of \(\mathtt{*this}\), for example, the result of applying a Riesz map, or change of basis, or change of memory layout.

Returns: A const reference to dual representation.

By default, returns the current object. Please overload if you need a dual representation.

Reimplemented from ROL::ROL::Vector< Real >.

Definition at line 137 of file ROL_ScaledStdVector.hpp.

Referenced by main().

◆ apply()

template<class Real, class Element>

Real ROL::DualScaledStdVector< Real, Element >::apply ( const Vector< Real > & x ) const

inline

Definition at line 152 of file ROL_ScaledStdVector.hpp.

Referenced by main().

Member Data Documentation

◆ scaling_vec_

template<class Real, class Element>

Ptr<std::vector<Element> > ROL::DualScaledStdVector< Real, Element >::scaling_vec_

private

Definition at line 108 of file ROL_ScaledStdVector.hpp.

◆ primal_vec_

template<class Real, class Element>

Ptr<PrimalScaledStdVector<Real> > ROL::DualScaledStdVector< Real, Element >::primal_vec_

mutableprivate

Definition at line 109 of file ROL_ScaledStdVector.hpp.

◆ isDualInitialized_

template<class Real, class Element>

bool ROL::DualScaledStdVector< Real, Element >::isDualInitialized_

mutableprivate

Definition at line 110 of file ROL_ScaledStdVector.hpp.

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

ROL_ScaledStdVector.hpp

Public Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ uint

Constructor & Destructor Documentation

◆ DualScaledStdVector()

Member Function Documentation

◆ dot()

◆ clone()

◆ dual()

◆ apply()

Member Data Documentation

◆ scaling_vec_

◆ primal_vec_

◆ isDualInitialized_