ROL
ROL_NonlinearLeastSquaresObjective.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_NONLINEARLEASTSQUARESOBJECTIVE_H
45 #define ROL_NONLINEARLEASTSQUARESOBJECTIVE_H
46 
47 #include "ROL_Objective.hpp"
48 #include "ROL_Constraint.hpp"
49 #include "ROL_Types.hpp"
50 
70 namespace ROL {
71 
72 template <class Real>
74 private:
75  const ROL::Ptr<Constraint<Real> > con_;
76  const bool GaussNewtonHessian_;
77 
78  ROL::Ptr<Vector<Real> > c1_, c2_, c1dual_, x_;
79 
80 public:
89  const Vector<Real> &optvec,
90  const Vector<Real> &convec,
91  const bool GNH = false)
92  : con_(con), GaussNewtonHessian_(GNH) {
93  c1_ = convec.clone(); c1dual_ = c1_->dual().clone();
94  c2_ = convec.clone();
95  x_ = optvec.dual().clone();
96  }
97 
98  void update( const Vector<Real> &x, bool flag = true, int iter = -1 ) {
99  Real tol = std::sqrt(ROL_EPSILON<Real>());
100  con_->update(x,flag,iter);
101  con_->value(*c1_,x,tol);
102  c1dual_->set(c1_->dual());
103  }
104 
105  Real value( const Vector<Real> &x, Real &tol ) {
106  Real half(0.5);
107  return half*(c1_->dot(*c1dual_));
108  }
109 
110  void gradient( Vector<Real> &g, const Vector<Real> &x, Real &tol ) {
111  con_->applyAdjointJacobian(g,*c1dual_,x,tol);
112  }
113 
114  void hessVec( Vector<Real> &hv, const Vector<Real> &v, const Vector<Real> &x, Real &tol ) {
115  con_->applyJacobian(*c2_,v,x,tol);
116  con_->applyAdjointJacobian(hv,c2_->dual(),x,tol);
117  if ( !GaussNewtonHessian_ ) {
118  con_->applyAdjointHessian(*x_,*c1dual_,v,x,tol);
119  hv.plus(*x_);
120  }
121  }
122 
123 // Definitions for parametrized (stochastic) equality constraints
124 public:
125  void setParameter(const std::vector<Real> &param) {
127  con_->setParameter(param);
128  }
129 };
130 
131 } // namespace ROL
132 
133 #endif
Provides the interface to evaluate objective functions.
virtual const Vector & dual() const
Return dual representation of , for example, the result of applying a Riesz map, or change of basis...
Definition: ROL_Vector.hpp:226
virtual ROL::Ptr< Vector > clone() const =0
Clone to make a new (uninitialized) vector.
virtual void plus(const Vector &x)=0
Compute , where .
NonlinearLeastSquaresObjective(const ROL::Ptr< Constraint< Real > > &con, const Vector< Real > &optvec, const Vector< Real > &convec, const bool GNH=false)
Constructor.
Contains definitions of custom data types in ROL.
void gradient(Vector< Real > &g, const Vector< Real > &x, Real &tol)
Compute gradient.
void update(const Vector< Real > &x, bool flag=true, int iter=-1)
Update objective function.
Defines the linear algebra or vector space interface.
Definition: ROL_Vector.hpp:80
void setParameter(const std::vector< Real > &param)
virtual void setParameter(const std::vector< Real > &param)
Provides the interface to evaluate nonlinear least squares objective functions.
Real value(const Vector< Real > &x, Real &tol)
Compute value.
void hessVec(Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
Apply Hessian approximation to vector.
Defines the general constraint operator interface.