ImmutableCompositeFunction.cpp

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 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 +
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/ImmutableCompositeFunction.h"
#include "MantidKernel/Exception.h"
 
#include <algorithm>
 
namespace Mantid::API {
 
using std::size_t;
 
//-----------------------------------------------------------------------------------------------
std::string ImmutableCompositeFunction::writeToString(const std::string &parentLocalAttributesStr) const {
  return IFunction::writeToString(parentLocalAttributesStr);
}
 
void ImmutableCompositeFunction::addFunction(IFunction *fun) { addFunction(IFunction_sptr(fun)); }
 
void ImmutableCompositeFunction::setParameter(const std::string &name, const double &value, bool explicitlySet) {
  auto alias = m_aliases.find(name);
  if (alias != m_aliases.end()) {
    CompositeFunction::setParameter(alias->second, value, explicitlySet);
  } else {
    CompositeFunction::setParameter(name, value, explicitlySet);
  }
}
 
void ImmutableCompositeFunction::setParameterDescription(const std::string &name, const std::string &description) {
  auto alias = m_aliases.find(name);
  if (alias != m_aliases.end()) {
    CompositeFunction::setParameterDescription(alias->second, description);
  } else {
    CompositeFunction::setParameterDescription(name, description);
  }
}
 
double ImmutableCompositeFunction::getParameter(const std::string &name) const {
  auto alias = m_aliases.find(name);
  if (alias != m_aliases.end()) {
    return CompositeFunction::getParameter(alias->second);
  }
  return CompositeFunction::getParameter(name);
}
 
size_t ImmutableCompositeFunction::parameterIndex(const std::string &name) const {
  auto alias = m_aliases.find(name);
  if (alias != m_aliases.end()) {
    return alias->second;
  }
  return CompositeFunction::parameterIndex(name);
}
 
std::string ImmutableCompositeFunction::parameterName(size_t i) const {
  const auto found =
      std::find_if(m_aliases.cbegin(), m_aliases.cend(), [i](const auto &element) { return element.second == i; });
  if (found == m_aliases.cend()) {
    return CompositeFunction::parameterName(i);
  } else {
    return found->first;
  }
}
 
//-----------------------------------------------------------------------------------------------
void ImmutableCompositeFunction::setAlias(const std::string &parName, const std::string &alias) {
  // make sure the alias is unique
  if (m_aliases.count(alias) > 0) {
    throw Kernel::Exception::ExistsError("ImmutableCompositeFunction", alias);
  }
  m_aliases[alias] = CompositeFunction::parameterIndex(parName);
}
 
void ImmutableCompositeFunction::addDefaultTies(const std::string &ties) { CompositeFunction::addTies(ties, true); }
 
void ImmutableCompositeFunction::addDefaultConstraints(const std::string &constraints) {
  CompositeFunction::addConstraints(constraints, true);
}
 
} // namespace Mantid::API