MultiDomainFunction.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/CompositeFunction.h"
 
#include <map>
 
namespace Mantid {
namespace API {
class CompositeDomain;
class MANTID_API_DLL MultiDomainFunction : public CompositeFunction {
public:
  MultiDomainFunction();
 
  std::string name() const override { return "MultiDomainFunction"; }
  void function(const FunctionDomain &domain, FunctionValues &values) const override;
  void functionDeriv(const FunctionDomain &domain, Jacobian &jacobian) override;
  void iterationStarting() override;
  void iterationFinished() override;
 
  void setDomainIndex(size_t funIndex, size_t domainIndex);
  void setDomainIndices(size_t funIndex, const std::vector<size_t> &domainIndices);
  void clearDomainIndices();
  size_t getMaxIndex() const { return m_maxIndex; }
  void getDomainIndices(size_t funIndex, size_t nDomains, std::vector<size_t> &domains) const;
  size_t getNumberDomains() const override;
  std::vector<IFunction_sptr> createEquivalentFunctions() const override;
 
  size_t nLocalAttributes() const override { return 1; }
  std::vector<std::string> getLocalAttributeNames() const override { return std::vector<std::string>(1, "domains"); }
  Attribute getLocalAttribute(size_t funIndex, const std::string &attName) const override;
  void setLocalAttribute(size_t funIndex, const std::string &attName, const Attribute &) override;
  bool hasLocalAttribute(const std::string &attName) const override { return attName == "domains"; }
 
protected:
  void countNumberOfDomains();
  void countValueOffsets(const CompositeDomain &domain) const;
 
  std::map<size_t, std::vector<size_t>> m_domains;
  size_t m_nDomains;
  size_t m_maxIndex;
  mutable std::vector<size_t> m_valueOffsets;
};
 
} // namespace API
} // namespace Mantid