GSLFunctions.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
 
#include "MantidAPI/ICostFunction.h"
#include "MantidAPI/IFunction.h"
#include "MantidCurveFitting/CostFunctions/CostFuncLeastSquares.h"
#include "MantidCurveFitting/EigenJacobian.h"
#include <gsl/gsl_blas.h>
#include <gsl/gsl_multifit_nlin.h>
#include <gsl/gsl_multimin.h>
#include <gsl/gsl_statistics.h>
 
namespace Mantid {
namespace CurveFitting {
struct GSL_FitData {
  GSL_FitData(const std::shared_ptr<CostFunctions::CostFuncLeastSquares> &cf);
  ~GSL_FitData();
  size_t n;
  size_t p;
  API::IFunction_sptr function;
  std::shared_ptr<CostFunctions::CostFuncLeastSquares> costFunction;
  gsl_vector *initFuncParams;
  JacobianImpl1<EigenMatrix> J;
 
  // this is presently commented out in the implementation
  // gsl_matrix *holdCalculatedJacobian; ///< cache of the calculated jacobian
};
 
int gsl_f(const gsl_vector *x, void *params, gsl_vector *f);
int gsl_df(const gsl_vector *x, void *params, gsl_matrix *J);
int gsl_fdf(const gsl_vector *x, void *params, gsl_vector *f, gsl_matrix *J);
 
inline gsl_vector_view getGSLVectorView(vec_map_type &v) { return gsl_vector_view_array(v.data(), v.size()); }
inline gsl_matrix_view getGSLMatrixView(map_type &tr) { return gsl_matrix_view_array(tr.data(), tr.cols(), tr.rows()); }
 
inline gsl_vector_const_view const getGSLVectorView_const(const vec_map_type v) {
  return gsl_vector_const_view_array(v.data(), v.size());
}
inline gsl_matrix_const_view const getGSLMatrixView_const(const map_type m) {
  return gsl_matrix_const_view_array(m.data(), m.cols(), m.rows());
}
 
} // namespace CurveFitting
} // namespace Mantid