ROL
ROL_NonlinearLeastSquaresObjective_Def.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_DEF_H
45#define ROL_NONLINEARLEASTSQUARESOBJECTIVE_DEF_H
46
47namespace ROL {
48
49template<typename Real>
51 const Vector<Real> &optvec,
52 const Vector<Real> &convec,
53 const bool GNH)
54 : con_(con), GaussNewtonHessian_(GNH) {
55 c1_ = convec.clone(); c1dual_ = c1_->dual().clone();
56 c2_ = convec.clone();
57 x_ = optvec.dual().clone();
58}
59
60template<typename Real>
62 Real tol = std::sqrt(ROL_EPSILON<Real>());
63 con_->update(x,type,iter);
64 con_->value(*c1_,x,tol);
65 c1dual_->set(c1_->dual());
66}
67
68template<typename Real>
69void NonlinearLeastSquaresObjective<Real>::update( const Vector<Real> &x, bool flag, int iter ) {
70 Real tol = std::sqrt(ROL_EPSILON<Real>());
71 con_->update(x,flag,iter);
72 con_->value(*c1_,x,tol);
73 c1dual_->set(c1_->dual());
74}
75
76template<typename Real>
78 Real half(0.5);
79 return half*(c1_->dot(*c1_));
80}
81
82template<typename Real>
84 con_->applyAdjointJacobian(g,*c1dual_,x,tol);
85}
86
87template<typename Real>
89 con_->applyJacobian(*c2_,v,x,tol);
90 con_->applyAdjointJacobian(hv,c2_->dual(),x,tol);
91 if ( !GaussNewtonHessian_ ) {
92 con_->applyAdjointHessian(*x_,*c1dual_,v,x,tol);
93 hv.plus(*x_);
94 }
95}
96
97template<typename Real>
99 con_->applyPreconditioner(Pv,v,x,x.dual(),tol);
100}
101
102template<typename Real>
103void NonlinearLeastSquaresObjective<Real>::setParameter(const std::vector<Real> &param) {
105 con_->setParameter(param);
106}
107
108} // namespace ROL
109
110#endif
Defines the general constraint operator interface.
NonlinearLeastSquaresObjective(const Ptr< Constraint< Real > > &con, const Vector< Real > &optvec, const Vector< Real > &convec, const bool GNH=false)
Constructor.
void update(const Vector< Real > &x, UpdateType type, int iter=-1) override
Update objective function.
void gradient(Vector< Real > &g, const Vector< Real > &x, Real &tol) override
Compute gradient.
void setParameter(const std::vector< Real > &param) override
void hessVec(Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol) override
Apply Hessian approximation to vector.
void precond(Vector< Real > &Pv, const Vector< Real > &v, const Vector< Real > &x, Real &tol) override
Apply preconditioner to vector.
Real value(const Vector< Real > &x, Real &tol) override
Compute value.
virtual void setParameter(const std::vector< Real > &param)
Defines the linear algebra or vector space interface.
virtual const Vector & dual() const
Return dual representation of , for example, the result of applying a Riesz map, or change of basis,...
virtual void plus(const Vector &x)=0
Compute , where .
virtual ROL::Ptr< Vector > clone() const =0
Clone to make a new (uninitialized) vector.