Mercurial > hg > octave-nkf
comparison scripts/optimization/glpk.m @ 9051:1bf0ce0930be
Grammar check TexInfo in all .m files
Cleanup documentation sources to follow a few consistent rules.
Spellcheck was NOT done. (but will be in another changeset)
author | Rik <rdrider0-list@yahoo.com> |
---|---|
date | Fri, 27 Mar 2009 22:31:03 -0700 |
parents | eb63fbe60fab |
children | f0c3d3fc4903 |
comparison
equal
deleted
inserted
replaced
9044:656ad518f385 | 9051:1bf0ce0930be |
---|---|
70 ## subject to | 70 ## subject to |
71 ## | 71 ## |
72 ## @iftex | 72 ## @iftex |
73 ## @tex | 73 ## @tex |
74 ## $$ | 74 ## $$ |
75 ## Ax [ = | \leq | \geq ] b \qquad LB \leq x \leq UB | 75 ## Ax [ = | \leq | \geq ] b \qquad LB \leq x \leq UB |
76 ## $$ | 76 ## $$ |
77 ## @end tex | 77 ## @end tex |
78 ## @end iftex | 78 ## @end iftex |
79 ## @ifnottex | 79 ## @ifnottex |
80 ## @example | 80 ## @example |
254 ## | 254 ## |
255 ## Real parameters: | 255 ## Real parameters: |
256 ## | 256 ## |
257 ## @table @code | 257 ## @table @code |
258 ## @item relax (@code{LPX_K_RELAX}, default: 0.07) | 258 ## @item relax (@code{LPX_K_RELAX}, default: 0.07) |
259 ## Relaxation parameter used in the ratio test. If it is zero, the textbook | 259 ## Relaxation parameter used in the ratio test. If it is zero, the textbook |
260 ## ratio test is used. If it is non-zero (should be positive), Harris' | 260 ## ratio test is used. If it is non-zero (should be positive), Harris' |
261 ## two-pass ratio test is used. In the latter case on the first pass of the | 261 ## two-pass ratio test is used. In the latter case on the first pass of the |
262 ## ratio test basic variables (in the case of primal simplex) or reduced | 262 ## ratio test basic variables (in the case of primal simplex) or reduced |
263 ## costs of non-basic variables (in the case of dual simplex) are allowed | 263 ## costs of non-basic variables (in the case of dual simplex) are allowed |
264 ## to slightly violate their bounds, but not more than | 264 ## to slightly violate their bounds, but not more than |
265 ## @code{relax*tolbnd} or @code{relax*toldj (thus, @code{relax} is a | 265 ## @code{relax*tolbnd} or @code{relax*toldj (thus, @code{relax} is a |
266 ## percentage of @code{tolbnd} or @code{toldj}}. | 266 ## percentage of @code{tolbnd} or @code{toldj}}. |
284 ## Lower limit of the objective function. If on the phase II the objective | 284 ## Lower limit of the objective function. If on the phase II the objective |
285 ## function reaches this limit and continues decreasing, the solver stops | 285 ## function reaches this limit and continues decreasing, the solver stops |
286 ## the search. This parameter is used in the dual simplex method only. | 286 ## the search. This parameter is used in the dual simplex method only. |
287 ## | 287 ## |
288 ## @item objul (@code{LPX_K_OBJUL}, default: +DBL_MAX) | 288 ## @item objul (@code{LPX_K_OBJUL}, default: +DBL_MAX) |
289 ## Upper limit of the objective function. If on the phase II the objective | 289 ## Upper limit of the objective function. If on the phase II the objective |
290 ## function reaches this limit and continues increasing, the solver stops | 290 ## function reaches this limit and continues increasing, the solver stops |
291 ## the search. This parameter is used in the dual simplex only. | 291 ## the search. This parameter is used in the dual simplex only. |
292 ## | 292 ## |
293 ## @item tmlim (@code{LPX_K_TMLIM}, default: -1.0) | 293 ## @item tmlim (@code{LPX_K_TMLIM}, default: -1.0) |
294 ## Searching time limit, in seconds. If this value is positive, it is | 294 ## Searching time limit, in seconds. If this value is positive, it is |
295 ## decreased each time when one simplex iteration has been performed by the | 295 ## decreased each time when one simplex iteration has been performed by the |
296 ## amount of time spent for the iteration, and reaching zero value signals | 296 ## amount of time spent for the iteration, and reaching zero value signals |
297 ## the solver to stop the search. Negative value means no time limit. | 297 ## the solver to stop the search. Negative value means no time limit. |
298 ## | 298 ## |
299 ## @item outdly (@code{LPX_K_OUTDLY}, default: 0.0) | 299 ## @item outdly (@code{LPX_K_OUTDLY}, default: 0.0) |
300 ## Output delay, in seconds. This parameter specifies how long the solver | 300 ## Output delay, in seconds. This parameter specifies how long the solver |
301 ## should delay sending information about the solution to the standard | 301 ## should delay sending information about the solution to the standard |
302 ## output. Non-positive value means no delay. | 302 ## output. Non-positive value means no delay. |
303 ## | 303 ## |
304 ## @item tolint (@code{LPX_K_TOLINT}, default: 10e-5) | 304 ## @item tolint (@code{LPX_K_TOLINT}, default: 10e-5) |
305 ## Relative tolerance used to check if the current basic solution is integer | 305 ## Relative tolerance used to check if the current basic solution is integer |
306 ## feasible. It is not recommended that you change this parameter unless | 306 ## feasible. It is not recommended that you change this parameter unless |
307 ## you have a detailed understanding of its purpose. | 307 ## you have a detailed understanding of its purpose. |
416 ## s = -1; | 416 ## s = -1; |
417 ## | 417 ## |
418 ## param.msglev = 1; | 418 ## param.msglev = 1; |
419 ## param.itlim = 100; | 419 ## param.itlim = 100; |
420 ## | 420 ## |
421 ## [xmin, fmin, status, extra] = ... | 421 ## [xmin, fmin, status, extra] = @dots{} |
422 ## glpk (c, a, b, lb, ub, ctype, vartype, s, param); | 422 ## glpk (c, a, b, lb, ub, ctype, vartype, s, param); |
423 ## @end group | 423 ## @end group |
424 ## @end example | 424 ## @end example |
425 ## @end deftypefn | 425 ## @end deftypefn |
426 | 426 |