Mercurial > hg > octave-lyh
diff scripts/optimization/fzero.m @ 12632:2dbac27e0e40 stable
doc: miscellaneous touch-ups to documentation strings
* debug.txi: Correct line number for debug example.
* func.txi: Correct directory structure of functions shipped with Octave distribution.
* edit.m: Eliminate reference to editor used by bug_report.
* fzero.m: Add inline function to list of possible inputs.
* fplot.m: Add comma to break list of possible inputs.
* qqplot.m: Correct example so that it runs under current Octave distributions.
* assert.m: Add seealso reference to fail.
* fail.m: Add seealso reference to assert. Add additional calling forms of function.
* load-path.cc (addpath): Don't use @samp which created double double quotes around option.
* ov-fcn-inline.cc (vectorize): Add example usage.
* variables.cc (exist): Add seealso link to file_in_loadpath.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Mon, 25 Apr 2011 09:24:33 -0700 |
| parents | c792872f8942 |
| children | b9a89ca0fb75 |
line wrap: on
line diff
--- a/scripts/optimization/fzero.m +++ b/scripts/optimization/fzero.m @@ -24,10 +24,12 @@ ## @deftypefnx {Function File} {[@var{x}, @var{fval}, @var{info}, @var{output}] =} fzero (@dots{}) ## Find a zero of a univariate function. ## -## @var{fun} should be a function handle or name. @var{x0} should be a -## two-element vector specifying two points which bracket a zero. In -## other words, there must be a change in sign of the function between -## @var{x0}(1) and @var{x0}(2). More mathematically, the following must hold +## @var{fun} is a function handle, inline function, or string +## containing the name of the function to evaluate. +## @var{x0} should be a two-element vector specifying two points which +## bracket a zero. In other words, there must be a change in sign of the +## function between @var{x0}(1) and @var{x0}(2). More mathematically, the +## following must hold ## ## @example ## sign (@var{fun}(@var{x0}(1))) * sign (@var{fun}(@var{x0}(2))) <= 0