Mercurial > octave-nkf
diff scripts/ode/private/kahan.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 |
line wrap: on
line diff
--- a/scripts/ode/private/kahan.m Sat Oct 03 16:21:58 2015 -0400 +++ b/scripts/ode/private/kahan.m Sat Oct 03 21:03:16 2015 -0700 @@ -17,15 +17,15 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Command} {[@var{sum}] =} kahan (@var{sum}, -## @var{comp}, @var{temp}) -## @deftypefnx {Command} {[@var{sum}, @var{comp}] =} kahan (@var{sum}, -## @var{comp}, @var{temp}) +## @deftypefn {Function File} {[@var{sum}] =} kahan (@var{sum}, @var{comp}, @var{temp}) +## @deftypefnx {Function File} {[@var{sum}, @var{comp}] =} kahan (@var{sum}, @var{comp}, @var{temp}) ## ## This function is the implementation of the Kahan summation algorithm, -## also known as compensated summation. It significantly reduces the numerical -## error in the total obtained by adding a sequence of finite precision -## floating point numbers, compared to the obvious approach. For more details +## also known as compensated summation. +## +## It significantly reduces the numerical error in the total obtained by adding +## a sequence of finite precision floating point numbers, compared to the +## obvious approach. For more details ## see @url{http://en.wikipedia.org/wiki/Kahan_summation_algorithm}. ## This function is called in @command{integrate_adaptive} and in ## @command{integrate_const} to better catch equality comparisons. @@ -35,11 +35,11 @@ ## next calls to kahan function. ## ## The second input argument contains the compensation term and it is returned -## as second output argument so that it can be reused in the next calls -## of the same computation. +## as second output argument so that it can be reused in the next calls of the +## same computation. ## -## The third input argument is the variable that contains the term to -## be added to @var{Sum}. +## The third input argument is the variable that contains the term to be added +## to @var{Sum}. ## @end deftypefn function [Sum, comp] = kahan (Sum, comp, term)