ROL::InactiveSet_PrimalVector< Real > Class Template Reference

Defines the a Vector which has a diagonally scaled dot product that neglects active set elements Used to simplify Semi-smooth Newton method implementation. More...

#include <ROL_InactiveSetVector.hpp>

Public Member Functions
	InactiveSet_PrimalVector (const Ptr< V > &vec, const Ptr< V > &scaling_vec, const Ptr< V > &x, const Ptr< Bnd > &bnd)
virtual	~InactiveSet_PrimalVector ()
Real	dot (const V &x) const override
Ptr< V >	clone () const override
Ptr< V >	basis (const int i) const override
void const V &	dual () const override
void	setIterateVector (const Ptr< V > &x) const
const Ptr< V > &	getIterateVector ()
const Ptr< const V > &	getIterateVector () const

Private Types
using	V = Vector< Real >
using	Primal = InactiveSet_PrimalVector< Real >
using	Dual = InactiveSet_DualVector< Real >
using	Bnd = BoundConstraint< Real >

Private Attributes
Ptr< V >	x_
Ptr< Bnd >	bnd_

Detailed Description

template<typename Real>
class ROL::InactiveSet_PrimalVector< Real >

Defines the a Vector which has a diagonally scaled dot product that neglects active set elements Used to simplify Semi-smooth Newton method implementation.

Definition at line 69 of file ROL_InactiveSetVector.hpp.

Member Typedef Documentation

V

template<typename Real >

using ROL::InactiveSet_PrimalVector< Real >::V = Vector<Real>

private

Definition at line 71 of file ROL_InactiveSetVector.hpp.

Primal

template<typename Real >

using ROL::InactiveSet_PrimalVector< Real >::Primal = InactiveSet_PrimalVector<Real>

private

Definition at line 72 of file ROL_InactiveSetVector.hpp.

Dual

template<typename Real >

using ROL::InactiveSet_PrimalVector< Real >::Dual = InactiveSet_DualVector<Real>

private

Definition at line 73 of file ROL_InactiveSetVector.hpp.

Bnd

template<typename Real >

using ROL::InactiveSet_PrimalVector< Real >::Bnd = BoundConstraint<Real>

private

Definition at line 74 of file ROL_InactiveSetVector.hpp.

Constructor & Destructor Documentation

InactiveSet_PrimalVector()

template<typename Real >

ROL::InactiveSet_PrimalVector< Real >::InactiveSet_PrimalVector ( const Ptr< V > &  vec, const Ptr< V > &  scaling_vec, const Ptr< V > &  x, const Ptr< Bnd > &  bnd  )

inline

Definition at line 83 of file ROL_InactiveSetVector.hpp.

~InactiveSet_PrimalVector()

template<typename Real >

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

inlinevirtual

Definition at line 89 of file ROL_InactiveSetVector.hpp.

Member Function Documentation

dot()

template<typename Real >

Real ROL::InactiveSet_PrimalVector< Real >::dot ( const V &  x ) const

inlineoverride

Definition at line 92 of file ROL_InactiveSetVector.hpp.

References ROL::InactiveSet_PrimalVector< Real >::bnd_, and ROL::InactiveSet_PrimalVector< Real >::x_.

clone()

template<typename Real >

Ptr<V> ROL::InactiveSet_PrimalVector< Real >::clone ( ) const

inlineoverride

Definition at line 105 of file ROL_InactiveSetVector.hpp.

References ROL::InactiveSet_PrimalVector< Real >::bnd_, and ROL::InactiveSet_PrimalVector< Real >::x_.

basis()

template<typename Real >

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

inlineoverride

Definition at line 111 of file ROL_InactiveSetVector.hpp.

References ROL::InactiveSet_PrimalVector< Real >::bnd_, and ROL::InactiveSet_PrimalVector< Real >::x_.

dual()

template<typename Real >

void const V& ROL::InactiveSet_PrimalVector< Real >::dual ( ) const

inlineoverride

Definition at line 117 of file ROL_InactiveSetVector.hpp.

References ROL::InactiveSet_PrimalVector< Real >::bnd_, and ROL::InactiveSet_PrimalVector< Real >::x_.

setIterateVector()

template<typename Real >

void ROL::InactiveSet_PrimalVector< Real >::setIterateVector ( const Ptr< V > &  x ) const

inline

Definition at line 124 of file ROL_InactiveSetVector.hpp.

References ROL::InactiveSet_PrimalVector< Real >::x_.

getIterateVector() [1/2]

template<typename Real >

const Ptr<V>& ROL::InactiveSet_PrimalVector< Real >::getIterateVector ( )

inline

Definition at line 125 of file ROL_InactiveSetVector.hpp.

References ROL::InactiveSet_PrimalVector< Real >::x_.

getIterateVector() [2/2]

template<typename Real >

const Ptr<const V>& ROL::InactiveSet_PrimalVector< Real >::getIterateVector ( ) const

inline

Definition at line 126 of file ROL_InactiveSetVector.hpp.

References ROL::InactiveSet_PrimalVector< Real >::x_.

Member Data Documentation

x_

template<typename Real >

Ptr<V> ROL::InactiveSet_PrimalVector< Real >::x_

mutableprivate

Definition at line 78 of file ROL_InactiveSetVector.hpp.

Referenced by ROL::InactiveSet_PrimalVector< Real >::basis(), ROL::InactiveSet_PrimalVector< Real >::clone(), ROL::InactiveSet_PrimalVector< Real >::dot(), ROL::InactiveSet_PrimalVector< Real >::dual(), ROL::InactiveSet_PrimalVector< Real >::getIterateVector(), and ROL::InactiveSet_PrimalVector< Real >::setIterateVector().

bnd_

template<typename Real >

Ptr<Bnd> ROL::InactiveSet_PrimalVector< Real >::bnd_

private

Definition at line 79 of file ROL_InactiveSetVector.hpp.

Referenced by ROL::InactiveSet_PrimalVector< Real >::basis(), ROL::InactiveSet_PrimalVector< Real >::clone(), ROL::InactiveSet_PrimalVector< Real >::dot(), and ROL::InactiveSet_PrimalVector< Real >::dual().

---

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

• ROL_InactiveSetVector.hpp