Power.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
 
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAlgorithms/UnaryOperation.h"
 
namespace Mantid {
namespace Algorithms {
 
class MANTID_ALGORITHMS_DLL Power : public UnaryOperation {
public:
  Power();
  const std::string name() const override { return "Power"; }
  const std::string summary() const override {
    return "The Power algorithm will raise the base workspace to a particular "
           "power. Corresponding error values will be created.";
  }
 
  int version() const override { return 1; }
  const std::vector<std::string> seeAlso() const override { return {"Exponential", "Logarithm"}; }
  const std::string category() const override { return "Arithmetic"; }
 
private:
  // Overridden UnaryOperation methods
  void defineProperties() override;
  void retrieveProperties() override;
  void performUnaryOperation(const double XIn, const double YIn, const double EIn, double &YOut, double &EOut) override;
  inline double calculatePower(const double base, const double exponent);
  double m_exponent;
};
} // namespace Algorithms
} // namespace Mantid