Mercurial > hg > octave-terminal
changeset 10297:ed88ea036716
improve docs of fzero/fminbnd
author | Jaroslav Hajek <highegg@gmail.com> |
---|---|
date | Wed, 10 Feb 2010 16:15:30 +0100 |
parents | 035ac548a67e |
children | 2be9b7e71f32 |
files | scripts/ChangeLog scripts/optimization/fminbnd.m scripts/optimization/fzero.m |
diffstat | 3 files changed, 8 insertions(+), 12 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/ChangeLog +++ b/scripts/ChangeLog @@ -1,3 +1,9 @@ +2010-02-10 Jaroslav Hajek <highegg@gmail.com> + + * optimization/fminbnd.m: Undocument impossible info values. + * optimization/fzero.m: Ditto. + + * optimization/fzero.m: Make default TolX consistent with fminbnd. 2010-02-10 Jaroslav Hajek <highegg@gmail.com> * optimization/fminbnd.m: New function.
--- a/scripts/optimization/fminbnd.m +++ b/scripts/optimization/fminbnd.m @@ -30,6 +30,7 @@ ## On exit, the function returns @var{x}, the approximate minimum point ## and @var{fval}, the function value thereof. ## @var{info} is an exit flag that can have these values: +## ## @itemize ## @item 1 ## The algorithm converged to a solution. @@ -37,12 +38,6 @@ ## Maximum number of iterations or function evaluations has been exhausted. ## @item -1 ## The algorithm has been terminated from user output function. -## @item -2 -## A general unexpected error. -## @item -3 -## A non-real value encountered. -## @item -4 -## A NaN value encountered. ## @end itemize ## @seealso{optimset, fzero, fminunc} ## @end deftypefn
--- a/scripts/optimization/fzero.m +++ b/scripts/optimization/fzero.m @@ -30,6 +30,7 @@ ## On exit, the function returns @var{x}, the approximate zero point ## and @var{fval}, the function value thereof. ## @var{info} is an exit flag that can have these values: +## ## @itemize ## @item 1 ## The algorithm converged to a solution. @@ -37,12 +38,6 @@ ## Maximum number of iterations or function evaluations has been exhausted. ## @item -1 ## The algorithm has been terminated from user output function. -## @item -2 -## A general unexpected error. -## @item -3 -## A non-real value encountered. -## @item -4 -## A NaN value encountered. ## @end itemize ## @seealso{optimset, fsolve} ## @end deftypefn