Alexandria  2.25.0
SDC-CH common library for the Euclid project
SecantMethod.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2022 Euclid Science Ground Segment
3  *
4  * This library is free software; you can redistribute it and/or modify it under
5  * the terms of the GNU Lesser General Public License as published by the Free
6  * Software Foundation; either version 3.0 of the License, or (at your option)
7  * any later version.
8  *
9  * This library is distributed in the hope that it will be useful, but WITHOUT
10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11  * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
12  * details.
13  *
14  * You should have received a copy of the GNU Lesser General Public License
15  * along with this library; if not, write to the Free Software Foundation, Inc.,
16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18 
19 #ifndef _FUNCTIONUTILS_SECANTMETHOD_H
20 #define _FUNCTIONUTILS_SECANTMETHOD_H
21 
23 #include <limits>
24 
25 namespace Euclid {
26 namespace MathUtils {
27 
29 
30 struct SecantParams {
32  double atol = 1e-8;
37 };
38 
39 struct SecantReturn {
40  double root;
43 };
44 
57 SecantReturn secantMethod(const Function& func, double x0, double x1, const SecantParams& params = SecantParams{});
58 
59 } // namespace MathUtils
60 } // namespace Euclid
61 
62 #endif // _FUNCTIONUTILS_SECANTMETHOD_H
Interface class representing a function with an arbitrary number of parameters.
Definition: Function.h:104
T infinity(T... args)
constexpr double e
SecantReturn secantMethod(const Function &func, double x0, double x1, const SecantParams &params=SecantParams{})
std::size_t max_iter
Maximum number of iterations.
Definition: SecantMethod.h:31
double min
If the gradient moves the next iteration below this limit, clip the result.
Definition: SecantMethod.h:34
double max
If the gradient moves the next iteration above this limit, clip the result.
Definition: SecantMethod.h:36
double root
Solution for the function.
Definition: SecantMethod.h:40
std::size_t iterations
Number of iterations.
Definition: SecantMethod.h:42
SecantEndReason reason
End reason.
Definition: SecantMethod.h:41