Intermediate abstract class which does not require users implements plus, set, scale, axpy, norm, dot, or zero if they implement the three elementwise functions: applyUnary, applyBinary, and reduce. More...

#include <ROL_ElementwiseVector.hpp>

Inheritance diagram for ROL::ElementwiseVector< Real >:

Public Member Functions
virtual	~ElementwiseVector ()

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}\).

virtual Real	dot (const Vector< Real > &x) const
	Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\).

virtual Real	norm () const
	Returns \( \\| y \\| \) where \(y = \mathtt{*this}\).

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.

void	set (const Vector< Real > &x)
	Set \(y \leftarrow x\) where \(y = \mathtt{*this}\).

virtual void	applyUnary (const Elementwise::UnaryFunction< Real > &uf)=0

virtual void	applyBinary (const Elementwise::BinaryFunction< Real > &bf, const Vector< Real > &x)=0

virtual Real	reduce (const Elementwise::ReductionOp< Real > &r) const =0

Public Member Functions inherited from ROL::Vector< Real >
virtual	~Vector ()

virtual ROL::Ptr< Vector >	clone () const =0
	Clone to make a new (uninitialized) 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 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	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.

Detailed Description

template<class Real>
class ROL::ElementwiseVector< Real >

Intermediate abstract class which does not require users implements plus, set, scale, axpy, norm, dot, or zero if they implement the three elementwise functions: applyUnary, applyBinary, and reduce.

dot and norm are unweighted dot products and Euclidean norm by default

Definition at line 30 of file ROL_ElementwiseVector.hpp.

Constructor & Destructor Documentation

◆ ~ElementwiseVector()

template<class Real >

virtual ROL::ElementwiseVector< Real >::~ElementwiseVector ( )

inlinevirtual

Definition at line 34 of file ROL_ElementwiseVector.hpp.

Member Function Documentation

◆ plus()

template<class Real >

void ROL::ElementwiseVector< Real >::plus ( const Vector< Real > & x )

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 36 of file ROL_ElementwiseVector.hpp.

References ROL::ElementwiseVector< Real >::applyBinary().

◆ scale()

template<class Real >

void ROL::ElementwiseVector< Real >::scale ( const Real alpha )

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 40 of file ROL_ElementwiseVector.hpp.

References ROL::ElementwiseVector< Real >::applyUnary().

◆ dot()

template<class Real >

virtual Real ROL::ElementwiseVector< Real >::dot ( const Vector< Real > & x ) const

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 >.

Reimplemented in ROL::RieszPrimalVector< Real >, and ROL::RieszDualVector< Real >.

Definition at line 44 of file ROL_ElementwiseVector.hpp.

References ROL::Vector< Real >::clone().

Referenced by ROL::ElementwiseVector< Real >::norm().

◆ norm()

template<class Real >

virtual Real ROL::ElementwiseVector< Real >::norm ( ) const

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 51 of file ROL_ElementwiseVector.hpp.

References ROL::ElementwiseVector< Real >::dot().

◆ axpy()

template<class Real >

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

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 55 of file ROL_ElementwiseVector.hpp.

References ROL::ElementwiseVector< Real >::applyBinary().

◆ zero()

template<class Real >

void ROL::ElementwiseVector< 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 59 of file ROL_ElementwiseVector.hpp.

References ROL::ElementwiseVector< Real >::applyUnary().

◆ set()

template<class Real >

void ROL::ElementwiseVector< Real >::set ( const Vector< Real > & x )

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 63 of file ROL_ElementwiseVector.hpp.

References ROL::ElementwiseVector< Real >::applyBinary().