ROL_NonlinearLeastSquaresObjective.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//               Rapid Optimization Library (ROL) Package
//
// Copyright 2014 NTESS and the ROL contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER

#ifndef ROL_NONLINEARLEASTSQUARESOBJECTIVE_H
#define ROL_NONLINEARLEASTSQUARESOBJECTIVE_H

#include "ROL_Objective.hpp"
#include "ROL_Constraint.hpp"
#include "ROL_Types.hpp"

namespace ROL {

template<typename Real>
class NonlinearLeastSquaresObjective : public Objective<Real> {
private:
  const Ptr<Constraint<Real> > con_;
  const bool GaussNewtonHessian_;

  Ptr<Vector<Real> > c1_, c2_, c1dual_, x_;

public:
  NonlinearLeastSquaresObjective(const Ptr<Constraint<Real> > &con,
                                 const Vector<Real> &optvec,
                                 const Vector<Real> &convec,
                                 const bool GNH = false);

  void update( const Vector<Real> &x, UpdateType type, int iter = -1 ) override;
  void update( const Vector<Real> &x, bool flag = true, int iter = -1 ) override;
  Real value( const Vector<Real> &x, Real &tol ) override;
  void gradient( Vector<Real> &g, const Vector<Real> &x, Real &tol ) override;
  void hessVec( Vector<Real> &hv, const Vector<Real> &v, const Vector<Real> &x, Real &tol ) override;
  void precond( Vector<Real> &Pv, const Vector<Real> &v, const Vector<Real> &x, Real &tol ) override;

// Definitions for parametrized (stochastic) equality constraints
public:
  void setParameter(const std::vector<Real> &param) override;
};

} // namespace ROL

#include "ROL_NonlinearLeastSquaresObjective_Def.hpp"

#endif