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

#include <ROL_AtomVector.hpp>

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

Public Member Functions

 DualAtomVector (const ROL::Ptr< std::vector< Real > > &vec, const ROL::Ptr< BatchManager< Real > > &bman, const int numMySamples, const int dimension, const ROL::Ptr< std::vector< Real > > &scale)
 
Real dot (const Vector< Real > &x) const
 Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\). More...
 
ROL::Ptr< Vector< Real > > clone (void) const
 Clone to make a new (uninitialized) vector. More...
 
const Vector< Real > & 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...
 
- Public Member Functions inherited from ROL::AtomVector< Real >
 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)
 
int dimension (void) const
 Return dimension of the vector space. More...
 
Real reduce (const Elementwise::ReductionOp< Real > &r) const
 
const Ptr< BatchManager< Real > > getBatchManager (void) const
 
- Public Member Functions inherited from ROL::StdVector< Real >
 StdVector (const Ptr< std::vector< Real >> &std_vec)
 
 StdVector (const int dim, const Realval=0.0)
 
 StdVector (std::initializer_list< Real > 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}\). More...
 
void plus (const Vector< Real > &x)
 Compute \(y \leftarrow y + x\), where \(y = \mathtt{*this}\). More...
 
void axpy (const Real alpha, const Vector< Real > &x)
 Compute \(y \leftarrow \alpha x + y\) where \(y = \mathtt{*this}\). More...
 
void scale (const Real alpha)
 Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\). More...
 
Real norm () const
 Returns \( \| y \| \) where \(y = \mathtt{*this}\). More...
 
Ptr< const std::vector< Real > > getVector () const
 
Ptr< std::vector< Real > > getVector ()
 
Ptr< Vector< Real > > basis (const int i) const
 Return i-th basis vector. More...
 
int dimension () const
 Return dimension of the vector space. More...
 
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}\). More...
 
void randomize (const Real l=0.0, const Real u=1.0)
 Set vector to be uniform random between [l,u]. More...
 
virtual void print (std::ostream &outStream) const
 
- Public Member Functions inherited from ROL::Vector< Real >
virtual ~Vector ()
 
virtual void zero ()
 Set to zero vector. More...
 
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 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 std::vector< Real >
::size_type 
uint
 

Private Attributes

const ROL::Ptr< std::vector
< Real > > 
scale_
 
ROL::Ptr< PrimalAtomVector
< Real > > 
primal_vec_
 
bool isDualInitialized_
 

Detailed Description

template<class Real>
class ROL::DualAtomVector< Real >

Definition at line 26 of file ROL_AtomVector.hpp.

Member Typedef Documentation

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

Definition at line 143 of file ROL_AtomVector.hpp.

Constructor & Destructor Documentation

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

Definition at line 150 of file ROL_AtomVector.hpp.

Member Function Documentation

template<class Real >
Real ROL::DualAtomVector< Real >::dot ( const Vector< Real > &  x) const
inlinevirtual

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

Parameters
[in]xis the vector that forms the dot product with \(\mathtt{*this}\).
Returns
The number equal to \(\langle \mathtt{*this}, x \rangle\).

Reimplemented from ROL::BatchStdVector< Real >.

Definition at line 157 of file ROL_AtomVector.hpp.

References ROL::BatchStdVector< Real >::dimension(), ROL::BatchStdVector< Real >::getBatchManager(), ROL::AtomVector< Real >::getDimension(), ROL::AtomVector< Real >::getNumMyAtoms(), ROL::StdVector< Real >::getVector(), and ROL::StdVector< Real, Element >::getVector().

template<class Real >
ROL::Ptr<Vector<Real> > ROL::DualAtomVector< Real >::clone ( void  ) 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.


Reimplemented from ROL::BatchStdVector< Real >.

Definition at line 178 of file ROL_AtomVector.hpp.

References ROL::BatchStdVector< Real >::dimension(), ROL::AtomVector< Real >::getDimension(), ROL::AtomVector< Real >::getNumMyAtoms(), and ROL::DualAtomVector< Real >::scale_.

template<class Real >
const Vector<Real>& ROL::DualAtomVector< 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 >.

Definition at line 187 of file ROL_AtomVector.hpp.

References ROL::BatchStdVector< Real >::dimension(), ROL::AtomVector< Real >::getDimension(), ROL::AtomVector< Real >::getNumMyAtoms(), ROL::StdVector< Real, Element >::getVector(), ROL::DualAtomVector< Real >::isDualInitialized_, ROL::DualAtomVector< Real >::primal_vec_, and ROL::DualAtomVector< Real >::scale_.

Member Data Documentation

template<class Real >
const ROL::Ptr<std::vector<Real> > ROL::DualAtomVector< Real >::scale_
private
template<class Real >
ROL::Ptr<PrimalAtomVector<Real> > ROL::DualAtomVector< Real >::primal_vec_
mutableprivate

Definition at line 146 of file ROL_AtomVector.hpp.

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

template<class Real >
bool ROL::DualAtomVector< Real >::isDualInitialized_
mutableprivate

Definition at line 147 of file ROL_AtomVector.hpp.

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


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