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

#include <ROL_ScaledStdVector.hpp>

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

Public Member Functions
	PrimalScaledStdVector (const Teuchos::RCP< std::vector< Element > > &std_vec, const Teuchos::RCP< std::vector< Element > > &scaling_vec)

void	set (const Vector< Real > &x)
	Set \(y \leftarrow x\) where \(y = \mathtt{*this}\). More...

void	plus (const Vector< Real > &x)
	Compute \(y \leftarrow y + x\), where \(y = \mathtt{*this}\). More...

void	axpy (const Real alpha, const Vector< Real > &x)
	Compute \(y \leftarrow \alpha x + y\) where \(y = \mathtt{*this}\). More...

void	scale (const Real alpha)
	Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\). More...

Real	dot (const Vector< Real > &x) const
	Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\). More...

Real	norm () const
	Returns \( \\| y \\| \) where \(y = \mathtt{*this}\). More...

Teuchos::RCP< Vector< Real > >	clone () const
	Clone to make a new (uninitialized) vector. More...

Teuchos::RCP< const std::vector< Element > >	getVector () const

Teuchos::RCP< std::vector< Element > >	getVector ()

const ROL::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. More...

Teuchos::RCP< Vector< Real > >	basis (const int i) const
	Return i-th basis vector. More...

int	dimension () const
	Return dimension of the vector space. More...

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

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

virtual void	zero ()
	Set to zero vector. More...

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. More...

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

Private Attributes
Teuchos::RCP< std::vector< Element > >	std_vec_

Teuchos::RCP< std::vector< Element > >	scaling_vec_

Teuchos::RCP< DualScaledStdVector< Real > >	dual_vec_

Detailed Description

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

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

Definition at line 65 of file ROL_ScaledStdVector.hpp.

Member Typedef Documentation

template<class Real, class Element>

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

private

Definition at line 73 of file ROL_ScaledStdVector.hpp.

Constructor & Destructor Documentation

template<class Real, class Element>

ROL::PrimalScaledStdVector< Real, Element >::PrimalScaledStdVector	(	const Teuchos::RCP< std::vector< Element > > &	std_vec,
		const Teuchos::RCP< std::vector< Element > > &	scaling_vec
	)

inline

Definition at line 83 of file ROL_ScaledStdVector.hpp.

Referenced by ROL::PrimalScaledStdVector< Real, Element >::basis(), and ROL::PrimalScaledStdVector< Real, Element >::clone().

Member Function Documentation

template<class Real, class Element>

void ROL::PrimalScaledStdVector< Real, Element >::set ( const Vector< Real > & x )

inlinevirtual

Set \(y \leftarrow x\) where \(y = \mathtt{*this}\).

Parameters

[in] x is a vector.

On return \(\mathtt{*this} = x\). Uses zero and plus methods for the computation. Please overload if a more efficient implementation is needed.

Reimplemented from ROL::Vector< Real >.

Definition at line 87 of file ROL_ScaledStdVector.hpp.

References ROL::PrimalScaledStdVector< Real, Element >::getVector().

template<class Real, class Element>

void ROL::PrimalScaledStdVector< Real, Element >::plus ( const Vector< Real > & x )

inlinevirtual

Compute \(y \leftarrow y + x\), where \(y = \mathtt{*this}\).

Parameters

[in] x is the vector to be added to \(\mathtt{*this}\).

On return \(\mathtt{*this} = \mathtt{*this} + x\).

Implements ROL::Vector< Real >.

Definition at line 93 of file ROL_ScaledStdVector.hpp.

References ROL::PrimalScaledStdVector< Real, Element >::dimension(), and ROL::PrimalScaledStdVector< Real, Element >::getVector().

template<class Real, class Element>

void ROL::PrimalScaledStdVector< Real, Element >::axpy	(	const Real	alpha,
		const Vector< Real > &	x
	)

inlinevirtual

Compute \(y \leftarrow \alpha x + y\) where \(y = \mathtt{*this}\).

Parameters

[in]	alpha	is the scaling of x.
[in]	x	is a vector.

On return \(\mathtt{*this} = \mathtt{*this} + \alpha x \). Uses clone, set, scale and plus for the computation. Please overload if a more efficient implementation is needed.

Reimplemented from ROL::Vector< Real >.

Definition at line 102 of file ROL_ScaledStdVector.hpp.

References ROL::PrimalScaledStdVector< Real, Element >::dimension(), and ROL::PrimalScaledStdVector< Real, Element >::getVector().

template<class Real, class Element>

void ROL::PrimalScaledStdVector< Real, Element >::scale ( const Real alpha )

inlinevirtual

Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\).

Parameters

[in] alpha is the scaling of \(\mathtt{*this}\).

On return \(\mathtt{*this} = \alpha (\mathtt{*this}) \).

Implements ROL::Vector< Real >.

Definition at line 111 of file ROL_ScaledStdVector.hpp.

References ROL::PrimalScaledStdVector< Real, Element >::dimension().

template<class Real, class Element>

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

inlinevirtual

Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\).

Parameters

[in] x is the vector that forms the dot product with \(\mathtt{*this}\).

Returns: The number equal to \(\langle \mathtt{*this}, x \rangle\).

Implements ROL::Vector< Real >.

Definition at line 118 of file ROL_ScaledStdVector.hpp.

References ROL::PrimalScaledStdVector< Real, Element >::dimension(), and ROL::PrimalScaledStdVector< Real, Element >::getVector().

Referenced by ROL::PrimalScaledStdVector< Real, Element >::norm(), and ROL::DualScaledStdVector< Real, Element >::norm().

template<class Real, class Element>

Real ROL::PrimalScaledStdVector< Real, Element >::norm ( ) const

inlinevirtual

Returns \( \| y \| \) where \(y = \mathtt{*this}\).

Returns: A nonnegative number equal to the norm of \(\mathtt{*this}\).

Implements ROL::Vector< Real >.

Definition at line 129 of file ROL_ScaledStdVector.hpp.

References ROL::PrimalScaledStdVector< Real, Element >::dot().

template<class Real, class Element>

Teuchos::RCP<Vector<Real> > ROL::PrimalScaledStdVector< Real, Element >::clone ( ) const

inlinevirtual

Clone to make a new (uninitialized) vector.

Returns: A reference-counted pointer to the cloned vector.

Provides the means of allocating temporary memory in ROL.

Implements ROL::Vector< Real >.

Definition at line 135 of file ROL_ScaledStdVector.hpp.

References ROL::PrimalScaledStdVector< Real, Element >::PrimalScaledStdVector(), and ROL::PrimalScaledStdVector< Real, Element >::scaling_vec_.

template<class Real, class Element>

Teuchos::RCP<const std::vector<Element> > ROL::PrimalScaledStdVector< Real, Element >::getVector ( ) const

inline

Definition at line 139 of file ROL_ScaledStdVector.hpp.

References ROL::PrimalScaledStdVector< Real, Element >::std_vec_.

Referenced by ROL::PrimalScaledStdVector< Real, Element >::applyBinary(), ROL::DualScaledStdVector< Real, Element >::applyBinary(), ROL::PrimalScaledStdVector< Real, Element >::axpy(), ROL::PrimalScaledStdVector< Real, Element >::dot(), ROL::PrimalScaledStdVector< Real, Element >::plus(), and ROL::PrimalScaledStdVector< Real, Element >::set().

template<class Real, class Element>

Teuchos::RCP<std::vector<Element> > ROL::PrimalScaledStdVector< Real, Element >::getVector ( )

inline

Definition at line 143 of file ROL_ScaledStdVector.hpp.

References ROL::PrimalScaledStdVector< Real, Element >::std_vec_.

template<class Real, class Element>

const ROL::Vector<Real>& ROL::PrimalScaledStdVector< 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::Vector< Real >.

Definition at line 147 of file ROL_ScaledStdVector.hpp.

References ROL::PrimalScaledStdVector< Real, Element >::dual_vec_.

template<class Real, class Element>

Teuchos::RCP<Vector<Real> > ROL::PrimalScaledStdVector< Real, Element >::basis ( const int i ) const

inlinevirtual

Return i-th basis vector.

Parameters

[in] i is the index of the basis function.

Returns: A reference-counted pointer to the basis vector with index i.

Overloading the basis is only required if the default gradient implementation is used, which computes a finite-difference approximation.

Reimplemented from ROL::Vector< Real >.

Definition at line 155 of file ROL_ScaledStdVector.hpp.

References ROL::PrimalScaledStdVector< Real, Element >::PrimalScaledStdVector().

template<class Real, class Element>

int ROL::PrimalScaledStdVector< Real, Element >::dimension ( ) const

inlinevirtual

Return dimension of the vector space.

Returns: The dimension of the vector space, i.e., the total number of basis vectors.

Overload if the basis is overloaded.

Reimplemented from ROL::Vector< Real >.

Definition at line 161 of file ROL_ScaledStdVector.hpp.

template<class Real, class Element>

void ROL::PrimalScaledStdVector< Real, Element >::applyUnary ( const Elementwise::UnaryFunction< Real > & f )

inlinevirtual

Reimplemented from ROL::Vector< Real >.

Definition at line 165 of file ROL_ScaledStdVector.hpp.

References ROL::PrimalScaledStdVector< Real, Element >::dimension().

template<class Real, class Element>

void ROL::PrimalScaledStdVector< Real, Element >::applyBinary	(	const Elementwise::BinaryFunction< Real > &	f,
		const Vector< Real > &	x
	)

inlinevirtual

Reimplemented from ROL::Vector< Real >.

Definition at line 173 of file ROL_ScaledStdVector.hpp.

References ROL::PrimalScaledStdVector< Real, Element >::dimension(), ROL::PrimalScaledStdVector< Real, Element >::getVector(), and ROL::DualScaledStdVector< Real, Element >::getVector().

template<class Real, class Element>

Real ROL::PrimalScaledStdVector< Real, Element >::reduce ( const Elementwise::ReductionOp< Real > & r ) const

inlinevirtual

Reimplemented from ROL::Vector< Real >.

Definition at line 190 of file ROL_ScaledStdVector.hpp.

References ROL::PrimalScaledStdVector< Real, Element >::dimension().

Member Data Documentation

template<class Real, class Element>

Teuchos::RCP<std::vector<Element> > ROL::PrimalScaledStdVector< Real, Element >::std_vec_

private

Definition at line 77 of file ROL_ScaledStdVector.hpp.

Referenced by ROL::PrimalScaledStdVector< Real, Element >::getVector(), and ROL::DualScaledStdVector< Real, Element >::getVector().

template<class Real, class Element>

Teuchos::RCP<std::vector<Element> > ROL::PrimalScaledStdVector< Real, Element >::scaling_vec_

private

Definition at line 78 of file ROL_ScaledStdVector.hpp.

Referenced by ROL::PrimalScaledStdVector< Real, Element >::clone(), and ROL::DualScaledStdVector< Real, Element >::clone().

template<class Real, class Element>

Teuchos::RCP<DualScaledStdVector<Real> > ROL::PrimalScaledStdVector< Real, Element >::dual_vec_

mutableprivate

Definition at line 79 of file ROL_ScaledStdVector.hpp.

Referenced by ROL::PrimalScaledStdVector< Real, Element >::dual(), and ROL::DualScaledStdVector< Real, Element >::dual().

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

ROL_ScaledStdVector.hpp

Public Member Functions

Private Types

Private Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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