Mercurial > octave-nkf
comparison scripts/ode/private/integrate_adaptive.m @ 20580:25623ef2ff4f
doc: Rewrite docstrings for ode* family of functions.
* scripts/ode/module.mk: Remove extra newline.
* ode45.m, odeget.m, odeset.m: Rewrite docstrings.
* AbsRel_Norm.m, fuzzy_compare.m, hermite_quartic_interpolation.m,
integrate_adaptive.m, integrate_const.m, integrate_n_steps.m, kahan.m,
ode_struct_value_check.m, odepkg_event_handle.m, odepkg_structure_check.m,
runge_kutta_45_dorpri.m, starting_stepsize.m:
Don't break @deftypefn lines. Wrap lines at 80 columns rather than 72.
author | Rik <rik@octave.org> |
---|---|
date | Sat, 03 Oct 2015 21:03:16 -0700 |
parents | 3339c9bdfe6a |
children | eb9e2d187ed2 |
comparison
equal
deleted
inserted
replaced
20579:52ce821a52fd | 20580:25623ef2ff4f |
---|---|
14 ## | 14 ## |
15 ## You should have received a copy of the GNU General Public License | 15 ## You should have received a copy of the GNU General Public License |
16 ## along with Octave; see the file COPYING. If not, see | 16 ## along with Octave; see the file COPYING. If not, see |
17 ## <http://www.gnu.org/licenses/>. | 17 ## <http://www.gnu.org/licenses/>. |
18 | 18 |
19 | |
20 ## -*- texinfo -*- | 19 ## -*- texinfo -*- |
21 ## @deftypefn {Command} {[@var{t}, @var{y}] =} | 20 ## @deftypefn {Function File} {[@var{t}, @var{y}] =} integrate_adaptive (@var{@@stepper}, @var{order}, @var{@@fun}, @var{tspan}, @var{x0}, @var{options}) |
22 ## integrate_adaptive (@var{@@stepper}, @var{order}, @var{@@fun}, @var{tspan}, | 21 ## |
23 ## @var{x0}, @var{options}) | 22 ## This function file can be called by an ODE solver function in order to |
24 ## | |
25 ## This function file can be called by a ODE solver function in order to | |
26 ## integrate the set of ODEs on the interval @var{[t0,t1]} with an | 23 ## integrate the set of ODEs on the interval @var{[t0,t1]} with an |
27 ## adaptive timestep. | 24 ## adaptive timestep. |
28 ## | 25 ## |
29 ## This function must be called with two output arguments: @var{t} and @var{y}. | 26 ## This function must be called with two output arguments: @var{t} and @var{y}. |
30 ## Variable @var{t} is a column vector and contains the time stamps, instead | 27 ## Variable @var{t} is a column vector and contains the time stamps, instead |
33 ## that each row of @var{y} contains the values of all unknowns at the time | 30 ## that each row of @var{y} contains the values of all unknowns at the time |
34 ## value contained in the corresponding row in @var{t}. | 31 ## value contained in the corresponding row in @var{t}. |
35 ## | 32 ## |
36 ## The first input argument must be a function_handle or an inline function | 33 ## The first input argument must be a function_handle or an inline function |
37 ## representing the stepper, that is the function responsible for step-by-step | 34 ## representing the stepper, that is the function responsible for step-by-step |
38 ## integration. This function discriminates one method from the others. | 35 ## integration. This function discriminates one method from the others. |
39 ## | 36 ## |
40 ## The second input argument is the order of the stepper. It is needed | 37 ## The second input argument is the order of the stepper. It is needed |
41 ## to compute the adaptive timesteps. | 38 ## to compute the adaptive timesteps. |
42 ## | 39 ## |
43 ## The third input argument is a function_handle or an inline function that | 40 ## The third input argument is a function_handle or an inline function that |
44 ## defines the set of ODE: | 41 ## defines the set of ODE: |
45 ## @ifhtml | 42 ## @ifhtml |