Mercurial > octave-nkf
comparison scripts/ode/private/hermite_quartic_interpolation.m @ 20580:25623ef2ff4f
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 |
---|---|
14 ## | 14 ## |
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 | |
20 ## -*- texinfo -*- | 19 ## -*- texinfo -*- |
21 ## @deftypefn {Command} {[@var{x_out}] =} | 20 ## @deftypefn {Function File} {[@var{x_out}] =} hermite_quartic_interpolation (@var{t}, @var{x}, @var{der}, @var{t_out}) |
22 ## hermite_quartic_interpolation (@var{t}, @var{x}, @var{der}, @var{t_out}) | |
23 ## | 21 ## |
24 ## This function file can be called by a ODE solver function in order to | 22 ## This function file can be called by an ODE solver function in order to |
25 ## interpolate the solution at the time @var{t_out} using 4th order | 23 ## interpolate the solution at the time @var{t_out} using 4th order |
26 ## hermite interpolation. | 24 ## Hermite interpolation. |
27 ## | 25 ## |
28 ## This function must be called with one output arguments: @var{x_out} | 26 ## This function must be called with one output arguments: @var{x_out} |
29 ## which contains the evaluation at @var{t_out} of the hermite interpolant. | 27 ## which contains the evaluation at @var{t_out} of the Hermite interpolant. |
30 ## | 28 ## |
31 ## The first input argument is the vector with two given times. | 29 ## The first input argument is the vector with two given times. |
32 ## | 30 ## |
33 ## The second input argument is the vector with the values of the function | 31 ## The second input argument is the vector with the values of the function |
34 ## to interpolate at the times specified in @var{t} and at the middle point. | 32 ## to interpolate at the times specified in @var{t} and at the middle point. |