ROL::InactiveSet_PrimalVector Class 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

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 64 of file ROL_InactiveSetVector.hpp.

Member Typedef Documentation

V

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

private

Definition at line 71 of file ROL_InactiveSetVector.hpp.

Primal

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

private

Definition at line 72 of file ROL_InactiveSetVector.hpp.

Dual

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

private

Definition at line 73 of file ROL_InactiveSetVector.hpp.

Bnd

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

private

Definition at line 74 of file ROL_InactiveSetVector.hpp.

Constructor & Destructor Documentation

InactiveSet_PrimalVector()

ROL::InactiveSet_PrimalVector::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()

virtual ROL::InactiveSet_PrimalVector::~InactiveSet_PrimalVector ( )

inlinevirtual

Definition at line 89 of file ROL_InactiveSetVector.hpp.

Member Function Documentation

dot()

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

inlineoverride

Definition at line 92 of file ROL_InactiveSetVector.hpp.

References bnd_, and x_.

clone()

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

inlineoverride

Definition at line 105 of file ROL_InactiveSetVector.hpp.

References bnd_, and x_.

basis()

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

inlineoverride

Definition at line 111 of file ROL_InactiveSetVector.hpp.

References bnd_, and x_.

dual()

void const V& ROL::InactiveSet_PrimalVector::dual ( ) const

inlineoverride

Definition at line 117 of file ROL_InactiveSetVector.hpp.

References bnd_, and x_.

setIterateVector()

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

inline

Definition at line 124 of file ROL_InactiveSetVector.hpp.

References x_.

getIterateVector() [1/2]

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

inline

Definition at line 125 of file ROL_InactiveSetVector.hpp.

References x_.

getIterateVector() [2/2]

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

inline

Definition at line 126 of file ROL_InactiveSetVector.hpp.

References x_.

Member Data Documentation

x_

Ptr<V> ROL::InactiveSet_PrimalVector::x_

mutableprivate

Definition at line 78 of file ROL_InactiveSetVector.hpp.

Referenced by basis(), clone(), dot(), dual(), getIterateVector(), and setIterateVector().

bnd_

Ptr<Bnd> ROL::InactiveSet_PrimalVector::bnd_

private

Definition at line 79 of file ROL_InactiveSetVector.hpp.

Referenced by basis(), clone(), dot(), and dual().

---

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

• ROL_InactiveSetVector.hpp