IFunctionMD.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/FunctionFactory.h"
#include "MantidAPI/IFunction.h"
#include "MantidAPI/IMDIterator.h"
#include "MantidGeometry/MDGeometry/IMDDimension.h"
#include "MantidKernel/Unit.h"
#ifndef Q_MOC_RUN
#include <boost/scoped_array.hpp>
#include <boost/variant.hpp>
#endif
#include <memory>
#include <string>
#include <vector>
 
namespace Mantid {
 
namespace API {
//----------------------------------------------------------------------
// Forward declaration
//----------------------------------------------------------------------
class IMDWorkspace;
class IMDIterator;
class Jacobian;
class ParameterTie;
class IConstraint;
class ParameterReference;
class FunctionHandler;
class FunctionDomainMD;
 
class MANTID_API_DLL IFunctionMD : public virtual IFunction {
public:
  /* Overidden methods */
 
  std::shared_ptr<IFunction> clone() const override;
  void setWorkspace(std::shared_ptr<const Workspace> ws) override;
 
  void function(const FunctionDomain &domain, FunctionValues &values) const override;
  void functionDeriv(const FunctionDomain &domain, Jacobian &jacobian) override { calNumericalDeriv(domain, jacobian); }
 
protected:
  void evaluateFunction(const FunctionDomainMD &domain, FunctionValues &values) const;
 
  virtual void useDimension(const std::string &id);
  virtual void initDimensions() {}
  virtual double functionMD(const IMDIterator &r) const = 0;
 
  std::map<std::string, size_t> m_dimensionIndexMap;
  std::vector<std::shared_ptr<const Mantid::Geometry::IMDDimension>> m_dimensions;
 
private:
  virtual void useAllDimensions(std::shared_ptr<const IMDWorkspace> workspace);
};
 
} // namespace API
} // namespace Mantid