ROL
Public Member Functions | Private Types | Private Attributes | Static Private Attributes | List of all members
ROL::InteriorPointBoundConstraint< Real > Class Template Reference

Require positivity of slack variables. More...

#include <ROL_InteriorPoint.hpp>

+ Inheritance diagram for ROL::InteriorPointBoundConstraint< Real >:

Public Member Functions

 InteriorPointBoundConstraint (const Vector< Real > &x)
 
void project (Vector< Real > &x)
 Project optimization variables onto the bounds. More...
 
void pruneUpperActive (Vector< Real > &v, const Vector< Real > &x, Real eps)
 Set variables to zero if they correspond to the upper \(\epsilon\)-active set. More...
 
void pruneUpperActive (Vector< Real > &v, const Vector< Real > &g, const Vector< Real > &x, Real eps)
 Set variables to zero if they correspond to the upper \(\epsilon\)-binding set. More...
 
void pruneLowerActive (Vector< Real > &v, const Vector< Real > &x, Real eps)
 Set variables to zero if they correspond to the lower \(\epsilon\)-active set. More...
 
void pruneLowerActive (Vector< Real > &v, const Vector< Real > &g, const Vector< Real > &x, Real eps)
 Set variables to zero if they correspond to the lower \(\epsilon\)-binding set. More...
 
void setVectorToUpperBound (Vector< Real > &u)
 Set the input vector to the upper bound. More...
 
void setVectorToLowerBound (Vector< Real > &l)
 Set the input vector to the lower bound. More...
 
bool isFeasible (const Vector< Real > &v)
 Check if the vector, v, is feasible. More...
 
- Public Member Functions inherited from ROL::BoundConstraint< Real >
virtual ~BoundConstraint ()
 
 BoundConstraint (void)
 
 BoundConstraint (const Teuchos::RCP< Vector< Real > > &x_lo, const Teuchos::RCP< Vector< Real > > &x_up, Real scale=1.0)
 Default constructor. More...
 
virtual void update (const Vector< Real > &x, bool flag=true, int iter=-1)
 Update bounds. More...
 
virtual void pruneActive (Vector< Real > &v, const Vector< Real > &x, Real eps=0.0)
 Set variables to zero if they correspond to the \(\epsilon\)-active set. More...
 
virtual void pruneActive (Vector< Real > &v, const Vector< Real > &g, const Vector< Real > &x, Real eps=0.0)
 Set variables to zero if they correspond to the \(\epsilon\)-binding set. More...
 
void activate (void)
 Turn on bounds. More...
 
void deactivate (void)
 Turn off bounds. More...
 
bool isActivated (void)
 Check if bounds are on. More...
 
void pruneInactive (Vector< Real > &v, const Vector< Real > &x, Real eps=0.0)
 Set variables to zero if they correspond to the \(\epsilon\)-inactive set. More...
 
void pruneLowerInactive (Vector< Real > &v, const Vector< Real > &x, Real eps=0.0)
 
void pruneUpperInactive (Vector< Real > &v, const Vector< Real > &x, Real eps=0.0)
 
void pruneInactive (Vector< Real > &v, const Vector< Real > &g, const Vector< Real > &x, Real eps=0.0)
 Set variables to zero if they correspond to the \(\epsilon\)-nonbinding set. More...
 
void pruneLowerInactive (Vector< Real > &v, const Vector< Real > &g, const Vector< Real > &x, Real eps=0.0)
 
void pruneUpperInactive (Vector< Real > &v, const Vector< Real > &g, const Vector< Real > &x, Real eps=0.0)
 
void computeProjectedGradient (Vector< Real > &g, const Vector< Real > &x)
 Compute projected gradient. More...
 
void computeProjectedStep (Vector< Real > &v, const Vector< Real > &x)
 Compute projected step. More...
 

Private Types

typedef Vector< Real > V
 
typedef PartitionedVector< Real > PV
 
typedef PV::size_type size_type
 

Private Attributes

Teuchos::RCP< BoundConstraint< Real > > bc_
 
Teuchos::RCP< Vector< Real > > lower_
 
Teuchos::RCP< Vector< Real > > upper_
 

Static Private Attributes

static const size_type OPT = 0
 
static const size_type SLACK = 1
 

Detailed Description

template<class Real>
class ROL::InteriorPointBoundConstraint< Real >

Require positivity of slack variables.

Definition at line 352 of file ROL_InteriorPoint.hpp.

Member Typedef Documentation

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

Definition at line 354 of file ROL_InteriorPoint.hpp.

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

Definition at line 355 of file ROL_InteriorPoint.hpp.

template<class Real >
typedef PV::size_type ROL::InteriorPointBoundConstraint< Real >::size_type
private

Definition at line 356 of file ROL_InteriorPoint.hpp.

Constructor & Destructor Documentation

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

Member Function Documentation

template<class Real >
void ROL::InteriorPointBoundConstraint< Real >::project ( Vector< Real > &  x)
inlinevirtual

Project optimization variables onto the bounds.

This function implements the projection of \(x\) onto the bounds, i.e.,

\[ (P_{[a,b]}(x))(\xi) = \min\{b(\xi),\max\{a(\xi),x(\xi)\}\} \quad \text{for almost every }\xi\in\Xi. \]

Parameters
[in,out]xis the optimization variable.

Reimplemented from ROL::BoundConstraint< Real >.

Definition at line 395 of file ROL_InteriorPoint.hpp.

template<class Real >
void ROL::InteriorPointBoundConstraint< Real >::pruneUpperActive ( Vector< Real > &  v,
const Vector< Real > &  x,
Real  eps 
)
inlinevirtual

Set variables to zero if they correspond to the upper \(\epsilon\)-active set.

This function sets \(v(\xi)=0\) if \(\xi\in\mathcal{A}^+_\epsilon(x)\). Here, the upper \(\epsilon\)-active set is defined as

\[ \mathcal{A}^+_\epsilon(x) = \{\,\xi\in\Xi\,:\,x(\xi) = b(\xi)-\epsilon\,\}. \]

Parameters
[out]vis the variable to be pruned.
[in]xis the current optimization variable.
[in]epsis the active-set tolerance \(\epsilon\).

Reimplemented from ROL::BoundConstraint< Real >.

Definition at line 399 of file ROL_InteriorPoint.hpp.

template<class Real >
void ROL::InteriorPointBoundConstraint< Real >::pruneUpperActive ( Vector< Real > &  v,
const Vector< Real > &  g,
const Vector< Real > &  x,
Real  eps 
)
inlinevirtual

Set variables to zero if they correspond to the upper \(\epsilon\)-binding set.

This function sets \(v(\xi)=0\) if \(\xi\in\mathcal{B}^+_\epsilon(x)\). Here, the upper \(\epsilon\)-binding set is defined as

\[ \mathcal{B}^+_\epsilon(x) = \{\,\xi\in\Xi\,:\,x(\xi) = b(\xi)-\epsilon,\; g(\xi) < 0 \,\}. \]

Parameters
[out]vis the variable to be pruned.
[in]xis the current optimization variable.
[in]gis the negative search direction.
[in]epsis the active-set tolerance \(\epsilon\).

Reimplemented from ROL::BoundConstraint< Real >.

Definition at line 403 of file ROL_InteriorPoint.hpp.

template<class Real >
void ROL::InteriorPointBoundConstraint< Real >::pruneLowerActive ( Vector< Real > &  v,
const Vector< Real > &  x,
Real  eps 
)
inlinevirtual

Set variables to zero if they correspond to the lower \(\epsilon\)-active set.

This function sets \(v(\xi)=0\) if \(\xi\in\mathcal{A}^-_\epsilon(x)\). Here, the lower \(\epsilon\)-active set is defined as

\[ \mathcal{A}^-_\epsilon(x) = \{\,\xi\in\Xi\,:\,x(\xi) = a(\xi)+\epsilon\,\}. \]

Parameters
[out]vis the variable to be pruned.
[in]xis the current optimization variable.
[in]epsis the active-set tolerance \(\epsilon\).

Reimplemented from ROL::BoundConstraint< Real >.

Definition at line 408 of file ROL_InteriorPoint.hpp.

template<class Real >
void ROL::InteriorPointBoundConstraint< Real >::pruneLowerActive ( Vector< Real > &  v,
const Vector< Real > &  g,
const Vector< Real > &  x,
Real  eps 
)
inlinevirtual

Set variables to zero if they correspond to the lower \(\epsilon\)-binding set.

This function sets \(v(\xi)=0\) if \(\xi\in\mathcal{B}^-_\epsilon(x)\). Here, the lower \(\epsilon\)-binding set is defined as

\[ \mathcal{B}^-_\epsilon(x) = \{\,\xi\in\Xi\,:\,x(\xi) = a(\xi)+\epsilon,\; g(\xi) > 0 \,\}. \]

Parameters
[out]vis the variable to be pruned.
[in]xis the current optimization variable.
[in]gis the negative search direction.
[in]epsis the active-set tolerance \(\epsilon\).

Reimplemented from ROL::BoundConstraint< Real >.

Definition at line 412 of file ROL_InteriorPoint.hpp.

template<class Real >
void ROL::InteriorPointBoundConstraint< Real >::setVectorToUpperBound ( Vector< Real > &  u)
inlinevirtual

Set the input vector to the upper bound.

This function sets the input vector \(u\) to the upper bound \(b\).

Parameters
[out]uis the vector to be set to the upper bound.

Reimplemented from ROL::BoundConstraint< Real >.

Definition at line 417 of file ROL_InteriorPoint.hpp.

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

template<class Real >
void ROL::InteriorPointBoundConstraint< Real >::setVectorToLowerBound ( Vector< Real > &  l)
inlinevirtual

Set the input vector to the lower bound.

This function sets the input vector \(l\) to the lower bound \(a\).

Parameters
[out]lis the vector to be set to the lower bound.

Reimplemented from ROL::BoundConstraint< Real >.

Definition at line 421 of file ROL_InteriorPoint.hpp.

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

template<class Real >
bool ROL::InteriorPointBoundConstraint< Real >::isFeasible ( const Vector< Real > &  v)
inlinevirtual

Check if the vector, v, is feasible.

This function returns true if \(v = P_{[a,b]}(v)\).

Parameters
[in]vis the vector to be checked.

Reimplemented from ROL::BoundConstraint< Real >.

Definition at line 425 of file ROL_InteriorPoint.hpp.

Member Data Documentation

template<class Real >
const size_type ROL::InteriorPointBoundConstraint< Real >::OPT = 0
staticprivate

Definition at line 358 of file ROL_InteriorPoint.hpp.

template<class Real >
const size_type ROL::InteriorPointBoundConstraint< Real >::SLACK = 1
staticprivate

Definition at line 359 of file ROL_InteriorPoint.hpp.

template<class Real >
Teuchos::RCP<BoundConstraint<Real> > ROL::InteriorPointBoundConstraint< Real >::bc_
private

Definition at line 361 of file ROL_InteriorPoint.hpp.

template<class Real >
Teuchos::RCP<Vector<Real> > ROL::InteriorPointBoundConstraint< Real >::lower_
private

Definition at line 363 of file ROL_InteriorPoint.hpp.

template<class Real >
Teuchos::RCP<Vector<Real> > ROL::InteriorPointBoundConstraint< Real >::upper_
private

Definition at line 364 of file ROL_InteriorPoint.hpp.


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