ROL::PartitionedVector< Real > Class Template Reference

Defines the linear algebra of vector space on a generic partitioned vector. More...

#include <ROL_PartitionedVector.hpp>

Inheritance diagram for ROL::PartitionedVector< Real >:

Public Types
typedef std::vector< PV > ::size_type	size_type

Public Member Functions
	PartitionedVector (const std::vector< Vp > &vecs)
void	set (const V &x)
	Set \(y \leftarrow x\) where \(y = \mathtt{*this}\). More...
void	plus (const V &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...
void	axpy (const Real alpha, const V &x)
	Compute \(y \leftarrow \alpha x + y\) where \(y = \mathtt{*this}\). More...
Real	dot (const V &x) const
	Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\). More...
Real	norm () const
	Returns \( \| y \| \) where \(y = \mathtt{*this}\). More...
Vp	clone () const
	Clone to make a new (uninitialized) vector. More...
const V &	dual (void) 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...
Vp	basis (const int i) const
	Return i-th basis vector. More...
int	dimension () const
	Return dimension of the vector space. More...
void	zero ()
	Set to zero vector. More...
void	applyUnary (const Elementwise::UnaryFunction< Real > &f)
void	applyBinary (const Elementwise::BinaryFunction< Real > &f, const V &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
const Vector< Real > &	operator[] (size_type i) const
Vector< Real > &	operator[] (size_type i)
ROL::Ptr< const Vector< Real > >	get (size_type i) const
ROL::Ptr< Vector< Real > >	get (size_type i)
void	set (size_type i, const V &x)
void	zero (size_type i)
size_type	numVectors () 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...

Static Public Member Functions
static Ptr< PartitionedVector >	create (std::initializer_list< Vp > vs)
static Ptr< PartitionedVector >	create (const V &x, size_type N)

Private Types
typedef Vector< Real >	V
typedef ROL::Ptr< V >	Vp
typedef PartitionedVector< Real >	PV

Private Attributes
const std::vector< Vp >	vecs_
std::vector< Vp >	dual_vecs_
ROL::Ptr< PV >	dual_pvec_

Detailed Description

template<class Real>
class ROL::PartitionedVector< Real >

Defines the linear algebra of vector space on a generic partitioned vector.

Definition at line 60 of file ROL_PartitionedVector.hpp.

Member Typedef Documentation

template<class Real>

typedef Vector<Real> ROL::PartitionedVector< Real >::V

private

Definition at line 62 of file ROL_PartitionedVector.hpp.

template<class Real>

typedef ROL::Ptr<V> ROL::PartitionedVector< Real >::Vp

private

Definition at line 63 of file ROL_PartitionedVector.hpp.

template<class Real>

typedef PartitionedVector<Real> ROL::PartitionedVector< Real >::PV

private

Definition at line 64 of file ROL_PartitionedVector.hpp.

template<class Real>

typedef std::vector<PV>::size_type ROL::PartitionedVector< Real >::size_type

Definition at line 72 of file ROL_PartitionedVector.hpp.

Constructor & Destructor Documentation

template<class Real>

ROL::PartitionedVector< Real >::PartitionedVector ( const std::vector< Vp > &  vecs )

inline

Definition at line 74 of file ROL_PartitionedVector.hpp.

References ROL::PartitionedVector< Real >::clone(), ROL::PartitionedVector< Real >::dual(), ROL::PartitionedVector< Real >::dual_vecs_, and ROL::PartitionedVector< Real >::vecs_.

Member Function Documentation

template<class Real>

void ROL::PartitionedVector< Real >::set ( const V &  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 80 of file ROL_PartitionedVector.hpp.

References ROL::PartitionedVector< Real >::get(), ROL::PartitionedVector< Real >::numVectors(), and ROL::PartitionedVector< Real >::vecs_.

Referenced by ROL::AugmentedSystemPrecOperator< Real >::applyInverse(), ROL::Fletcher< Real >::AugSystemPrecond::applyInverse(), ROL::BoundFletcher< Real >::AugSystemPrecond::applyInverse(), and ROL::PartitionedVector< Real >::basis().

template<class Real>

void ROL::PartitionedVector< Real >::plus ( const V &  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 90 of file ROL_PartitionedVector.hpp.

References ROL::PartitionedVector< Real >::get(), ROL::PartitionedVector< Real >::numVectors(), and ROL::PartitionedVector< Real >::vecs_.

template<class Real>

void ROL::PartitionedVector< 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 100 of file ROL_PartitionedVector.hpp.

References ROL::PartitionedVector< Real >::vecs_.

template<class Real>

void ROL::PartitionedVector< Real >::axpy ( const Real  alpha, const V &  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 106 of file ROL_PartitionedVector.hpp.

References ROL::PartitionedVector< Real >::get(), ROL::PartitionedVector< Real >::numVectors(), and ROL::PartitionedVector< Real >::vecs_.

template<class Real>

Real ROL::PartitionedVector< Real >::dot ( const V &  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 117 of file ROL_PartitionedVector.hpp.

References ROL::PartitionedVector< Real >::get(), ROL::PartitionedVector< Real >::numVectors(), and ROL::PartitionedVector< Real >::vecs_.

template<class Real>

Real ROL::PartitionedVector< 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 129 of file ROL_PartitionedVector.hpp.

References ROL::PartitionedVector< Real >::vecs_.

template<class Real>

Vp ROL::PartitionedVector< 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 137 of file ROL_PartitionedVector.hpp.

References ROL::PartitionedVector< Real >::vecs_.

Referenced by ROL::PartitionedVector< Real >::basis(), and ROL::PartitionedVector< Real >::PartitionedVector().

template<class Real>

const V& ROL::PartitionedVector< 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 145 of file ROL_PartitionedVector.hpp.

References ROL::PartitionedVector< Real >::dual_pvec_, ROL::PartitionedVector< Real >::dual_vecs_, and ROL::PartitionedVector< Real >::vecs_.

Referenced by ROL::PartitionedVector< Real >::PartitionedVector().

template<class Real>

Vp ROL::PartitionedVector< 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 153 of file ROL_PartitionedVector.hpp.

References ROL::PartitionedVector< Real >::clone(), ROL::PartitionedVector< Real >::dimension(), ROL::PartitionedVector< Real >::set(), ROL::PartitionedVector< Real >::vecs_, and ROL::PartitionedVector< Real >::zero().

template<class Real>

int ROL::PartitionedVector< 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 176 of file ROL_PartitionedVector.hpp.

References ROL::PartitionedVector< Real >::vecs_.

Referenced by ROL::PartitionedVector< Real >::basis().

template<class Real>

void ROL::PartitionedVector< 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 184 of file ROL_PartitionedVector.hpp.

References ROL::PartitionedVector< Real >::vecs_.

Referenced by ROL::PartitionedVector< Real >::basis().

template<class Real>

void ROL::PartitionedVector< Real >::applyUnary ( const Elementwise::UnaryFunction< Real > &  f )

inlinevirtual

Reimplemented from ROL::Vector< Real >.

Definition at line 191 of file ROL_PartitionedVector.hpp.

References ROL::PartitionedVector< Real >::vecs_.

template<class Real>

void ROL::PartitionedVector< Real >::applyBinary ( const Elementwise::BinaryFunction< Real > &  f, const V &  x  )

inlinevirtual

Reimplemented from ROL::Vector< Real >.

Definition at line 198 of file ROL_PartitionedVector.hpp.

References ROL::PartitionedVector< Real >::get(), and ROL::PartitionedVector< Real >::vecs_.

template<class Real>

Real ROL::PartitionedVector< Real >::reduce ( const Elementwise::ReductionOp< Real > &  r ) const

inlinevirtual

Reimplemented from ROL::Vector< Real >.

Definition at line 206 of file ROL_PartitionedVector.hpp.

References ROL::PartitionedVector< Real >::vecs_.

template<class Real>

void ROL::PartitionedVector< Real >::setScalar ( const Real  C )

inlinevirtual

Set \(y \leftarrow C\) where \(C\in\mathbb{R}\).

Parameters

[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_PartitionedVector.hpp.

References ROL::PartitionedVector< Real >::vecs_.

template<class Real>

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

inlinevirtual

Set vector to be uniform random between [l,u].

Parameters

[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 221 of file ROL_PartitionedVector.hpp.

References ROL::PartitionedVector< Real >::vecs_.

template<class Real>

void ROL::PartitionedVector< Real >::print ( std::ostream &  outStream ) const

inlinevirtual

Reimplemented from ROL::Vector< Real >.

Definition at line 227 of file ROL_PartitionedVector.hpp.

References ROL::PartitionedVector< Real >::vecs_.

template<class Real>

const Vector<Real>& ROL::PartitionedVector< Real >::operator[] ( size_type  i ) const

inline

Definition at line 235 of file ROL_PartitionedVector.hpp.

References ROL::PartitionedVector< Real >::vecs_.

template<class Real>

Vector<Real>& ROL::PartitionedVector< Real >::operator[] ( size_type  i )

inline

Definition at line 239 of file ROL_PartitionedVector.hpp.

References ROL::PartitionedVector< Real >::vecs_.

template<class Real>

ROL::Ptr<const Vector<Real> > ROL::PartitionedVector< Real >::get ( size_type  i ) const

inline

Definition at line 243 of file ROL_PartitionedVector.hpp.

References ROL::PartitionedVector< Real >::vecs_.

Referenced by ROL::AugmentedSystemOperator< Real >::apply(), ROL::BlockOperator< Real >::apply(), ROL::PrimalDualInteriorPointBlock11< Real >::apply(), ROL::Fletcher< Real >::AugSystem::apply(), ROL::PrimalDualInteriorPointBlock12< Real >::apply(), ROL::PrimalDualInteriorPointBlock21< Real >::apply(), ROL::BoundFletcher< Real >::AugSystemSym::apply(), ROL::BoundFletcher< Real >::AugSystemNonSym::apply(), ROL::PrimalDualInteriorPointBlock22< Real >::apply(), ROL::InteriorPoint::PrimalDualSymmetrizer< Real >::apply(), ROL::Constraint_Partitioned< Real >::applyAdjointHessian(), ROL::Constraint_Partitioned< Real >::applyAdjointJacobian(), ROL::PartitionedVector< Real >::applyBinary(), ROL::AugmentedSystemPrecOperator< Real >::applyInverse(), ROL::Fletcher< Real >::AugSystemPrecond::applyInverse(), ROL::BoundFletcher< Real >::AugSystemPrecond::applyInverse(), ROL::PrimalDualInteriorPointBlock22< Real >::applyInverse(), ROL::InteriorPoint::PrimalDualSymmetrizer< Real >::applyInverse(), ROL::Constraint_Partitioned< Real >::applyJacobian(), ROL::InteriorPoint::PrimalDualResidual< Real >::applyJacobian(), ROL::PrimalDualInteriorPointResidual< Real >::applyJacobian(), ROL::Constraint_Partitioned< Real >::applyPreconditioner(), ROL::PartitionedVector< Real >::axpy(), ROL::InteriorPoint::MeritFunction< Real >::dirDeriv(), ROL::PartitionedVector< Real >::dot(), ROL::Constraint_TimeSimOpt< Real >::getNewVector(), ROL::Constraint_TimeSimOpt< Real >::getOldVector(), ROL::PrimalDualInteriorPointResidual< Real >::getOptMult(), ROL::ReducedDynamicObjective< Real >::gradient(), ROL::ReducedDynamicObjective< Real >::hessVec(), ROL::BoundConstraint_Partitioned< Real >::isFeasible(), ROL::InteriorPoint::MeritFunction< Real >::MeritFunction(), ROL::PartitionedVector< Real >::plus(), ROL::PrimalDualInteriorPointBlock11< Real >::PrimalDualInteriorPointBlock11(), ROL::PrimalDualInteriorPointBlock21< Real >::PrimalDualInteriorPointBlock21(), ROL::PrimalDualInteriorPointBlock22< Real >::PrimalDualInteriorPointBlock22(), ROL::PrimalDualInteriorPointResidual< Real >::PrimalDualInteriorPointResidual(), ROL::InteriorPoint::PrimalDualResidual< Real >::PrimalDualResidual(), ROL::BoundConstraint_Partitioned< Real >::project(), ROL::BoundConstraint_Partitioned< Real >::projectInterior(), ROL::BoundConstraint_Partitioned< Real >::pruneLowerActive(), ROL::BoundConstraint_Partitioned< Real >::pruneUpperActive(), ROL::PrimalDualSystemStep< Real >::repartition(), ROL::PartitionedVector< Real >::set(), ROL::ReducedDynamicObjective< Real >::solveAdjoint(), ROL::ReducedDynamicObjective< Real >::solveState(), ROL::PrimalDualInteriorPointBlock11< Real >::update(), ROL::BoundConstraint_Partitioned< Real >::update(), ROL::PrimalDualInteriorPointResidual< Real >::update(), ROL::PrimalDualInteriorPointBlock21< Real >::update(), ROL::PrimalDualInteriorPointBlock22< Real >::update(), ROL::ReducedDynamicObjective< Real >::updateSketch(), ROL::Constraint_Partitioned< Real >::value(), ROL::InteriorPoint::PrimalDualResidual< Real >::value(), ROL::InteriorPoint::MeritFunction< Real >::value(), ROL::PrimalDualInteriorPointResidual< Real >::value(), ROL::ReducedDynamicObjective< Real >::value(), and ROL::SlacklessObjective< Real >::zeroSlack().

template<class Real>

ROL::Ptr<Vector<Real> > ROL::PartitionedVector< Real >::get ( size_type  i )

inline

Definition at line 247 of file ROL_PartitionedVector.hpp.

References ROL::PartitionedVector< Real >::vecs_.

template<class Real>

void ROL::PartitionedVector< Real >::set ( size_type  i, const V &  x  )

inline

Definition at line 251 of file ROL_PartitionedVector.hpp.

References ROL::PartitionedVector< Real >::vecs_.

template<class Real>

void ROL::PartitionedVector< Real >::zero ( size_type  i )

inline

Definition at line 255 of file ROL_PartitionedVector.hpp.

References ROL::PartitionedVector< Real >::vecs_.

template<class Real>

size_type ROL::PartitionedVector< Real >::numVectors ( ) const

inline

Definition at line 259 of file ROL_PartitionedVector.hpp.

References ROL::PartitionedVector< Real >::vecs_.

Referenced by ROL::BlockOperator< Real >::apply(), ROL::PartitionedVector< Real >::axpy(), ROL::PartitionedVector< Real >::dot(), ROL::PartitionedVector< Real >::plus(), ROL::PartitionedVector< Real >::set(), and ROL::SlacklessObjective< Real >::zeroSlack().

template<class Real>

static Ptr<PartitionedVector> ROL::PartitionedVector< Real >::create ( std::initializer_list< Vp >  vs )

inlinestatic

Definition at line 266 of file ROL_PartitionedVector.hpp.

Referenced by main(), and ROL::ReducedDynamicObjective< Real >::makeDynamicVector().

template<class Real>

static Ptr<PartitionedVector> ROL::PartitionedVector< Real >::create ( const V &  x, size_type  N  )

inlinestatic

Definition at line 272 of file ROL_PartitionedVector.hpp.

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

Member Data Documentation

template<class Real>

const std::vector<Vp> ROL::PartitionedVector< Real >::vecs_

private

Definition at line 67 of file ROL_PartitionedVector.hpp.

Referenced by ROL::PartitionedVector< Real >::applyBinary(), ROL::PartitionedVector< Real >::applyUnary(), ROL::PartitionedVector< Real >::axpy(), ROL::PartitionedVector< Real >::basis(), ROL::PartitionedVector< Real >::clone(), ROL::PartitionedVector< Real >::dimension(), ROL::PartitionedVector< Real >::dot(), ROL::PartitionedVector< Real >::dual(), ROL::PartitionedVector< Real >::get(), ROL::PartitionedVector< Real >::norm(), ROL::PartitionedVector< Real >::numVectors(), ROL::PartitionedVector< Real >::operator[](), ROL::PartitionedVector< Real >::PartitionedVector(), ROL::PartitionedVector< Real >::plus(), ROL::PartitionedVector< Real >::print(), ROL::PartitionedVector< Real >::randomize(), ROL::PartitionedVector< Real >::reduce(), ROL::PartitionedVector< Real >::scale(), ROL::PartitionedVector< Real >::set(), ROL::PartitionedVector< Real >::setScalar(), and ROL::PartitionedVector< Real >::zero().

template<class Real>

std::vector<Vp> ROL::PartitionedVector< Real >::dual_vecs_

mutableprivate

Definition at line 68 of file ROL_PartitionedVector.hpp.

Referenced by ROL::PartitionedVector< Real >::dual(), and ROL::PartitionedVector< Real >::PartitionedVector().

template<class Real>

ROL::Ptr<PV> ROL::PartitionedVector< Real >::dual_pvec_

mutableprivate

Definition at line 69 of file ROL_PartitionedVector.hpp.

Referenced by ROL::PartitionedVector< Real >::dual().

---

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

• ROL_PartitionedVector.hpp