Mercurial > octave-nkf

comparison scripts/ode/odeset.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
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 20
21 ## -*- texinfo -*- 21 ## -*- texinfo -*-
22 ## @deftypefn {Function File} {[@var{}] =} odeset () 22 ## @deftypefn {Function File} {} odeset ()
23 ## @deftypefnx {Function File} {[@var{odestruct}] =} odeset (@var{"field1"}, @var{value1}, @var{"field2"}, @var{value2}, @dots{}) 23 ## @deftypefnx {Function File} {@var{odestruct} =} odeset (@var{"field1"}, @var{value1}, @var{"field2"}, @var{value2}, @dots{})
24 ## @deftypefnx {Function File} {[@var{odestruct}] =} odeset (@var{oldstruct}, @var{"field1"}, @var{value1}, @var{"field2"}, @var{value2}, @dots{}) 24 ## @deftypefnx {Function File} {@var{odestruct} =} odeset (@var{oldstruct}, @var{"field1"}, @var{value1}, @var{"field2"}, @var{value2}, @dots{})
25 ## @deftypefnx {Function File} {[@var{odestruct}] =} odeset (@var{oldstruct}, 25 ## @deftypefnx {Function File} {@var{odestruct} =} odeset (@var{oldstruct}, @var{newstruct})
26 ## @var{newstruct}) 26 ##
27 ## 27 ## Create or modify an ODE options structure.
28 ## If this function is called without an input argument then return a new 28 ##
29 ## ODE options structure array that contains all the necessary fields and 29 ## If this function is called without an input argument then return a new ODE
30 ## sets the values of all fields to default values. 30 ## options structure array that contains all the necessary fields and sets
31 ## the values of all fields to default values.
31 ## 32 ##
32 ## If this function is called with string input arguments @var{"field1"}, 33 ## If this function is called with string input arguments @var{"field1"},
33 ## @var{"field2"}, @dots{} identifying valid ODE options then return a 34 ## @var{"field2"}, @dots{} identifying valid ODE options then return a new
34 ## new ODE options structure with all necessary fields and set the values 35 ## ODE options structure with all necessary fields and set the values of the
35 ## of the fields @var{"field1"}, @var{"field2"}, @dots{} to the values 36 ## fields @var{"field1"}, @var{"field2"}, @dots{} to the values @var{value1},
36 ## @var{value1}, @var{value2}, @dots{} 37 ## @var{value2}, @dots{}
37 ## 38 ##
38 ## If this function is called with a first input argument @var{oldstruct} 39 ## If this function is called with a first input argument @var{oldstruct} of
39 ## of type structure array then overwrite all values of the options 40 ## type structure array then overwrite all values of the options
40 ## @var{"field1"}, @var{"field2"}, @dots{} of the structure @var{oldstruct} 41 ## @var{"field1"}, @var{"field2"}, @dots{} of the structure @var{oldstruct}
41 ## with new values @var{value1}, @var{value2}, @dots{} and return the 42 ## with new values @var{value1}, @var{value2}, @dots{} and return the
42 ## modified structure array. 43 ## modified structure array.
43 ## 44 ##
44 ## If this function is called with two input arguments @var{oldstruct} 45 ## If this function is called with two input arguments @var{oldstruct} and
45 ## and @var{newstruct} of type structure array then overwrite all values 46 ## @var{newstruct} of type structure array then overwrite all values in the
46 ## in the fields from the structure @var{oldstruct} with new values of the 47 ## fields from the structure @var{oldstruct} with new values of the fields
47 ## fields from the structure @var{newstruct}. Empty values of @var{newstruct} 48 ## from the structure @var{newstruct}. Empty values of @var{newstruct} will
48 ## will not overwrite values in @var{oldstruct}. 49 ## not overwrite values in @var{oldstruct}.
50 ## @seealso{odeget}
49 ## @end deftypefn 51 ## @end deftypefn
50 ##
51 52
52 function opt = odeset (varargin) 53 function opt = odeset (varargin)
53 54
54 ## Check number and types of all input arguments 55 ## Check number and types of all input arguments
55 if ((nargin == 0) 56 if ((nargin == 0)