ROL
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
void value (Vector< RealT > &c, const Vector< RealT > &x, RealT &tol) override
void applyJacobian (Vector< RealT > &jv, const Vector< RealT > &v, const Vector< RealT > &x, RealT &tol) override
void applyAdjointJacobian (Vector< RealT > &ajv, const Vector< RealT > &v, const Vector< RealT > &x, RealT &tol) override
void applyAdjointHessian (Vector< RealT > &ahuv, const Vector< RealT > &u, const Vector< RealT > &v, const Vector< RealT > &x, RealT &tol) override
std::vector< RealTsolveAugmentedSystem (Vector< RealT > &v1, Vector< RealT > &v2, const Vector< RealT > &b1, const Vector< RealT > &b2, const Vector< RealT > &x, RealT &tol) override
void applyPreconditioner (Vector< RealT > &pv, const Vector< RealT > &v, const Vector< RealT > &x, const Vector< RealT > &g, RealT &tol) override
Public Member Functions inherited from ROL::Constraint< RealT >
virtual ~Constraint (void)
 Constraint (void)
virtual void update (const Vector< RealT > &x, UpdateType type, int iter=-1)
 Update constraint function.
virtual void value (Vector< RealT > &c, const Vector< RealT > &x, RealT &tol)=0
 Evaluate the constraint operator \(c:\mathcal{X} \rightarrow \mathcal{C}\) at \(x\).
virtual void applyJacobian (Vector< RealT > &jv, const Vector< RealT > &v, const Vector< RealT > &x, RealT &tol)
 Apply the constraint Jacobian at \(x\), \(c'(x) \in L(\mathcal{X}, \mathcal{C})\), to vector \(v\).
virtual void applyAdjointJacobian (Vector< RealT > &ajv, const Vector< RealT > &v, const Vector< RealT > &x, RealT &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< RealT > &ahuv, const Vector< RealT > &u, const Vector< RealT > &v, const Vector< RealT > &x, RealT &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 \).
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< RealT > > checkApplyJacobian (const Vector< RealT > &x, const Vector< RealT > &v, const Vector< RealT > &jv, const std::vector< RealT > &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< RealT > > checkApplyAdjointJacobian (const Vector< RealT > &x, const Vector< RealT > &v, const Vector< RealT > &c, const Vector< RealT > &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 RealT checkAdjointConsistencyJacobian (const Vector< RealT > &w, const Vector< RealT > &v, const Vector< RealT > &x, const bool printToStream=true, std::ostream &outStream=std::cout)
virtual std::vector< std::vector< RealT > > checkApplyAdjointHessian (const Vector< RealT > &x, const Vector< RealT > &u, const Vector< RealT > &v, const Vector< RealT > &hv, const std::vector< RealT > &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 void setParameter (const std::vector< RealT > &param)

Private Attributes

VectorT d_
VectorT dv_
int n_
int m_

Additional Inherited Members

Protected Member Functions inherited from ROL::Constraint< RealT >
const std::vector< RealTgetParameter (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.

References d_, dv_, m_, and n_.

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(), and OuterConstraint().

◆ n_

int OuterConstraint::n_
private

◆ m_

int OuterConstraint::m_
private

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