ROL
ROL_ObjectiveFromConstraint.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_OBJECTIVE_FROM_CONSTRAINT_H
45 #define ROL_OBJECTIVE_FROM_CONSTRAINT_H
46 
47 #include "ROL_Objective.hpp"
48 #include "ROL_Constraint.hpp"
49 
59 namespace ROL {
60 
61 template <class Real>
62 class ObjectiveFromConstraint : public Objective<Real> {
63 
64 private:
65 
66  ROL::Ptr<Constraint<Real> > con_;
67  ROL::Ptr<Vector<Real> > l_; // Lagrange multiplier
68  ROL::Ptr<Vector<Real> > c_; // Constraint vector
69 
70 
71 public:
72 
73  ObjectiveFromConstraint( const ROL::Ptr<Constraint<Real> > &con,
74  const Vector<Real> &l ) :
75  con_(con), l_(l.clone()), c_(l.dual().clone()) {
76  l_->set(l);
77  }
78 
80 
81  void update( const Vector<Real> &x, bool flag = true, int iter = -1 ) {
82  con_->update(x,flag,iter);
83  }
84 
85  Real value( const Vector<Real> &x, Real &tol ) {
86  con_->value(*c_,x,tol);
87  return l_->dot(c_->dual());
88  }
89 
90  void gradient( Vector<Real> &g, const Vector<Real> &x, Real &tol ) {
91  con_->applyAdjointJacobian(g,*l_,x,tol);
92  }
93 
94  void hessVec( Vector<Real> &hv, const Vector<Real> &v, const Vector<Real> &x, Real &tol ) {
95  con_->applyAdjointHessian(hv,*l_,v,x,tol);
96  }
97 
98  void updateMultiplier( const Vector<Real> &l ) {
99  l_->set(l);
100  }
101 
102 }; // class ObjectiveFromConstraint
103 
104 } // namespace ROL
105 
106 #endif // ROL_OBJECTIVE_FROM_CONSTRAINT_H
void updateMultiplier(const Vector< Real > &l)
Provides the interface to evaluate objective functions.
Form an objective function from a ROL::Constraint and a vector in the dual constraint space ...
Real value(const Vector< Real > &x, Real &tol)
Compute value.
void update(const Vector< Real > &x, bool flag=true, int iter=-1)
Update objective function.
void gradient(Vector< Real > &g, const Vector< Real > &x, Real &tol)
Compute gradient.
ROL::Ptr< Constraint< Real > > con_
Defines the linear algebra or vector space interface.
Definition: ROL_Vector.hpp:80
void hessVec(Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
Apply Hessian approximation to vector.
ObjectiveFromConstraint(const ROL::Ptr< Constraint< Real > > &con, const Vector< Real > &l)
Defines the general constraint operator interface.