1 %feature("docstring") gum::IApproximationSchemeConfiguration::burnIn
2 "
3 Returns
4 -------
5 int
6 	size of burn in on number of iteration
7 "
8 
9 %feature("docstring") gum::IApproximationSchemeConfiguration::currentTime
10 "
11 Returns
12 -------
13 double
14 	get the current running time in second (double)
15 "
16 
17 %feature("docstring") gum::IApproximationSchemeConfiguration::epsilon
18 "
19 Returns
20 -------
21 double
22 	the value of epsilon
23 "
24 
25 %feature("docstring") gum::IApproximationSchemeConfiguration::history
26 "
27 Returns
28 -------
29 tuple
30 	the scheme history
31 
32 Raises
33 ------
34 pyAgrum.OperationNotAllowed
35 	If the scheme did not performed or if verbosity is set to false
36 "
37 
38 %feature("docstring") gum::IApproximationSchemeConfiguration::maxIter
39 "
40 Returns
41 -------
42 int
43 	the criterion on number of iterations
44 "
45 
46 %feature("docstring") gum::IApproximationSchemeConfiguration::maxTime
47 "
48 Returns
49 -------
50 double
51 	the timeout(in seconds)
52 "
53 
54 %feature("docstring") gum::IApproximationSchemeConfiguration::messageApproximationScheme
55 "
56 Returns
57 -------
58 str
59 	the approximation scheme message
60 "
61 
62 %feature("docstring") gum::IApproximationSchemeConfiguration::minEpsilonRate
63 "
64 Returns
65 -------
66 double
67 	the value of the minimal epsilon rate
68 "
69 
70 %feature("docstring") gum::IApproximationSchemeConfiguration::nbrIterations
71 "
72 Returns
73 -------
74 int
75 	the number of iterations
76 "
77 
78 %feature("docstring") gum::IApproximationSchemeConfiguration::periodSize
79 "
80 Returns
81 -------
82 int
83 	the number of samples between 2 stopping
84 
85 Raises
86 ------
87 pyAgrum.OutOfBounds
88 	If p<1
89 "
90 
91 %feature("docstring") gum::IApproximationSchemeConfiguration::setBurnIn
92 "
93 Parameters
94 ----------
95 b : int
96 	size of burn in on number of iteration
97 "
98 
99 %feature("docstring") gum::IApproximationSchemeConfiguration::setEpsilon
100 "
101 Parameters
102 ----------
103 eps : double
104 	the epsilon we want to use
105 
106 Raises
107 ------
108 pyAgrum.OutOfBounds
109 	If eps<0
110 "
111 
112 
113 %feature("docstring") gum::IApproximationSchemeConfiguration::setMaxIter
114 "
115 Parameters
116 ----------
117 max : int
118 	the maximum number of iteration
119 
120 Raises
121 ------
122 pyAgrum.OutOfBounds
123 	If max <= 1
124 "
125 
126 %feature("docstring") gum::IApproximationSchemeConfiguration::setMaxTime
127 "
128 Parameters
129 ----------
130 tiemout : double
131 	stopping criterion on timeout (in seconds)
132 
133 Raises
134 ------
135 pyAgrum.OutOfBounds
136 	If timeout<=0.0
137 "
138 
139 %feature("docstring") gum::IApproximationSchemeConfiguration::setMinEpsilonRate
140 "
141 Parameters
142 ----------
143 rate : double
144 	the minimal epsilon rate
145 "
146 
147 %feature("docstring") gum::IApproximationSchemeConfiguration::setPeriodSize
148 "
149 Parameters
150 ----------
151 p : int
152 	number of samples between 2 stopping
153 
154 Raises
155 ------
156 pyAgrum.OutOfBounds
157 	If p<1
158 "
159 
160 
161 %feature("docstring") gum::IApproximationSchemeConfiguration::setVerbosity
162 "
163 Parameters
164 ----------
165 v : bool
166         verbosity
167 "
168 
169 %feature("docstring") gum::IApproximationSchemeConfiguration::verbosity
170 "
171 Returns
172 -------
173 bool
174 	True if the verbosity is enabled
175 "
176