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 Teuchos::RCP< 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...

Teuchos::RCP< 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...

Teuchos::RCP< 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...

Teuchos::RCP< Vector< Real > >	getVector ()

Teuchos::RCP< 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	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
template<typename T >
using	RCP = Teuchos::RCP< T >

typedef Vector< Real >	V

Private Member Functions
template<>
ROL::VectorFunctionCalls< int >	functionCalls_

Private Attributes
Teuchos::RCP< 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 97 of file ROL_ProfiledVector.hpp.

Member Typedef Documentation

◆ RCP

template<class Ordinal, class Real>

template<typename T >

using ROL::ProfiledVector< Ordinal, Real >::RCP = Teuchos::RCP<T>

private

Definition at line 131 of file ROL_ProfiledVector.hpp.

◆ V

template<class Ordinal, class Real>

typedef Vector<Real> ROL::ProfiledVector< Ordinal, Real >::V

private

Definition at line 132 of file ROL_ProfiledVector.hpp.

Constructor & Destructor Documentation

◆ ProfiledVector()

template<class Ordinal, class Real>

ROL::ProfiledVector< Ordinal, Real >::ProfiledVector ( const Teuchos::RCP< Vector< Real > > & v )

inline

Definition at line 139 of file ROL_ProfiledVector.hpp.

References ROL::VectorFunctionCalls< Ordinal >::constructor_.

◆ ~ProfiledVector()

template<class Ordinal, class Real>

virtual ROL::ProfiledVector< Ordinal, Real >::~ProfiledVector ( )

inlinevirtual

Definition at line 151 of file ROL_ProfiledVector.hpp.

References ROL::VectorFunctionCalls< Ordinal >::destructor_.

Member Function Documentation

◆ plus()

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] x is the vector to be added to \(\mathtt{*this}\).

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

Implements ROL::Vector< Real >.

Definition at line 155 of file ROL_ProfiledVector.hpp.

References ROL::VectorFunctionCalls< Ordinal >::plus_.

◆ scale()

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] alpha is the scaling of \(\mathtt{*this}\).

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

Implements ROL::Vector< Real >.

Definition at line 162 of file ROL_ProfiledVector.hpp.

References ROL::VectorFunctionCalls< Ordinal >::scale_.

◆ dot()

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] x is 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 167 of file ROL_ProfiledVector.hpp.

References ROL::VectorFunctionCalls< Ordinal >::dot_.

◆ norm()

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 173 of file ROL_ProfiledVector.hpp.

References ROL::VectorFunctionCalls< Ordinal >::norm_.

◆ clone()

template<class Ordinal, class Real>

Teuchos::RCP<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 178 of file ROL_ProfiledVector.hpp.

References ROL::VectorFunctionCalls< Ordinal >::clone_.

◆ axpy()

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]	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 183 of file ROL_ProfiledVector.hpp.

References ROL::VectorFunctionCalls< Ordinal >::axpy_.

◆ zero()

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 189 of file ROL_ProfiledVector.hpp.

References ROL::VectorFunctionCalls< Ordinal >::zero_.

◆ basis()

template<class Ordinal, class Real>

Teuchos::RCP<Vector<Real> > ROL::ProfiledVector< Ordinal, Real >::basis ( const int i ) const

inlinevirtual

Return i-th basis vector.

Parameters

[in] i is 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 194 of file ROL_ProfiledVector.hpp.

References ROL::VectorFunctionCalls< Ordinal >::basis_.

◆ dimension()

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 199 of file ROL_ProfiledVector.hpp.

References ROL::VectorFunctionCalls< Ordinal >::dimension_.

◆ set()

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] 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 204 of file ROL_ProfiledVector.hpp.

References ROL::VectorFunctionCalls< Ordinal >::set_.

◆ dual()

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 211 of file ROL_ProfiledVector.hpp.

References ROL::VectorFunctionCalls< Ordinal >::dual_.

◆ getVector() [1/2]

template<class Ordinal, class Real>

Teuchos::RCP<Vector<Real> > ROL::ProfiledVector< Ordinal, Real >::getVector ( )

inline

Definition at line 216 of file ROL_ProfiledVector.hpp.

◆ getVector() [2/2]

template<class Ordinal, class Real>

Teuchos::RCP<const Vector<Real> > ROL::ProfiledVector< Ordinal, Real >::getVector ( ) const

inline

Definition at line 220 of file ROL_ProfiledVector.hpp.

◆ applyUnary()

template<class Ordinal, class Real>

void ROL::ProfiledVector< Ordinal, Real >::applyUnary ( const Elementwise::UnaryFunction< Real > & f )

inlinevirtual

Reimplemented from ROL::Vector< Real >.

Definition at line 224 of file ROL_ProfiledVector.hpp.

References ROL::VectorFunctionCalls< Ordinal >::applyUnary_.

◆ applyBinary()

template<class Ordinal, class Real>

void ROL::ProfiledVector< Ordinal, Real >::applyBinary	(	const Elementwise::BinaryFunction< Real > &	f,
		const Vector< Real > &	x
	)

inlinevirtual

Reimplemented from ROL::Vector< Real >.

Definition at line 229 of file ROL_ProfiledVector.hpp.

References ROL::VectorFunctionCalls< Ordinal >::applyBinary_.

◆ reduce()

template<class Ordinal, class Real>

Real ROL::ProfiledVector< Ordinal, Real >::reduce ( const Elementwise::ReductionOp< Real > & r ) const

inlinevirtual

Reimplemented from ROL::Vector< Real >.

Definition at line 234 of file ROL_ProfiledVector.hpp.

References ROL::VectorFunctionCalls< Ordinal >::reduce_.

◆ print()

template<class Ordinal, class Real>

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

inlinevirtual

Reimplemented from ROL::Vector< Real >.

Definition at line 239 of file ROL_ProfiledVector.hpp.

◆ functionCalls_()

template<>

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

private

Definition at line 63 of file vector/test_06.cpp.

Friends And Related Function Documentation

◆ getVectorFunctionCalls

template<class Ordinal, class Real>

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

friend

Definition at line 100 of file ROL_ProfiledVector.hpp.

◆ printVectorFunctionCalls

template<class Ordinal, class Real>

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

friend

Definition at line 105 of file ROL_ProfiledVector.hpp.

Member Data Documentation

◆ v_

template<class Ordinal, class Real>

Teuchos::RCP<Vector<Real> > ROL::ProfiledVector< Ordinal, Real >::v_

private

Definition at line 135 of file ROL_ProfiledVector.hpp.

◆ functionCalls_

template<class Ordinal, class Real>

VectorFunctionCalls<Ordinal> ROL::ProfiledVector< Ordinal, Real >::functionCalls_

staticprivate

Definition at line 136 of file ROL_ProfiledVector.hpp.

Referenced by ROL::getVectorFunctionCalls(), and ROL::printVectorFunctionCalls().

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

ROL_ProfiledVector.hpp

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

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

Member Typedef Documentation

◆ RCP

◆ V

Constructor & Destructor Documentation

◆ ProfiledVector()

◆ ~ProfiledVector()

Member Function Documentation

◆ plus()

◆ scale()

◆ dot()

◆ norm()

◆ clone()

◆ axpy()

◆ zero()

◆ basis()

◆ dimension()

◆ set()

◆ dual()

◆ getVector() [1/2]

◆ getVector() [2/2]

◆ applyUnary()

◆ applyBinary()

◆ reduce()

◆ print()

◆ functionCalls_()

Friends And Related Function Documentation

◆ getVectorFunctionCalls

◆ printVectorFunctionCalls

Member Data Documentation

◆ v_

◆ functionCalls_

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