ROL::ZOO::EqualityConstraint_HS32< Real > Class Template Reference

#include <ROL_HS32.hpp>

Inheritance diagram for ROL::ZOO::EqualityConstraint_HS32< Real >:

Public Member Functions
	EqualityConstraint_HS32 ()
void	value (Vector< Real > &c, const Vector< Real > &x, Real &tol)
void	applyJacobian (Vector< Real > &jv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
void	applyAdjointJacobian (Vector< Real > &ajv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
void	applyAdjointHessian (Vector< Real > &ahuv, const Vector< Real > &u, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
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 Types
typedef std::vector< Real >	vector
typedef Vector< Real >	V
typedef StdVector< Real >	SV

Private Member Functions
Ptr< const vector >	getVector (const V &x)
Ptr< vector >	getVector (V &x)

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

Detailed Description

template<class Real>
class ROL::ZOO::EqualityConstraint_HS32< Real >

Definition at line 75 of file ROL_HS32.hpp.

Member Typedef Documentation

vector

template<class Real>

typedef std::vector<Real> ROL::ZOO::EqualityConstraint_HS32< Real >::vector

private

Definition at line 77 of file ROL_HS32.hpp.

V

template<class Real>

typedef Vector<Real> ROL::ZOO::EqualityConstraint_HS32< Real >::V

private

Definition at line 78 of file ROL_HS32.hpp.

SV

template<class Real>

typedef StdVector<Real> ROL::ZOO::EqualityConstraint_HS32< Real >::SV

private

Definition at line 79 of file ROL_HS32.hpp.

Constructor & Destructor Documentation

EqualityConstraint_HS32()

template<class Real>

ROL::ZOO::EqualityConstraint_HS32< Real >::EqualityConstraint_HS32 ( )

inline

Definition at line 92 of file ROL_HS32.hpp.

Member Function Documentation

getVector() [1/2]

template<class Real>

Ptr< const vector > ROL::ZOO::EqualityConstraint_HS32< Real >::getVector ( const V & x )

inlineprivate

Definition at line 83 of file ROL_HS32.hpp.

References getVector().

Referenced by applyAdjointJacobian(), applyJacobian(), getVector(), getVector(), and value().

getVector() [2/2]

template<class Real>

Ptr< vector > ROL::ZOO::EqualityConstraint_HS32< Real >::getVector ( V & x )

inlineprivate

Definition at line 87 of file ROL_HS32.hpp.

References getVector().

value()

template<class Real>

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

inline

Definition at line 94 of file ROL_HS32.hpp.

References getVector().

applyJacobian()

template<class Real>

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

inline

Definition at line 102 of file ROL_HS32.hpp.

References getVector().

applyAdjointJacobian()

template<class Real>

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

inline

Definition at line 110 of file ROL_HS32.hpp.

References getVector().

applyAdjointHessian()

template<class Real>

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

inline

Definition at line 120 of file ROL_HS32.hpp.

References ROL::Vector< Real >::zero().

---

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

• ROL_HS32.hpp