Mercurial > hg > octave-nkf
comparison scripts/optimization/fzero.m @ 9051:1bf0ce0930be
Grammar check TexInfo in all .m files
Cleanup documentation sources to follow a few consistent rules.
Spellcheck was NOT done. (but will be in another changeset)
author | Rik <rdrider0-list@yahoo.com> |
---|---|
date | Fri, 27 Mar 2009 22:31:03 -0700 |
parents | eb63fbe60fab |
children | 74d5c1a4ca96 |
comparison
equal
deleted
inserted
replaced
9044:656ad518f385 | 9051:1bf0ce0930be |
---|---|
18 ## | 18 ## |
19 ## Author: Jaroslav Hajek <highegg@gmail.com> | 19 ## Author: Jaroslav Hajek <highegg@gmail.com> |
20 | 20 |
21 ## -*- texinfo -*- | 21 ## -*- texinfo -*- |
22 ## @deftypefn{Function File}{[@var{x}, @var{fval}, @var{info}, @var{output}] =} fzero (@var{fun}, @var{x0}, @var{options}) | 22 ## @deftypefn{Function File}{[@var{x}, @var{fval}, @var{info}, @var{output}] =} fzero (@var{fun}, @var{x0}, @var{options}) |
23 ## Find a zero point of a univariate function. @var{fun} should be a function | 23 ## Find a zero point of a univariate function. @var{fun} should be a function |
24 ## handle or name. @var{x0} specifies a starting point. @var{options} is a | 24 ## handle or name. @var{x0} specifies a starting point. @var{options} is a |
25 ## structure specifying additional options. Currently, @code{fzero} | 25 ## structure specifying additional options. Currently, @code{fzero} |
26 ## recognizes these options: @code{"FunValCheck"}, @code{"OutputFcn"}, | 26 ## recognizes these options: @code{"FunValCheck"}, @code{"OutputFcn"}, |
27 ## @code{"TolX"}, @code{"MaxIter"}, @code{"MaxFunEvals"}. | 27 ## @code{"TolX"}, @code{"MaxIter"}, @code{"MaxFunEvals"}. |
28 ## For description of these options, see @ref{doc-optimset,,optimset}. | 28 ## For description of these options, see @ref{doc-optimset,,optimset}. |
29 ## | 29 ## |
30 ## On exit, the function returns @var{x}, the approximate zero point | 30 ## On exit, the function returns @var{x}, the approximate zero point |