Mercurial > hg > octave-nkf
diff scripts/optimization/fminunc.m @ 10687:a8ce6bdecce5
Improve documentation strings.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Tue, 08 Jun 2010 20:22:38 -0700 |
parents | 95c3e38098bf |
children | be55736a0783 |
line wrap: on
line diff
--- a/scripts/optimization/fminunc.m +++ b/scripts/optimization/fminunc.m @@ -19,15 +19,16 @@ ## Author: Jaroslav Hajek <highegg@gmail.com> ## -*- texinfo -*- -## @deftypefn{Function File} {} fminunc (@var{fcn}, @var{x0}, @var{options}) -## @deftypefnx{Function File} {[@var{x}, @var{fvec}, @var{info}, @var{output}, @var{grad}, @var{hess}]} = fminunc (@var{fcn}, @dots{}) -## Solve a unconstrained optimization problem defined by the function @var{fcn}. +## @deftypefn {Function File} {} fminunc (@var{fcn}, @var{x0}) +## @deftypefnx {Function File} {} fminunc (@var{fcn}, @var{x0}, @var{options}) +## @deftypefnx {Function File} {[@var{x}, @var{fvec}, @var{info}, @var{output}, @var{grad}, @var{hess}]} = fminunc (@var{fcn}, @dots{}) +## Solve an unconstrained optimization problem defined by the function @var{fcn}. ## @var{fcn} should accepts a vector (array) defining the unknown variables, ## and return the objective function value, optionally with gradient. ## In other words, this function attempts to determine a vector @var{x} such ## that @code{@var{fcn} (@var{x})} is a local minimum. ## @var{x0} determines a starting guess. The shape of @var{x0} is preserved -## in all calls to @var{fcn}, but otherwise it is treated as a column vector. +## in all calls to @var{fcn}, but otherwise is treated as a column vector. ## @var{options} is a structure specifying additional options. ## Currently, @code{fminunc} recognizes these options: ## @code{"FunValCheck"}, @code{"OutputFcn"}, @code{"TolX"},