Mercurial > octave
diff scripts/optimization/fminunc.m @ 27390:baeed03c3766
doc: Use common verbiage to describe input FUN in optimization functions.
* fminbnd.m, fminunc.m, fsolve.m: Use common verbiage to describe input FUN.
| author | Rik <rik@octave.org> |
|---|---|
| date | Thu, 12 Sep 2019 09:57:34 -0700 |
| parents | 0a62d9a6aa2d |
| children | b0626d075ad7 |
line wrap: on
line diff
--- a/scripts/optimization/fminunc.m Thu Sep 12 09:51:18 2019 -0700 +++ b/scripts/optimization/fminunc.m Thu Sep 12 09:57:34 2019 -0700 @@ -25,11 +25,14 @@ ## Solve an unconstrained optimization problem defined by the function ## @var{fcn}. ## -## @var{fcn} should accept a vector (array) defining the unknown variables, and -## return the objective function value, optionally with gradient. ## @code{fminunc} attempts to determine a vector @var{x} such that ## @code{@var{fcn} (@var{x})} is a local minimum. ## +## @var{fun} is a function handle, inline function, or string containing the +## name of the function to evaluate. @var{fcn} should accept a vector (array) +## defining the unknown variables, and return the objective function value, +## optionally with gradient. +## ## @var{x0} determines a starting guess. The shape of @var{x0} is preserved in ## all calls to @var{fcn}, but otherwise is treated as a column vector. ##