Mercurial > hg > octave-nkf
diff scripts/optimization/fzero.m @ 8515:ec2715c76039
fzero.m, fsolve.m: additional doc fixes
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Wed, 14 Jan 2009 16:06:48 -0500 |
parents | cadc73247d65 |
children | 8833c0b18eb2 |
line wrap: on
line diff
--- a/scripts/optimization/fzero.m +++ b/scripts/optimization/fzero.m @@ -20,11 +20,12 @@ ## -*- texinfo -*- ## @deftypefn{Function File}{[@var{x}, @var{fval}, @var{info}, @var{output}] =} fzero (@var{fun}, @var{x0}, @var{options}) -## Finds a zero point of a univariate function. @var{fun} should be a function +## Find a zero point of a univariate function. @var{fun} should be a function ## handle or name. @var{x0} specifies a starting point. @var{options} is a -## structure specifying additional options. Currently, fzero recognizes these -## options: FunValCheck, OutputFcn, TolX, MaxIter, MaxFunEvals. -## For description of these options, see @code{optimset}. +## structure specifying additional options. Currently, @code{fzero} +## recognizes these options: @code{"FunValCheck"}, @code{"OutputFcn"}, +## @code{"TolX"}, @code{"MaxIter"}, @code{"MaxFunEvals"}. +## For description of these options, see @ref{doc-optimset,,optimset}. ## ## On exit, the function returns @var{x}, the approximate zero point ## and @var{fval}, the function value thereof. @@ -43,7 +44,7 @@ ## @item -4 ## A NaN value encountered. ## @end itemize -## @seealso{optimset, fminbnd, fsolve} +## @seealso{optimset, fsolve} ## @end deftypefn ## This is essentially the ACM algorithm 748: Enclosing Zeros of