ROL
Public Types | 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< RCPV > &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...
 
RCPV 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...
 
RCPV 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 print (std::ostream &outStream) const
 
Teuchos::RCP< const Vector< Real > > get (size_type i) const
 
Teuchos::RCP< 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...
 

Private Types

typedef Vector< Real > V
 
typedef Teuchos::RCP< V > RCPV
 
typedef PartitionedVector< Real > PV
 

Private Attributes

const std::vector< RCPV > vecs_
 
std::vector< RCPV > dual_vecs_
 
Teuchos::RCP< 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 58 of file ROL_PartitionedVector.hpp.

Member Typedef Documentation

◆ V

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

Definition at line 60 of file ROL_PartitionedVector.hpp.

◆ RCPV

template<class Real >
typedef Teuchos::RCP<V> ROL::PartitionedVector< Real >::RCPV
private

Definition at line 61 of file ROL_PartitionedVector.hpp.

◆ PV

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

Definition at line 62 of file ROL_PartitionedVector.hpp.

◆ size_type

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

Definition at line 70 of file ROL_PartitionedVector.hpp.

Constructor & Destructor Documentation

◆ PartitionedVector()

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

Definition at line 72 of file ROL_PartitionedVector.hpp.

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

Member Function Documentation

◆ set() [1/2]

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

Set \(y \leftarrow x\) where \(y = \mathtt{*this}\).

Parameters
[in]xis 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 78 of file ROL_PartitionedVector.hpp.

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

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

◆ plus()

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

Compute \(y \leftarrow y + x\), where \(y = \mathtt{*this}\).

Parameters
[in]xis the vector to be added to \(\mathtt{*this}\).

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

Implements ROL::Vector< Real >.

Definition at line 91 of file ROL_PartitionedVector.hpp.

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

◆ scale()

template<class Real >
void ROL::PartitionedVector< Real >::scale ( const Real  alpha)
inlinevirtual

Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\).

Parameters
[in]alphais the scaling of \(\mathtt{*this}\).

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

Implements ROL::Vector< Real >.

Definition at line 104 of file ROL_PartitionedVector.hpp.

◆ axpy()

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]alphais the scaling of x.
[in]xis 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 110 of file ROL_PartitionedVector.hpp.

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

◆ dot()

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

Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\).

Parameters
[in]xis 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 123 of file ROL_PartitionedVector.hpp.

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

◆ norm()

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

◆ clone()

template<class Real >
RCPV 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 146 of file ROL_PartitionedVector.hpp.

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

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

Definition at line 157 of file ROL_PartitionedVector.hpp.

References ROL::PartitionedVector< Real >::dual_pvec_, and ROL::Vector< Real >::set().

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

◆ basis()

template<class Real >
RCPV ROL::PartitionedVector< Real >::basis ( const int  i) const
inlinevirtual

Return i-th basis vector.

Parameters
[in]iis 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 167 of file ROL_PartitionedVector.hpp.

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

◆ dimension()

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

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

Definition at line 211 of file ROL_PartitionedVector.hpp.

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

◆ applyUnary()

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

Reimplemented from ROL::Vector< Real >.

Definition at line 218 of file ROL_PartitionedVector.hpp.

◆ applyBinary()

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

References ROL::PartitionedVector< Real >::get().

◆ reduce()

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

Reimplemented from ROL::Vector< Real >.

Definition at line 233 of file ROL_PartitionedVector.hpp.

◆ print()

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

Reimplemented from ROL::Vector< Real >.

Definition at line 242 of file ROL_PartitionedVector.hpp.

◆ get() [1/2]

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

Definition at line 251 of file ROL_PartitionedVector.hpp.

Referenced by ROL::BlockOperator< Real >::apply(), ROL::PrimalDualInteriorPointBlock11< Real >::apply(), ROL::PrimalDualInteriorPointBlock12< Real >::apply(), ROL::PrimalDualInteriorPointBlock21< Real >::apply(), ROL::PrimalDualInteriorPointBlock22< Real >::apply(), ROL::InteriorPoint::PrimalDualSymmetrizer< Real >::apply(), ROL::EqualityConstraint_Partitioned< Real >::applyAdjointHessian(), ROL::CompositeConstraint< Real >::applyAdjointHessian(), ROL::InteriorPoint::CompositeConstraint< Real >::applyAdjointHessian(), ROL::EqualityConstraint_Partitioned< Real >::applyAdjointJacobian(), ROL::CompositeConstraint< Real >::applyAdjointJacobian(), ROL::InteriorPoint::CompositeConstraint< Real >::applyAdjointJacobian(), ROL::PartitionedVector< Real >::applyBinary(), ROL::PrimalDualInteriorPointBlock22< Real >::applyInverse(), ROL::InteriorPoint::PrimalDualSymmetrizer< Real >::applyInverse(), ROL::EqualityConstraint_Partitioned< Real >::applyJacobian(), ROL::CompositeConstraint< Real >::applyJacobian(), ROL::InteriorPoint::PrimalDualResidual< Real >::applyJacobian(), ROL::PrimalDualInteriorPointResidual< Real >::applyJacobian(), ROL::InteriorPoint::CompositeConstraint< Real >::applyJacobian(), ROL::EqualityConstraint_Partitioned< Real >::applyPreconditioner(), ROL::PartitionedVector< Real >::axpy(), ROL::InteriorPoint::MeritFunction< Real >::dirDeriv(), ROL::PartitionedVector< Real >::dot(), ROL::PrimalDualInteriorPointResidual< Real >::getOptMult(), ROL::InteriorPoint::PenalizedObjective< Real >::gradient(), ROL::InteriorPoint::PenalizedObjective< 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 >::pruneActive(), ROL::BoundConstraint_Partitioned< Real >::pruneLowerActive(), ROL::BoundConstraint_Partitioned< Real >::pruneUpperActive(), ROL::PrimalDualSystemStep< Real >::repartition(), ROL::PartitionedVector< Real >::set(), ROL::PrimalDualInteriorPointBlock11< Real >::update(), ROL::CompositeConstraint< Real >::update(), ROL::BoundConstraint_Partitioned< Real >::update(), ROL::InteriorPoint::PenalizedObjective< Real >::update(), ROL::PrimalDualInteriorPointResidual< Real >::update(), ROL::PrimalDualInteriorPointBlock21< Real >::update(), ROL::PrimalDualInteriorPointBlock22< Real >::update(), ROL::InteriorPoint::CompositeConstraint< Real >::update(), ROL::EqualityConstraint_Partitioned< Real >::value(), ROL::CompositeConstraint< Real >::value(), ROL::InteriorPoint::PrimalDualResidual< Real >::value(), ROL::InteriorPoint::MeritFunction< Real >::value(), ROL::InteriorPoint::PenalizedObjective< Real >::value(), ROL::PrimalDualInteriorPointResidual< Real >::value(), and ROL::InteriorPoint::CompositeConstraint< Real >::value().

◆ get() [2/2]

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

Definition at line 255 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 259 of file ROL_PartitionedVector.hpp.

◆ zero() [2/2]

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

Definition at line 263 of file ROL_PartitionedVector.hpp.

◆ numVectors()

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

Definition at line 267 of file ROL_PartitionedVector.hpp.

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

Member Data Documentation

◆ vecs_

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

Definition at line 65 of file ROL_PartitionedVector.hpp.

◆ dual_vecs_

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

Definition at line 66 of file ROL_PartitionedVector.hpp.

◆ dual_pvec_

template<class Real >
Teuchos::RCP<PV> ROL::PartitionedVector< Real >::dual_pvec_
mutableprivate

Definition at line 67 of file ROL_PartitionedVector.hpp.

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

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