ROL
Public Member Functions | Private Attributes | List of all members
OuterConstraint Class Reference
+ Inheritance diagram for OuterConstraint:

Public Member Functions

 OuterConstraint (int n)
 
void update (const VectorT &x, ROL::UpdateType type, int iter) override
 
void value (VectorT &c, const VectorT &x, RealT &tol) override
 
void applyJacobian (VectorT &jv, const VectorT &v, const VectorT &x, RealT &tol) override
 
void applyAdjointJacobian (VectorT &ajl, const VectorT &l, const VectorT &x, RealT &tol) override
 
void applyAdjointHessian (VectorT &ahlv, const VectorT &l, const VectorT &v, const VectorT &x, RealT &tol) override
 
- Public Member Functions inherited from ROL::StdConstraint< RealT >
virtual ~StdConstraint ()
 
void update (const Vector< RealT > &x, bool flag=true, int iter=-1) override
 Update constraint functions.
x is the optimization variable, flag = true if optimization variable is changed, iter is the outer algorithm iterations count.
 
virtual void update (const std::vector< RealT > &x, bool flag=true, int iter=-1)
 
void update (const Vector< RealT > &x, UpdateType type, int iter=-1) override
 Update constraint function.
 
virtual void update (const std::vector< RealT > &x, UpdateType type, int iter=-1)
 
void value (Vector< RealT > &c, const Vector< RealT > &x, RealT &tol) override
 Evaluate the constraint operator \(c:\mathcal{X} \rightarrow \mathcal{C}\) at \(x\).
 
virtual void value (std::vector< RealT > &c, const std::vector< RealT > &x, RealT &tol)=0
 
void applyJacobian (Vector< RealT > &jv, const Vector< RealT > &v, const Vector< RealT > &x, RealT &tol) override
 Apply the constraint Jacobian at \(x\), \(c'(x) \in L(\mathcal{X}, \mathcal{C})\), to vector \(v\).
 
virtual void applyJacobian (std::vector< RealT > &jv, const std::vector< RealT > &v, const std::vector< RealT > &x, RealT &tol)
 
void applyAdjointJacobian (Vector< RealT > &ajv, const Vector< RealT > &v, const Vector< RealT > &x, RealT &tol) override
 Apply the adjoint of the the constraint Jacobian at \(x\), \(c'(x)^* \in L(\mathcal{C}^*, \mathcal{X}^*)\), to vector \(v\).
 
virtual void applyAdjointJacobian (std::vector< RealT > &ajv, const std::vector< RealT > &v, const std::vector< RealT > &x, RealT &tol)
 
void applyAdjointHessian (Vector< RealT > &ahuv, const Vector< RealT > &u, const Vector< RealT > &v, const Vector< RealT > &x, RealT &tol) override
 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 void applyAdjointHessian (std::vector< RealT > &ahuv, const std::vector< RealT > &u, const std::vector< RealT > &v, const std::vector< RealT > &x, RealT &tol)
 
std::vector< RealTsolveAugmentedSystem (Vector< RealT > &v1, Vector< RealT > &v2, const Vector< RealT > &b1, const Vector< RealT > &b2, const Vector< RealT > &x, RealT &tol) override
 Approximately solves the augmented system
 
virtual std::vector< RealTsolveAugmentedSystem (std::vector< RealT > &v1, std::vector< RealT > &v2, const std::vector< RealT > &b1, const std::vector< RealT > &b2, const std::vector< RealT > &x, RealT tol)
 
void applyPreconditioner (Vector< RealT > &pv, const Vector< RealT > &v, const Vector< RealT > &x, const Vector< RealT > &g, RealT &tol) override
 Apply a constraint preconditioner at \(x\), \(P(x) \in L(\mathcal{C}, \mathcal{C}^*)\), to vector \(v\). Ideally, this preconditioner satisfies the following relationship:
 
virtual void applyPreconditioner (std::vector< RealT > &pv, const std::vector< RealT > &v, const std::vector< RealT > &x, const std::vector< RealT > &g, RealT &tol)
 
- Public Member Functions inherited from ROL::Constraint< Real >
virtual ~Constraint (void)
 
 Constraint (void)
 
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\).
 
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

VectorT d_
 
VectorT dv_
 
int n_
 
int m_
 

Additional Inherited Members

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

Detailed Description

Definition at line 91 of file function/constraint/test_03.cpp.

Constructor & Destructor Documentation

◆ OuterConstraint()

OuterConstraint::OuterConstraint ( int  n)
inline

Definition at line 93 of file function/constraint/test_03.cpp.

Member Function Documentation

◆ update()

void OuterConstraint::update ( const VectorT x,
ROL::UpdateType  type,
int  iter 
)
inlineoverride

Definition at line 95 of file function/constraint/test_03.cpp.

References d_, and m_.

◆ value()

void OuterConstraint::value ( VectorT c,
const VectorT x,
RealT tol 
)
inlineoverride

Definition at line 102 of file function/constraint/test_03.cpp.

References d_, and m_.

◆ applyJacobian()

void OuterConstraint::applyJacobian ( VectorT jv,
const VectorT v,
const VectorT x,
RealT tol 
)
inlineoverride

Definition at line 109 of file function/constraint/test_03.cpp.

References d_, and m_.

◆ applyAdjointJacobian()

void OuterConstraint::applyAdjointJacobian ( VectorT ajl,
const VectorT l,
const VectorT x,
RealT tol 
)
inlineoverride

Definition at line 117 of file function/constraint/test_03.cpp.

References d_, m_, and n_.

◆ applyAdjointHessian()

void OuterConstraint::applyAdjointHessian ( VectorT ahlv,
const VectorT l,
const VectorT v,
const VectorT x,
RealT tol 
)
inlineoverride

Definition at line 130 of file function/constraint/test_03.cpp.

References dv_, m_, and n_.

Member Data Documentation

◆ d_

VectorT OuterConstraint::d_
private

◆ dv_

VectorT OuterConstraint::dv_
private

Definition at line 147 of file function/constraint/test_03.cpp.

Referenced by applyAdjointHessian().

◆ n_

int OuterConstraint::n_
private

Definition at line 148 of file function/constraint/test_03.cpp.

Referenced by applyAdjointHessian(), and applyAdjointJacobian().

◆ m_

int OuterConstraint::m_
private

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