Defines the linear algebra of a vector space on a generic partitioned vector where the individual vectors are distributed in batches defined by ROL::BatchManager. This is a batch-distributed version of ROL::PartitionedVector. More...

#include <ROL_SimulatedVector.hpp>

Inheritance diagram for ROL::SimulatedVector< Real >:

Public Types
typedef std::vector< PV > ::size_type	size_type

Public Member Functions
	SimulatedVector (const std::vector< Vp > &vecs, const VBMp &bman)

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

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

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

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

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

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

virtual Vp	clone () const
	Clone to make a new (uninitialized) vector. More...

virtual const V &	dual (void) 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...

Vp	basis (const int i) const
	Return i-th basis vector. More...

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

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

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)
	Set \(y \leftarrow C\) where \(C\in\mathbb{R}\). More...

void	randomize (const Real l=0.0, const Real u=1.0)
	Set vector to be uniform random between [l,u]. More...

ROL::Ptr< const Vector< Real > >	get (size_type i) const

ROL::Ptr< Vector< Real > >	get (size_type i)

void	set (size_type i, const V &x)

void	zero (size_type i)

size_type	numVectors () const

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

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())}\). More...

virtual void	print (std::ostream &outStream) const

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 Vector< Real >	V

typedef ROL::Ptr< V >	Vp

typedef ROL::Ptr< BatchManager < Real > >	VBMp

typedef SimulatedVector< Real >	PV

Private Attributes
const std::vector< Vp >	vecs_

ROL::Ptr< BatchManager< Real > >	bman_

std::vector< Vp >	dual_vecs_

ROL::Ptr< PV >	dual_pvec_

Detailed Description

template<class Real>
class ROL::SimulatedVector< Real >

Defines the linear algebra of a vector space on a generic partitioned vector where the individual vectors are distributed in batches defined by ROL::BatchManager. This is a batch-distributed version of ROL::PartitionedVector.

Definition at line 34 of file ROL_SimulatedVector.hpp.

Member Typedef Documentation

template<class Real>

typedef Vector<Real> ROL::SimulatedVector< Real >::V

private

Definition at line 36 of file ROL_SimulatedVector.hpp.

template<class Real>

typedef ROL::Ptr<V> ROL::SimulatedVector< Real >::Vp

private

Definition at line 37 of file ROL_SimulatedVector.hpp.

template<class Real>

typedef ROL::Ptr<BatchManager<Real> > ROL::SimulatedVector< Real >::VBMp

private

Definition at line 38 of file ROL_SimulatedVector.hpp.

template<class Real>

typedef SimulatedVector<Real> ROL::SimulatedVector< Real >::PV

private

Definition at line 39 of file ROL_SimulatedVector.hpp.

template<class Real>

typedef std::vector<PV>::size_type ROL::SimulatedVector< Real >::size_type

Definition at line 48 of file ROL_SimulatedVector.hpp.

Constructor & Destructor Documentation

template<class Real>

ROL::SimulatedVector< Real >::SimulatedVector	(	const std::vector< Vp > &	vecs,
		const VBMp &	bman
	)

inline

Definition at line 50 of file ROL_SimulatedVector.hpp.

References ROL::SimulatedVector< Real >::clone(), ROL::SimulatedVector< Real >::dual(), ROL::SimulatedVector< Real >::dual_vecs_, and ROL::SimulatedVector< Real >::vecs_.

Member Function Documentation

template<class Real>

void ROL::SimulatedVector< Real >::set ( const V & 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 56 of file ROL_SimulatedVector.hpp.

References ROL::SimulatedVector< Real >::get(), ROL::SimulatedVector< Real >::numVectors(), and ROL::SimulatedVector< Real >::vecs_.

Referenced by ROL::SimulatedVector< Real >::basis().

template<class Real>

void ROL::SimulatedVector< Real >::plus ( const V & 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 69 of file ROL_SimulatedVector.hpp.

References ROL::SimulatedVector< Real >::get(), ROL::SimulatedVector< Real >::numVectors(), and ROL::SimulatedVector< Real >::vecs_.

template<class Real>

void ROL::SimulatedVector< Real >::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 82 of file ROL_SimulatedVector.hpp.

References ROL::SimulatedVector< Real >::vecs_.

template<class Real>

void ROL::SimulatedVector< Real >::axpy	(	const Real	alpha,
		const V &	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 88 of file ROL_SimulatedVector.hpp.

References ROL::SimulatedVector< Real >::get(), ROL::SimulatedVector< Real >::numVectors(), and ROL::SimulatedVector< Real >::vecs_.

template<class Real>

virtual Real ROL::SimulatedVector< Real >::dot ( const V & 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 >.

Reimplemented in ROL::DualSimulatedVector< Real >, and ROL::PrimalSimulatedVector< Real >.

Definition at line 101 of file ROL_SimulatedVector.hpp.

References ROL::SimulatedVector< Real >::bman_, ROL::SimulatedVector< Real >::get(), ROL::SimulatedVector< Real >::numVectors(), and ROL::SimulatedVector< Real >::vecs_.

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

template<class Real>

Real ROL::SimulatedVector< Real >::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 120 of file ROL_SimulatedVector.hpp.

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

template<class Real>

virtual Vp ROL::SimulatedVector< Real >::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 >.

Reimplemented in ROL::DualSimulatedVector< Real >, and ROL::PrimalSimulatedVector< Real >.

Definition at line 124 of file ROL_SimulatedVector.hpp.

References ROL::SimulatedVector< Real >::bman_, and ROL::SimulatedVector< Real >::vecs_.

Referenced by ROL::SimulatedVector< Real >::basis(), and ROL::SimulatedVector< Real >::SimulatedVector().

template<class Real>

virtual const V& ROL::SimulatedVector< Real >::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 >.

Reimplemented in ROL::DualSimulatedVector< Real >, and ROL::PrimalSimulatedVector< Real >.

Definition at line 135 of file ROL_SimulatedVector.hpp.

References ROL::SimulatedVector< Real >::bman_, ROL::SimulatedVector< Real >::dual_pvec_, ROL::SimulatedVector< Real >::dual_vecs_, and ROL::SimulatedVector< Real >::vecs_.

Referenced by ROL::SimulatedVector< Real >::SimulatedVector().

template<class Real>

Vp ROL::SimulatedVector< Real >::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 145 of file ROL_SimulatedVector.hpp.

References ROL::SimulatedVector< Real >::clone(), ROL::SimulatedVector< Real >::dimension(), ROL::SimulatedVector< Real >::set(), ROL::SimulatedVector< Real >::vecs_, and ROL::SimulatedVector< Real >::zero().

template<class Real>

int ROL::SimulatedVector< Real >::dimension ( void ) 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 176 of file ROL_SimulatedVector.hpp.

References ROL::SimulatedVector< Real >::vecs_.

Referenced by ROL::SimulatedVector< Real >::basis().

template<class Real>

void ROL::SimulatedVector< Real >::zero ( )

inlinevirtual

Set to zero vector.

Uses scale by zero for the computation. Please overload if a more efficient implementation is needed.

Reimplemented from ROL::Vector< Real >.

Definition at line 184 of file ROL_SimulatedVector.hpp.

References ROL::SimulatedVector< Real >::vecs_.

Referenced by ROL::SimulatedVector< Real >::basis().

template<class Real>

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

inlinevirtual

Reimplemented from ROL::Vector< Real >.

Definition at line 191 of file ROL_SimulatedVector.hpp.

References ROL::SimulatedVector< Real >::vecs_.

template<class Real>

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

inlinevirtual

Reimplemented from ROL::Vector< Real >.

Definition at line 198 of file ROL_SimulatedVector.hpp.

References ROL::SimulatedVector< Real >::get(), and ROL::SimulatedVector< Real >::vecs_.

template<class Real>

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

inlinevirtual

Reimplemented from ROL::Vector< Real >.

Definition at line 206 of file ROL_SimulatedVector.hpp.

References ROL::SimulatedVector< Real >::vecs_.

template<class Real>

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

inlinevirtual

Set \(y \leftarrow C\) where \(C\in\mathbb{R}\).

Parameters

[in] C is a scalar.

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

Reimplemented from ROL::Vector< Real >.

Definition at line 215 of file ROL_SimulatedVector.hpp.

References ROL::SimulatedVector< Real >::vecs_.

template<class Real>

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

inlinevirtual

Set vector to be uniform random between [l,u].

Parameters

[in]	l	is a the lower bound.
[in]	u	is a the upper bound.

On return the components of \(\mathtt{*this}\) are uniform random numbers on the interval \([l,u]\). The default implementation uses applyUnary methods for the computation. Please overload if a more efficient implementation is needed.

Reimplemented from ROL::Vector< Real >.

Definition at line 221 of file ROL_SimulatedVector.hpp.

References ROL::SimulatedVector< Real >::vecs_.

template<class Real>

ROL::Ptr<const Vector<Real> > ROL::SimulatedVector< Real >::get ( size_type i ) const