ICostFunction.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2010 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/CostFunctionFactory.h"
#include "MantidKernel/System.h"
 
namespace Mantid {
namespace API {
class MANTID_API_DLL ICostFunction {
public:
  virtual ~ICostFunction() = default;
 
  virtual std::string name() const = 0;
 
  virtual std::string shortName() const { return "Quality"; }
 
  virtual double getParameter(size_t i) const = 0;
  virtual void setParameter(size_t i, const double &value) = 0;
  virtual size_t nParams() const = 0;
 
  virtual double val() const = 0;
 
  virtual void deriv(std::vector<double> &der) const = 0;
 
  virtual double valAndDeriv(std::vector<double> &der) const = 0;
};
 
using ICostFunction_sptr = std::shared_ptr<ICostFunction>;
 
#define DECLARE_COSTFUNCTION(classname, username)                                                                      \
  namespace {                                                                                                          \
  Mantid::Kernel::RegistrationHelper register_costfunction_##classname(                                                \
      ((Mantid::API::CostFunctionFactory::Instance().subscribe<classname>(#username)), 0));                            \
  }
 
} // namespace API
} // namespace Mantid