ROL
ROL_ChainRuleObjective.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_CHAIN_RULE_OBJECTIVE_HPP
45 #define ROL_CHAIN_RULE_OBJECTIVE_HPP
46 
47 #include "ROL_Objective.hpp"
48 #include "ROL_Constraint.hpp"
49 
64 namespace ROL {
65 
66 template<typename Real>
67 class ChainRuleObjective : public ROL::Objective<Real> {
68 public:
69 
77  const Ptr<Constraint<Real>>& con,
78  const Vector<Real>& x,
79  const Vector<Real>& l )
80  : obj_(obj), con_(con), g_(l.clone()), y_(l.dual().clone()), Jv_(l.dual().clone()),
81  HJv_(l.clone()), JtHJv_(x.dual().clone()), tol_(0) {}
82 
83  virtual ~ChainRuleObjective() = default;
84 
92  virtual void update( const Vector<Real> &x, UpdateType type, int iter = -1 ) {
93  con_->update(x,type,iter);
94  con_->value(*y_,x,tol_);
95  obj_->update(*y_,type,iter);
96  }
97 
105  virtual void update( const Vector<Real> &x, bool flag = true, int iter = -1 ) {
106  con_->update(x,flag,iter);
107  con_->value(*y_,x,tol_);
108  obj_->update(*y_,flag,iter);
109  }
110 
117  virtual Real value( const Vector<Real> &x, Real &tol ) {
118  con_->value(*y_,x,tol);
119  return obj_->value(*y_,tol);
120  }
121 
130  virtual void gradient( Vector<Real> &g, const Vector<Real> &x, Real &tol ) {
131  con_->value(*y_,x,tol);
132  obj_->gradient(*g_,*y_,tol);
133  con_->applyAdjointJacobian(g,*g_,x,tol);
134  }
135 
144  virtual void hessVec( Vector<Real> &hv, const Vector<Real> &v, const Vector<Real> &x, Real &tol ) {
145  con_->value(*y_,x,tol);
146  obj_->gradient(*g_,*y_,tol);
147  con_->applyJacobian(*Jv_,v,x,tol);
148  obj_->hessVec(*HJv_,*Jv_,*y_,tol);
149  con_->applyAdjointJacobian(*JtHJv_,*HJv_,x,tol);
150  con_->applyAdjointHessian(hv,*g_,v,x,tol);
151  hv.plus(*JtHJv_);
152  }
153 
154 private:
155 
156  const Ptr<Objective<Real>> obj_;
157  const Ptr<Constraint<Real>> con_;
158  Ptr<Vector<Real>> g_, y_, Jv_, HJv_, JtHJv_;
159  Real tol_;
160 
161 }; // class ChainRuleObjective
162 
163 } // namespace ROL
164 
165 #endif // ROL_CHAIN_RULE_OBJECTIVE_HPP
Provides the interface to evaluate objective functions.
virtual void plus(const Vector &x)=0
Compute , where .
Defines the linear algebra or vector space interface.
Definition: ROL_Vector.hpp:80
ChainRuleObjective(const Ptr< Objective< Real >> &obj, const Ptr< Constraint< Real >> &con, const Vector< Real > &x, const Vector< Real > &l)
Constructor.
virtual void update(const Vector< Real > &x, bool flag=true, int iter=-1)
Update objective function.
virtual void hessVec(Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
Apply Hessian approximation to vector.
const Ptr< Objective< Real > > obj_
virtual void gradient(Vector< Real > &g, const Vector< Real > &x, Real &tol)
Compute gradient.
virtual Real value(const Vector< Real > &x, Real &tol)
Compute value.
Defines the general constraint operator interface.
virtual void update(const Vector< Real > &x, UpdateType type, int iter=-1)
Update objective function.
virtual ~ChainRuleObjective()=default
const Ptr< Constraint< Real > > con_
Defines an objective of the form f(g(x)) where.