ROL
Public Member Functions | Protected Attributes | Private Attributes | List of all members
ROL::BoundConstraint< Real > Class Template Reference

Provides the interface to apply upper and lower bound constraints. More...

#include <ROL_BoundConstraint.hpp>

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

Public Member Functions

virtual ~BoundConstraint ()
 
 BoundConstraint (void)
 
 BoundConstraint (const Vector< Real > &x)
 
virtual void project (Vector< Real > &x)
 Project optimization variables onto the bounds. More...
 
virtual void projectInterior (Vector< Real > &x)
 Project optimization variables into the interior of the feasible set. More...
 
virtual void pruneUpperActive (Vector< Real > &v, const Vector< Real > &x, Real eps=Real(0))
 Set variables to zero if they correspond to the upper \(\epsilon\)-active set. More...
 
virtual void pruneUpperActive (Vector< Real > &v, const Vector< Real > &g, const Vector< Real > &x, Real xeps=Real(0), Real geps=Real(0))
 Set variables to zero if they correspond to the upper \(\epsilon\)-binding set. More...
 
virtual void pruneLowerActive (Vector< Real > &v, const Vector< Real > &x, Real eps=Real(0))
 Set variables to zero if they correspond to the lower \(\epsilon\)-active set. More...
 
virtual void pruneLowerActive (Vector< Real > &v, const Vector< Real > &g, const Vector< Real > &x, Real xeps=Real(0), Real geps=Real(0))
 Set variables to zero if they correspond to the \(\epsilon\)-binding set. More...
 
virtual const Ptr< const Vector< Real > > getLowerBound (void) const
 Return the ref count pointer to the lower bound vector. More...
 
virtual const Ptr< const Vector< Real > > getUpperBound (void) const
 Return the ref count pointer to the upper bound vector. More...
 
virtual bool isFeasible (const Vector< Real > &v)
 Check if the vector, v, is feasible. More...
 
void activateLower (void)
 Turn on lower bound. More...
 
void activateUpper (void)
 Turn on upper bound. More...
 
void activate (void)
 Turn on bounds. More...
 
void deactivateLower (void)
 Turn off lower bound. More...
 
void deactivateUpper (void)
 Turn off upper bound. More...
 
void deactivate (void)
 Turn off bounds. More...
 
bool isLowerActivated (void) const
 Check if lower bound are on. More...
 
bool isUpperActivated (void) const
 Check if upper bound are on. More...
 
bool isActivated (void) const
 Check if bounds are on. More...
 
void pruneActive (Vector< Real > &v, const Vector< Real > &x, Real eps=Real(0))
 Set variables to zero if they correspond to the \(\epsilon\)-active set. More...
 
void pruneActive (Vector< Real > &v, const Vector< Real > &g, const Vector< Real > &x, Real xeps=Real(0), Real geps=Real(0))
 Set variables to zero if they correspond to the \(\epsilon\)-binding set. More...
 
void pruneLowerInactive (Vector< Real > &v, const Vector< Real > &x, Real eps=Real(0))
 Set variables to zero if they correspond to the \(\epsilon\)-inactive set. More...
 
void pruneUpperInactive (Vector< Real > &v, const Vector< Real > &x, Real eps=Real(0))
 Set variables to zero if they correspond to the \(\epsilon\)-inactive set. More...
 
void pruneLowerInactive (Vector< Real > &v, const Vector< Real > &g, const Vector< Real > &x, Real xeps=Real(0), Real geps=Real(0))
 Set variables to zero if they correspond to the \(\epsilon\)-nonbinding set. More...
 
void pruneUpperInactive (Vector< Real > &v, const Vector< Real > &g, const Vector< Real > &x, Real xeps=Real(0), Real geps=Real(0))
 Set variables to zero if they correspond to the \(\epsilon\)-nonbinding set. More...
 
void pruneInactive (Vector< Real > &v, const Vector< Real > &x, Real eps=Real(0))
 Set variables to zero if they correspond to the \(\epsilon\)-inactive set. More...
 
void pruneInactive (Vector< Real > &v, const Vector< Real > &g, const Vector< Real > &x, Real xeps=Real(0), Real geps=Real(0))
 Set variables to zero if they correspond to the \(\epsilon\)-nonbinding set. More...
 
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...
 

Protected Attributes

Ptr< Vector< Real > > lower_
 
Ptr< Vector< Real > > upper_
 

Private Attributes

bool Lactivated_
 Flag that determines whether or not the lower bounds are being used. More...
 
bool Uactivated_
 Flag that determines whether or not the upper bounds are being used. More...
 

Detailed Description

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

Provides the interface to apply upper and lower bound constraints.

ROL's bound constraint class is to designed to handle point wise bound constraints on optimization variables. That is, let \(\mathcal{X}\) be a Banach space of functions from \(\Xi\) into \(\mathbb{R}\) (for example, \(\Xi\subset\mathbb{R}^d\) for some positive integer \(d\) and \(\mathcal{X}=L^2(\Xi)\) or \(\Xi = \{1,\ldots,n\}\) and \(\mathcal{X}=\mathbb{R}^n\)). For any \(x\in\mathcal{X}\), we consider bounds of the form

\[ a(\xi) \le x(\xi) \le b(\xi) \quad \text{for almost every }\xi\in\Xi. \]

Here, \(a(\xi)\le b(\xi)\) for almost every \(\xi\in\Xi\) and \(a,b\in \mathcal{X}\).

Definition at line 73 of file ROL_BoundConstraint.hpp.

Constructor & Destructor Documentation

◆ ~BoundConstraint()

template<typename Real>
virtual ROL::BoundConstraint< Real >::~BoundConstraint ( )
inlinevirtual

Definition at line 84 of file ROL_BoundConstraint.hpp.

◆ BoundConstraint() [1/2]

template<typename Real >
ROL::BoundConstraint< Real >::BoundConstraint ( void  )

Definition at line 50 of file ROL_BoundConstraint_Def.hpp.

◆ BoundConstraint() [2/2]

template<typename Real >
ROL::BoundConstraint< Real >::BoundConstraint ( const Vector< Real > &  x)

Member Function Documentation

◆ project()

template<typename Real >
void ROL::BoundConstraint< Real >::project ( Vector< Real > &  x)
virtual

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 in H1BoundConstraint< Real >, H1BoundConstraint< Real >, L2BoundConstraint< Real >, H1BoundConstraint< Real >, L2BoundConstraint< Real >, L2BoundConstraint< Real >, BoundConstraint_BurgersControl< Real >, ROL::RiskBoundConstraint< Real >, ROL::BoundConstraint_Partitioned< Real >, ROL::Bounds< Real >, ROL::BoundConstraint_SimOpt< Real >, ROL::SimulatedBoundConstraint< Real >, and ROL::StdBoundConstraint< Real >.

Definition at line 67 of file ROL_BoundConstraint_Def.hpp.

Referenced by ROL::LineSearchStep< Real >::compute(), ROL::PrimalDualActiveSetStep< Real >::compute(), ROL::PrimalDualActiveSetStep< Real >::computeCriticalityMeasure(), ROL::TrustRegionStep< Real >::computeCriticalityMeasure(), ROL::AugmentedLagrangianStep< Real >::computeGradient(), ROL::FletcherStep< Real >::computeProjGradientNorm(), ROL::LineSearchStep< Real >::GradDotStep(), ROL::Step< Real >::initialize(), ROL::TypeB::KelleySachsAlgorithm< Real >::initialize(), ROL::MoreauYosidaPenaltyStep< Real >::initialize(), ROL::AugmentedLagrangianStep< Real >::initialize(), ROL::PrimalDualActiveSetStep< Real >::initialize(), ROL::TrustRegionStep< Real >::initialize(), ROL::TypeB::KelleySachsAlgorithm< Real >::run(), ROL::TypeB::PrimalDualActiveSetAlgorithm< Real >::run(), ROL::ProjectedNewtonStep< Real >::update(), ROL::ProjectedSecantStep< Real >::update(), ROL::TrustRegion< Real >::update(), ROL::ProjectedNewtonKrylovStep< Real >::update(), ROL::InteriorPointStep< Real >::update(), and ROL::LineSearch< Real >::updateIterate().

◆ projectInterior()

template<typename Real >
void ROL::BoundConstraint< Real >::projectInterior ( Vector< Real > &  x)
virtual

Project optimization variables into the interior of the feasible set.

This function implements the projection of \(x\) into the interior of the feasible set, i.e.,

\[ (\bar{P}_{[a,b]}(x))(\xi) \in (a(\xi),b(\xi)) \quad \text{for almost every }\xi\in\Xi. \]

Parameters
[in,out]xis the optimization variable.

Reimplemented in ROL::RiskBoundConstraint< Real >, ROL::BoundConstraint_Partitioned< Real >, ROL::BoundConstraint_SimOpt< Real >, ROL::Bounds< Real >, ROL::SimulatedBoundConstraint< Real >, and ROL::StdBoundConstraint< Real >.

Definition at line 74 of file ROL_BoundConstraint_Def.hpp.

Referenced by ROL::TypeB::InteriorPointAlgorithm< Real >::initialize(), ROL::TypeG::InteriorPointAlgorithm< Real >::initialize(), ROL::InteriorPointStep< Real >::initialize(), and ROL::TrustRegionStep< Real >::initialize().

◆ pruneUpperActive() [1/2]

template<typename Real >
void ROL::BoundConstraint< Real >::pruneUpperActive ( Vector< Real > &  v,
const Vector< Real > &  x,
Real  eps = Real(0) 
)
virtual

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) \ge 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 in H1BoundConstraint< Real >, H1BoundConstraint< Real >, L2BoundConstraint< Real >, H1BoundConstraint< Real >, L2BoundConstraint< Real >, L2BoundConstraint< Real >, BoundConstraint_BurgersControl< Real >, ROL::RiskBoundConstraint< Real >, ROL::BoundConstraint_SimOpt< Real >, ROL::BoundConstraint_Partitioned< Real >, ROL::Bounds< Real >, ROL::SimulatedBoundConstraint< Real >, and ROL::StdBoundConstraint< Real >.

Definition at line 81 of file ROL_BoundConstraint_Def.hpp.

Referenced by ROL::PrimalDualActiveSetStep< Real >::compute().

◆ pruneUpperActive() [2/2]

template<typename Real >
void ROL::BoundConstraint< Real >::pruneUpperActive ( Vector< Real > &  v,
const Vector< Real > &  g,
const Vector< Real > &  x,
Real  xeps = Real(0),
Real  geps = Real(0) 
)
virtual

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) \ge b(\xi)-\epsilon_x,\; g(\xi) < -\epsilon_g \,\}. \]

Parameters
[out]vis the variable to be pruned.
[in]gis the negative search direction.
[in]xis the current optimization variable.
[in]xepsis the active-set tolerance \(\epsilon_x\).
[in]gepsis the binding-set tolerance \(\epsilon_g\).

Reimplemented in H1BoundConstraint< Real >, H1BoundConstraint< Real >, L2BoundConstraint< Real >, H1BoundConstraint< Real >, L2BoundConstraint< Real >, L2BoundConstraint< Real >, BoundConstraint_BurgersControl< Real >, ROL::RiskBoundConstraint< Real >, ROL::BoundConstraint_SimOpt< Real >, ROL::BoundConstraint_Partitioned< Real >, ROL::Bounds< Real >, ROL::SimulatedBoundConstraint< Real >, and ROL::StdBoundConstraint< Real >.

Definition at line 88 of file ROL_BoundConstraint_Def.hpp.

◆ pruneLowerActive() [1/2]

template<typename Real >
void ROL::BoundConstraint< Real >::pruneLowerActive ( Vector< Real > &  v,
const Vector< Real > &  x,
Real  eps = Real(0) 
)
virtual

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) \le 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 in H1BoundConstraint< Real >, H1BoundConstraint< Real >, L2BoundConstraint< Real >, H1BoundConstraint< Real >, L2BoundConstraint< Real >, L2BoundConstraint< Real >, BoundConstraint_BurgersControl< Real >, ROL::RiskBoundConstraint< Real >, ROL::BoundConstraint_SimOpt< Real >, ROL::BoundConstraint_Partitioned< Real >, ROL::SimulatedBoundConstraint< Real >, ROL::Bounds< Real >, and ROL::StdBoundConstraint< Real >.

Definition at line 95 of file ROL_BoundConstraint_Def.hpp.

Referenced by ROL::PrimalDualActiveSetStep< Real >::compute().

◆ pruneLowerActive() [2/2]

template<typename Real >
void ROL::BoundConstraint< Real >::pruneLowerActive ( Vector< Real > &  v,
const Vector< Real > &  g,
const Vector< Real > &  x,
Real  xeps = Real(0),
Real  geps = Real(0) 
)
virtual

Set variables to zero if they correspond to the \(\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) \le a(\xi)+\epsilon,\; g(\xi) > 0 \,\}. \]

Parameters
[out]vis the variable to be pruned.
[in]gis the negative search direction.
[in]xis the current optimization variable.
[in]xepsis the active-set tolerance \(\epsilon_x\).
[in]gepsis the binding-set tolerance \(\epsilon_g\).

Reimplemented in H1BoundConstraint< Real >, H1BoundConstraint< Real >, L2BoundConstraint< Real >, H1BoundConstraint< Real >, L2BoundConstraint< Real >, L2BoundConstraint< Real >, BoundConstraint_BurgersControl< Real >, ROL::RiskBoundConstraint< Real >, ROL::BoundConstraint_SimOpt< Real >, ROL::BoundConstraint_Partitioned< Real >, ROL::SimulatedBoundConstraint< Real >, ROL::Bounds< Real >, and ROL::StdBoundConstraint< Real >.

Definition at line 102 of file ROL_BoundConstraint_Def.hpp.

◆ getLowerBound()

template<typename Real >
const Ptr< const Vector< Real > > ROL::BoundConstraint< Real >::getLowerBound ( void  ) const
virtual

◆ getUpperBound()

template<typename Real >
const Ptr< const Vector< Real > > ROL::BoundConstraint< Real >::getUpperBound ( void  ) const
virtual

◆ isFeasible()

template<typename Real >
bool ROL::BoundConstraint< Real >::isFeasible ( const Vector< Real > &  v)
virtual

◆ activateLower()

template<typename Real >
void ROL::BoundConstraint< Real >::activateLower ( void  )

Turn on lower bound.

This function turns on lower bounds.

Definition at line 138 of file ROL_BoundConstraint_Def.hpp.

Referenced by ROL::Bounds< Real >::Bounds(), and ROL::StdBoundConstraint< Real >::StdBoundConstraint().

◆ activateUpper()

template<typename Real >
void ROL::BoundConstraint< Real >::activateUpper ( void  )

Turn on upper bound.

This function turns on upper bounds.

Definition at line 143 of file ROL_BoundConstraint_Def.hpp.

Referenced by ROL::Bounds< Real >::Bounds(), and ROL::StdBoundConstraint< Real >::StdBoundConstraint().

◆ activate()

template<typename Real >
void ROL::BoundConstraint< Real >::activate ( void  )

◆ deactivateLower()

template<typename Real >
void ROL::BoundConstraint< Real >::deactivateLower ( void  )

Turn off lower bound.

This function turns the lower bounds off.

Definition at line 154 of file ROL_BoundConstraint_Def.hpp.

◆ deactivateUpper()

template<typename Real >
void ROL::BoundConstraint< Real >::deactivateUpper ( void  )

Turn off upper bound.

This function turns the upper bounds off.

Definition at line 159 of file ROL_BoundConstraint_Def.hpp.

◆ deactivate()

template<typename Real >
void ROL::BoundConstraint< Real >::deactivate ( void  )

◆ isLowerActivated()

template<typename Real >
bool ROL::BoundConstraint< Real >::isLowerActivated ( void  ) const

Check if lower bound are on.

This function returns true if the lower bounds are turned on.

Definition at line 170 of file ROL_BoundConstraint_Def.hpp.

Referenced by ROL::BoundConstraint_Partitioned< Real >::BoundConstraint_Partitioned(), and ROL::ObjectiveFromBoundConstraint< Real >::ObjectiveFromBoundConstraint().

◆ isUpperActivated()

template<typename Real >
bool ROL::BoundConstraint< Real >::isUpperActivated ( void  ) const

Check if upper bound are on.

This function returns true if the upper bounds are turned on.

Definition at line 175 of file ROL_BoundConstraint_Def.hpp.

Referenced by ROL::BoundConstraint_Partitioned< Real >::BoundConstraint_Partitioned(), and ROL::ObjectiveFromBoundConstraint< Real >::ObjectiveFromBoundConstraint().

◆ isActivated()

template<typename Real >
bool ROL::BoundConstraint< Real >::isActivated ( void  ) const

◆ pruneActive() [1/2]

template<typename Real >
void ROL::BoundConstraint< Real >::pruneActive ( Vector< Real > &  v,
const Vector< Real > &  x,
Real  eps = Real(0) 
)

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

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

\[ \mathcal{A}_\epsilon(x) = \mathcal{A}^+_\epsilon(x)\cap\mathcal{A}^-_\epsilon(x). \]

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

Definition at line 185 of file ROL_BoundConstraint_Def.hpp.

Referenced by ROL::TypeB::KelleySachsAlgorithm< Real >::applyFreeHessian(), ROL::TypeB::LinMoreAlgorithm< Real >::applyFreeHessian(), ROL::TypeB::KelleySachsAlgorithm< Real >::applyFreePrecond(), ROL::TypeB::LinMoreAlgorithm< Real >::applyFreePrecond(), ROL::ProjectedNewtonStep< Real >::compute(), ROL::ProjectedSecantStep< Real >::compute(), ROL::PrimalDualActiveSetStep< Real >::compute(), ROL::LineSearchStep< Real >::GradDotStep(), ROL::TypeB::KelleySachsAlgorithm< Real >::run(), ROL::TypeB::LinMoreAlgorithm< Real >::run(), ROL::TypeB::PrimalDualActiveSetAlgorithm< Real >::run(), ROL::LineSearch< Real >::status(), and ROL::TrustRegion< Real >::update().

◆ pruneActive() [2/2]

template<typename Real >
void ROL::BoundConstraint< Real >::pruneActive ( Vector< Real > &  v,
const Vector< Real > &  g,
const Vector< Real > &  x,
Real  xeps = Real(0),
Real  geps = Real(0) 
)

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

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

\[ \mathcal{B}^+_\epsilon(x) = \mathcal{B}^+_\epsilon(x)\cap\mathcal{B}^-_\epsilon(x). \]

Parameters
[out]vis the variable to be pruned.
[in]gis the negative search direction.
[in]xis the current optimization variable.
[in]xepsis the active-set tolerance \(\epsilon_x\).
[in]gepsis the binding-set tolerance \(\epsilon_g\).

Definition at line 193 of file ROL_BoundConstraint_Def.hpp.

◆ pruneLowerInactive() [1/2]

template<typename Real >
void ROL::BoundConstraint< Real >::pruneLowerInactive ( Vector< Real > &  v,
const Vector< Real > &  x,
Real  eps = Real(0) 
)

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

This function sets \(v(\xi)=0\) if \(\xi\in\Xi\setminus\mathcal{A}_\epsilon(x)\). Here,

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

Definition at line 201 of file ROL_BoundConstraint_Def.hpp.

References ROL::Vector< Real >::axpy(), and ROL::Vector< Real >::clone().

Referenced by ROL::TypeB::PrimalDualActiveSetAlgorithm< Real >::run().

◆ pruneUpperInactive() [1/2]

template<typename Real >
void ROL::BoundConstraint< Real >::pruneUpperInactive ( Vector< Real > &  v,
const Vector< Real > &  x,
Real  eps = Real(0) 
)

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

This function sets \(v(\xi)=0\) if \(\xi\in\Xi\setminus\mathcal{A}_\epsilon(x)\). Here,

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

Definition at line 212 of file ROL_BoundConstraint_Def.hpp.

References ROL::Vector< Real >::axpy(), and ROL::Vector< Real >::clone().

Referenced by ROL::TypeB::PrimalDualActiveSetAlgorithm< Real >::run().

◆ pruneLowerInactive() [2/2]

template<typename Real >
void ROL::BoundConstraint< Real >::pruneLowerInactive ( Vector< Real > &  v,
const Vector< Real > &  g,
const Vector< Real > &  x,
Real  xeps = Real(0),
Real  geps = Real(0) 
)

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

This function sets \(v(\xi)=0\) if \(\xi\in\Xi\setminus\mathcal{B}_\epsilon(x)\).

Parameters
[out]vis the variable to be pruned.
[in]xis the current optimization variable.
[in]gis the negative search direction.
[in]xepsis the active-set tolerance \(\epsilon_x\).
[in]gepsis the binding-set tolerance \(\epsilon_g\).

Definition at line 223 of file ROL_BoundConstraint_Def.hpp.

References ROL::Vector< Real >::axpy(), and ROL::Vector< Real >::clone().

◆ pruneUpperInactive() [2/2]

template<typename Real >
void ROL::BoundConstraint< Real >::pruneUpperInactive ( Vector< Real > &  v,
const Vector< Real > &  g,
const Vector< Real > &  x,
Real  xeps = Real(0),
Real  geps = Real(0) 
)

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

This function sets \(v(\xi)=0\) if \(\xi\in\Xi\setminus\mathcal{B}_\epsilon(x)\).

Parameters
[out]vis the variable to be pruned.
[in]xis the current optimization variable.
[in]gis the negative search direction.
[in]xepsis the active-set tolerance \(\epsilon_x\).
[in]gepsis the binding-set tolerance \(\epsilon_g\).

Definition at line 234 of file ROL_BoundConstraint_Def.hpp.

References ROL::Vector< Real >::axpy(), and ROL::Vector< Real >::clone().

◆ pruneInactive() [1/2]

template<typename Real >
void ROL::BoundConstraint< Real >::pruneInactive ( Vector< Real > &  v,
const Vector< Real > &  x,
Real  eps = Real(0) 
)

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

This function sets \(v(\xi)=0\) if \(\xi\in\Xi\setminus\mathcal{A}_\epsilon(x)\). Here,

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

Definition at line 245 of file ROL_BoundConstraint_Def.hpp.

References ROL::Vector< Real >::axpy(), and ROL::Vector< Real >::clone().

Referenced by ROL::TypeB::KelleySachsAlgorithm< Real >::applyFreeHessian(), ROL::TypeB::KelleySachsAlgorithm< Real >::applyFreePrecond(), ROL::ProjectedNewtonStep< Real >::compute(), ROL::ProjectedSecantStep< Real >::compute(), ROL::LineSearchStep< Real >::GradDotStep(), ROL::TypeB::PrimalDualActiveSetAlgorithm< Real >::run(), and ROL::LineSearch< Real >::status().

◆ pruneInactive() [2/2]

template<typename Real >
void ROL::BoundConstraint< Real >::pruneInactive ( Vector< Real > &  v,
const Vector< Real > &  g,
const Vector< Real > &  x,
Real  xeps = Real(0),
Real  geps = Real(0) 
)

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

This function sets \(v(\xi)=0\) if \(\xi\in\Xi\setminus\mathcal{B}_\epsilon(x)\).

Parameters
[out]vis the variable to be pruned.
[in]xis the current optimization variable.
[in]gis the negative search direction.
[in]xepsis the active-set tolerance \(\epsilon_x\).
[in]gepsis the binding-set tolerance \(\epsilon_g\).

Definition at line 256 of file ROL_BoundConstraint_Def.hpp.

References ROL::Vector< Real >::axpy(), and ROL::Vector< Real >::clone().

◆ computeProjectedGradient()

template<typename Real >
void ROL::BoundConstraint< Real >::computeProjectedGradient ( Vector< Real > &  g,
const Vector< Real > &  x 
)

Compute projected gradient.

This function projects the gradient \(g\) onto the tangent cone.

Parameters
[in,out]gis the gradient of the objective function at x.
[in]xis the optimization variable

Definition at line 267 of file ROL_BoundConstraint_Def.hpp.

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

Referenced by ROL::TrustRegionStep< Real >::computeCriticalityMeasure(), ROL::ProjectedNewtonStep< Real >::update(), ROL::ProjectedSecantStep< Real >::update(), and ROL::ProjectedNewtonKrylovStep< Real >::update().

◆ computeProjectedStep()

template<typename Real >
void ROL::BoundConstraint< Real >::computeProjectedStep ( Vector< Real > &  v,
const Vector< Real > &  x 
)

Compute projected step.

This function computes the projected step \(P_{[a,b]}(x+v) - x\).

Parameters
[in,out]vis the step variable.
[in]xis the optimization variable.

Definition at line 276 of file ROL_BoundConstraint_Def.hpp.

References ROL::Vector< Real >::axpy(), and ROL::Vector< Real >::plus().

Member Data Documentation

◆ Lactivated_

template<typename Real>
bool ROL::BoundConstraint< Real >::Lactivated_
private

Flag that determines whether or not the lower bounds are being used.

Definition at line 75 of file ROL_BoundConstraint.hpp.

◆ Uactivated_

template<typename Real>
bool ROL::BoundConstraint< Real >::Uactivated_
private

Flag that determines whether or not the upper bounds are being used.

Definition at line 76 of file ROL_BoundConstraint.hpp.

◆ lower_

template<typename Real>
Ptr<Vector<Real> > ROL::BoundConstraint< Real >::lower_
protected

◆ upper_

template<typename Real>
Ptr<Vector<Real> > ROL::BoundConstraint< Real >::upper_
protected

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