Logarithm.h

Go to the documentation of this file.

// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2007 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
 
#include "MantidAlgorithms/UnaryOperation.h"
namespace Mantid {
namespace Algorithms {
class MANTID_ALGORITHMS_DLL Logarithm : public UnaryOperation {
public:
  Logarithm();
  const std::string name() const override { return "Logarithm"; }
  const std::string summary() const override {
    return "Logarithm function calculates the logarithm of the data, held in a "
           "workspace. A user can choose between natural (default) or base 10 "
           "logarithm";
  }
 
  int version() const override { return (1); }
  const std::vector<std::string> seeAlso() const override { return {"Power", "Exponential"}; }
  // cppcheck-suppress uselessOverride
  const std::string category() const override { return "Arithmetic"; }
 
private:
  double log_Min;
  bool is_natural;
 
  void defineProperties() override;
  void retrieveProperties() override;
  void performUnaryOperation(const double XIn, const double YIn, const double EIn, double &YOut, double &EOut) override;
};
 
} // End namespace Algorithms
} // End namespace Mantid