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
87
88
89
90
91
92
|
/**
* \file GyotoFunctors.h
* \brief Classes with an operator() method
*/
/*
Copyright 2011 Thibaut Paumard
This file is part of Gyoto.
Gyoto 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.
Gyoto 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 Gyoto. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef __GyotoFunctors_H_
#define __GyotoFunctors_H_
namespace Gyoto {
/**
* \namespace Gyoto::Functor
* \brief Classes with an operator() method
*/
namespace Functor {
class Double_constDoubleArray;
class Double_Double_const;
}
}
/**
* \brief A functor like double (func) (double const data[])
*/
class Gyoto::Functor::Double_constDoubleArray
{
public:
virtual ~Double_constDoubleArray();
/**
* \brief The actual function
*/
virtual double operator()(double const data[]) = 0;
};
/**
* \brief A functor like double (func) (double) const
*/
class Gyoto::Functor::Double_Double_const
{
public:
virtual ~Double_Double_const();
/**
* \brief Exit status code of "various" methods (at least secant() !)
*/
int status;
/**
* \brief The actual function
*/
virtual double operator()(double) const = 0;
/**
* \brief Ridder's root-finding method applied on operator()()
* \param from, to boundaries for root-searching
* \return the root
*/
double ridders(double from, double to) const;
/**
* \brief Secant root-finding method applied on operator()()
*
* Sets status to
* -0 in case of convergence
* -1 if two distinct inputs evaluated to the same output
* -2 if maximum number of iterations (20) reached
*
* \param from, to boundaries for root-finding
* \return the root
*/
double secant(double from, double to);
};
#endif
|
