Mercurial > octave
diff scripts/optimization/fminunc.m @ 21546:f7f97d7e9294
doc: Wrap m-file docstrings to 79 characters + newline (80 total).
* isrecording.m, soundsc.m, delaunay3.m, cell2mat.m, cumtrapz.m, del2.m,
inputParser.m, interp1.m, interp3.m, narginchk.m, profile.m,
validateattributes.m, delaunayn.m, tsearchn.m, voronoin.m, brighten.m,
cmunique.m, colorcube.m, imfinfo.m, imshow.m, edit.m, orderfields.m, run.m,
warning_ids.m, ode23.m, ode45.m, odeget.m, integrate_adaptive.m, kahan.m,
ode_struct_value_check.m, runge_kutta_23.m, fminunc.m, fsolve.m, fzero.m,
pkg.m, build.m, specular.m, view.m, bar.m, barh.m, contour3.m, isosurface.m,
line.m, pie.m, pie3.m, quiver3.m, scatter.m, scatter3.m, stem3.m, stemleaf.m,
surfl.m, tetramesh.m, isfigure.m, mkpp.m, pchip.m, residue.m, splinefit.m,
rmpref.m, unique.m, eigs.m, ilu.m, factor.m, factorial.m, gallery.m, hankel.m,
histc.m, ols.m, finv.m, fpdf.m, kruskal_wallis_test.m, weekday.m:
Wrap m-file docstrings to 79 characters + newline (80 total).
| author | Rik <rik@octave.org> |
|---|---|
| date | Sun, 27 Mar 2016 15:50:01 -0700 |
| parents | 3be6a07e8bad |
| children | 683a1beee538 |
line wrap: on
line diff
--- a/scripts/optimization/fminunc.m Sun Mar 27 15:15:24 2016 -0700 +++ b/scripts/optimization/fminunc.m Sun Mar 27 15:50:01 2016 -0700 @@ -41,11 +41,11 @@ ## @qcode{"AutoScaling"}. ## ## If @qcode{"GradObj"} is @qcode{"on"}, it specifies that @var{fcn}, when -## called with two output arguments, also returns the Jacobian matrix of partial -## first derivatives at the requested point. @code{TolX} specifies the -## termination tolerance for the unknown variables @var{x}, while @code{TolFun} -## is a tolerance for the objective function value @var{fval}. The default is -## @code{1e-7} for both options. +## called with two output arguments, also returns the Jacobian matrix of +## partial first derivatives at the requested point. @code{TolX} specifies +## the termination tolerance for the unknown variables @var{x}, while +## @code{TolFun} is a tolerance for the objective function value @var{fval}. +## The default is @code{1e-7} for both options. ## ## For a description of the other options, see @code{optimset}. ## @@ -76,9 +76,10 @@ ## The trust region radius became excessively small. ## @end table ## -## Optionally, @code{fminunc} can return a structure with convergence statistics -## (@var{output}), the output gradient (@var{grad}) at the solution @var{x}, -## and approximate Hessian (@var{hess}) at the solution @var{x}. +## Optionally, @code{fminunc} can return a structure with convergence +## statistics (@var{output}), the output gradient (@var{grad}) at the +## solution @var{x}, and approximate Hessian (@var{hess}) at the solution +## @var{x}. ## ## Application Notes: If the objective function is a single nonlinear equation ## of one variable then using @code{fminbnd} is usually a better choice.