CalculateCostFunction.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 +
#include "MantidCurveFitting/Algorithms/CalculateCostFunction.h"
 
#include "MantidAPI/CostFunctionFactory.h"
#include "MantidCurveFitting/CostFunctions/CostFuncFitting.h"
#include "MantidKernel/ListValidator.h"
 
namespace Mantid::CurveFitting::Algorithms {
 
using namespace Kernel;
using namespace API;
 
// Register the algorithm into the AlgorithmFactory
DECLARE_ALGORITHM(CalculateCostFunction)
 
//----------------------------------------------------------------------------------------------
 
 
const std::string CalculateCostFunction::name() const { return "CalculateCostFunction"; }
 
int CalculateCostFunction::version() const { return 1; }
 
const std::string CalculateCostFunction::summary() const {
  return "Calculate cost function for a function and a data set in a "
         "workspace.";
}
 
//----------------------------------------------------------------------------------------------
void CalculateCostFunction::initConcrete() {
  declareCostFunctionProperty();
  declareProperty("Value", 0.0, "Output value of the cost function.", Direction::Output);
}
 
//----------------------------------------------------------------------------------------------
void CalculateCostFunction::execConcrete() {
 
  if (!m_costFunction) {
    m_costFunction = getCostFunctionInitialized();
  }
 
  // Get the result.
  double value = m_costFunction->val();
  // Store the result.
  setProperty("Value", value);
}
 
} // namespace Mantid::CurveFitting::Algorithms