-
Notifications
You must be signed in to change notification settings - Fork 121
/
Exponential.h
86 lines (71 loc) · 2.99 KB
/
Exponential.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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
#ifndef MANTID_ALGORITHM_EXPONENTIAL_H_
#define MANTID_ALGORITHM_EXPONENTIAL_H_
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAlgorithms/UnaryOperation.h"
namespace Mantid {
namespace Algorithms {
/**
Exponential performs the exponential function on an input workspace.
It inherits from the Algorithm class, and overrides
the init() & exec() methods.
Required Properties:
<UL>
<LI> InputWorkspace1 - The name of the workspace </LI>
<LI> Exponent - The value of the exponent to raise each value to </LI>
<LI> OutputWorkspace - The name of the workspace in which to store the output
data </LI>
</UL>
@author Ron Fowler
@date 12/05/2010
Copyright © 2007-2010 ISIS Rutherford Appleton Laboratory, NScD Oak Ridge
National Laboratory & European Spallation Source
This file is part of Mantid.
Mantid is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
Mantid is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
File change history is stored at: <https://github.com/mantidproject/mantid>
*/
class DLLExport Exponential : public UnaryOperation {
public:
/// Default constructor
Exponential();
/// Algorithm's name for identification overriding a virtual method
const std::string name() const override { return "Exponential"; }
/// Summary of algorithms purpose
const std::string summary() const override {
return "The Exponential algorithm will transform the signal values 'y' "
"into e^y.";
}
/// Algorithm's version for identification overriding a virtual method
int version() const override { return (1); }
private:
// Overridden UnaryOperation methods
void performUnaryOperation(const double XIn, const double YIn,
const double EIn, double &YOut,
double &EOut) override;
/*
void performBinaryOperation(const MantidVec& lhsX, const MantidVec& lhsY,
const MantidVec& lhsE,
const MantidVec& rhsY, const MantidVec& rhsE,
MantidVec& YOut, MantidVec& EOut);
void performBinaryOperation(const MantidVec& lhsX, const MantidVec& lhsY,
const MantidVec& lhsE,
const double& rhsY, const double& rhsE, MantidVec&
YOut, MantidVec& EOut);
*/
// try and set output units field
// void setOutputUnits(const API::MatrixWorkspace_const_sptr
// lhs,API::MatrixWorkspace_sptr out);
};
} // namespace Algorithm
} // namespace Mantid
#endif /*MANTID_ALGORITHM_EXPONENTIAL_H_*/