Mercurial > octave-nkf

comparison scripts/ode/private/integrate_const.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{t}, @var{y}] =} integrate_const (@var{@@stepper}, 20 ## @deftypefn {Function File} {[@var{t}, @var{y}] =} integrate_const (@var{@@stepper}, @var{@@fun}, @var{tspan}, @var{x0}, @var{dt}, @var{options})
21 ## @var{@@fun}, @var{tspan}, @var{x0}, @var{dt}, @var{options})
22 ## 21 ##
23 ## This function file can be called by an ODE solver function in order to 22 ## This function file can be called by an ODE solver function in order to
24 ## integrate the set of ODEs on the interval @var{[t0,t1]} with a 23 ## integrate the set of ODEs on the interval @var{[t0,t1]} with a constant
25 ## constant timestep @var{dt}. 24 ## timestep @var{dt}.
26 ## 25 ##
27 ## 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}.
28 ## Variable @var{t} is a column vector and contains the time stamps, 27 ## Variable @var{t} is a column vector and contains the time stamps, instead
29 ## instead @var{y} is a matrix in which each column refers to a different 28 ## @var{y} is a matrix in which each column refers to a different unknown of
30 ## unknown of the problem and the rows number is the same of @var{t} rows 29 ## the problem and the rows number is the same of @var{t} rows number so that
31 ## number so that each row of @var{y} contains the values of all unknowns at 30 ## each row of @var{y} contains the values of all unknowns at the time value
32 ## the time value contained in the corresponding row in @var{t}. 31 ## contained in the corresponding row in @var{t}.
33 ## 32 ##
34 ## 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
35 ## 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
36 ## integration. This function discriminates one method from the others. 35 ## integration. This function discriminates one method from the others.
37 ## 36 ##
38 ## The second input argument is the order of the stepper. It is needed to 37 ## The second input argument is the order of the stepper. It is needed to
39 ## compute the adaptive timesteps. 38 ## compute the adaptive timesteps.
40 ## 39 ##
41 ## The third input argument is a function_handle or an inline function 40 ## The third input argument is a function_handle or an inline function that
42 ## that defines the set of ODE: 41 ## defines the set of ODE:
43 ## 42 ##
44 ## @ifhtml 43 ## @ifhtml
45 ## @example 44 ## @example
46 ## @math{y' = f(t,y)} 45 ## @math{y' = f(t,y)}
47 ## @end example 46 ## @end example