@@ -181,17 +181,18 @@ allow to specify, when the algorithm switches from contraction to Newton-Kantoro
181181iterations and general parameters, which let the algorithm stop. So far, there is no
182182switching back implemented.
183183
184- **max_cont_steps : ** *(int) * The maximum number of contraction iterations before
185- switching to Newton-Kantorovich iterations. Default is 20.
184+ - **max_cont_steps : ** *(int) * The maximum number of contraction iterations before
185+ switching to Newton-Kantorovich iterations. Default is 20.
186186
187- **switch_tol : ** *(float) * If this threshold is reached by contraction iterations, then
188- the algorithm switches to Newton-Kantorovich iterations. Default is :math: `10 ^{-3 }`.
187+ - **switch_tol : ** *(float) * If this threshold is reached by contraction iterations,
188+ then the algorithm switches to Newton-Kantorovich iterations. Default is
189+ :math: `10 ^{-3 }`.
189190
190- **max_newt_kant_steps : ** *(int) * The maximum number of Newton-Kantorovich iterations
191- before the algorithm stops. Default is 20.
191+ - **max_newt_kant_steps : ** *(int) * The maximum number of Newton-Kantorovich iterations
192+ before the algorithm stops. Default is 20.
192193
193- **threshold : ** *(float) * If this threshold is reached by Newton-Kantorovich iterations,
194- then the algorithm stops. Default is :math: `10 ^{-12 }`.
194+ - **threshold : ** *(float) * If this threshold is reached by Newton-Kantorovich
195+ iterations, then the algorithm stops. Default is :math: `10 ^{-12 }`.
195196
196197.. _ev :
197198
@@ -292,23 +293,22 @@ This dictionairy provides all the necessary information about how the demand
292293function is supposed to look like and how precisely it is supposed to be calculated.
293294It has to hold the following keys:
294295
295- **RC_lower_bound : ** *(float) * The lowest replacement cost for which the demand
296- is supposed to be calculated.
296+ - **RC_lower_bound : ** *(float) * The lowest replacement cost for which the demand is
297+ supposed to be calculated.
297298
298- **RC_upper_bound : ** *(float) * The highest replacement cost for which the demand
299- is supposed to be calculated.
299+ - **RC_upper_bound : ** *(float) * The highest replacement cost for which the demand is
300+ supposed to be calculated.
300301
301- **demand_evaluations : ** *(int) * The grid size of the replacement cost between
302- RC_lower_bound and RC_upper_bound for which the demand level shall be calculated.
302+ - **demand_evaluations : ** *(int) * The grid size of the replacement cost between
303+ RC_lower_bound and RC_upper_bound for which the demand level shall be calculated.
303304
304- **tolerance : ** *(float) * The stopping tolerance for the fixed point calculation
305- needed to obtain each demand level.
305+ - **tolerance : ** *(float) * The stopping tolerance for the fixed point calculation
306+ needed to obtain each demand level.
306307
307- **num_periods : ** *(int) * Number of months :math: `T` for which the expected demand
308- is derived. Consequently, set it to 12 if you want to get the annual expected demand.
308+ - **num_periods : ** *(int) * Number of months :math: `T` for which the expected demand
309+ is derived. Consequently, set it to 12 if you want to get the annual expected demand.
309310
310- **num_buses : ** *(int) * Number of buses :math: `M` for which the demand is
311- calculated.
311+ - **num_buses : ** *(int) * Number of buses :math: `M` for which the demand is calculated.
312312
313313
314314.. _demand_params :
@@ -342,5 +342,4 @@ which indicates whether the fixed point algorithm converged successfully.
342342
343343
344344The use of the ``get_demand `` function is shown in the following `replication
345- <https://github.com/OpenSourceEconomics/ruspy/blob/kantevorich/promotion
346- /replication/replication.ipynb> `_ notebook.
345+ <tutorials/replication/replication.ipynb> `_ notebook.
0 commit comments