Mercurial > forge
changeset 3311:5a1cc2386bad octave-forge
minor improvements to help string
| author | mcreel |
|---|---|
| date | Thu, 19 Apr 2007 08:25:57 +0000 |
| parents | 2f14263b6a50 |
| children | d442b2b4a4b3 |
| files | main/optim/src/samin.cc |
| diffstat | 1 files changed, 9 insertions(+), 6 deletions(-) [+] |
line wrap: on
line diff
--- a/main/optim/src/samin.cc Sun Apr 15 15:29:29 2007 +0000 +++ b/main/optim/src/samin.cc Thu Apr 19 08:25:57 2007 +0000 @@ -169,7 +169,7 @@ //-------------- The annealing algorithm -------------- DEFUN_DLD(samin, args, , "samin: simulated annealing minimization of a function. See samin_example.m\n\ \n\ -[x, obj, convergence, details] = samin(\"f\", {args}, {control})\n\ +usage: [x, obj, convergence, details] = samin(\"f\", {args}, {control})\n\ \n\ Arguments:\n\ * \"f\": function name (string)\n\ @@ -179,11 +179,12 @@ * UB - vector of upper bounds\n\ * nt - integer: # of iterations between temperature reductions\n\ * ns - integer: # of iterations between bounds adjustments\n\ - * rt - 0 < rt <1: temperature reduction factor\n\ + * rt - (0 < rt <1): temperature reduction factor\n\ * maxevals - integer: limit on function evaluations\n\ * neps - integer: number of values final result is compared to\n\ - * functol - > 0: the required tolerance level for function value comparisons\n\ - * paramtol - > 0: the required tolerance level for parameters\n\ + * functol - (> 0): the required tolerance level for function value\n\ + comparisons\n\ + * paramtol - (> 0): the required tolerance level for parameters\n\ * verbosity - scalar: 0, 1, or 2.\n\ * 0 = no screen output\n\ * 1 = only final results to screen\n\ @@ -196,8 +197,10 @@ * convergence:\n\ 0 if no convergence within maxevals function evaluations\n\ 1 if normal convergence to a point interior to the parameter space\n\ - 2 if convergence to point very near bounds of parameter space (suggest re-running with looser bounds)\n\ -* details: a px2 matrix. The first column is the history of the temperature, the second is the history of the function value.\n\ + 2 if convergence to point very near bounds of parameter space\n\ + (suggest re-running with looser bounds)\n\ +* details: a px2 matrix. The first column is the history of the temperature,\n\ + the second is the history of the function value.\n\ \n\ Example: see samin_example\n\ ")