DampedGaussNewtonMinimizer.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2009 ISIS Rutherford Appleton Laboratory UKRI,
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
// SPDX - License - Identifier: GPL - 3.0 +
#pragma once
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/IFuncMinimizer.h"
#include "MantidCurveFitting/EigenMatrix.h"
#include "MantidCurveFitting/EigenVector.h"
 
namespace Mantid {
namespace CurveFitting {
namespace CostFunctions {
class CostFuncLeastSquares;
} // namespace CostFunctions
namespace FuncMinimisers {
 
class MANTID_CURVEFITTING_DLL DampedGaussNewtonMinimizer : public API::IFuncMinimizer {
public:
  DampedGaussNewtonMinimizer(double relTol = 0.0001);
  std::string name() const override { return "DampedGaussNewtonMinimizer"; }
 
  void initialize(API::ICostFunction_sptr function, size_t maxIterations = 0) override;
  bool iterate(size_t) override;
  double costFunctionVal() override;
 
private:
  std::shared_ptr<CostFunctions::CostFuncLeastSquares> m_leastSquares;
  double m_relTol;
  // double m_damping;
};
} // namespace FuncMinimisers
} // namespace CurveFitting
} // namespace Mantid