Provides the std::vector implementation of the ROL::Vector interface. More...

#include <ROL_StdVector.hpp>

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

Public Member Functions
	StdVector (const Teuchos::RCP< std::vector< Element > > &std_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 ()

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 const Vector &	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...

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< Real >::size_type	uint

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

Detailed Description

template<class Real, class Element = Real>
class ROL::StdVector< Real, Element >

Provides the std::vector implementation of the ROL::Vector interface.

Definition at line 60 of file ROL_StdVector.hpp.

Member Typedef Documentation

template<class Real, class Element = Real>

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

private

Definition at line 62 of file ROL_StdVector.hpp.

Constructor & Destructor Documentation

template<class Real, class Element = Real>

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

inline

Definition at line 70 of file ROL_StdVector.hpp.

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

Member Function Documentation

template<class Real, class Element = Real>

void ROL::StdVector< 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 72 of file ROL_StdVector.hpp.

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

Referenced by main().

template<class Real, class Element = Real>

void ROL::StdVector< 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 78 of file ROL_StdVector.hpp.

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

template<class Real, class Element = Real>

void ROL::StdVector< 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 87 of file ROL_StdVector.hpp.

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

Referenced by main(), and ROL::ZOO::Objective_PoissonInversion< Real >::solve_adjoint_sensitivity_equation().

template<class Real, class Element = Real>

void ROL::StdVector< 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 96 of file ROL_StdVector.hpp.

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

Referenced by main().

template<class Real, class Element = Real>

Real ROL::StdVector< 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 103 of file ROL_StdVector.hpp.

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

Referenced by ROL::StdVector< Real, Element >::norm().

template<class Real, class Element = Real>

Real ROL::StdVector< 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 114 of file ROL_StdVector.hpp.

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

Referenced by main().

template<class Real, class Element = Real>

Teuchos::RCP<Vector<Real> > ROL::StdVector< 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 120 of file ROL_StdVector.hpp.

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

Referenced by main(), and ROL::ZOO::Objective_PoissonInversion< Real >::value().

template<class Real, class Element = Real>

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

inline

Definition at line 124 of file ROL_StdVector.hpp.

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

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

template<class Real, class Element = Real>

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

inline

Definition at line 128 of file ROL_StdVector.hpp.

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

template<class Real, class Element = Real>

Teuchos::RCP<Vector<Real> > ROL::StdVector< 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 132 of file ROL_StdVector.hpp.

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

Referenced by main().

template<class Real, class Element = Real>

int ROL::StdVector< 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 138 of file ROL_StdVector.hpp.

Referenced by ROL::StdVector< Real, Element >::applyBinary(), ROL::StdVector< Real, Element >::applyUnary(), ROL::StdVector< Real, Element >::axpy(), ROL::StdVector< Real, Element >::dot(), main(), ROL::StdVector< Real, Element >::plus(), ROL::StdVector< Real, Element >::reduce(), and ROL::StdVector< Real, Element >::scale().

template<class Real, class Element = Real>

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

inlinevirtual

Reimplemented from ROL::Vector< Real >.

Definition at line 142 of file ROL_StdVector.hpp.

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

template<class Real, class Element = Real>

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

inlinevirtual

Reimplemented from ROL::Vector< Real >.

Definition at line 150 of file ROL_StdVector.hpp.

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

template<class Real, class Element = Real>

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

inlinevirtual

Reimplemented from ROL::Vector< Real >.

Definition at line 160 of file ROL_StdVector.hpp.

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

Member Data Documentation

template<class Real, class Element = Real>

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

private

Definition at line 66 of file ROL_StdVector.hpp.

Referenced by ROL::StdVector< Real, Element >::getVector().

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

ROL_StdVector.hpp

Public Member Functions

Private Types

Private Attributes

Detailed Description

template<class Real, class Element = Real> class ROL::StdVector< Real, Element >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class Real, class Element = Real>
class ROL::StdVector< Real, Element >