A composite composite BoundConstraint formed from bound constraints on subvectors of a PartitionedVector. More...

#include <ROL_BoundConstraint_Partitioned.hpp>

Inheritance diagram for ROL::BoundConstraint_Partitioned< Real >:

Public Member Functions
	~BoundConstraint_Partitioned ()

	BoundConstraint_Partitioned (const std::vector< Ptr< BoundConstraint< Real >>> &bnd, const std::vector< Ptr< Vector< Real >>> &x)

void	update (const Vector< Real > &x, bool flag=true, int iter=-1)

void	project (Vector< Real > &x)
	Project optimization variables onto the bounds. More...

void	projectInterior (Vector< Real > &x)
	Project optimization variables into the interior of the feasible set. More...

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...

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...

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...

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...

bool	isFeasible (const Vector< Real > &v)
	Check if the vector, v, is feasible. More...

void	applyInverseScalingFunction (Vector< Real > &dv, const Vector< Real > &v, const Vector< Real > &x, const Vector< Real > &g) const
	Apply inverse scaling function. More...

void	applyScalingFunctionJacobian (Vector< Real > &dv, const Vector< Real > &v, const Vector< Real > &x, const Vector< Real > &g) const
	Apply scaling function Jacobian. More...

Public Member Functions inherited from ROL::BoundConstraint< Real >
virtual	~BoundConstraint ()

	BoundConstraint (void)

	BoundConstraint (const Vector< Real > &x)

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...

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...

Private Types
typedef Vector< Real >	V

typedef PartitionedVector< Real >	PV

typedef std::vector< Real > ::size_type	uint

Private Attributes
std::vector< Ptr < BoundConstraint< Real > > >	bnd_

Ptr< V >	l_

Ptr< V >	u_

uint	dim_

bool	hasLvec_

bool	hasUvec_

Additional Inherited Members
Protected Member Functions inherited from ROL::BoundConstraint< Real >
Real	computeInf (const Vector< Real > &x) const

Protected Attributes inherited from ROL::BoundConstraint< Real >
Ptr< Vector< Real > >	lower_

Ptr< Vector< Real > >	upper_

Detailed Description

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

A composite composite BoundConstraint formed from bound constraints on subvectors of a PartitionedVector.

Definition at line 61 of file ROL_BoundConstraint_Partitioned.hpp.

Member Typedef Documentation

template<typename Real >

typedef Vector<Real> ROL::BoundConstraint_Partitioned< Real >::V

private

Definition at line 63 of file ROL_BoundConstraint_Partitioned.hpp.

template<typename Real >

typedef PartitionedVector<Real> ROL::BoundConstraint_Partitioned< Real >::PV

private

Definition at line 64 of file ROL_BoundConstraint_Partitioned.hpp.

template<typename Real >

typedef std::vector<Real>::size_type ROL::BoundConstraint_Partitioned< Real >::uint

private

Definition at line 65 of file ROL_BoundConstraint_Partitioned.hpp.

Constructor & Destructor Documentation

template<typename Real >

ROL::BoundConstraint_Partitioned< Real >::~BoundConstraint_Partitioned ( )

inline

Definition at line 81 of file ROL_BoundConstraint_Partitioned.hpp.

template<typename Real >

ROL::BoundConstraint_Partitioned< Real >::BoundConstraint_Partitioned	(	const std::vector< Ptr< BoundConstraint< Real >>> &	bnd,
		const std::vector< Ptr< Vector< Real >>> &	x
	)

inline

Definition at line 83 of file ROL_BoundConstraint_Partitioned.hpp.

Member Function Documentation

template<typename Real >

void ROL::BoundConstraint_Partitioned< Real >::update	(	const Vector< Real > &	x,
		bool	flag = `true`,
		int	iter = `-1`
	)

inline

Definition at line 143 of file ROL_BoundConstraint_Partitioned.hpp.

template<typename Real >

void ROL::BoundConstraint_Partitioned< 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] x is the optimization variable.

Reimplemented from ROL::BoundConstraint< Real >.

Definition at line 146 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().

template<typename Real >

void ROL::BoundConstraint_Partitioned< Real >::projectInterior ( Vector< Real > & x )

inlinevirtual

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] x is the optimization variable.

Reimplemented from ROL::BoundConstraint< Real >.

Definition at line 155 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().

template<typename Real >

void ROL::BoundConstraint_Partitioned< Real >::pruneUpperActive	(	Vector< Real > &	v,
		const Vector< Real > &	x,
		Real	eps = `Real(0)`
	)

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) \ge b(\xi)-\epsilon\,\}. \]

Parameters

[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 164 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().

template<typename Real >

void ROL::BoundConstraint_Partitioned< Real >::pruneUpperActive	(	Vector< Real > &	v,
		const Vector< Real > &	g,
		const Vector< Real > &	x,
		Real	xeps = `Real(0)`,
		Real	geps = `Real(0)`
	)

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

Parameters

[out]	v	is the variable to be pruned.
[in]	g	is the negative search direction.
[in]	x	is the current optimization variable.
[in]	xeps	is the active-set tolerance \(\epsilon_x\).
[in]	geps	is the binding-set tolerance \(\epsilon_g\).

Reimplemented from ROL::BoundConstraint< Real >.

Definition at line 174 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().

template<typename Real >

void ROL::BoundConstraint_Partitioned< Real >::pruneLowerActive	(	Vector< Real > &	v,
		const Vector< Real > &	x,
		Real	eps = `Real(0)`
	)

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) \le a(\xi)+\epsilon\,\}. \]

Parameters

[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 185 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().

template<typename Real >

void ROL::BoundConstraint_Partitioned< Real >::pruneLowerActive	(	Vector< Real > &	v,
		const Vector< Real > &	g,
		const Vector< Real > &	x,
		Real	xeps = `Real(0)`,
		Real	geps = `Real(0)`
	)

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 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]	v	is the variable to be pruned.
[in]	g	is the negative search direction.
[in]	x	is the current optimization variable.
[in]	xeps	is the active-set tolerance \(\epsilon_x\).
[in]	geps	is the binding-set tolerance \(\epsilon_g\).

Reimplemented from ROL::BoundConstraint< Real >.

Definition at line 195 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().

template<typename Real >

bool ROL::BoundConstraint_Partitioned< 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] v is the vector to be checked.

Reimplemented from ROL::BoundConstraint< Real >.

Definition at line 206 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().

template<typename Real >

void ROL::BoundConstraint_Partitioned< Real >::applyInverseScalingFunction	(	Vector< Real > &	dv,
		const Vector< Real > &	v,
		const Vector< Real > &	x,
		const Vector< Real > &	g
	)		const

inlinevirtual

Apply inverse scaling function.

This function applies the inverse scaling function \(d(x,g)\) to a vector \(v\), i.e., the output is \(\mathrm{diag}(d(x,g)^{-1})v\). The scaling function must satisfy: (i) \(d(x,g)_i = 0\) if \(x_i = a_i\) and \(g_i \ge 0\); (ii) \(d(x,g)_i = 0\) if \(x_i = b_i\) and \(g_i \le 0\); and (iii) \(d(x,g)_i > 0\) otherwise.

Parameters

[out]	dv	is the inverse scaling function applied to v.
[in]	v	is the vector being scaled.
[in]	x	is the primal vector at which the scaling function is evaluated.
[in]	g	is the dual vector at which the scaling function is evaluated.

Reimplemented from ROL::BoundConstraint< Real >.

Definition at line 217 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().

template<typename Real >

void ROL::BoundConstraint_Partitioned< Real >::applyScalingFunctionJacobian	(	Vector< Real > &	dv,
		const Vector< Real > &	v,
		const Vector< Real > &	x,
		const Vector< Real > &	g
	)		const

inlinevirtual

Apply scaling function Jacobian.

This function applies the Jacobian of the scaling function \(d(x,g)\) to a vector \(v\). The output is \(\mathrm{diag}(d_x(x,g)g)v\). The scaling function must satisfy: (i) \(d(x,g)_i = 0\) if \(x_i = a_i\) and \(g_i \ge 0\); (ii) \(d(x,g)_i = 0\) if \(x_i = b_i\) and \(g_i \le 0\); and (iii) \(d(x,g)_i > 0\) otherwise.

Parameters

[out]	dv	is the scaling function Jacobian applied to v.
[in]	v	is the vector being scaled.
[in]	x	is the primal vector at which the scaling function is evaluated.
[in]	g	is the dual vector at which the scaling function is evaluated.