ROL
ROL::RiskLessConstraint< Real > Class Template Reference

#include <ROL_RiskLessConstraint.hpp>

Inheritance diagram for ROL::RiskLessConstraint< Real >:

Public Member Functions

 RiskLessConstraint (const Ptr< Constraint< Real > > &con)
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
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 Attributes

const Ptr< Constraint< Real > > con_

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

Definition at line 19 of file ROL_RiskLessConstraint.hpp.

Constructor & Destructor Documentation

◆ RiskLessConstraint()

template<typename Real>
ROL::RiskLessConstraint< Real >::RiskLessConstraint ( const Ptr< Constraint< Real > > & con)

Member Function Documentation

◆ update() [1/2]

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

Definition at line 20 of file ROL_RiskLessConstraint_Def.hpp.

References con_.

◆ update() [2/2]

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

Definition at line 26 of file ROL_RiskLessConstraint_Def.hpp.

References con_.

◆ value()

template<typename Real>
void ROL::RiskLessConstraint< Real >::value ( Vector< Real > & c,
const Vector< Real > & x,
Real & tol )
override

Definition at line 32 of file ROL_RiskLessConstraint_Def.hpp.

References con_.

◆ applyJacobian()

template<typename Real>
void ROL::RiskLessConstraint< Real >::applyJacobian ( Vector< Real > & jv,
const Vector< Real > & v,
const Vector< Real > & x,
Real & tol )
override

Definition at line 38 of file ROL_RiskLessConstraint_Def.hpp.

References con_.

◆ applyAdjointJacobian()

template<typename Real>
void ROL::RiskLessConstraint< Real >::applyAdjointJacobian ( Vector< Real > & ajv,
const Vector< Real > & v,
const Vector< Real > & x,
Real & tol )
override

Definition at line 45 of file ROL_RiskLessConstraint_Def.hpp.

References con_.

◆ applyAdjointHessian()

template<typename Real>
void ROL::RiskLessConstraint< Real >::applyAdjointHessian ( Vector< Real > & ahuv,
const Vector< Real > & u,
const Vector< Real > & v,
const Vector< Real > & x,
Real & tol )
override

Definition at line 52 of file ROL_RiskLessConstraint_Def.hpp.

References con_.

◆ setParameter()

template<typename Real>
void ROL::RiskLessConstraint< Real >::setParameter ( const std::vector< Real > & param)
overridevirtual

Reimplemented from ROL::ROL::Constraint< Real >.

Definition at line 60 of file ROL_RiskLessConstraint_Def.hpp.

References con_, and ROL::Constraint< Real >::setParameter().

Member Data Documentation

◆ con_

template<class Real>
const Ptr<Constraint<Real> > ROL::RiskLessConstraint< Real >::con_
private

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