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

#include <ROL_SingletonVector.hpp>

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

Public Member Functions

 SingletonVector (Real value=Real(0))
 
Real getValue () const
 
void setValue (Real v)
 
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 axpy (const Real alpha, const V &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 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...
 
ROL::Ptr< Vclone () const
 Clone to make a new (uninitialized) vector. More...
 
ROL::Ptr< Vbasis (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 V &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...
 
void print (std::ostream &os) const
 
- Public Member Functions inherited from ROL::Vector< Real >
virtual ~Vector ()
 
virtual void zero ()
 Set to zero vector. More...
 
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. 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

using V = Vector< Real >
 

Private Member Functions

Real getValueX (const V &x) const
 

Private Attributes

Real value_
 

Detailed Description

template<class Real>
class ROL::SingletonVector< Real >

Definition at line 25 of file ROL_SingletonVector.hpp.

Member Typedef Documentation

template<class Real>
using ROL::SingletonVector< Real >::V = Vector<Real>
private

Definition at line 27 of file ROL_SingletonVector.hpp.

Constructor & Destructor Documentation

template<class Real>
ROL::SingletonVector< Real >::SingletonVector ( Real  value = Real(0))
inline

Definition at line 39 of file ROL_SingletonVector.hpp.

Member Function Documentation

template<class Real>
Real ROL::SingletonVector< Real >::getValueX ( const V x) const
inlineprivate
template<class Real>
Real ROL::SingletonVector< Real >::getValue ( ) const
inline
template<class Real>
void ROL::SingletonVector< Real >::setValue ( Real  v)
inline
template<class Real>
void ROL::SingletonVector< Real >::set ( const V x)
inlinevirtual

Set \(y \leftarrow x\) where \(y = \mathtt{*this}\).

Parameters
[in]xis 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 44 of file ROL_SingletonVector.hpp.

References ROL::SingletonVector< Real >::getValueX(), and ROL::SingletonVector< Real >::value_.

template<class Real>
void ROL::SingletonVector< Real >::plus ( const V x)
inlinevirtual

Compute \(y \leftarrow y + x\), where \(y = \mathtt{*this}\).

Parameters
[in]xis the vector to be added to \(\mathtt{*this}\).

On return \(\mathtt{*this} = \mathtt{*this} + x\).


Implements ROL::Vector< Real >.

Definition at line 48 of file ROL_SingletonVector.hpp.

References ROL::SingletonVector< Real >::getValueX(), and ROL::SingletonVector< Real >::value_.

template<class Real>
void ROL::SingletonVector< Real >::axpy ( const Real  alpha,
const V x 
)
inlinevirtual

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

Parameters
[in]alphais the scaling of x.
[in]xis 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 52 of file ROL_SingletonVector.hpp.

References ROL::SingletonVector< Real >::getValueX(), and ROL::SingletonVector< Real >::value_.

template<class Real>
void ROL::SingletonVector< Real >::scale ( const Real  alpha)
inlinevirtual

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

Parameters
[in]alphais the scaling of \(\mathtt{*this}\).

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


Implements ROL::Vector< Real >.

Definition at line 56 of file ROL_SingletonVector.hpp.

References ROL::SingletonVector< Real >::value_.

template<class Real>
Real ROL::SingletonVector< Real >::dot ( const V 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\).

Implements ROL::Vector< Real >.

Definition at line 60 of file ROL_SingletonVector.hpp.

References ROL::SingletonVector< Real >::getValueX(), and ROL::SingletonVector< Real >::value_.

template<class Real>
Real ROL::SingletonVector< 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 66 of file ROL_SingletonVector.hpp.

References ROL::SingletonVector< Real >::value_.

template<class Real>
ROL::Ptr<V> ROL::SingletonVector< 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 >.

Definition at line 70 of file ROL_SingletonVector.hpp.

template<class Real>
ROL::Ptr<V> ROL::SingletonVector< Real >::basis ( const int  i) const
inlinevirtual

Return i-th basis vector.

Parameters
[in]iis 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 74 of file ROL_SingletonVector.hpp.

template<class Real>
int ROL::SingletonVector< 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 81 of file ROL_SingletonVector.hpp.

template<class Real>
void ROL::SingletonVector< Real >::applyUnary ( const Elementwise::UnaryFunction< Real > &  f)
inlinevirtual

Reimplemented from ROL::Vector< Real >.

Definition at line 83 of file ROL_SingletonVector.hpp.

References ROL::SingletonVector< Real >::value_.

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

Reimplemented from ROL::Vector< Real >.

Definition at line 91 of file ROL_SingletonVector.hpp.

References ROL::SingletonVector< Real >::value_.

template<class Real>
void ROL::SingletonVector< Real >::setScalar ( const Real  C)
inlinevirtual

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

Parameters
[in]Cis a scalar.

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


Reimplemented from ROL::Vector< Real >.

Definition at line 95 of file ROL_SingletonVector.hpp.

References ROL::SingletonVector< Real >::value_.

template<class Real>
void ROL::SingletonVector< Real >::randomize ( const Real  l = 0.0,
const Real  u = 1.0 
)
inlinevirtual

Set vector to be uniform random between [l,u].

Parameters
[in]lis a the lower bound.
[in]uis a the upper bound.

On return the components of \(\mathtt{*this}\) are uniform random numbers on the interval \([l,u]\). 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 99 of file ROL_SingletonVector.hpp.

References ROL::SingletonVector< Real >::value_.

template<class Real>
void ROL::SingletonVector< Real >::print ( std::ostream &  os) const
inlinevirtual

Reimplemented from ROL::Vector< Real >.

Definition at line 106 of file ROL_SingletonVector.hpp.

References ROL::SingletonVector< Real >::value_.

Member Data Documentation

template<class Real>
Real ROL::SingletonVector< Real >::value_
private

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