ROL
Public Member Functions | Private Types | Private Attributes | List of all members
ROL::BoundConstraint_Partitioned< Real > Class Template Reference
User Interface » Functional Interface

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)
void projectInterior (Vector< Real > &x)
void pruneUpperActive (Vector< Real > &v, const Vector< Real > &x, Real eps=Real(0))
void pruneUpperActive (Vector< Real > &v, const Vector< Real > &g, const Vector< Real > &x, Real xeps=Real(0), Real geps=Real(0))
void pruneLowerActive (Vector< Real > &v, const Vector< Real > &x, Real eps=Real(0))
void pruneLowerActive (Vector< Real > &v, const Vector< Real > &g, const Vector< Real > &x, Real xeps=Real(0), Real geps=Real(0))
bool isFeasible (const Vector< Real > &v)
void applyInverseScalingFunction (Vector< Real > &dv, const Vector< Real > &v, const Vector< Real > &x, const Vector< Real > &g) const
void applyScalingFunctionJacobian (Vector< Real > &dv, const Vector< Real > &v, const Vector< Real > &x, const Vector< Real > &g) const
Public Member Functions inherited from ROL::ROL::BoundConstraint< Real >
virtual ~BoundConstraint ()
 BoundConstraint (void)
 BoundConstraint (const Vector< Real > &x)
virtual void project (Vector< Real > &x)
 Project optimization variables onto the bounds.
virtual void projectInterior (Vector< Real > &x)
 Project optimization variables into the interior of the feasible set.
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.
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.
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.
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.
virtual const Ptr< const Vector< Real > > getLowerBound (void) const
 Return the ref count pointer to the lower bound vector.
virtual const Ptr< const Vector< Real > > getUpperBound (void) const
 Return the ref count pointer to the upper bound vector.
virtual bool isFeasible (const Vector< Real > &v)
 Check if the vector, v, is feasible.
virtual void applyInverseScalingFunction (Vector< Real > &dv, const Vector< Real > &v, const Vector< Real > &x, const Vector< Real > &g) const
 Apply inverse scaling function.
virtual void applyScalingFunctionJacobian (Vector< Real > &dv, const Vector< Real > &v, const Vector< Real > &x, const Vector< Real > &g) const
 Apply scaling function Jacobian.
void activateLower (void)
 Turn on lower bound.
void activateUpper (void)
 Turn on upper bound.
void activate (void)
 Turn on bounds.
void deactivateLower (void)
 Turn off lower bound.
void deactivateUpper (void)
 Turn off upper bound.
void deactivate (void)
 Turn off bounds.
bool isLowerActivated (void) const
 Check if lower bound are on.
bool isUpperActivated (void) const
 Check if upper bound are on.
bool isActivated (void) const
 Check if bounds are on.
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.
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.
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.
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.
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.
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.
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.
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.
void computeProjectedGradient (Vector< Real > &g, const Vector< Real > &x)
 Compute projected gradient.
void computeProjectedStep (Vector< Real > &v, const Vector< Real > &x)
 Compute projected step.

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::ROL::BoundConstraint< Real >
Real computeInf (const Vector< Real > &x) const
Protected Attributes inherited from ROL::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

◆ V

template<typename Real>
typedef Vector<Real> ROL::BoundConstraint_Partitioned< Real >::V
private

Definition at line 63 of file ROL_BoundConstraint_Partitioned.hpp.

◆ PV

template<typename Real>
typedef PartitionedVector<Real> ROL::BoundConstraint_Partitioned< Real >::PV
private

Definition at line 64 of file ROL_BoundConstraint_Partitioned.hpp.

◆ uint

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

◆ ~BoundConstraint_Partitioned()

template<typename Real>
ROL::BoundConstraint_Partitioned< Real >::~BoundConstraint_Partitioned ( )
inline

Definition at line 81 of file ROL_BoundConstraint_Partitioned.hpp.

◆ BoundConstraint_Partitioned()

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.

References ROL::BoundConstraint< Real >::activate(), bnd_, ROL::ROL::BoundConstraint< Real >::BoundConstraint(), ROL::BoundConstraint< Real >::computeInf(), ROL::BoundConstraint< Real >::deactivate(), dim_, ROL::ROL::BoundConstraint< Real >::getLowerBound(), ROL::ROL::BoundConstraint< Real >::getUpperBound(), hasLvec_, hasUvec_, ROL::ROL::BoundConstraint< Real >::isActivated(), ROL::ROL::BoundConstraint< Real >::isLowerActivated(), ROL::ROL::BoundConstraint< Real >::isUpperActivated(), ROL::ROL::BoundConstraint< Real >::lower_, and ROL::ROL::BoundConstraint< Real >::upper_.

Member Function Documentation

◆ update()

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.

References bnd_, dim_, ROL::PartitionedVector< Real >::get(), and ROL::ROL::BoundConstraint< Real >::isActivated().

◆ project()

template<typename Real>
void ROL::BoundConstraint_Partitioned< Real >::project ( Vector< Real > & x)
inline

Definition at line 152 of file ROL_BoundConstraint_Partitioned.hpp.

References bnd_, dim_, ROL::PartitionedVector< Real >::get(), and ROL::ROL::BoundConstraint< Real >::isActivated().

◆ projectInterior()

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

Definition at line 161 of file ROL_BoundConstraint_Partitioned.hpp.

References bnd_, dim_, ROL::PartitionedVector< Real >::get(), and ROL::ROL::BoundConstraint< Real >::isActivated().

◆ pruneUpperActive() [1/2]

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

Definition at line 170 of file ROL_BoundConstraint_Partitioned.hpp.

References bnd_, dim_, ROL::PartitionedVector< Real >::get(), and ROL::ROL::BoundConstraint< Real >::isActivated().

◆ pruneUpperActive() [2/2]

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) )
inline

Definition at line 180 of file ROL_BoundConstraint_Partitioned.hpp.

References bnd_, dim_, ROL::PartitionedVector< Real >::get(), and ROL::ROL::BoundConstraint< Real >::isActivated().

◆ pruneLowerActive() [1/2]

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

Definition at line 191 of file ROL_BoundConstraint_Partitioned.hpp.

References bnd_, dim_, ROL::PartitionedVector< Real >::get(), and ROL::ROL::BoundConstraint< Real >::isActivated().

◆ pruneLowerActive() [2/2]

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) )
inline

Definition at line 201 of file ROL_BoundConstraint_Partitioned.hpp.

References bnd_, dim_, ROL::PartitionedVector< Real >::get(), and ROL::ROL::BoundConstraint< Real >::isActivated().

◆ isFeasible()

template<typename Real>
bool ROL::BoundConstraint_Partitioned< Real >::isFeasible ( const Vector< Real > & v)
inline

Definition at line 212 of file ROL_BoundConstraint_Partitioned.hpp.

References bnd_, dim_, ROL::PartitionedVector< Real >::get(), and ROL::ROL::BoundConstraint< Real >::isActivated().

◆ applyInverseScalingFunction()

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
inline

Definition at line 223 of file ROL_BoundConstraint_Partitioned.hpp.

References bnd_, dim_, ROL::PartitionedVector< Real >::get(), and ROL::ROL::BoundConstraint< Real >::isActivated().

◆ applyScalingFunctionJacobian()

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
inline

Definition at line 235 of file ROL_BoundConstraint_Partitioned.hpp.

References bnd_, dim_, ROL::PartitionedVector< Real >::get(), and ROL::ROL::BoundConstraint< Real >::isActivated().

Member Data Documentation

◆ bnd_

template<typename Real>
std::vector<Ptr<BoundConstraint<Real> > > ROL::BoundConstraint_Partitioned< Real >::bnd_
private

Definition at line 68 of file ROL_BoundConstraint_Partitioned.hpp.

Referenced by applyInverseScalingFunction(), applyScalingFunctionJacobian(), BoundConstraint_Partitioned(), isFeasible(), project(), projectInterior(), pruneLowerActive(), pruneLowerActive(), pruneUpperActive(), pruneUpperActive(), and update().

◆ l_

template<typename Real>
Ptr<V> ROL::BoundConstraint_Partitioned< Real >::l_
private

Definition at line 72 of file ROL_BoundConstraint_Partitioned.hpp.

◆ u_

template<typename Real>
Ptr<V> ROL::BoundConstraint_Partitioned< Real >::u_
private

Definition at line 73 of file ROL_BoundConstraint_Partitioned.hpp.

◆ dim_

template<typename Real>
uint ROL::BoundConstraint_Partitioned< Real >::dim_
private

Definition at line 75 of file ROL_BoundConstraint_Partitioned.hpp.

Referenced by applyInverseScalingFunction(), applyScalingFunctionJacobian(), BoundConstraint_Partitioned(), isFeasible(), project(), projectInterior(), pruneLowerActive(), pruneLowerActive(), pruneUpperActive(), pruneUpperActive(), and update().

◆ hasLvec_

template<typename Real>
bool ROL::BoundConstraint_Partitioned< Real >::hasLvec_
private

Definition at line 77 of file ROL_BoundConstraint_Partitioned.hpp.

Referenced by BoundConstraint_Partitioned().

◆ hasUvec_

template<typename Real>
bool ROL::BoundConstraint_Partitioned< Real >::hasUvec_
private

Definition at line 78 of file ROL_BoundConstraint_Partitioned.hpp.

Referenced by BoundConstraint_Partitioned().

The documentation for this class was generated from the following file:
Generated by doxygen 1.17.0