Has both inequality and equality constraints. Treat inequality constraint as equality with slack variable. More...

#include <ROL_Constraint_Partitioned.hpp>

Inheritance diagram for ROL::Constraint_Partitioned< Real >:

Public Member Functions
	Constraint_Partitioned (const std::vector< Ptr< Constraint< Real > > > &cvec, bool isInequality=false, int offset=0)
	Constraint_Partitioned (const std::vector< Ptr< Constraint< Real > > > &cvec, std::vector< bool > isInequality, int offset=0)
int	getNumberConstraintEvaluations (void) const
Ptr< Constraint< Real > >	get (int ind=0) const
void	update (const Vector< Real > &x, UpdateType type, int iter=-1) override
void	update (const Vector< Real > &x, bool flag=true, int iter=-1) override
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
virtual void	applyPreconditioner (Vector< Real > &pv, const Vector< Real > &v, const Vector< Real > &x, const Vector< Real > &g, Real &tol) override
void	setParameter (const std::vector< Real > &param) override
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.

Private Member Functions
Vector< Real > &	getOpt (Vector< Real > &xs) const
const Vector< Real > &	getOpt (const Vector< Real > &xs) const
Vector< Real > &	getSlack (Vector< Real > &xs, int ind) const
const Vector< Real > &	getSlack (const Vector< Real > &xs, int ind) const

Private Attributes
std::vector< Ptr< Constraint< Real > > >	cvec_
std::vector< bool >	isInequality_
const int	offset_
Ptr< Vector< Real > >	scratch_
int	ncval_
bool	initialized_

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::Constraint_Partitioned< Real >

Has both inequality and equality constraints. Treat inequality constraint as equality with slack variable.

Definition at line 25 of file ROL_Constraint_Partitioned.hpp.

Constructor & Destructor Documentation

◆ Constraint_Partitioned() [1/2]

template<typename Real>

ROL::Constraint_Partitioned< Real >::Constraint_Partitioned	(	const std::vector< Ptr< Constraint< Real > > > &	cvec,
		bool	isInequality = false,
		int	offset = 0 )

Definition at line 16 of file ROL_Constraint_Partitioned_Def.hpp.

References ROL::ROL::Constraint< Real >::Constraint(), cvec_, initialized_, isInequality_, ncval_, offset_, and scratch_.

◆ Constraint_Partitioned() [2/2]

template<typename Real>

ROL::Constraint_Partitioned< Real >::Constraint_Partitioned	(	const std::vector< Ptr< Constraint< Real > > > &	cvec,
		std::vector< bool >	isInequality,
		int	offset = 0 )

Definition at line 25 of file ROL_Constraint_Partitioned_Def.hpp.

References ROL::ROL::Constraint< Real >::Constraint(), cvec_, initialized_, isInequality_, ncval_, offset_, and scratch_.

Member Function Documentation

◆ getNumberConstraintEvaluations()

template<typename Real>

int ROL::Constraint_Partitioned< Real >::getNumberConstraintEvaluations ( void ) const

Definition at line 32 of file ROL_Constraint_Partitioned_Def.hpp.

References ncval_.

◆ get()

template<typename Real>

Ptr< Constraint< Real > > ROL::Constraint_Partitioned< Real >::get ( int ind = 0 ) const

Definition at line 37 of file ROL_Constraint_Partitioned_Def.hpp.

References cvec_.

Referenced by getOpt(), getOpt(), getSlack(), and getSlack().

◆ update() [1/2]

template<typename Real>

void ROL::Constraint_Partitioned< Real >::update	(	const Vector< Real > &	x,
		UpdateType	type,
		int	iter = -1 )

override

Definition at line 45 of file ROL_Constraint_Partitioned_Def.hpp.

References cvec_, and getOpt().

◆ update() [2/2]

template<typename Real>

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

override

Definition at line 53 of file ROL_Constraint_Partitioned_Def.hpp.

References cvec_, and getOpt().

◆ value()

template<typename Real>

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

override

Definition at line 61 of file ROL_Constraint_Partitioned_Def.hpp.

References cvec_, ROL::PartitionedVector< Real >::get(), getOpt(), getSlack(), isInequality_, ncval_, and offset_.

◆ applyJacobian()

template<typename Real>

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

override

Definition at line 78 of file ROL_Constraint_Partitioned_Def.hpp.

References cvec_, ROL::PartitionedVector< Real >::get(), getOpt(), getSlack(), isInequality_, and offset_.

◆ applyAdjointJacobian()

template<typename Real>

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

override

Definition at line 97 of file ROL_Constraint_Partitioned_Def.hpp.

References cvec_, ROL::PartitionedVector< Real >::get(), getOpt(), getSlack(), initialized_, isInequality_, offset_, and scratch_.

◆ applyAdjointHessian()

template<typename Real>

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

override

Definition at line 125 of file ROL_Constraint_Partitioned_Def.hpp.

References cvec_, ROL::PartitionedVector< Real >::get(), getOpt(), getSlack(), initialized_, isInequality_, offset_, and scratch_.

◆ applyPreconditioner()

template<typename Real>

void ROL::Constraint_Partitioned< Real >::applyPreconditioner	(	Vector< Real > &	pv,
		const Vector< Real > &	v,
		const Vector< Real > &	x,
		const Vector< Real > &	g,
		Real &	tol )