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

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

#include <ROL_AtomVector.hpp>

+ Inheritance diagram for ROL::AtomVector< Real >:

Public Member Functions

 AtomVector (const ROL::Ptr< std::vector< Real > > &vec, const ROL::Ptr< BatchManager< Real > > &bman, const int numMySamples, const int dimension)
 
ROL::Ptr< const std::vector< Real > > getAtom (const int i) const
 
void setAtom (const int i, const std::vector< Real > &pt)
 
int getNumMyAtoms (void) const
 
int getDimension (void) const
 
- Public Member Functions inherited from ROL::BatchStdVector< Real >
 BatchStdVector (const Ptr< std::vector< Real > > &vec, const Ptr< BatchManager< Real > > &bman)
 
virtual Real dot (const Vector< Real > &x) const
 Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\).
 
virtual Ptr< Vector< Real > > clone (void) const
 Clone to make a new (uninitialized) vector.
 
int dimension (void) const
 Return dimension of the vector space.
 
Real reduce (const Elementwise::ReductionOp< Real > &r) const
 
const Ptr< BatchManager< Real > > getBatchManager (void) const
 
- Public Member Functions inherited from ROL::StdVector< Real, Element >
 StdVector (const Ptr< std::vector< Element > > &std_vec)
 
 StdVector (const int dim, const Element val=0.0)
 
 StdVector (std::initializer_list< Element > ilist)
 
Real & operator[] (int i)
 
const Real & operator[] (int i) const
 
void set (const Vector< Real > &x)
 Set \(y \leftarrow x\) where \(y = \mathtt{*this}\).
 
void plus (const Vector< Real > &x)
 Compute \(y \leftarrow y + x\), where \(y = \mathtt{*this}\).
 
void axpy (const Real alpha, const Vector< Real > &x)
 Compute \(y \leftarrow \alpha x + y\) where \(y = \mathtt{*this}\).
 
void scale (const Real alpha)
 Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\).
 
virtual Real dot (const Vector< Real > &x) const
 Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\).
 
Real norm () const
 Returns \( \| y \| \) where \(y = \mathtt{*this}\).
 
virtual Ptr< Vector< Real > > clone () const
 Clone to make a new (uninitialized) vector.
 
Ptr< const std::vector< Element > > getVector () const
 
Ptr< std::vector< Element > > getVector ()
 
Ptr< Vector< Real > > basis (const int i) const
 Return i-th basis vector.
 
int dimension () const
 Return dimension of the vector space.
 
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
 
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].
 
virtual void print (std::ostream &outStream) 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 std::vector< Real >::size_type uint
 

Private Attributes

const int numMySamples_
 
const int dimension_
 

Detailed Description

template<class Real>
class ROL::AtomVector< Real >

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

Definition at line 63 of file ROL_AtomVector.hpp.

Member Typedef Documentation

◆ uint

template<class Real >
typedef std::vector<Real>::size_type ROL::AtomVector< Real >::uint
private

Definition at line 64 of file ROL_AtomVector.hpp.

Constructor & Destructor Documentation

◆ AtomVector()

template<class Real >
ROL::AtomVector< Real >::AtomVector ( const ROL::Ptr< std::vector< Real > > &  vec,
const ROL::Ptr< BatchManager< Real > > &  bman,
const int  numMySamples,
const int  dimension 
)
inline

Definition at line 70 of file ROL_AtomVector.hpp.

Member Function Documentation

◆ getAtom()

template<class Real >
ROL::Ptr< const std::vector< Real > > ROL::AtomVector< Real >::getAtom ( const int  i) const
inline

◆ setAtom()

template<class Real >
void ROL::AtomVector< Real >::setAtom ( const int  i,
const std::vector< Real > &  pt 
)
inline

◆ getNumMyAtoms()

template<class Real >
int ROL::AtomVector< Real >::getNumMyAtoms ( void  ) const
inline

◆ getDimension()

template<class Real >
int ROL::AtomVector< Real >::getDimension ( void  ) const
inline

Member Data Documentation

◆ numMySamples_

template<class Real >
const int ROL::AtomVector< Real >::numMySamples_
private

◆ dimension_

template<class Real >
const int ROL::AtomVector< Real >::dimension_
private

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