Mercurial > octave-nkf

comparison scripts/ode/private/starting_stepsize.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 6256f6e366ac
children eb9e2d187ed2
comparison
equal deleted inserted replaced
20579:52ce821a52fd 20580:25623ef2ff4f
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 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Command} {[@var{h}] =} starting_stepsize (@var{order}, 20 ## @deftypefn {Function File} {[@var{h}] =} starting_stepsize (@var{order}, @var{@@fun}, @var{t0}, @var{x0})
21 ## @var{@@fun}, @var{t0}, @var{x0})
22 ## 21 ##
23 ## This function file can be used to determine a good initial step for an ODE 22 ## This function file can be used to determine a good initial step for an ODE
24 ## solver of order @var{order}. The algorithm is that one described in [1]. 23 ## solver of order @var{order}. The algorithm is that one described in [1].
25 ## 24 ##
26 ## Second input argument, which is @var{@@fun}, is the function describing 25 ## Second input argument, which is @var{@@fun}, is the function describing
27 ## the differential equations, @var{t0} is the initial time and @var{x0} 26 ## the differential equations, @var{t0} is the initial time and @var{x0} is
28 ## is the initial condition. 27 ## the initial condition.
29 ## 28 ##
30 ## This function returns a good guess for the initial timestep @var{h}. 29 ## This function returns a good guess for the initial timestep @var{h}.
31 ## 30 ##
32 ## References: 31 ## References:
33 ## [1] E. Hairer, S.P. Norsett and G. Wanner, 32 ## [1] E. Hairer, S.P. Norsett and G. Wanner,