Fit1D.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2007 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/Algorithm.h"
#include "MantidAPI/IFunction.h"
#include "MantidCurveFitting/DllConfig.h"
 
namespace Mantid {
 
namespace CurveFitting {
namespace Algorithms {
class MANTID_CURVEFITTING_DLL Fit1D : public API::Algorithm {
public:
  const std::string name() const override { return "Fit1D"; }
  int version() const override { return (1); }
  const std::string category() const override { return "Optimization"; }
 
  virtual void function(const double *in, double *out, const double *xValues, const size_t nData) = 0;
  virtual void functionDeriv(const double *in, API::Jacobian *out, const double *xValues, const size_t nData);
 
protected:
  ~Fit1D() = default;
  // Overridden Algorithm methods
  void init() override;
  void exec() override;
 
  virtual void modifyStartOfRange(double &startX) {
    (void)startX; // Avoid compiler warning
  }
  virtual void modifyEndOfRange(double &endX) {
    (void)endX; // Avoid compiler warning
  }
 
  virtual void declareAdditionalProperties(){};
  virtual void prepare(){};
 
  virtual void afterDataRangedDetermined(const int &m_minX, const int &m_maxX) {
    (void)m_minX;
    (void)m_maxX; // Avoid compiler warning
  };
 
  virtual void declareParameters() = 0;
 
  virtual void modifyInitialFittedParameters(std::vector<double> &fittedParameter);
 
  virtual void modifyFinalFittedParameters(std::vector<double> &fittedParameter);
 
  std::vector<double> m_fittedParameter;
 
  std::vector<std::string> m_parameterNames;
 
  size_t nParams() const { return m_parameterNames.size(); }
 
  friend struct FitData;
};
 
} // namespace Algorithms
} // namespace CurveFitting
} // namespace Mantid