ROL
Public Member Functions | Private Types | Private Member Functions | Private Attributes | Static Private Attributes | Friends | List of all members
ROL::ProfiledVector< Ordinal, Real > Class Template Reference

By keeping a pointer to this in a derived Vector class, a tally of all methods is kept for profiling function calls. More...

#include <ROL_ProfiledVector.hpp>

+ Inheritance diagram for ROL::ProfiledVector< Ordinal, Real >:

Public Member Functions

 ProfiledVector (const ROL::Ptr< Vector< Real > > &v)
 
virtual ~ProfiledVector ()
 
void plus (const Vector< Real > &x)
 Compute \(y \leftarrow y + x\), where \(y = \mathtt{*this}\). More...
 
void scale (const Real alpha)
 Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\). More...
 
Real dot (const Vector< Real > &x) const
 Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\). More...
 
Real norm () const
 Returns \( \| y \| \) where \(y = \mathtt{*this}\). More...
 
ROL::Ptr< Vector< Real > > clone () const
 Clone to make a new (uninitialized) vector. More...
 
void axpy (const Real alpha, const Vector< Real > &x)
 Compute \(y \leftarrow \alpha x + y\) where \(y = \mathtt{*this}\). More...
 
void zero ()
 Set to zero vector. More...
 
ROL::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 set (const Vector< Real > &x)
 Set \(y \leftarrow x\) where \(y = \mathtt{*this}\). More...
 
const Vector< Real > & dual () 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...
 
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...
 
ROL::Ptr< Vector< Real > > getVector ()
 
ROL::Ptr< const Vector< Real > > getVector () const
 
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...
 
void print (std::ostream &outStream) const
 
- Public Member Functions inherited from ROL::Vector< Real >
virtual ~Vector ()
 
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 Vector< Real > V
 

Private Member Functions

template<>
ROL::VectorFunctionCalls< int > functionCalls_
 
template<>
ROL::VectorFunctionCalls
< size_type
functionCalls_
 

Private Attributes

ROL::Ptr< Vector< Real > > v_
 

Static Private Attributes

static VectorFunctionCalls
< Ordinal > 
functionCalls_
 

Friends

VectorFunctionCalls< Ordinal > getVectorFunctionCalls (const ProfiledVector< Ordinal, Real > &)
 
void printVectorFunctionCalls (const ProfiledVector< Ordinal, Real > &, std::ostream &)
 

Detailed Description

template<class Ordinal, class Real>
class ROL::ProfiledVector< Ordinal, Real >

By keeping a pointer to this in a derived Vector class, a tally of all methods is kept for profiling function calls.

NOTE: This class is not yet compatible with vectors that have true duals

In the cpp file where this is used, you must initialize the VectorFunctionCalls object.

Example usage:

template<> VectorFunctionCalls<int> ProfiledVector<int,double>::functionCalls = VectorFunctionCalls<int>();

Definition at line 66 of file ROL_ProfiledVector.hpp.

Member Typedef Documentation

template<class Ordinal, class Real>
typedef Vector<Real> ROL::ProfiledVector< Ordinal, Real >::V
private

Definition at line 103 of file ROL_ProfiledVector.hpp.

Constructor & Destructor Documentation

template<class Ordinal, class Real>
ROL::ProfiledVector< Ordinal, Real >::ProfiledVector ( const ROL::Ptr< Vector< Real > > &  v)
inline
template<class Ordinal, class Real>
virtual ROL::ProfiledVector< Ordinal, Real >::~ProfiledVector ( )
inlinevirtual

Member Function Documentation

template<class Ordinal, class Real>
void ROL::ProfiledVector< Ordinal, Real >::plus ( const Vector< Real > &  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 126 of file ROL_ProfiledVector.hpp.

References ROL::ProfiledVector< Ordinal, Real >::functionCalls_(), ROL::ProfiledVector< Ordinal, Real >::getVector(), and ROL::ProfiledVector< Ordinal, Real >::v_.

template<class Ordinal, class Real>
void ROL::ProfiledVector< Ordinal, 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 133 of file ROL_ProfiledVector.hpp.

References ROL::ProfiledVector< Ordinal, Real >::functionCalls_(), and ROL::ProfiledVector< Ordinal, Real >::v_.

template<class Ordinal, class Real>
Real ROL::ProfiledVector< Ordinal, 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\).

Implements ROL::Vector< Real >.

Definition at line 138 of file ROL_ProfiledVector.hpp.

References ROL::ProfiledVector< Ordinal, Real >::functionCalls_(), ROL::ProfiledVector< Ordinal, Real >::getVector(), and ROL::ProfiledVector< Ordinal, Real >::v_.

template<class Ordinal, class Real>
Real ROL::ProfiledVector< Ordinal, 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 144 of file ROL_ProfiledVector.hpp.

References ROL::ProfiledVector< Ordinal, Real >::functionCalls_(), and ROL::ProfiledVector< Ordinal, Real >::v_.

template<class Ordinal, class Real>
ROL::Ptr<Vector<Real> > ROL::ProfiledVector< Ordinal, 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 149 of file ROL_ProfiledVector.hpp.

References ROL::ProfiledVector< Ordinal, Real >::functionCalls_(), and ROL::ProfiledVector< Ordinal, Real >::v_.

template<class Ordinal, class Real>
void ROL::ProfiledVector< Ordinal, Real >::axpy ( const Real  alpha,
const Vector< Real > &  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 154 of file ROL_ProfiledVector.hpp.

References ROL::ProfiledVector< Ordinal, Real >::functionCalls_(), ROL::ProfiledVector< Ordinal, Real >::getVector(), and ROL::ProfiledVector< Ordinal, Real >::v_.

template<class Ordinal, class Real>
void ROL::ProfiledVector< Ordinal, 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 160 of file ROL_ProfiledVector.hpp.

References ROL::ProfiledVector< Ordinal, Real >::functionCalls_(), and ROL::ProfiledVector< Ordinal, Real >::v_.

template<class Ordinal, class Real>
ROL::Ptr<Vector<Real> > ROL::ProfiledVector< Ordinal, 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 165 of file ROL_ProfiledVector.hpp.

References ROL::ProfiledVector< Ordinal, Real >::functionCalls_(), and ROL::ProfiledVector< Ordinal, Real >::v_.

template<class Ordinal, class Real>
int ROL::ProfiledVector< Ordinal, 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 170 of file ROL_ProfiledVector.hpp.

References ROL::ProfiledVector< Ordinal, Real >::functionCalls_(), and ROL::ProfiledVector< Ordinal, Real >::v_.

template<class Ordinal, class Real>
void ROL::ProfiledVector< Ordinal, Real >::set ( const Vector< Real > &  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 175 of file ROL_ProfiledVector.hpp.

References ROL::ProfiledVector< Ordinal, Real >::functionCalls_(), ROL::ProfiledVector< Ordinal, Real >::getVector(), and ROL::ProfiledVector< Ordinal, Real >::v_.

template<class Ordinal, class Real>
const Vector<Real>& ROL::ProfiledVector< Ordinal, 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 182 of file ROL_ProfiledVector.hpp.

References ROL::ProfiledVector< Ordinal, Real >::functionCalls_().

template<class Ordinal, class Real>
Real ROL::ProfiledVector< Ordinal, Real >::apply ( const Vector< Real > &  x) const
inlinevirtual

Apply \(\mathtt{*this}\) to a dual vector. This is equivalent to the call \(\mathtt{this->dot(x.dual())}\).

Parameters
[in]xis a vector
Returns
The number equal to \(\langle \mathtt{*this}, x \rangle\).

Reimplemented from ROL::Vector< Real >.

Definition at line 187 of file ROL_ProfiledVector.hpp.

References ROL::ProfiledVector< Ordinal, Real >::functionCalls_(), and ROL::ProfiledVector< Ordinal, Real >::v_.

template<class Ordinal, class Real>
ROL::Ptr<Vector<Real> > ROL::ProfiledVector< Ordinal, Real >::getVector ( )
inline
template<class Ordinal, class Real>
ROL::Ptr<const Vector<Real> > ROL::ProfiledVector< Ordinal, Real >::getVector ( ) const
inline

Definition at line 196 of file ROL_ProfiledVector.hpp.

References ROL::ProfiledVector< Ordinal, Real >::v_.

template<class Ordinal, class Real>
void ROL::ProfiledVector< Ordinal, Real >::applyUnary ( const Elementwise::UnaryFunction< Real > &  f)
inlinevirtual
template<class Ordinal, class Real>
void ROL::ProfiledVector< Ordinal, Real >::applyBinary ( const Elementwise::BinaryFunction< Real > &  f,
const Vector< Real > &  x 
)
inlinevirtual
template<class Ordinal, class Real>
Real ROL::ProfiledVector< Ordinal, Real >::reduce ( const Elementwise::ReductionOp< Real > &  r) const
inlinevirtual
template<class Ordinal, class Real>
void ROL::ProfiledVector< Ordinal, 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 215 of file ROL_ProfiledVector.hpp.

References ROL::ProfiledVector< Ordinal, Real >::functionCalls_(), and ROL::ProfiledVector< Ordinal, Real >::v_.

template<class Ordinal, class Real>
void ROL::ProfiledVector< Ordinal, 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 220 of file ROL_ProfiledVector.hpp.

References ROL::ProfiledVector< Ordinal, Real >::functionCalls_(), and ROL::ProfiledVector< Ordinal, Real >::v_.

template<class Ordinal, class Real>
void ROL::ProfiledVector< Ordinal, Real >::print ( std::ostream &  outStream) const
inlinevirtual

Reimplemented from ROL::Vector< Real >.

Definition at line 225 of file ROL_ProfiledVector.hpp.

References ROL::ProfiledVector< Ordinal, Real >::v_.

template<>
ROL::VectorFunctionCalls< int > ROL::ProfiledVector< int, RealT >::functionCalls_ ( )
private
template<>
ROL::VectorFunctionCalls< size_type > ROL::ProfiledVector< size_type, RealT >::functionCalls_ ( )
private

Definition at line 28 of file vector/test_09.cpp.

Friends And Related Function Documentation

template<class Ordinal, class Real>
VectorFunctionCalls<Ordinal> getVectorFunctionCalls ( const ProfiledVector< Ordinal, Real > &  x)
friend

Definition at line 69 of file ROL_ProfiledVector.hpp.

template<class Ordinal, class Real>
void printVectorFunctionCalls ( const ProfiledVector< Ordinal, Real > &  x,
std::ostream &  outStream = std::cout 
)
friend

Definition at line 74 of file ROL_ProfiledVector.hpp.

Member Data Documentation

template<class Ordinal, class Real>
ROL::Ptr<Vector<Real> > ROL::ProfiledVector< Ordinal, Real >::v_
private
template<class Ordinal, class Real>
VectorFunctionCalls<Ordinal> ROL::ProfiledVector< Ordinal, Real >::functionCalls_
staticprivate

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