ROL
Public Types | Public Member Functions | Private Types | Private Attributes | List of all members
ROL::SimulatedVector< Real > Class Template Reference

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}\).
 
void plus (const V &x)
 Compute \(y \leftarrow y + x\), where \(y = \mathtt{*this}\).
 
void scale (const Real alpha)
 Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\).
 
void axpy (const Real alpha, const V &x)
 Compute \(y \leftarrow \alpha x + y\) where \(y = \mathtt{*this}\).
 
virtual Real dot (const V &x) const
 Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\).
 
Real norm () const
 Returns \( \| y \| \) where \(y = \mathtt{*this}\).
 
virtual Vp clone () const
 Clone to make a new (uninitialized) vector.
 
virtual const Vdual (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::Vector< Real >
virtual ~Vector ()
 
virtual void plus (const Vector &x)=0
 Compute \(y \leftarrow y + x\), where \(y = \mathtt{*this}\).
 
virtual void scale (const Real alpha)=0
 Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\).
 
virtual Real dot (const Vector &x) const =0
 Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\).
 
virtual Real norm () const =0
 Returns \( \| y \| \) where \(y = \mathtt{*this}\).
 
virtual ROL::Ptr< Vectorclone () const =0
 Clone to make a new (uninitialized) vector.
 
virtual void axpy (const Real alpha, const Vector &x)
 Compute \(y \leftarrow \alpha x + y\) where \(y = \mathtt{*this}\).
 
virtual void zero ()
 Set to zero vector.
 
virtual ROL::Ptr< Vectorbasis (const int i) const
 Return i-th basis vector.
 
virtual int dimension () const
 Return dimension of the vector space.
 
virtual void set (const Vector &x)
 Set \(y \leftarrow x\) where \(y = \mathtt{*this}\).
 
virtual const Vectordual () 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.
 
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 applyUnary (const Elementwise::UnaryFunction< Real > &f)
 
virtual void applyBinary (const Elementwise::BinaryFunction< Real > &f, const Vector &x)
 
virtual Real reduce (const Elementwise::ReductionOp< Real > &r) const
 
virtual void print (std::ostream &outStream) const
 
virtual void setScalar (const Real C)
 Set \(y \leftarrow C\) where \(C\in\mathbb{R}\).
 
virtual void randomize (const Real l=0.0, const Real u=1.0)
 Set vector to be uniform random between [l,u].
 
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< VVp
 
typedef ROL::Ptr< BatchManager< Real > > VBMp
 
typedef SimulatedVector< Real > PV
 

Private Attributes

const std::vector< Vpvecs_
 
ROL::Ptr< BatchManager< Real > > bman_
 
std::vector< Vpdual_vecs_
 
ROL::Ptr< PVdual_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.

◆ Vp

template<class Real >
typedef ROL::Ptr<V> ROL::SimulatedVector< Real >::Vp
private

Definition at line 71 of file ROL_SimulatedVector.hpp.

◆ VBMp

template<class Real >
typedef ROL::Ptr<BatchManager<Real> > ROL::SimulatedVector< Real >::VBMp
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< Vp > &  vecs,
const VBMp bman 
)
inline

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

   @param[in]      x     is a vector.

   On return \f$\mathtt{*this} = x\f$.
   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(), ROL::SimulatedVector< Real >::numVectors(), and ROL::SimulatedVector< Real >::vecs_.

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

   @param[in]      x  is the vector to be added to \f$\mathtt{*this}\f$.

   On return \f$\mathtt{*this} = \mathtt{*this} + x\f$.

   ---

Implements ROL::Vector< Real >.

Definition at line 103 of file ROL_SimulatedVector.hpp.

References ROL::SimulatedVector< Real >::get(), ROL::SimulatedVector< Real >::numVectors(), and ROL::SimulatedVector< Real >::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::Vector< Real >.

Definition at line 116 of file ROL_SimulatedVector.hpp.

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

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

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

   On return \f$\mathtt{*this} = \mathtt{*this} + \alpha x \f$.
   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(), ROL::SimulatedVector< Real >::numVectors(), and ROL::SimulatedVector< Real >::vecs_.

◆ dot()

template<class Real >
virtual Real ROL::SimulatedVector< Real >::dot ( const V x) const
inlinevirtual

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

   @param[in]      x  is the vector that forms the dot product with \f$\mathtt{*this}\f$.
   @return         The number equal to \f$\langle \mathtt{*this}, x \rangle\f$.

   ---

Implements ROL::Vector< Real >.

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

Definition at line 135 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().

◆ 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::Vector< Real >.

Definition at line 154 of file ROL_SimulatedVector.hpp.

References ROL::SimulatedVector< Real >::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::Vector< Real >.

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

Definition at line 158 of file ROL_SimulatedVector.hpp.

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

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

Definition at line 169 of file ROL_SimulatedVector.hpp.

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

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

Definition at line 179 of file ROL_SimulatedVector.hpp.

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

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

Definition at line 210 of file ROL_SimulatedVector.hpp.

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

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

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

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

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

◆ applyBinary()

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

◆ reduce()

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

◆ 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::Vector< Real >.

Definition at line 249 of file ROL_SimulatedVector.hpp.

References ROL::SimulatedVector< Real >::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::Vector< Real >.

Definition at line 255 of file ROL_SimulatedVector.hpp.

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

◆ get() [1/2]

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

◆ get() [2/2]

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

Definition at line 269 of file ROL_SimulatedVector.hpp.

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

◆ set() [2/2]

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

Definition at line 273 of file ROL_SimulatedVector.hpp.

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

◆ zero() [2/2]

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

Definition at line 277 of file ROL_SimulatedVector.hpp.

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

◆ numVectors()

template<class Real >
size_type ROL::SimulatedVector< Real >::numVectors ( ) const
inline

Member Data Documentation

◆ vecs_

template<class Real >
const std::vector<Vp> ROL::SimulatedVector< Real >::vecs_
private

◆ bman_

template<class Real >
ROL::Ptr<BatchManager<Real> > ROL::SimulatedVector< Real >::bman_
private

◆ dual_vecs_

template<class Real >
std::vector<Vp> ROL::SimulatedVector< Real >::dual_vecs_
mutableprivate

◆ dual_pvec_

template<class Real >
ROL::Ptr<PV> ROL::SimulatedVector< Real >::dual_pvec_
mutableprivate

Definition at line 79 of file ROL_SimulatedVector.hpp.

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


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