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}\). | |
void | scale (const Real alpha) |
Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\). | |
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}\). | |
ROL::Ptr< Vector< Real > > | clone () const |
Clone to make a new (uninitialized) vector. | |
void | axpy (const Real alpha, const Vector< Real > &x) |
Compute \(y \leftarrow \alpha x + y\) where \(y = \mathtt{*this}\). | |
void | zero () |
Set to zero vector. | |
ROL::Ptr< Vector< Real > > | basis (const int i) const |
Return i-th basis vector. | |
int | dimension () const |
Return dimension of the vector space. | |
void | set (const Vector< Real > &x) |
Set \(y \leftarrow x\) where \(y = \mathtt{*this}\). | |
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. | |
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())}\). | |
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}\). | |
void | randomize (const Real l=0.0, const Real u=1.0) |
Set vector to be uniform random between [l,u]. | |
void | print (std::ostream &outStream) const |
![]() | |
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< Vector > | clone () 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< Vector > | basis (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 Vector & | 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. | |
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 Vector< Real > | V |
Private Member Functions | |
ROL::VectorFunctionCalls< int > | functionCalls_ |
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 135 of file ROL_ProfiledVector.hpp.
|
private |
Definition at line 137 of file ROL_ProfiledVector.hpp.
|
inline |
Definition at line 144 of file ROL_ProfiledVector.hpp.
References ROL::ProfiledVector< Ordinal, Real >::functionCalls_, and ROL::ProfiledVector< Ordinal, Real >::v_.
|
inlinevirtual |
Definition at line 156 of file ROL_ProfiledVector.hpp.
References ROL::ProfiledVector< Ordinal, Real >::functionCalls_.
|
inlinevirtual |
Compute \(y \leftarrow y + x\), where \(y = \mathtt{*this}\).
@param[in] x is the vector to be added to \f$\mathtt{*this}\f$. On return \f$\mathtt{*this} = \mathtt{*this} + x\f$. ---
Implements ROL::Vector< Real >.
Definition at line 160 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}\).
@param[in] alpha is the scaling of \f$\mathtt{*this}\f$. On return \f$\mathtt{*this} = \alpha (\mathtt{*this}) \f$. ---
Implements ROL::Vector< Real >.
Definition at line 167 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}\).
@param[in] x is the vector that forms the dot product with \f$\mathtt{*this}\f$. @return The number equal to \f$\langle \mathtt{*this}, x \rangle\f$. ---
Implements ROL::Vector< Real >.
Definition at line 172 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}\).
@return A nonnegative number equal to the norm of \f$\mathtt{*this}\f$. ---
Implements ROL::Vector< Real >.
Definition at line 178 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.
@return A reference-counted pointer to the cloned vector. Provides the means of allocating temporary memory in ROL. ---
Implements ROL::Vector< Real >.
Definition at line 183 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}\).
@param[in] alpha is the scaling of @b x. @param[in] x is a vector. On return \f$\mathtt{*this} = \mathtt{*this} + \alpha x \f$. 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 188 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 194 of file ROL_ProfiledVector.hpp.
References ROL::ProfiledVector< Ordinal, Real >::functionCalls_, and ROL::ProfiledVector< Ordinal, Real >::v_.
|
inlinevirtual |
Return i-th basis vector.
@param[in] i is the index of the basis function. @return A reference-counted pointer to the basis vector with index @b 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 199 of file ROL_ProfiledVector.hpp.
References ROL::ProfiledVector< Ordinal, Real >::functionCalls_, and ROL::ProfiledVector< Ordinal, Real >::v_.
|
inlinevirtual |
Return dimension of the vector space.
@return 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 204 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}\).
@param[in] x is a vector. On return \f$\mathtt{*this} = x\f$. 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 209 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 216 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 221 of file ROL_ProfiledVector.hpp.
References ROL::ProfiledVector< Ordinal, Real >::functionCalls_, and ROL::ProfiledVector< Ordinal, Real >::v_.
|
inline |
Definition at line 226 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 230 of file ROL_ProfiledVector.hpp.
References ROL::ProfiledVector< Ordinal, Real >::v_.
|
inlinevirtual |
Reimplemented from ROL::Vector< Real >.
Definition at line 234 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 239 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 244 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}\).
@param[in] C is a scalar. On return \f$\mathtt{*this} = C\f$. Uses #applyUnary methods for the computation. Please overload if a more efficient implementation is needed. ---
Reimplemented from ROL::Vector< Real >.
Definition at line 249 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].
@param[in] l is a the lower bound. @param[in] u is a the upper bound. On return the components of \f$\mathtt{*this}\f$ are uniform random numbers on the interval \f$[l,u]\f$. 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 254 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 259 of file ROL_ProfiledVector.hpp.
References ROL::ProfiledVector< Ordinal, Real >::v_.
|
private |
Definition at line 63 of file vector/test_06.cpp.
|
private |
Definition at line 62 of file vector/test_09.cpp.
|
friend |
Definition at line 103 of file ROL_ProfiledVector.hpp.
|
friend |
Definition at line 108 of file ROL_ProfiledVector.hpp.
|
private |
Definition at line 140 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 141 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 >::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().