/
ProductFunction.h
65 lines (53 loc) · 2.32 KB
/
ProductFunction.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
#ifndef MANTID_CURVEFITTING_PRODUCTFUNCTION_H_
#define MANTID_CURVEFITTING_PRODUCTFUNCTION_H_
//----------------------------------------------------------------------
// Includes
//----------------------------------------------------------------------
#include "MantidAPI/CompositeFunction.h"
#include <boost/shared_array.hpp>
#include <cmath>
namespace Mantid {
namespace CurveFitting {
namespace Functions {
/**
Allow user to create a fit function which is the product of two or
more other fit functions.
@author Anders Markvardsen, ISIS, RAL
@date 4/4/2011
Copyright © 2007-8 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>
Code Documentation is available at: <http://doxygen.mantidproject.org>
*/
class DLLExport ProductFunction : public API::CompositeFunction {
public:
/// overwrite IFunction base class methods
std::string name() const override { return "ProductFunction"; }
/// Function you want to fit to.
/// @param domain :: The space on which the function acts
/// @param values :: The buffer for writing the calculated values. Must be big
/// enough to accept dataSize() values
void function(const API::FunctionDomain &domain,
API::FunctionValues &values) const override;
/// Calculate the derivatives
void functionDeriv(const API::FunctionDomain &domain,
API::Jacobian &jacobian) override;
protected:
/// overwrite IFunction base class method, which declare function parameters
void init() override{};
};
} // namespace Functions
} // namespace CurveFitting
} // namespace Mantid
#endif /*MANTID_CURVEFITTING_PRODUCTFUNCTIONMW_H_*/