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)

void	scale (const Real alpha)

Real	dot (const Vector< Real > &x) const

Real	norm () const

ROL::Ptr< Vector< Real > >	clone () const

void	axpy (const Real alpha, const Vector< Real > &x)

void	zero ()

ROL::Ptr< Vector< Real > >	basis (const int i) const

int	dimension () const

void	set (const Vector< Real > &x)

const Vector< Real > &	dual () const

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)

void	randomize (const Real l=0.0, const Real u=1.0)

void	print (std::ostream &outStream) const

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 &)

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

Member Typedef Documentation

◆ V

template<class Ordinal , class Real >

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

private

Definition at line 135 of file ROL_ProfiledVector.hpp.

Constructor & Destructor Documentation

◆ ProfiledVector()

template<class Ordinal , class Real >

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

inline

Definition at line 142 of file ROL_ProfiledVector.hpp.

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

◆ ~ProfiledVector()

template<class Ordinal , class Real >

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

inlinevirtual

Definition at line 154 of file ROL_ProfiledVector.hpp.

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

Member Function Documentation

◆ plus()

template<class Ordinal , class Real >

void ROL::ProfiledVector< Ordinal, Real >::plus ( const Vector< Real > & x )

inline

Definition at line 158 of file ROL_ProfiledVector.hpp.

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

◆ scale()

template<class Ordinal , class Real >

void ROL::ProfiledVector< Ordinal, Real >::scale ( const Real alpha )

inline

Definition at line 165 of file ROL_ProfiledVector.hpp.

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

◆ dot()

template<class Ordinal , class Real >

Real ROL::ProfiledVector< Ordinal, Real >::dot ( const Vector< Real > & x ) const

inline

Definition at line 170 of file ROL_ProfiledVector.hpp.

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

◆ norm()

template<class Ordinal , class Real >

Real ROL::ProfiledVector< Ordinal, Real >::norm ( void ) const

inline

Definition at line 176 of file ROL_ProfiledVector.hpp.

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

◆ clone()

template<class Ordinal , class Real >

ROL::Ptr<Vector<Real> > ROL::ProfiledVector< Ordinal, Real >::clone ( void ) const

inline

Definition at line 181 of file ROL_ProfiledVector.hpp.

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

◆ axpy()

template<class Ordinal , class Real >

void ROL::ProfiledVector< Ordinal, Real >::axpy	(	const Real	alpha,
		const Vector< Real > &	x
	)

inline

Definition at line 186 of file ROL_ProfiledVector.hpp.

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

◆ zero()

template<class Ordinal , class Real >

void ROL::ProfiledVector< Ordinal, Real >::zero ( )

inline

Definition at line 192 of file ROL_ProfiledVector.hpp.

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

◆ basis()

template<class Ordinal , class Real >

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

inline

Definition at line 197 of file ROL_ProfiledVector.hpp.

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

◆ dimension()

template<class Ordinal , class Real >

int ROL::ProfiledVector< Ordinal, Real >::dimension ( void ) const

inline

Definition at line 202 of file ROL_ProfiledVector.hpp.

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

◆ set()

template<class Ordinal , class Real >

void ROL::ProfiledVector< Ordinal, Real >::set ( const Vector< Real > & x )

inline

Definition at line 207 of file ROL_ProfiledVector.hpp.

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

◆ dual()

template<class Ordinal , class Real >

const Vector<Real>& ROL::ProfiledVector< Ordinal, Real >::dual ( void ) const

inline

Definition at line 214 of file ROL_ProfiledVector.hpp.

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

◆ getVector() [1/2]

template<class Ordinal , class Real >

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

inline

Definition at line 219 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().

◆ getVector() [2/2]

template<class Ordinal , class Real >

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

inline

Definition at line 223 of file ROL_ProfiledVector.hpp.

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

◆ applyUnary()

template<class Ordinal , class Real >

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

inline

Definition at line 227 of file ROL_ProfiledVector.hpp.

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

◆ applyBinary()

template<class Ordinal , class Real >

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

inline

Definition at line 232 of file ROL_ProfiledVector.hpp.

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

◆ reduce()

template<class Ordinal , class Real >

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

inline

Definition at line 237 of file ROL_ProfiledVector.hpp.

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

◆ setScalar()

template<class Ordinal , class Real >

void ROL::ProfiledVector< Ordinal, Real >::setScalar ( const Real C )

inline

Definition at line 242 of file ROL_ProfiledVector.hpp.

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

◆ randomize()

template<class Ordinal , class Real >

void ROL::ProfiledVector< Ordinal, Real >::randomize	(	const Real	l = `0.0`,
		const Real	u = `1.0`
	)

inline

Definition at line 247 of file ROL_ProfiledVector.hpp.

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

◆ print()

template<class Ordinal , class Real >

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

inline

Definition at line 252 of file ROL_ProfiledVector.hpp.

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

◆ functionCalls_() [1/2]

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

private

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

◆ functionCalls_() [2/2]

ROL::VectorFunctionCalls< size_type > ROL::ProfiledVector< size_type, RealT >::functionCalls_

private

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

Friends And Related Function Documentation

◆ getVectorFunctionCalls

template<class Ordinal , class Real >

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

friend

Definition at line 102 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 107 of file ROL_ProfiledVector.hpp.

Member Data Documentation

◆ v_

template<class Ordinal , class Real >

ROL::Ptr<Vector<Real> > ROL::ProfiledVector< Ordinal, Real >::v_

private

Definition at line 138 of file ROL_ProfiledVector.hpp.

◆ functionCalls_

template<class Ordinal , class Real >

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

staticprivate

Definition at line 139 of file ROL_ProfiledVector.hpp.

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

◆ 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()

◆ setScalar()

◆ randomize()

◆ print()

◆ functionCalls_() [1/2]

◆ functionCalls_() [2/2]

Friends And Related Function Documentation

◆ getVectorFunctionCalls

◆ printVectorFunctionCalls

Member Data Documentation

◆ v_

◆ functionCalls_

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