Mercurial > hg > octave-max
changeset 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 | 39867b4aca52 |
children | e2a179415bac |
files | doc/interpreter/nonlin.txi scripts/optimization/fsolve.m scripts/optimization/fzero.m |
diffstat | 3 files changed, 12 insertions(+), 9 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/interpreter/nonlin.txi +++ b/doc/interpreter/nonlin.txi @@ -152,3 +152,4 @@ @noindent which gives the same solution as before. +@DOCSTRING(fzero)
--- a/scripts/optimization/fsolve.m +++ b/scripts/optimization/fsolve.m @@ -29,10 +29,11 @@ ## that @code{@var{fcn} (@var{x})} gives (approximately) all zeros. ## @var{x0} determines a starting guess. The shape of @var{x0} is preserved ## in all calls to @var{fcn}, but otherwise it is treated as a column vector. -## @var{options} is a structure specifying additional options. Currently, fsolve -## recognizes these options: @code{"FunValCheck"}, @code{"OutputFcn"}, -## @code{"TolX"}, @code{"TolFun"}, @code{"MaxIter"}, -## @code{"MaxFunEvals"}, and @code{"Jacobian"}. +## @var{options} is a structure specifying additional options. +## Currently, @code{fsolve} recognizes these options: +## @code{"FunValCheck"}, @code{"OutputFcn"}, @code{"TolX"}, +## @code{"TolFun"}, @code{"MaxIter"}, @code{"MaxFunEvals"}, and +## @code{"Jacobian"}. ## ## If @code{"Jacobian"} is @code{"on"}, it specifies that @var{fcn}, ## called with 2 output arguments, also returns the Jacobian matrix
--- 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