ROL
Public Types | Public Member Functions | Static Public Member Functions | Private Types | Private Attributes | List of all members
ROL::PartitionedVector< Real > Class Template Reference
User Interface » Linear Algebra Interface

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)
void plus (const V &x)
void scale (const Real alpha)
 Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\).
void axpy (const Real alpha, const V &x)
Real dot (const V &x) const
Real norm () const
 Returns \( \| y \| \) where \(y = \mathtt{*this}\).
Vp clone () const
 Clone to make a new (uninitialized) vector.
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.
Real apply (const Vector< Real > &x) const
Vp basis (const int i) const
 Return i-th basis vector.
int dimension () const
 Return dimension of the vector space.
void zero ()
 Set to zero vector.
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}\).
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
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::ROL::Vector< Real >
virtual ~Vector ()
virtual void plus (const Vector &x)=0
 Compute \(y \leftarrow y + x\), where \(y = \mathtt{*this}\).
virtual Real dot (const Vector &x) const =0
 Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\).
virtual void axpy (const Real alpha, const Vector &x)
 Compute \(y \leftarrow \alpha x + y\) where \(y = \mathtt{*this}\).
virtual void set (const Vector &x)
 Set \(y \leftarrow x\) where \(y = \mathtt{*this}\).
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 applyBinary (const Elementwise::BinaryFunction< Real > &f, const Vector &x)
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.

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

Member Typedef Documentation

◆ V

template<class Real>
typedef Vector<Real> ROL::PartitionedVector< Real >::V
private

Definition at line 28 of file ROL_PartitionedVector.hpp.

◆ Vp

template<class Real>
typedef ROL::Ptr<V> ROL::PartitionedVector< Real >::Vp
private

Definition at line 29 of file ROL_PartitionedVector.hpp.

◆ PV

template<class Real>
typedef PartitionedVector<Real> ROL::PartitionedVector< Real >::PV
private

Definition at line 30 of file ROL_PartitionedVector.hpp.

◆ size_type

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

Definition at line 38 of file ROL_PartitionedVector.hpp.

Constructor & Destructor Documentation

◆ PartitionedVector()

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

Definition at line 40 of file ROL_PartitionedVector.hpp.

Member Function Documentation

◆ set() [1/2]

template<class Real>
void ROL::PartitionedVector< Real >::set ( const V & x)
inline

Definition at line 46 of file ROL_PartitionedVector.hpp.

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

◆ plus()

template<class Real>
void ROL::PartitionedVector< Real >::plus ( const V & x)
inline

Definition at line 56 of file ROL_PartitionedVector.hpp.

◆ scale()

template<class Real>
void ROL::PartitionedVector< 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::ROL::Vector< Real >.

Definition at line 66 of file ROL_PartitionedVector.hpp.

◆ axpy()

template<class Real>
void ROL::PartitionedVector< Real >::axpy ( const Real alpha,
const V & x )
inline

Definition at line 72 of file ROL_PartitionedVector.hpp.

◆ dot()

template<class Real>
Real ROL::PartitionedVector< Real >::dot ( const V & x) const
inline

Definition at line 83 of file ROL_PartitionedVector.hpp.

◆ norm()

template<class Real>
Real ROL::PartitionedVector< 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::ROL::Vector< Real >.

Definition at line 95 of file ROL_PartitionedVector.hpp.

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

◆ clone()

template<class Real>
Vp ROL::PartitionedVector< Real >::clone ( ) const
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::ROL::Vector< Real >.

Definition at line 103 of file ROL_PartitionedVector.hpp.

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

◆ dual()

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::ROL::Vector< Real >.

Definition at line 111 of file ROL_PartitionedVector.hpp.

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

◆ apply()

template<class Real>
Real ROL::PartitionedVector< Real >::apply ( const Vector< Real > & x) const
inline

Definition at line 119 of file ROL_PartitionedVector.hpp.

◆ basis()

template<class Real>
Vp ROL::PartitionedVector< Real >::basis ( const int i) const
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::ROL::Vector< Real >.

Definition at line 131 of file ROL_PartitionedVector.hpp.

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

◆ dimension()

template<class Real>
int ROL::PartitionedVector< Real >::dimension ( void ) const
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::ROL::Vector< Real >.

Definition at line 154 of file ROL_PartitionedVector.hpp.

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

◆ zero() [1/2]

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::ROL::Vector< Real >.

Definition at line 162 of file ROL_PartitionedVector.hpp.

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

◆ applyUnary()

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

Reimplemented from ROL::ROL::Vector< Real >.

Definition at line 169 of file ROL_PartitionedVector.hpp.

◆ applyBinary()

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

Definition at line 176 of file ROL_PartitionedVector.hpp.

◆ reduce()

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

Reimplemented from ROL::ROL::Vector< Real >.

Definition at line 184 of file ROL_PartitionedVector.hpp.

Referenced by ROL::size_type< Real >::reduce().

◆ setScalar()

template<class Real>
void ROL::PartitionedVector< Real >::setScalar ( const Real C)
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::ROL::Vector< Real >.

Definition at line 193 of file ROL_PartitionedVector.hpp.

◆ randomize()

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

  @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::ROL::Vector< Real >.

Definition at line 199 of file ROL_PartitionedVector.hpp.

◆ print()

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

Reimplemented from ROL::ROL::Vector< Real >.

Definition at line 205 of file ROL_PartitionedVector.hpp.

◆ operator[]() [1/2]

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

Definition at line 213 of file ROL_PartitionedVector.hpp.

◆ operator[]() [2/2]

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

Definition at line 217 of file ROL_PartitionedVector.hpp.

◆ get() [1/2]

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

Definition at line 221 of file ROL_PartitionedVector.hpp.

Referenced by ROL::AugmentedSystemOperator< Real >::apply(), ROL::BlockOperator< Real >::apply(), ROL::BoundFletcher< Real >::AugSystemNonSym::apply(), ROL::BoundFletcher< Real >::AugSystemSym::apply(), ROL::Fletcher< Real >::AugSystem::apply(), ROL::FletcherObjectiveE< Real >::AugSystem::apply(), ROL::InteriorPoint::PrimalDualSymmetrizer< Real >::apply(), ROL::PrimalDualInteriorPointBlock11< Real >::apply(), ROL::PrimalDualInteriorPointBlock12< Real >::apply(), ROL::PrimalDualInteriorPointBlock21< Real >::apply(), ROL::PrimalDualInteriorPointBlock22< Real >::apply(), ROL::size_type< Real >::apply(), ROL::TypeB::PrimalDualActiveSetAlgorithm< Real >::HessianPDAS_Poly::apply(), ROL::Constraint_Partitioned< Real >::applyAdjointHessian(), ROL::BoundToConstraint< Real >::applyAdjointJacobian(), ROL::Constraint_Partitioned< Real >::applyAdjointJacobian(), ROL::size_type< Real >::applyBinary(), ROL::AugmentedSystemPrecOperator< Real >::applyInverse(), ROL::BoundFletcher< Real >::AugSystemPrecond::applyInverse(), ROL::Fletcher< Real >::AugSystemPrecond::applyInverse(), ROL::FletcherObjectiveE< Real >::AugSystemPrecond::applyInverse(), ROL::InteriorPoint::PrimalDualSymmetrizer< Real >::applyInverse(), ROL::PrimalDualInteriorPointBlock22< Real >::applyInverse(), ROL::TypeB::PrimalDualActiveSetAlgorithm< Real >::PrecondPDAS_Poly::applyInverse(), ROL::BoundConstraint_Partitioned< Real >::applyInverseScalingFunction(), ROL::BoundToConstraint< Real >::applyJacobian(), ROL::Constraint_Partitioned< Real >::applyJacobian(), ROL::InteriorPoint::PrimalDualResidual< Real >::applyJacobian(), ROL::PrimalDualInteriorPointResidual< Real >::applyJacobian(), ROL::Constraint_Partitioned< Real >::applyPreconditioner(), ROL::BoundConstraint_Partitioned< Real >::applyScalingFunctionJacobian(), ROL::size_type< Real >::axpy(), ROL::InteriorPoint::MeritFunction< Real >::dirDeriv(), ROL::size_type< Real >::dot(), ROL::Problem< Real >::finalizeIteration(), ROL::Constraint_TimeSimOpt< Real >::getNewVector(), ROL::Constraint_TimeSimOpt< Real >::getNewVector(), ROL::Constraint_TimeSimOpt< Real >::getOldVector(), ROL::Constraint_TimeSimOpt< Real >::getOldVector(), ROL::PrimalDualInteriorPointResidual< Real >::getOptMult(), ROL::PrimalDualInteriorPointResidual< Real >::getOptMult(), ROL::ReducedDynamicObjective< Real >::gradient(), ROL::ReducedDynamicObjective< Real >::hessVec(), ROL::SlacklessObjective< Real >::invHessVec(), ROL::BoundConstraint_Partitioned< Real >::isFeasible(), ROL::InteriorPoint::MeritFunction< Real >::MeritFunction(), ROL::size_type< Real >::plus(), ROL::SlacklessObjective< Real >::precond(), ROL::PrimalDualInteriorPointBlock11< Real >::PrimalDualInteriorPointBlock11(), ROL::PrimalDualInteriorPointBlock21< Real >::PrimalDualInteriorPointBlock21(), ROL::PrimalDualInteriorPointBlock22< Real >::PrimalDualInteriorPointBlock22(), ROL::PrimalDualInteriorPointResidual< Real >::PrimalDualInteriorPointResidual(), 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 >::pruneLowerActive(), ROL::BoundConstraint_Partitioned< Real >::pruneUpperActive(), ROL::BoundConstraint_Partitioned< Real >::pruneUpperActive(), ROL::PrimalDualSystemStep< Real >::repartition(), ROL::PrimalDualSystemStep< Real >::repartition(), ROL::size_type< Real >::set(), ROL::ReducedDynamicObjective< Real >::solveAdjoint(), ROL::ReducedDynamicObjective< Real >::solveState(), ROL::PrimalDualInteriorPointBlock11< Real >::update(), ROL::PrimalDualInteriorPointBlock21< Real >::update(), ROL::PrimalDualInteriorPointBlock22< Real >::update(), ROL::PrimalDualInteriorPointResidual< Real >::update(), ROL::ReducedDynamicObjective< Real >::updateSketch(), ROL::BoundToConstraint< Real >::value(), ROL::Constraint_Partitioned< Real >::value(), ROL::InteriorPoint::MeritFunction< Real >::value(), ROL::InteriorPoint::PrimalDualResidual< Real >::value(), ROL::PrimalDualInteriorPointResidual< Real >::value(), ROL::ReducedDynamicObjective< Real >::value(), ROL::SlacklessConstraint< Real >::zeroSlack(), and ROL::SlacklessObjective< Real >::zeroSlack().

◆ get() [2/2]

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

Definition at line 225 of file ROL_PartitionedVector.hpp.

◆ set() [2/2]

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

Definition at line 229 of file ROL_PartitionedVector.hpp.

◆ zero() [2/2]

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

Definition at line 233 of file ROL_PartitionedVector.hpp.

◆ numVectors()

template<class Real>
size_type ROL::PartitionedVector< Real >::numVectors ( ) const
inline

Definition at line 237 of file ROL_PartitionedVector.hpp.

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

◆ create() [1/2]

template<class Real>
Ptr< PartitionedVector > ROL::PartitionedVector< Real >::create ( std::initializer_list< Vp > vs)
inlinestatic

Definition at line 244 of file ROL_PartitionedVector.hpp.

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

◆ create() [2/2]

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

Definition at line 250 of file ROL_PartitionedVector.hpp.

Member Data Documentation

◆ vecs_

template<class Real>
const std::vector<Vp> ROL::PartitionedVector< Real >::vecs_
private

Definition at line 33 of file ROL_PartitionedVector.hpp.

◆ dual_vecs_

template<class Real>
std::vector<Vp> ROL::PartitionedVector< Real >::dual_vecs_
mutableprivate

Definition at line 34 of file ROL_PartitionedVector.hpp.

◆ dual_pvec_

template<class Real>
ROL::Ptr<PV> ROL::PartitionedVector< Real >::dual_pvec_
mutableprivate

Definition at line 35 of file ROL_PartitionedVector.hpp.

The documentation for this class was generated from the following file:
Generated by doxygen 1.15.0