comparison scripts/optimization/optimset.m @ 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 b76f0740940e
children f8bb15f6a19b
comparison
equal deleted inserted replaced
14386:59aab666f2bf 14387:966ec84e7858
32 ## @item ComplexEqn 32 ## @item ComplexEqn
33 ## 33 ##
34 ## @item FinDiffType 34 ## @item FinDiffType
35 ## 35 ##
36 ## @item FunValCheck 36 ## @item FunValCheck
37 ## When enabled, display an error if the objective function returns a complex 37 ## When enabled, display an error if the objective function returns an invalid
38 ## value or NaN@. Must be set to "on" or "off" [default]. 38 ## value (a complex value, NaN, or Inf). Must be set to "on" or "off"
39 ## [default]. Note: the functions @code{fzero} and @code{fminbnd} correctly
40 ## handle Inf values and only complex values or NaN will cause an error in this
41 ## case.
39 ## 42 ##
40 ## @item GradObj 43 ## @item GradObj
41 ## When set to "on", the function to be minimized must return a second argument 44 ## When set to "on", the function to be minimized must return a second argument
42 ## which is the gradient, or first derivative, of the function at the point 45 ## which is the gradient, or first derivative, of the function at the point
43 ## @var{x}. If set to "off" [default], the gradient is computed via finite 46 ## @var{x}. If set to "off" [default], the gradient is computed via finite