Mercurial > octave-nkf
changeset 14387:966ec84e7858
doc: Update optimset docstring with details of FunValCheck option.
* optimset.m: Update optimset docstring with details of FunValCheck option.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Sat, 18 Feb 2012 12:54:41 -0800 |
| parents | 59aab666f2bf |
| children | b5b49f400f9b |
| files | scripts/optimization/optimset.m |
| diffstat | 1 files changed, 5 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/optimization/optimset.m Sat Feb 18 12:43:46 2012 -0800 +++ b/scripts/optimization/optimset.m Sat Feb 18 12:54:41 2012 -0800 @@ -34,8 +34,11 @@ ## @item FinDiffType ## ## @item FunValCheck -## When enabled, display an error if the objective function returns a complex -## value or NaN@. Must be set to "on" or "off" [default]. +## When enabled, display an error if the objective function returns an invalid +## value (a complex value, NaN, or Inf). Must be set to "on" or "off" +## [default]. Note: the functions @code{fzero} and @code{fminbnd} correctly +## handle Inf values and only complex values or NaN will cause an error in this +## case. ## ## @item GradObj ## When set to "on", the function to be minimized must return a second argument