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 ROL::Ptr< const Vector< Real > > &lo, const ROL::Ptr< const Vector< Real > > &up, Real gamma)
	BinaryConstraint (const BoundConstraint< Real > &bnd, Real gamma)
	BinaryConstraint (const ROL::Ptr< const BoundConstraint< Real > > &bnd, Real gamma)
void	value (Vector< Real > &c, const Vector< Real > &x, Real &tol) override
void	applyJacobian (Vector< Real > &jv, const Vector< Real > &v, const Vector< Real > &x, Real &tol) override
void	applyAdjointJacobian (Vector< Real > &ajv, const Vector< Real > &v, const Vector< Real > &x, Real &tol) override
void	applyAdjointHessian (Vector< Real > &ahuv, const Vector< Real > &u, const Vector< Real > &v, const Vector< Real > &x, Real &tol) override
void	setPenalty (Real gamma)
Public Member Functions inherited from ROL::ROL::Constraint< Real >
virtual	~Constraint (void)
	Constraint (void)
virtual void	update (const Vector< Real > &x, UpdateType type, int iter=-1)
	Update constraint function.
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.
virtual void	value (Vector< Real > &c, const Vector< Real > &x, Real &tol)=0
	Evaluate the constraint operator \(c:\mathcal{X} \rightarrow \mathcal{C}\) at \(x\).
virtual void	applyJacobian (Vector< Real > &jv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
	Apply the constraint Jacobian at \(x\), \(c'(x) \in L(\mathcal{X}, \mathcal{C})\), to vector \(v\).
virtual void	applyAdjointJacobian (Vector< Real > &ajv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
	Apply the adjoint of the the constraint Jacobian at \(x\), \(c'(x)^* \in L(\mathcal{C}^, \mathcal{X}^)\), to vector \(v\).
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\).
virtual void	applyAdjointHessian (Vector< Real > &ahuv, const Vector< Real > &u, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
	Apply the derivative of the adjoint of the constraint Jacobian at \(x\) to vector \(u\) in direction \(v\), according to \( v \mapsto c''(x)(v,\cdot)^*u \).
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 .
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:
void	activate (void)
	Turn on constraints.
void	deactivate (void)
	Turn off constraints.
bool	isActivated (void)
	Check if constraints are on.
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.
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.
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.
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.
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.
virtual void	setParameter (const std::vector< Real > &param)

Private Attributes
const Ptr< const Vector< Real > >	lo_
const Ptr< const Vector< Real > >	up_
Ptr< Vector< Real > >	d_
Real	gamma_

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

Detailed Description

template<typename 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 27 of file ROL_BinaryConstraint.hpp.

Constructor & Destructor Documentation

◆ BinaryConstraint() [1/3]

template<typename Real>

ROL::BinaryConstraint< Real >::BinaryConstraint	(	const ROL::Ptr< const Vector< Real > > &	lo,
		const ROL::Ptr< const Vector< Real > > &	up,
		Real	gamma )

Definition at line 16 of file ROL_BinaryConstraint_Def.hpp.

References d_, gamma_, lo_, and up_.

Referenced by BinaryConstraint(), and BinaryConstraint().

◆ BinaryConstraint() [2/3]

template<typename Real>

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

Definition at line 21 of file ROL_BinaryConstraint_Def.hpp.

References BinaryConstraint().

◆ BinaryConstraint() [3/3]

template<typename Real>

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

Definition at line 25 of file ROL_BinaryConstraint_Def.hpp.

References BinaryConstraint().

Member Function Documentation

◆ value()

template<typename Real>

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

override

Definition at line 29 of file ROL_BinaryConstraint_Def.hpp.

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

◆ applyJacobian()

template<typename Real>

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

override

Definition at line 40 of file ROL_BinaryConstraint_Def.hpp.

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

◆ applyAdjointJacobian()

template<typename Real>

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

override

Definition at line 52 of file ROL_BinaryConstraint_Def.hpp.

References applyJacobian().

◆ applyAdjointHessian()

template<typename Real>

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