-
Notifications
You must be signed in to change notification settings - Fork 122
/
Power.h
65 lines (57 loc) · 2.25 KB
/
Power.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
// 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 {
/**
Provides the ability to raise the values in the workspace to a specified power.
Required Properties:
<UL>
<LI> InputWorkspace - The name of the workspace to correct</LI>
<LI> OutputWorkspace - The name of the corrected workspace (can be the same as
the input one)</LI>
<LI> exponent - The exponent to use in the power calculation</LI>
</UL>
@author Owen Arnold, Tessella plc
@date 12/04/2010
*/
class MANTID_ALGORITHMS_DLL Power : public UnaryOperation {
public:
/// Default constructor
Power();
/// Algorithm's name for identification
const std::string name() const override { return "Power"; }
/// Summary of algorithms purpose
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.";
}
/// Algorithm's version for identification
int version() const override { return 1; }
const std::vector<std::string> seeAlso() const override {
return {"Exponential", "Logarithm"};
}
/// Algorithm's category for identification overriding a virtual method
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;
/// calculate the power
inline double calculatePower(const double base, const double exponent);
/// Exponent to raise the base workspace to
double m_exponent;
};
} // namespace Algorithms
} // namespace Mantid