ROL
|
A composite composite BoundConstraint formed from bound constraints on subvectors of a PartitionedVector. More...
#include <ROL_BoundConstraint_Partitioned.hpp>
Public Member Functions | |
~BoundConstraint_Partitioned () | |
BoundConstraint_Partitioned (const std::vector< Teuchos::RCP< BoundConstraint< Real > > > &bnd) | |
Default constructor. More... | |
void | update (const Vector< Real > &x, bool flag=true, int iter=-1) |
Update bounds. More... | |
void | project (Vector< Real > &x) |
Project optimization variables onto the bounds. More... | |
void | pruneUpperActive (Vector< Real > &v, const Vector< Real > &x, Real eps=0.0) |
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=0.0) |
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=0.0) |
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=0.0) |
Set variables to zero if they correspond to the lower \(\epsilon\)-binding set. More... | |
const Teuchos::RCP< const Vector< Real > > | getLowerVectorRCP (void) const |
Return the ref count pointer to the lower bound vector. More... | |
const Teuchos::RCP< const Vector< Real > > | getUpperVectorRCP (void) const |
Return the ref count pointer to the upper bound vector. More... | |
const Teuchos::RCP< Vector< Real > > | getLowerVectorRCP (void) |
Return the ref count pointer to the lower bound vector. More... | |
const Teuchos::RCP< Vector< Real > > | getUpperVectorRCP (void) |
Return the ref count pointer to the upper bound vector. 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... | |
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... | |
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... | |
bool | isFeasible (const Vector< Real > &v) |
Check if the vector, v, is feasible. More... | |
![]() | |
virtual | ~BoundConstraint () |
BoundConstraint (void) | |
BoundConstraint (const Vector< Real > &x) | |
BoundConstraint (const Teuchos::RCP< Vector< Real > > &x_lo, const Teuchos::RCP< Vector< Real > > &x_up, const Real scale=1) | |
Default constructor. 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) |
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) |
void | pruneUpperInactive (Vector< Real > &v, const Vector< Real > &x, Real eps=0) |
void | pruneInactive (Vector< Real > &v, const Vector< Real > &g, const Vector< Real > &x, Real eps=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) |
void | pruneUpperInactive (Vector< Real > &v, const Vector< Real > &g, const Vector< Real > &x, Real eps=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 std::vector< Real >::size_type | uint |
Private Attributes | |
std::vector< Teuchos::RCP< BoundConstraint< Real > > > | bnd_ |
Teuchos::RCP< V > | l_ |
Teuchos::RCP< V > | u_ |
uint | dim_ |
A composite composite BoundConstraint formed from bound constraints on subvectors of a PartitionedVector.
Definition at line 61 of file ROL_BoundConstraint_Partitioned.hpp.
|
private |
Definition at line 63 of file ROL_BoundConstraint_Partitioned.hpp.
|
private |
Definition at line 64 of file ROL_BoundConstraint_Partitioned.hpp.
|
private |
Definition at line 65 of file ROL_BoundConstraint_Partitioned.hpp.
|
inline |
Definition at line 76 of file ROL_BoundConstraint_Partitioned.hpp.
|
inline |
Default constructor.
The default constructor automatically turns the constraints on.
Definition at line 82 of file ROL_BoundConstraint_Partitioned.hpp.
References ROL::BoundConstraint< Real >::activate(), ROL::BoundConstraint_Partitioned< Real >::bnd_, ROL::BoundConstraint< Real >::deactivate(), ROL::BoundConstraint_Partitioned< Real >::dim_, ROL::BoundConstraint_Partitioned< Real >::getLowerVectorRCP(), ROL::BoundConstraint_Partitioned< Real >::getUpperVectorRCP(), ROL::BoundConstraint< Real >::isActivated(), ROL::BoundConstraint_Partitioned< Real >::l_, and ROL::BoundConstraint_Partitioned< Real >::u_.
|
inlinevirtual |
Update bounds.
The update function allows the user to update the bounds at each new iterations.
[in] | x | is the optimization variable. |
[in] | flag | is set to true if control is changed. |
[in] | iter | is the outer algorithm iterations count. |
Reimplemented from ROL::BoundConstraint< Real >.
Definition at line 113 of file ROL_BoundConstraint_Partitioned.hpp.
References ROL::BoundConstraint_Partitioned< Real >::bnd_, ROL::BoundConstraint_Partitioned< Real >::dim_, ROL::PartitionedVector< Real >::get(), and ROL::BoundConstraint< Real >::isActivated().
|
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. \]
[in,out] | x | is the optimization variable. |
Reimplemented from ROL::BoundConstraint< Real >.
Definition at line 132 of file ROL_BoundConstraint_Partitioned.hpp.
References ROL::BoundConstraint_Partitioned< Real >::bnd_, ROL::BoundConstraint_Partitioned< Real >::dim_, ROL::PartitionedVector< Real >::get(), and ROL::BoundConstraint< Real >::isActivated().
|
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\,\}. \]
[out] | v | is the variable to be pruned. |
[in] | x | is the current optimization variable. |
[in] | eps | is the active-set tolerance \(\epsilon\). |
Reimplemented from ROL::BoundConstraint< Real >.
Definition at line 153 of file ROL_BoundConstraint_Partitioned.hpp.
References ROL::BoundConstraint_Partitioned< Real >::bnd_, ROL::BoundConstraint_Partitioned< Real >::dim_, ROL::PartitionedVector< Real >::get(), and ROL::BoundConstraint< Real >::isActivated().
|
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 \,\}. \]
[out] | v | is the variable to be pruned. |
[in] | x | is the current optimization variable. |
[in] | g | is the negative search direction. |
[in] | eps | is the active-set tolerance \(\epsilon\). |
Reimplemented from ROL::BoundConstraint< Real >.
Definition at line 181 of file ROL_BoundConstraint_Partitioned.hpp.
References ROL::BoundConstraint_Partitioned< Real >::bnd_, ROL::BoundConstraint_Partitioned< Real >::dim_, ROL::PartitionedVector< Real >::get(), and ROL::BoundConstraint< Real >::isActivated().
|
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\,\}. \]
[out] | v | is the variable to be pruned. |
[in] | x | is the current optimization variable. |
[in] | eps | is the active-set tolerance \(\epsilon\). |
Reimplemented from ROL::BoundConstraint< Real >.
Definition at line 208 of file ROL_BoundConstraint_Partitioned.hpp.
References ROL::BoundConstraint_Partitioned< Real >::bnd_, ROL::BoundConstraint_Partitioned< Real >::dim_, ROL::PartitionedVector< Real >::get(), and ROL::BoundConstraint< Real >::isActivated().
|
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 \,\}. \]
[out] | v | is the variable to be pruned. |
[in] | x | is the current optimization variable. |
[in] | g | is the negative search direction. |
[in] | eps | is the active-set tolerance \(\epsilon\). |
Reimplemented from ROL::BoundConstraint< Real >.
Definition at line 236 of file ROL_BoundConstraint_Partitioned.hpp.
References ROL::BoundConstraint_Partitioned< Real >::bnd_, ROL::BoundConstraint_Partitioned< Real >::dim_, ROL::PartitionedVector< Real >::get(), and ROL::BoundConstraint< Real >::isActivated().
|
inlinevirtual |
Return the ref count pointer to the lower bound vector.
Reimplemented from ROL::BoundConstraint< Real >.
Definition at line 251 of file ROL_BoundConstraint_Partitioned.hpp.
References ROL::BoundConstraint_Partitioned< Real >::l_.
Referenced by ROL::BoundConstraint_Partitioned< Real >::BoundConstraint_Partitioned().
|
inlinevirtual |
Return the ref count pointer to the upper bound vector.
Reimplemented from ROL::BoundConstraint< Real >.
Definition at line 257 of file ROL_BoundConstraint_Partitioned.hpp.
References ROL::BoundConstraint_Partitioned< Real >::u_.
Referenced by ROL::BoundConstraint_Partitioned< Real >::BoundConstraint_Partitioned().
|
inlinevirtual |
Return the ref count pointer to the lower bound vector.
Reimplemented from ROL::BoundConstraint< Real >.
Definition at line 261 of file ROL_BoundConstraint_Partitioned.hpp.
References ROL::BoundConstraint_Partitioned< Real >::l_.
|
inlinevirtual |
Return the ref count pointer to the upper bound vector.
Reimplemented from ROL::BoundConstraint< Real >.
Definition at line 265 of file ROL_BoundConstraint_Partitioned.hpp.
References ROL::BoundConstraint_Partitioned< Real >::u_.
|
inlinevirtual |
Set the input vector to the upper bound.
This function sets the input vector \(u\) to the upper bound \(b\).
[out] | u | is the vector to be set to the upper bound. |
Reimplemented from ROL::BoundConstraint< Real >.
Definition at line 276 of file ROL_BoundConstraint_Partitioned.hpp.
References ROL::Vector< Real >::set(), and ROL::BoundConstraint_Partitioned< Real >::u_.
|
inlinevirtual |
Set the input vector to the lower bound.
This function sets the input vector \(l\) to the lower bound \(a\).
[out] | l | is the vector to be set to the lower bound. |
Reimplemented from ROL::BoundConstraint< Real >.
Definition at line 292 of file ROL_BoundConstraint_Partitioned.hpp.
References ROL::BoundConstraint_Partitioned< Real >::l_, and ROL::Vector< Real >::set().
|
inlinevirtual |
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). \]
[out] | v | is the variable to be pruned. |
[in] | x | is the current optimization variable. |
[in] | eps | is the active-set tolerance \(\epsilon\). |
Reimplemented from ROL::BoundConstraint< Real >.
Definition at line 314 of file ROL_BoundConstraint_Partitioned.hpp.
References ROL::BoundConstraint_Partitioned< Real >::bnd_, ROL::BoundConstraint_Partitioned< Real >::dim_, ROL::PartitionedVector< Real >::get(), and ROL::BoundConstraint< Real >::isActivated().
|
inlinevirtual |
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). \]
[out] | v | is the variable to be pruned. |
[in] | x | is the current optimization variable. |
[in] | g | is the negative search direction. |
[in] | eps | is the active-set tolerance \(\epsilon\). |
Reimplemented from ROL::BoundConstraint< Real >.
Definition at line 341 of file ROL_BoundConstraint_Partitioned.hpp.
References ROL::BoundConstraint_Partitioned< Real >::bnd_, ROL::BoundConstraint_Partitioned< Real >::dim_, ROL::PartitionedVector< Real >::get(), and ROL::BoundConstraint< Real >::isActivated().
|
inlinevirtual |
Check if the vector, v, is feasible.
This function returns true if \(v = P_{[a,b]}(v)\).
[in] | v | is the vector to be checked. |
Reimplemented from ROL::BoundConstraint< Real >.
Definition at line 365 of file ROL_BoundConstraint_Partitioned.hpp.
References ROL::BoundConstraint_Partitioned< Real >::bnd_, ROL::BoundConstraint_Partitioned< Real >::dim_, ROL::PartitionedVector< Real >::get(), and ROL::BoundConstraint< Real >::isActivated().
|
private |
Definition at line 68 of file ROL_BoundConstraint_Partitioned.hpp.
Referenced by ROL::BoundConstraint_Partitioned< Real >::BoundConstraint_Partitioned(), ROL::BoundConstraint_Partitioned< Real >::isFeasible(), ROL::BoundConstraint_Partitioned< Real >::project(), ROL::BoundConstraint_Partitioned< Real >::pruneActive(), ROL::BoundConstraint_Partitioned< Real >::pruneLowerActive(), ROL::BoundConstraint_Partitioned< Real >::pruneUpperActive(), and ROL::BoundConstraint_Partitioned< Real >::update().
|
private |
|
private |
|
private |
Definition at line 73 of file ROL_BoundConstraint_Partitioned.hpp.
Referenced by ROL::BoundConstraint_Partitioned< Real >::BoundConstraint_Partitioned(), ROL::BoundConstraint_Partitioned< Real >::isFeasible(), ROL::BoundConstraint_Partitioned< Real >::project(), ROL::BoundConstraint_Partitioned< Real >::pruneActive(), ROL::BoundConstraint_Partitioned< Real >::pruneLowerActive(), ROL::BoundConstraint_Partitioned< Real >::pruneUpperActive(), and ROL::BoundConstraint_Partitioned< Real >::update().