IFuncMinimizer.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/DllConfig.h"
#include "MantidAPI/ICostFunction.h"
#include "MantidKernel/PropertyManager.h"
 
#include <string>
 
namespace Mantid {
namespace API {
// Forward declaration
class IFitFunction;
 
namespace MinimizerStatus {
inline const std::string SUCCESS = "success";
inline const std::string CHANGES_IN_FUNCTION_TOO_SMALL = "Changes in function value are too small";
inline const std::string CHANGES_IN_PARAMETER_TOO_SMALL = "Changes in parameter value are too small";
} // namespace MinimizerStatus
 
class MANTID_API_DLL IFuncMinimizer : public Kernel::PropertyManager {
public:
  virtual void initialize(API::ICostFunction_sptr function, size_t maxIterations = 1000) = 0;
 
  virtual std::string name() const = 0;
 
  virtual bool iterate(size_t iteration) = 0;
 
  virtual bool minimize(size_t maxIterations = 1000);
 
  virtual std::string getError() const { return m_errorString; }
 
  virtual double costFunctionVal() = 0;
 
  virtual void finalize() {}
 
protected:
  std::string m_errorString;
};
 
using IFuncMinimizer_sptr = std::shared_ptr<IFuncMinimizer>;
 
} // namespace API
} // namespace Mantid