Implements an equality constraint function that evaluates to zero on the surface of a bounded parallelpiped and is positive in the interior. More...

#include <ROL_BinaryConstraint.hpp>

Inheritance diagram for ROL::BinaryConstraint< Real >:

Classes
class	BoundsCheck

Public Member Functions
	BinaryConstraint (const RCP< const V > &lo, const RCP< const V > &up, Real gamma)

	BinaryConstraint (const BoundConstraint< Real > &bnd, Real gamma)

	BinaryConstraint (const RCP< const BoundConstraint< Real >> &bnd, Real gamma)

void	value (V &c, const V &x, Real &tol)
	Evaluate constraint \[ c_i(x) = \begin{cases} \gamma(u_i-x_i)(x_i-l_i) & -\infty<l_i,u_i<\infty \\ \gamma(x_i-l_i) & -\infty<l_i,u_i=\infty \\ \gamma(u_i-x_i) & l_i=-\infty,u_i<\infty \\ 0 & l_i=-\infty,u_i=\infty \end{cases} \] . More...

void	applyJacobian (V &jv, const V &v, const V &x, Real &tol)

void	applyAdjointJacobian (V &ajv, const V &v, const V &x, Real &tol)
	Apply the adjoint of the the constraint Jacobian at \(x\), \(c'(x)^* \in L(\mathcal{C}^, \mathcal{X}^)\), to vector \(v\). More...

void	applyAdjointHessian (V &ahuv, const V &u, const V &v, const V &x, Real &tol)

void	setPenalty (Real gamma)

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

virtual void	applyAdjointJacobian (Vector< Real > &ajv, const Vector< Real > &v, const Vector< Real > &x, const Vector< Real > &dualv, Real &tol)
	Apply the adjoint of the the constraint Jacobian at \(x\), \(c'(x)^* \in L(\mathcal{C}^, \mathcal{X}^)\), to vector \(v\). More...

virtual std::vector< Real >	solveAugmentedSystem (Vector< Real > &v1, Vector< Real > &v2, const Vector< Real > &b1, const Vector< Real > &b2, const Vector< Real > &x, Real &tol)
	Approximately solves the augmented system \[ \begin{pmatrix} I & c'(x)^* \\ c'(x) & 0 \end{pmatrix} \begin{pmatrix} v_{1} \\ v_{2} \end{pmatrix} = \begin{pmatrix} b_{1} \\ b_{2} \end{pmatrix} \] where \(v_{1} \in \mathcal{X}\), \(v_{2} \in \mathcal{C}^\), \(b_{1} \in \mathcal{X}^\), \(b_{2} \in \mathcal{C}\), \(I : \mathcal{X} \rightarrow \mathcal{X}^\) is an identity or Riesz operator, and \(0 : \mathcal{C}^ \rightarrow \mathcal{C}\) is a zero operator. More...

virtual void	applyPreconditioner (Vector< Real > &pv, const Vector< Real > &v, const Vector< Real > &x, const Vector< Real > &g, Real &tol)
	Apply a constraint preconditioner at \(x\), \(P(x) \in L(\mathcal{C}, \mathcal{C}^)\), to vector \(v\). Ideally, this preconditioner satisfies the following relationship: \[ \left[c'(x) \circ R \circ c'(x)^ \circ P(x)\right] v = v \,, \] where R is the appropriate Riesz map in \(L(\mathcal{X}^*, \mathcal{X})\). It is used by the solveAugmentedSystem method. More...

	EqualityConstraint (void)

virtual void	update (const Vector< Real > &x, bool flag=true, int iter=-1)
	Update constraint functions. x is the optimization variable, flag = true if optimization variable is changed, iter is the outer algorithm iterations count. More...

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

void	activate (void)
	Turn on constraints. More...

void	deactivate (void)
	Turn off constraints. More...

bool	isActivated (void)
	Check if constraints are on. More...

virtual std::vector< std::vector< Real > >	checkApplyJacobian (const Vector< Real > &x, const Vector< Real > &v, const Vector< Real > &jv, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)
	Finite-difference check for the constraint Jacobian application. More...

virtual std::vector< std::vector< Real > >	checkApplyJacobian (const Vector< Real > &x, const Vector< Real > &v, const Vector< Real > &jv, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
	Finite-difference check for the constraint Jacobian application. More...

virtual std::vector< std::vector< Real > >	checkApplyAdjointJacobian (const Vector< Real > &x, const Vector< Real > &v, const Vector< Real > &c, const Vector< Real > &ajv, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS)
	Finite-difference check for the application of the adjoint of constraint Jacobian. More...

virtual Real	checkAdjointConsistencyJacobian (const Vector< Real > &w, const Vector< Real > &v, const Vector< Real > &x, const bool printToStream=true, std::ostream &outStream=std::cout)

virtual Real	checkAdjointConsistencyJacobian (const Vector< Real > &w, const Vector< Real > &v, const Vector< Real > &x, const Vector< Real > &dualw, const Vector< Real > &dualv, const bool printToStream=true, std::ostream &outStream=std::cout)

virtual std::vector< std::vector< Real > >	checkApplyAdjointHessian (const Vector< Real > &x, const Vector< Real > &u, const Vector< Real > &v, const Vector< Real > &hv, const std::vector< Real > &step, const bool printToScreen=true, std::ostream &outStream=std::cout, const int order=1)
	Finite-difference check for the application of the adjoint of constraint Hessian. More...

virtual std::vector< std::vector< Real > >	checkApplyAdjointHessian (const Vector< Real > &x, const Vector< Real > &u, const Vector< Real > &v, const Vector< Real > &hv, const bool printToScreen=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
	Finite-difference check for the application of the adjoint of constraint Hessian. More...

virtual void	setParameter (const std::vector< Real > &param)

Private Types
template<typename T >
using	RCP = Teuchos::RCP< T >

using	V = Vector< Real >

Private Attributes
const RCP< const V >	lo_

const RCP< const V >	up_

RCP< V >	d_

Real	gamma_

Additional Inherited Members
Protected Member Functions inherited from ROL::EqualityConstraint< Real >
const std::vector< Real >	getParameter (void) const

Detailed Description

template<class Real>
class ROL::BinaryConstraint< Real >

Implements an equality constraint function that evaluates to zero on the surface of a bounded parallelpiped and is positive in the interior.

Definition at line 61 of file ROL_BinaryConstraint.hpp.

Member Typedef Documentation

◆ RCP

template<class Real >

template<typename T >

using ROL::BinaryConstraint< Real >::RCP = Teuchos::RCP<T>

private

Definition at line 63 of file ROL_BinaryConstraint.hpp.

◆ V

template<class Real >

using ROL::BinaryConstraint< Real >::V = Vector<Real>

private

Definition at line 65 of file ROL_BinaryConstraint.hpp.

Constructor & Destructor Documentation

◆ BinaryConstraint() [1/3]

template<class Real >

ROL::BinaryConstraint< Real >::BinaryConstraint	(	const RCP< const V > &	lo,
		const RCP< const V > &	up,
		Real	gamma
	)

inline

Definition at line 130 of file ROL_BinaryConstraint.hpp.

◆ BinaryConstraint() [2/3]

template<class Real >

ROL::BinaryConstraint< Real >::BinaryConstraint	(	const BoundConstraint< Real > &	bnd,
		Real	gamma
	)

inline

Definition at line 133 of file ROL_BinaryConstraint.hpp.

◆ BinaryConstraint() [3/3]

template<class Real >

ROL::BinaryConstraint< Real >::BinaryConstraint	(	const RCP< const BoundConstraint< Real >> &	bnd,
		Real	gamma
	)

inline

Definition at line 136 of file ROL_BinaryConstraint.hpp.

Member Function Documentation

◆ value()

template<class Real >

void ROL::BinaryConstraint< Real >::value	(	V &	c,
		const V &	x,
		Real &	tol
	)

inlinevirtual

Evaluate constraint

\[ c_i(x) = \begin{cases} \gamma(u_i-x_i)(x_i-l_i) & -\infty<l_i,u_i<\infty \\ \gamma(x_i-l_i) & -\infty<l_i,u_i=\infty \\ \gamma(u_i-x_i) & l_i=-\infty,u_i<\infty \\ 0 & l_i=-\infty,u_i=\infty \end{cases} \]

.

Implements ROL::EqualityConstraint< Real >.

Definition at line 149 of file ROL_BinaryConstraint.hpp.

References ROL::Vector< Real >::applyBinary(), ROL::Vector< Real >::axpy(), ROL::Vector< Real >::scale(), and ROL::Vector< Real >::set().

◆ applyJacobian()

template<class Real >

void ROL::BinaryConstraint< Real >::applyJacobian	(	V &	jv,
		const V &	v,
		const V &	x,
		Real &	tol
	)

inlinevirtual

Evaluate constraint Jacobian at x in the direction v

\[ c_i'(x)v = \begin{cases} \gamma(u_i+l_i-2x_i)v_i & -\infty<l_i,u_i<\infty \\ \gamma v_i & -\infty<l_i,u_i=\infty \\ -\gamma v_i & l_i=-\infty,u_i<\infty \\ 0 & l_i=-\infty,u_i=\infty \end{cases} \]

Reimplemented from ROL::EqualityConstraint< Real >.

Definition at line 174 of file ROL_BinaryConstraint.hpp.

References ROL::Vector< Real >::applyBinary(), ROL::Vector< Real >::axpy(), ROL::Vector< Real >::scale(), and ROL::Vector< Real >::set().

Referenced by ROL::BinaryConstraint< Real >::applyAdjointJacobian().

◆ applyAdjointJacobian()

template<class Real >

void ROL::BinaryConstraint< Real >::applyAdjointJacobian	(	V &	ajv,
		const V &	v,
		const V &	x,
		Real &	tol
	)

inlinevirtual

Apply the adjoint of the the constraint Jacobian at \(x\), \(c'(x)^* \in L(\mathcal{C}^*, \mathcal{X}^*)\), to vector \(v\).

Parameters

[out]	ajv	is the result of applying the adjoint of the constraint Jacobian to v at x; a dual optimization-space vector
[in]	v	is a dual constraint-space vector
[in]	x	is the constraint argument; an optimization-space vector
[in,out]	tol	is a tolerance for inexact evaluations; currently unused

On return, \(\mathsf{ajv} = c'(x)^*v\), where \(v \in \mathcal{C}^*\), \(\mathsf{ajv} \in \mathcal{X}^*\).

The default implementation is a finite-difference approximation.

Reimplemented from ROL::EqualityConstraint< Real >.

Definition at line 190 of file ROL_BinaryConstraint.hpp.

References ROL::BinaryConstraint< Real >::applyJacobian().

◆ applyAdjointHessian()

template<class Real >

void ROL::BinaryConstraint< Real >::applyAdjointHessian	(	V &	ahuv,
		const V &	u,
		const V &	v,
		const V &	x,
		Real &	tol
	)

inlinevirtual

c_i''(x)(w,v) = {cases} -2 v_i w_i & -<l_i,u_i< \ 0 & {otherwise} {cases}

Reimplemented from ROL::EqualityConstraint< Real >.

Definition at line 201 of file ROL_BinaryConstraint.hpp.

References ROL::Vector< Real >::applyBinary(), ROL::Vector< Real >::axpy(), ROL::Vector< Real >::scale(), and ROL::Vector< Real >::set().

◆ setPenalty()

template<class Real >

void ROL::BinaryConstraint< Real >::setPenalty ( Real gamma )

inline

Definition at line 219 of file ROL_BinaryConstraint.hpp.

Member Data Documentation

◆ lo_

template<class Real >

const RCP<const V> ROL::BinaryConstraint< Real >::lo_

private

Definition at line 70 of file ROL_BinaryConstraint.hpp.

◆ up_

template<class Real >

const RCP<const V> ROL::BinaryConstraint< Real >::up_

private

Definition at line 71 of file ROL_BinaryConstraint.hpp.

◆ d_

template<class Real >

RCP<V> ROL::BinaryConstraint< Real >::d_

private

Definition at line 73 of file ROL_BinaryConstraint.hpp.

◆ gamma_

template<class Real >

Real ROL::BinaryConstraint< Real >::gamma_

private

Definition at line 78 of file ROL_BinaryConstraint.hpp.

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

ROL_BinaryConstraint.hpp

Classes

Public Member Functions

Private Types

Private Attributes

Additional Inherited Members

Detailed Description

template<class Real> class ROL::BinaryConstraint< Real >

Member Typedef Documentation

◆ RCP

◆ V

Constructor & Destructor Documentation

◆ BinaryConstraint() [1/3]

◆ BinaryConstraint() [2/3]

◆ BinaryConstraint() [3/3]

Member Function Documentation

◆ value()

◆ applyJacobian()

◆ applyAdjointJacobian()

◆ applyAdjointHessian()

◆ setPenalty()

Member Data Documentation

◆ lo_

◆ up_

◆ d_

◆ gamma_

template<class Real>
class ROL::BinaryConstraint< Real >