ROL
|
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>
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 &) |
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.
|
private |
Definition at line 103 of file ROL_ProfiledVector.hpp.
|
inline |
Definition at line 110 of file ROL_ProfiledVector.hpp.
References ROL::ProfiledVector< Ordinal, Real >::functionCalls_(), and ROL::ProfiledVector< Ordinal, Real >::v_.
|
inlinevirtual |
Definition at line 122 of file ROL_ProfiledVector.hpp.
References ROL::ProfiledVector< Ordinal, Real >::functionCalls_().
|
inlinevirtual |
Compute \(y \leftarrow y + x\), where \(y = \mathtt{*this}\).
[in] | x | is 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_.
|
inlinevirtual |
Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\).
[in] | alpha | is 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_.
|
inlinevirtual |
Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\).
[in] | x | is the vector that forms the dot product with \(\mathtt{*this}\). |
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_.
|
inlinevirtual |
Returns \( \| y \| \) where \(y = \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_.
|
inlinevirtual |
Clone to make a new (uninitialized) 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_.
|
inlinevirtual |
Compute \(y \leftarrow \alpha x + y\) where \(y = \mathtt{*this}\).
[in] | alpha | is the scaling of x. |
[in] | x | is 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_.
|
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_.
|
inlinevirtual |
Return i-th basis vector.
[in] | i | is the index of the basis function. |
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_.
|
inlinevirtual |
Return dimension of the vector space.
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_.
|
inlinevirtual |
Set \(y \leftarrow x\) where \(y = \mathtt{*this}\).
[in] | x | is 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_.
|
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.
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_().
|
inlinevirtual |
Apply \(\mathtt{*this}\) to a dual vector. This is equivalent to the call \(\mathtt{this->dot(x.dual())}\).
[in] | x | is a vector |
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_.
|
inline |
Definition at line 192 of file ROL_ProfiledVector.hpp.
References ROL::ProfiledVector< Ordinal, Real >::v_.
Referenced by ROL::ProfiledVector< Ordinal, Real >::axpy(), ROL::ProfiledVector< Ordinal, Real >::dot(), ROL::ProfiledVector< Ordinal, Real >::plus(), and ROL::ProfiledVector< Ordinal, Real >::set().
|
inline |
Definition at line 196 of file ROL_ProfiledVector.hpp.
References ROL::ProfiledVector< Ordinal, Real >::v_.
|
inlinevirtual |
Reimplemented from ROL::Vector< Real >.
Definition at line 200 of file ROL_ProfiledVector.hpp.
References ROL::ProfiledVector< Ordinal, Real >::functionCalls_(), and ROL::ProfiledVector< Ordinal, Real >::v_.
|
inlinevirtual |
Reimplemented from ROL::Vector< Real >.
Definition at line 205 of file ROL_ProfiledVector.hpp.
References ROL::ProfiledVector< Ordinal, Real >::functionCalls_(), and ROL::ProfiledVector< Ordinal, Real >::v_.
|
inlinevirtual |
Reimplemented from ROL::Vector< Real >.
Definition at line 210 of file ROL_ProfiledVector.hpp.
References ROL::ProfiledVector< Ordinal, Real >::functionCalls_(), and ROL::ProfiledVector< Ordinal, Real >::v_.
|
inlinevirtual |
Set \(y \leftarrow C\) where \(C\in\mathbb{R}\).
[in] | C | is 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_.
|
inlinevirtual |
Set vector to be uniform random between [l,u].
[in] | l | is a the lower bound. |
[in] | u | is 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_.
|
inlinevirtual |
Reimplemented from ROL::Vector< Real >.
Definition at line 225 of file ROL_ProfiledVector.hpp.
References ROL::ProfiledVector< Ordinal, Real >::v_.
|
private |
Definition at line 29 of file vector/test_06.cpp.
Referenced by ROL::ProfiledVector< Ordinal, Real >::apply(), ROL::ProfiledVector< Ordinal, Real >::applyBinary(), ROL::ProfiledVector< Ordinal, Real >::applyUnary(), ROL::ProfiledVector< Ordinal, Real >::axpy(), ROL::ProfiledVector< Ordinal, Real >::basis(), ROL::ProfiledVector< Ordinal, Real >::clone(), ROL::ProfiledVector< Ordinal, Real >::dimension(), ROL::ProfiledVector< Ordinal, Real >::dot(), ROL::ProfiledVector< Ordinal, Real >::dual(), ROL::ProfiledVector< Ordinal, Real >::norm(), ROL::ProfiledVector< Ordinal, Real >::plus(), ROL::ProfiledVector< Ordinal, Real >::ProfiledVector(), ROL::ProfiledVector< Ordinal, Real >::randomize(), ROL::ProfiledVector< Ordinal, Real >::reduce(), ROL::ProfiledVector< Ordinal, Real >::scale(), ROL::ProfiledVector< Ordinal, Real >::set(), ROL::ProfiledVector< Ordinal, Real >::setScalar(), ROL::ProfiledVector< Ordinal, Real >::zero(), and ROL::ProfiledVector< Ordinal, Real >::~ProfiledVector().
|
private |
Definition at line 28 of file vector/test_09.cpp.
|
friend |
Definition at line 69 of file ROL_ProfiledVector.hpp.
|
friend |
Definition at line 74 of file ROL_ProfiledVector.hpp.
|
private |
Definition at line 106 of file ROL_ProfiledVector.hpp.
Referenced by ROL::ProfiledVector< Ordinal, Real >::apply(), ROL::ProfiledVector< Ordinal, Real >::applyBinary(), ROL::ProfiledVector< Ordinal, Real >::applyUnary(), ROL::ProfiledVector< Ordinal, Real >::axpy(), ROL::ProfiledVector< Ordinal, Real >::basis(), ROL::ProfiledVector< Ordinal, Real >::clone(), ROL::ProfiledVector< Ordinal, Real >::dimension(), ROL::ProfiledVector< Ordinal, Real >::dot(), ROL::ProfiledVector< Ordinal, Real >::getVector(), ROL::ProfiledVector< Ordinal, Real >::norm(), ROL::ProfiledVector< Ordinal, Real >::plus(), ROL::ProfiledVector< Ordinal, Real >::print(), ROL::ProfiledVector< Ordinal, Real >::ProfiledVector(), ROL::ProfiledVector< Ordinal, Real >::randomize(), ROL::ProfiledVector< Ordinal, Real >::reduce(), ROL::ProfiledVector< Ordinal, Real >::scale(), ROL::ProfiledVector< Ordinal, Real >::set(), ROL::ProfiledVector< Ordinal, Real >::setScalar(), and ROL::ProfiledVector< Ordinal, Real >::zero().
|
staticprivate |
Definition at line 107 of file ROL_ProfiledVector.hpp.
Referenced by ROL::getVectorFunctionCalls(), and ROL::printVectorFunctionCalls().