Mercurial > octave
comparison scripts/ode/odeget.m @ 21546:f7f97d7e9294
doc: Wrap m-file docstrings to 79 characters + newline (80 total).
* isrecording.m, soundsc.m, delaunay3.m, cell2mat.m, cumtrapz.m, del2.m,
inputParser.m, interp1.m, interp3.m, narginchk.m, profile.m,
validateattributes.m, delaunayn.m, tsearchn.m, voronoin.m, brighten.m,
cmunique.m, colorcube.m, imfinfo.m, imshow.m, edit.m, orderfields.m, run.m,
warning_ids.m, ode23.m, ode45.m, odeget.m, integrate_adaptive.m, kahan.m,
ode_struct_value_check.m, runge_kutta_23.m, fminunc.m, fsolve.m, fzero.m,
pkg.m, build.m, specular.m, view.m, bar.m, barh.m, contour3.m, isosurface.m,
line.m, pie.m, pie3.m, quiver3.m, scatter.m, scatter3.m, stem3.m, stemleaf.m,
surfl.m, tetramesh.m, isfigure.m, mkpp.m, pchip.m, residue.m, splinefit.m,
rmpref.m, unique.m, eigs.m, ilu.m, factor.m, factorial.m, gallery.m, hankel.m,
histc.m, ols.m, finv.m, fpdf.m, kruskal_wallis_test.m, weekday.m:
Wrap m-file docstrings to 79 characters + newline (80 total).
author | Rik <rik@octave.org> |
---|---|
date | Sun, 27 Mar 2016 15:50:01 -0700 |
parents | 0fb9de5b7903 |
children | bac0d6f07a3e |
comparison
equal
deleted
inserted
replaced
21545:a81c9a0a05e3 | 21546:f7f97d7e9294 |
---|---|
22 ## @deftypefnx {} {@var{val} =} odeget (@var{ode_opt}, @var{field}, @var{default}) | 22 ## @deftypefnx {} {@var{val} =} odeget (@var{ode_opt}, @var{field}, @var{default}) |
23 ## | 23 ## |
24 ## Query the value of the property @var{field} in the ODE options structure | 24 ## Query the value of the property @var{field} in the ODE options structure |
25 ## @var{ode_opt}. | 25 ## @var{ode_opt}. |
26 ## | 26 ## |
27 ## If called with two input arguments and the first input argument @var{ode_opt} | 27 ## If called with two input arguments and the first input argument |
28 ## is an ODE option structure and the second input argument @var{field} is a | 28 ## @var{ode_opt} is an ODE option structure and the second input argument |
29 ## string specifying an option name, then return the option value @var{val} | 29 ## @var{field} is a string specifying an option name, then return the option |
30 ## corresponding to @var{field} from @var{ode_opt}. | 30 ## value @var{val} corresponding to @var{field} from @var{ode_opt}. |
31 ## | 31 ## |
32 ## If called with an optional third input argument, and @var{field} is | 32 ## If called with an optional third input argument, and @var{field} is |
33 ## not set in the structure @var{ode_opt}, then return the default value | 33 ## not set in the structure @var{ode_opt}, then return the default value |
34 ## @var{default} instead. | 34 ## @var{default} instead. |
35 ## @seealso{odeset} | 35 ## @seealso{odeset} |