CubicSpline.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 "MantidCurveFitting/Functions/BackgroundFunction.h"
 
#include <boost/scoped_array.hpp>
#include <gsl/gsl_errno.h>
#include <gsl/gsl_spline.h>
#include <valarray>
 
namespace Mantid {
namespace CurveFitting {
namespace Functions {
class MANTID_CURVEFITTING_DLL CubicSpline : public BackgroundFunction {
 
public:
  CubicSpline();
 
  std::string name() const override { return "CubicSpline"; }
  const std::string category() const override { return "Background"; }
  void function1D(double *out, const double *xValues, const size_t nData) const override;
  void derivative1D(double *out, const double *xValues, size_t nData, const size_t order) const override;
  void setParameter(size_t i, const double &value, bool explicitlySet = true) override;
  using ParamFunction::setParameter;
 
  void setAttribute(const std::string &attName, const Attribute &) override;
 
  void setXAttribute(const size_t index, double x);
 
private:
  const int m_min_points;
 
  struct GSLFree {
    void operator()(gsl_spline *spline) { gsl_spline_free(spline); }
    void operator()(gsl_interp_accel *acc) { gsl_interp_accel_free(acc); }
  } m_gslFree;
 
  std::shared_ptr<gsl_interp_accel> m_acc;
 
  std::shared_ptr<gsl_spline> m_spline;
 
  mutable bool m_recalculateSpline;
 
  void reallocGSLObjects(const int n);
 
  void setupInput(boost::scoped_array<double> &x, boost::scoped_array<double> &y, int n) const;
 
  void calculateSpline(double *out, const double *xValues, const size_t nData) const;
 
  void calculateDerivative(double *out, const double *xValues, const size_t nData, const size_t order) const;
 
  void initGSLObjects(boost::scoped_array<double> &x, boost::scoped_array<double> &y, int n) const;
 
  void checkGSLError(const int status, const int errorType) const;
 
  bool checkXInRange(double x) const;
 
  double splineEval(const double x) const;
};
 
using CubicSpline_sptr = std::shared_ptr<CubicSpline>;
using CubicSpline_const_sptr = const std::shared_ptr<CubicSpline>;
 
} // namespace Functions
} // namespace CurveFitting
} // namespace Mantid