1%define OT_TemperatureProfile_doc
2"Base class to define a temperature profile.
3
4Notes
5-----
6The temperature profile is used in simulated annealing context
7"
8%enddef
9%feature("docstring") OT::TemperatureProfileImplementation
10OT_TemperatureProfile_doc
11
12// ---------------------------------------------------------------------
13%define OT_TemperatureProfile_call_doc
14"Compute the temperature T(i).
15
16Parameters
17----------
18i : int
19    The index for whome we seek temperature
20
21Returns
22-------
23temperature:  float
24    The temperature"
25%enddef
26%feature("docstring") OT::TemperatureProfileImplementation::operator()
27OT_TemperatureProfile_call_doc
28
29// ---------------------------------------------------------------------
30
31%define OT_TemperatureProfile_getIMax
32"Maximum index value accessor.
33
34Returns
35-------
36iMax : int
37    The maximum index value"
38%enddef
39%feature("docstring") OT::TemperatureProfileImplementation::getIMax
40OT_TemperatureProfile_getIMax
41
42// ---------------------------------------------------------------------
43
44%define OT_TemperatureProfile_getT0
45"Temperature origin accessor.
46
47Returns
48-------
49t0 : float
50    The temperature origin"
51%enddef
52%feature("docstring") OT::TemperatureProfileImplementation::getT0
53OT_TemperatureProfile_getT0
54