ROL
ROL_StdInequalityConstraint.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ************************************************************************
3 //
4 // Rapid Optimization Library (ROL) Package
5 // Copyright (2014) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact lead developers:
38 // Drew Kouri (dpkouri@sandia.gov) and
39 // Denis Ridzal (dridzal@sandia.gov)
40 //
41 // ************************************************************************
42 // @HEADER
43 
44 #ifndef ROL_STDINEQUALITYCONSTRAINT_HPP
45 #define ROL_STDINEQUALITYCONSTRAINT_HPP
46 
48 
55 namespace ROL {
56 
57 template<class Real>
59  public InequalityConstraint<Real> {
60 
62  typedef Vector<Real> V;
63 
64 public:
65 
67  void update( const Vector<Real> &x, bool flag = true, int iter = -1 ) {
68  StdEC::update(x,flag,iter);
69  }
70 
72  void value(V &c, const V &x, Real &tol ) {
73  StdEC::value(c,x,tol);
74  }
75 
77  void applyJacobian(V &jv, const V &v, const V &x, Real &tol) {
78  StdEC::applyJacobian(jv, v, x, tol);
79  }
80 
82  void applyAdjointJacobian(V &aju, const V &u, const V &x, Real &tol) {
83  StdEC::applyAdjointJacobian(aju, u, x, tol);
84  }
85 
87  void applyAdjointHessian(V &ahuv, const V &u, const V &v, const V &x, Real &tol) {
88  StdEC::applyAdjointHessian(ahuv, u, v, x, tol);
89 
90  }
91 
93  std::vector<Real> solveAugmentedSystem(Vector<Real> &v1, Vector<Real> &v2,
94  const Vector<Real> &b1, const Vector<Real> &b2,
95  const Vector<Real> &x, Real &tol) {
96  return StdEC::solveAugmentedSystem(v1,v2,b1,b2,x,tol);
97  }
98 
101  const Vector<Real> &g, Real &tol) {
102  StdEC::applyPreconditioner(pv,v,x,g,tol);
103  }
104 
105 }; // class StdInequalityConstraint
106 
107 } // namespace ROL
108 
109 #endif // ROL_STDINEQUALITYCONSTRAINT_HPP
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 ...
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 to vector in direction ...
void applyJacobian(V &jv, const V &v, const V &x, Real &tol)
Apply the constraint Jacobian at , , to vector .
void value(Vector< Real > &c, const Vector< Real > &x, Real &tol)
Evaluate the constraint operator at .
Defines the linear algebra or vector space interface.
Definition: ROL_Vector.hpp:76
void applyAdjointJacobian(V &aju, const V &u, const V &x, Real &tol)
Apply the adjoint of the the constraint Jacobian at , , to vector .
void applyPreconditioner(Vector< Real > &pv, const Vector< Real > &v, const Vector< Real > &x, const Vector< Real > &g, Real &tol)
Apply a constraint preconditioner at , , to vector . Ideally, this preconditioner satisfies the follo...
Defines the equality constraint operator interface.
Defines the equality constraint operator interface for StdVectors.
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 where , , , , is an identity or Riesz operator...
StdEqualityConstraint< Real > StdEC
Provides a unique argument for inequality constraints using std::vector types, which otherwise behave...
void applyAdjointJacobian(Vector< Real > &ajv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
Apply the adjoint of the the constraint Jacobian at , , to vector .
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 ...
void applyAdjointHessian(V &ahuv, const V &u, const V &v, const V &x, Real &tol)
Apply the derivative of the adjoint of the constraint Jacobian at to vector in direction ...
Provides a unique argument for inequality constraints, which otherwise behave exactly as equality con...
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 where , , , , is an identity or Riesz operator...
void applyPreconditioner(Vector< Real > &pv, const Vector< Real > &v, const Vector< Real > &x, const Vector< Real > &g, Real &tol)
Apply a constraint preconditioner at , , to vector . Ideally, this preconditioner satisfies the follo...
void applyJacobian(Vector< Real > &jv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
Apply the constraint Jacobian at , , to vector .
void value(V &c, const V &x, Real &tol)
Evaluate the constraint operator at .