Mercurial > octave-nkf

comparison scripts/ode/odeget.m @ 20580:25623ef2ff4f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 fcb792acab9b
children e368ce72a844
comparison
equal deleted inserted replaced
20579:52ce821a52fd 20580:25623ef2ff4f
16 ## You should have received a copy of the GNU General Public License 16 ## You should have received a copy of the GNU General Public License
17 ## along with Octave; see the file COPYING. If not, see 17 ## along with Octave; see the file COPYING. If not, see
18 ## <http://www.gnu.org/licenses/>. 18 ## <http://www.gnu.org/licenses/>.
19 19
20 ## -*- texinfo -*- 20 ## -*- texinfo -*-
21 ## @deftypefn {Function File} {[@var{}] =} odeget (@var{ode_opt}, @var{field}, [@var{default}], [@var{opt}]) 21 ## @deftypefn {Function File} {@var{option} =} odeget (@var{ode_opt}, @var{field})
22 ## @deftypefnx {Function File} {[@var{res}] =} odeget (@var{ode_opt}, @var{field}, [@var{default}], [@var{opt}]) 22 ## @deftypefnx {Function File} {@var{option} =} odeget (@var{ode_opt}, @var{field}, @var{default})
23 ##
24 ## Query the value of the property @var{field} in the ODE options structure
25 ## @var{ode_opt}.
23 ## 26 ##
24 ## If this function is called with two input arguments and the first input 27 ## If this function is called with two input arguments and the first input
25 ## argument @var{ode_opt} is of type structure array and the second input 28 ## argument @var{ode_opt} is of type structure array and the second input
26 ## argument @var{field} is of type string then return the option 29 ## argument @var{field} is of type string then return the option value
27 ## value @var{res} that is specified by the option name @var{field} in 30 ## @var{res} that is specified by the option name @var{field} in the ODE
28 ## the ODE option structure @var{ode_opt}. Optionally if this function 31 ## option structure @var{ode_opt}. Optionally if this function is called
29 ## is called with a third input argument then return the default value 32 ## with a third input argument then return the default value @var{default} if
30 ## @var{default} if @var{field} is not set in the structure @var{ode_opt}. 33 ## @var{field} is not set in the structure @var{ode_opt}.
34 ## @seealso{odeset}
31 ## @end deftypefn 35 ## @end deftypefn
32 ##
33 36
34 ## Note: 20061022, Thomas Treichl 37 ## Note: 2006-10-22, Thomas Treichl
35 ## We cannot create a function of the form odeget (@var{odestruct}, 38 ## We cannot create a function of the form odeget (@var{odestruct},
36 ## @var{name1}, @var{name2}) because we would get a mismatch with 39 ## @var{name1}, @var{name2}) because we would get a mismatch with
37 ## the function form 1 like described above. 40 ## the function form 1 like described above.
38 41
39 function res = odeget (ode_opt, field, default, opt) 42 function res = odeget (ode_opt, field, default, opt)