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< RCPV > &vecs, const RCPBM &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 RCPV	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...

RCPV	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

Teuchos::RCP< const Vector< Real > >	get (size_type i) const

Teuchos::RCP< 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 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 Teuchos::RCP< V >	RCPV

typedef Teuchos::RCP< BatchManager< Real > >	RCPBM

typedef SimulatedVector< Real >	PV

Private Attributes
const std::vector< RCPV >	vecs_

Teuchos::RCP< BatchManager< Real > >	bman_

std::vector< RCPV >	dual_vecs_

Teuchos::RCP< 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 68 of file ROL_SimulatedVector.hpp.

Member Typedef Documentation

◆ V

template<class Real>

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

private

Definition at line 70 of file ROL_SimulatedVector.hpp.

◆ RCPV

template<class Real>

typedef Teuchos::RCP<V> ROL::SimulatedVector< Real >::RCPV

private

Definition at line 71 of file ROL_SimulatedVector.hpp.

◆ RCPBM

template<class Real>

typedef Teuchos::RCP<BatchManager<Real> > ROL::SimulatedVector< Real >::RCPBM

private

Definition at line 72 of file ROL_SimulatedVector.hpp.

◆ PV

template<class Real>

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

private

Definition at line 73 of file ROL_SimulatedVector.hpp.

◆ size_type

template<class Real>

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

Definition at line 82 of file ROL_SimulatedVector.hpp.

Constructor & Destructor Documentation

◆ SimulatedVector()

template<class Real>

ROL::SimulatedVector< Real >::SimulatedVector	(	const std::vector< RCPV > &	vecs,
		const RCPBM &	bman
	)

inline

Definition at line 84 of file ROL_SimulatedVector.hpp.

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

Member Function Documentation

◆ set() [1/2]

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 90 of file ROL_SimulatedVector.hpp.

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

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

◆ plus()

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 103 of file ROL_SimulatedVector.hpp.

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

◆ scale()

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 116 of file ROL_SimulatedVector.hpp.

◆ axpy()

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 122 of file ROL_SimulatedVector.hpp.

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

◆ dot()

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 135 of file ROL_SimulatedVector.hpp.

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

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

◆ 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 154 of file ROL_SimulatedVector.hpp.

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

◆ clone()

template<class Real>

virtual RCPV 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 158 of file ROL_SimulatedVector.hpp.

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

◆ dual()

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 169 of file ROL_SimulatedVector.hpp.

References ROL::SimulatedVector< Real >::dual_pvec_, and ROL::Vector< Real >::set().

Referenced by ROL::PrimalSimulatedVector< Real >::dual(), ROL::DualSimulatedVector< Real >::dual(), ROL::DualSimulatedVector< Real >::DualSimulatedVector(), ROL::PrimalSimulatedVector< Real >::PrimalSimulatedVector(), and ROL::SimulatedVector< Real >::SimulatedVector().

◆ basis()

template<class Real>

RCPV 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 179 of file ROL_SimulatedVector.hpp.

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

◆ dimension()

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 215 of file ROL_SimulatedVector.hpp.

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

◆ zero() [1/2]

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 223 of file ROL_SimulatedVector.hpp.

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

◆ applyUnary()

template<class Real>

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

inlinevirtual

Reimplemented from ROL::Vector< Real >.

Definition at line 230 of file ROL_SimulatedVector.hpp.

◆ applyBinary()

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 237 of file ROL_SimulatedVector.hpp.

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

◆ reduce()

template<class Real>

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

inlinevirtual

Reimplemented from ROL::Vector< Real >.

Definition at line 245 of file ROL_SimulatedVector.hpp.

◆ get() [1/2]

template<class Real>

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

inline

Definition at line 258 of file ROL_SimulatedVector.hpp.

Referenced by ROL::SimulatedEqualityConstraint< Real >::applyAdjointHessian(), ROL::SimulatedEqualityConstraint< Real >::applyAdjointJacobian(), ROL::SimulatedVector< Real >::applyBinary(), ROL::SimulatedEqualityConstraint< Real >::applyJacobian(), ROL::SimulatedEqualityConstraint< Real >::applyPreconditioner(), ROL::SimulatedVector< Real >::axpy(), ROL::SimulatedVector< Real >::dot(), ROL::PrimalSimulatedVector< Real >::dot(), ROL::DualSimulatedVector< Real >::dot(), ROL::SimulatedObjective< Real >::gradient(), ROL::SimulatedObjectiveCVaR< Real >::gradient(), ROL::SimulatedObjective< Real >::hessVec(), ROL::SimulatedVector< Real >::plus(), ROL::SimulatedVector< Real >::set(), ROL::SimulatedObjective< Real >::value(), ROL::SimulatedEqualityConstraint< Real >::value(), and ROL::SimulatedObjectiveCVaR< Real >::value().

◆ get() [2/2]

template<class Real>

Teuchos::RCP<Vector<Real> > ROL::SimulatedVector< Real >::get ( size_type i )

inline

Definition at line 262 of file ROL_SimulatedVector.hpp.

◆ set() [2/2]

template<class Real>

void ROL::SimulatedVector< Real >::set	(	size_type	i,
		const V &	x
	)

inline

Definition at line 266 of file ROL_SimulatedVector.hpp.

◆ zero() [2/2]

template<class Real>

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

inline

Definition at line 270 of file ROL_SimulatedVector.hpp.

◆ numVectors()

template<class Real>

size_type ROL::SimulatedVector< Real >::numVectors ( ) const

inline

Definition at line 274 of file ROL_SimulatedVector.hpp.

Referenced by ROL::SimulatedEqualityConstraint< Real >::applyAdjointHessian(), ROL::SimulatedEqualityConstraint< Real >::applyAdjointJacobian(), ROL::SimulatedEqualityConstraint< Real >::applyJacobian(), ROL::SimulatedEqualityConstraint< Real >::applyPreconditioner(), ROL::SimulatedVector< Real >::axpy(), ROL::SimulatedVector< Real >::dot(), ROL::PrimalSimulatedVector< Real >::dot(), ROL::DualSimulatedVector< Real >::dot(), ROL::SimulatedObjective< Real >::gradient(), ROL::SimulatedObjectiveCVaR< Real >::gradient(), ROL::SimulatedObjective< Real >::hessVec(), ROL::SimulatedVector< Real >::plus(), ROL::SimulatedVector< Real >::set(), ROL::SimulatedObjective< Real >::value(), ROL::SimulatedEqualityConstraint< Real >::value(), and ROL::SimulatedObjectiveCVaR< Real >::value().

Member Data Documentation

◆ vecs_

template<class Real>

const std::vector<RCPV> ROL::SimulatedVector< Real >::vecs_

private

Definition at line 76 of file ROL_SimulatedVector.hpp.

◆ bman_

template<class Real>

Teuchos::RCP<BatchManager<Real> > ROL::SimulatedVector< Real >::bman_

private

Definition at line 77 of file ROL_SimulatedVector.hpp.

◆ dual_vecs_

template<class Real>

std::vector<RCPV> ROL::SimulatedVector< Real >::dual_vecs_

mutableprivate

Definition at line 78 of file ROL_SimulatedVector.hpp.

◆ dual_pvec_

template<class Real>

Teuchos::RCP<PV> ROL::SimulatedVector< Real >::dual_pvec_

mutableprivate

Definition at line 79 of file ROL_SimulatedVector.hpp.

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

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

ROL_SimulatedVector.hpp

Public Types

Public Member Functions

Private Types

Private Attributes

Detailed Description

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

Member Typedef Documentation

◆ V

◆ RCPV

◆ RCPBM

◆ PV

◆ size_type

Constructor & Destructor Documentation

◆ SimulatedVector()

Member Function Documentation

◆ set() [1/2]

◆ plus()

◆ scale()

◆ axpy()

◆ dot()

◆ norm()

◆ clone()

◆ dual()

◆ basis()

◆ dimension()

◆ zero() [1/2]

◆ applyUnary()

◆ applyBinary()

◆ reduce()

◆ get() [1/2]

◆ get() [2/2]

◆ set() [2/2]

◆ zero() [2/2]

◆ numVectors()

Member Data Documentation

◆ vecs_

◆ bman_

◆ dual_vecs_

◆ dual_pvec_

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