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)
void	plus (const V &x)
void	scale (const Real alpha)
	Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\).
void	axpy (const Real alpha, const V &x)
virtual Real	dot (const V &x) const
Real	norm () const
	Returns \( \\| y \\| \) where \(y = \mathtt{*this}\).
virtual Vp	clone () const
	Clone to make a new (uninitialized) vector.
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.
Vp	basis (const int i) const
	Return i-th basis vector.
int	dimension () const
	Return dimension of the vector space.
void	zero ()
	Set to zero vector.
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}\).
void	randomize (const Real l=0.0, const Real u=1.0)
	Set vector to be uniform random between [l,u].
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::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	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 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.

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

◆ V

template<class Real>

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

private

Definition at line 36 of file ROL_SimulatedVector.hpp.

◆ Vp

template<class Real>

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

private

Definition at line 37 of file ROL_SimulatedVector.hpp.

◆ VBMp

template<class Real>

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

private

Definition at line 38 of file ROL_SimulatedVector.hpp.

◆ PV

template<class Real>

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

private

Definition at line 39 of file ROL_SimulatedVector.hpp.

◆ size_type

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

◆ SimulatedVector()

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 bman_, clone(), dual(), dual_vecs_, and vecs_.

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

Member Function Documentation

◆ set() [1/2]

template<class Real>

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

inline

Definition at line 56 of file ROL_SimulatedVector.hpp.

References get(), numVectors(), and vecs_.

Referenced by basis().

◆ plus()

template<class Real>

void ROL::SimulatedVector< Real >::plus ( const V & x )

inline

Definition at line 69 of file ROL_SimulatedVector.hpp.

References get(), numVectors(), and vecs_.

◆ scale()

template<class Real>

void ROL::SimulatedVector< Real >::scale ( const Real alpha )

inlinevirtual

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

  @param[in]      alpha is the scaling of \f$\mathtt{*this}\f$.

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

  ---

Implements ROL::ROL::Vector< Real >.

Definition at line 82 of file ROL_SimulatedVector.hpp.

References vecs_.

◆ axpy()

template<class Real>

void ROL::SimulatedVector< Real >::axpy	(	const Real	alpha,
		const V &	x )

inline

Definition at line 88 of file ROL_SimulatedVector.hpp.

References get(), numVectors(), and vecs_.

◆ dot()

template<class Real>

virtual Real ROL::SimulatedVector< Real >::dot ( const V & x ) const

inlinevirtual

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

Definition at line 101 of file ROL_SimulatedVector.hpp.

References bman_, get(), numVectors(), and vecs_.

Referenced by norm().

◆ norm()

template<class Real>

Real ROL::SimulatedVector< Real >::norm ( ) const

inlinevirtual

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

  @return         A nonnegative number equal to the norm of \f$\mathtt{*this}\f$.

  ---

Implements ROL::ROL::Vector< Real >.

Definition at line 120 of file ROL_SimulatedVector.hpp.

References dot().

◆ clone()

template<class Real>

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

  ---

Implements ROL::ROL::Vector< Real >.

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

Definition at line 124 of file ROL_SimulatedVector.hpp.

References bman_, clone(), and vecs_.

Referenced by basis(), clone(), and 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::ROL::Vector< Real >.

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

Definition at line 135 of file ROL_SimulatedVector.hpp.

References bman_, dual(), dual_pvec_, dual_vecs_, and vecs_.

Referenced by dual(), and SimulatedVector().

◆ basis()

template<class Real>

Vp ROL::SimulatedVector< Real >::basis ( const int i ) const

inlinevirtual

Return i-th basis vector.

  @param[in] i is the index of the basis function.
  @return A reference-counted pointer to the basis vector with index @b i.

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

  ---

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

Definition at line 145 of file ROL_SimulatedVector.hpp.

References basis(), clone(), dimension(), set(), vecs_, and zero().

Referenced by basis().

◆ dimension()

template<class Real>

int ROL::SimulatedVector< Real >::dimension ( void ) const

inlinevirtual

Return dimension of the vector space.

  @return The dimension of the vector space, i.e., the total number of basis vectors.

  Overload if the basis is overloaded.

  ---

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

Definition at line 176 of file ROL_SimulatedVector.hpp.

References vecs_.

Referenced by 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::ROL::Vector< Real >.

Definition at line 184 of file ROL_SimulatedVector.hpp.

References vecs_.

Referenced by basis().

◆ applyUnary()

template<class Real>

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

inlinevirtual

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

Definition at line 191 of file ROL_SimulatedVector.hpp.

References vecs_.

◆ applyBinary()

template<class Real>

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

inline

Definition at line 198 of file ROL_SimulatedVector.hpp.

References get(), and vecs_.

◆ reduce()

template<class Real>

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

inlinevirtual

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

Definition at line 206 of file ROL_SimulatedVector.hpp.

References reduce(), and vecs_.

Referenced by reduce().

◆ setScalar()

template<class Real>

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

inlinevirtual

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

  @param[in]      C     is a scalar.

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

  ---

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

Definition at line 215 of file ROL_SimulatedVector.hpp.

References vecs_.

◆ randomize()

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

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

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

  ---

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

Definition at line 221 of file ROL_SimulatedVector.hpp.

References vecs_.

◆ get() [1/2]

template<class Real>

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

inline

Definition at line 231 of file ROL_SimulatedVector.hpp.

References vecs_.

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

◆ get() [2/2]

template<class Real>

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

inline

Definition at line 235 of file ROL_SimulatedVector.hpp.

References vecs_.

◆ set() [2/2]

template<class Real>

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

inline

Definition at line 239 of file ROL_SimulatedVector.hpp.

References vecs_.

◆ zero() [2/2]

template<class Real>

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

inline

Definition at line 243 of file ROL_SimulatedVector.hpp.

References vecs_.

◆ numVectors()

template<class Real>

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

inline

Definition at line 247 of file ROL_SimulatedVector.hpp.

References vecs_.

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

Member Data Documentation

◆ vecs_

template<class Real>

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

private

Definition at line 42 of file ROL_SimulatedVector.hpp.

Referenced by applyBinary(), applyUnary(), axpy(), basis(), clone(), dimension(), dot(), dual(), get(), get(), numVectors(), plus(), randomize(), reduce(), scale(), set(), set(), setScalar(), SimulatedVector(), zero(), and zero().

◆ bman_

template<class Real>

ROL::Ptr<BatchManager<Real> > ROL::SimulatedVector< Real >::bman_

private

Definition at line 43 of file ROL_SimulatedVector.hpp.

Referenced by clone(), dot(), dual(), and SimulatedVector().

◆ dual_vecs_

template<class Real>

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

mutableprivate

Definition at line 44 of file ROL_SimulatedVector.hpp.

Referenced by dual(), and SimulatedVector().

◆ dual_pvec_

template<class Real>

ROL::Ptr<PV> ROL::SimulatedVector< Real >::dual_pvec_

mutableprivate

Definition at line 45 of file ROL_SimulatedVector.hpp.

Referenced by 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

Member Typedef Documentation

◆ V

◆ Vp

◆ VBMp

◆ 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()

◆ setScalar()

◆ randomize()

◆ get() [1/2]

◆ get() [2/2]

◆ set() [2/2]

◆ zero() [2/2]

◆ numVectors()

Member Data Documentation

◆ vecs_

◆ bman_

◆ dual_vecs_

◆ dual_pvec_