Mercurial > hg > octave-nkf
diff scripts/optimization/glpk.m @ 20375:f1d0f506ee78 stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed optimization, polynomial, signal script directories.
* scripts/optimization/fminbnd.m, scripts/optimization/fminsearch.m,
scripts/optimization/fminunc.m, scripts/optimization/fsolve.m,
scripts/optimization/fzero.m, scripts/optimization/glpk.m,
scripts/optimization/lsqnonneg.m, scripts/optimization/pqpnonneg.m,
scripts/optimization/qp.m, scripts/optimization/sqp.m,
scripts/polynomial/compan.m, scripts/polynomial/mkpp.m,
scripts/polynomial/mpoles.m, scripts/polynomial/pchip.m,
scripts/polynomial/poly.m, scripts/polynomial/polyaffine.m,
scripts/polynomial/polyder.m, scripts/polynomial/polyeig.m,
scripts/polynomial/polyfit.m, scripts/polynomial/polygcd.m,
scripts/polynomial/polyint.m, scripts/polynomial/polyout.m,
scripts/polynomial/polyval.m, scripts/polynomial/ppder.m,
scripts/polynomial/ppint.m, scripts/polynomial/ppjumps.m,
scripts/polynomial/ppval.m, scripts/polynomial/residue.m,
scripts/polynomial/roots.m, scripts/polynomial/spline.m,
scripts/polynomial/splinefit.m, scripts/polynomial/unmkpp.m,
scripts/signal/arch_fit.m, scripts/signal/arch_rnd.m,
scripts/signal/arma_rnd.m, scripts/signal/autoreg_matrix.m,
scripts/signal/bartlett.m, scripts/signal/blackman.m, scripts/signal/detrend.m,
scripts/signal/diffpara.m, scripts/signal/durbinlevinson.m,
scripts/signal/fftconv.m, scripts/signal/fftfilt.m, scripts/signal/fftshift.m,
scripts/signal/filter2.m, scripts/signal/freqz.m, scripts/signal/hamming.m,
scripts/signal/hanning.m, scripts/signal/hurst.m, scripts/signal/ifftshift.m,
scripts/signal/periodogram.m, scripts/signal/sinc.m, scripts/signal/sinetone.m,
scripts/signal/sinewave.m, scripts/signal/spectral_adf.m,
scripts/signal/spectral_xdf.m, scripts/signal/spencer.m, scripts/signal/stft.m,
scripts/signal/synthesis.m, scripts/signal/unwrap.m,
scripts/signal/yulewalker.m:
Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 04 May 2015 21:50:57 -0700 |
parents | 4197fc428c7d |
children |
line wrap: on
line diff
--- a/scripts/optimization/glpk.m +++ b/scripts/optimization/glpk.m @@ -19,8 +19,9 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {[@var{xopt}, @var{fmin}, @var{errnum}, @var{extra}] =} glpk (@var{c}, @var{A}, @var{b}, @var{lb}, @var{ub}, @var{ctype}, @var{vartype}, @var{sense}, @var{param}) -## Solve a linear program using the GNU @sc{glpk} library. Given three -## arguments, @code{glpk} solves the following standard LP: +## Solve a linear program using the GNU @sc{glpk} library. +## +## Given three arguments, @code{glpk} solves the following standard LP: ## @tex ## $$ ## \min_x C^T x @@ -90,23 +91,21 @@ ## A matrix containing the constraints coefficients. ## ## @item b -## A column array containing the right-hand side value for each constraint -## in the constraint matrix. +## A column array containing the right-hand side value for each constraint in +## the constraint matrix. ## ## @item lb -## An array containing the lower bound on each of the variables. If -## @var{lb} is not supplied, the default lower bound for the variables is -## zero. +## An array containing the lower bound on each of the variables. If @var{lb} +## is not supplied, the default lower bound for the variables is zero. ## ## @item ub -## An array containing the upper bound on each of the variables. If -## @var{ub} is not supplied, the default upper bound is assumed to be -## infinite. +## An array containing the upper bound on each of the variables. If @var{ub} +## is not supplied, the default upper bound is assumed to be infinite. ## ## @item ctype ## An array of characters containing the sense of each constraint in the -## constraint matrix. Each element of the array may be one of the -## following values +## constraint matrix. Each element of the array may be one of the following +## values ## ## @table @asis ## @item @qcode{"F"} @@ -138,14 +137,14 @@ ## @end table ## ## @item sense -## If @var{sense} is 1, the problem is a minimization. If @var{sense} is -## -1, the problem is a maximization. The default value is 1. +## If @var{sense} is 1, the problem is a minimization. If @var{sense} is -1, +## the problem is a maximization. The default value is 1. ## ## @item param ## A structure containing the following parameters used to define the ## behavior of solver. Missing elements in the structure take on default -## values, so you only need to set the elements that you wish to change -## from the default. +## values, so you only need to set the elements that you wish to change from +## the default. ## ## Integer parameters: ## @@ -220,9 +219,8 @@ ## stop the search. ## ## @item outfrq (default: 200) -## Output frequency, in iterations. This parameter specifies how -## frequently the solver sends information about the solution to the -## standard output. +## Output frequency, in iterations. This parameter specifies how frequently +## the solver sends information about the solution to the standard output. ## ## @item branch (default: 4) ## Branching technique option (for MIP only): @@ -293,13 +291,12 @@ ## ## @item outdly (default: 0) ## Output delay, in seconds. This parameter specifies how long the solver -## should delay sending information about the solution to the standard -## output. +## should delay sending information about the solution to the standard output. ## ## @item save (default: 0) -## If this parameter is nonzero, save a copy of the problem in -## CPLEX LP format to the file @file{"outpb.lp"}. There is currently no -## way to change the name of the output file. +## If this parameter is nonzero, save a copy of the problem in CPLEX LP +## format to the file @file{"outpb.lp"}. There is currently no way to change +## the name of the output file. ## @end table ## ## Real parameters: @@ -316,30 +313,30 @@ ## have a detailed understanding of its purpose. ## ## @item tolpiv (default: 1e-10) -## Relative tolerance used to choose eligible pivotal elements of the -## simplex table. It is not recommended that you change this parameter unless -## you have a detailed understanding of its purpose. +## Relative tolerance used to choose eligible pivotal elements of the simplex +## table. It is not recommended that you change this parameter unless you have +## a detailed understanding of its purpose. ## ## @item objll (default: -DBL_MAX) -## Lower limit of the objective function. If the objective -## function reaches this limit and continues decreasing, the solver stops -## the search. This parameter is used in the dual simplex method only. +## Lower limit of the objective function. If the objective function reaches +## this limit and continues decreasing, the solver stops the search. This +## parameter is used in the dual simplex method only. ## ## @item objul (default: +DBL_MAX) -## Upper limit of the objective function. If the objective -## function reaches this limit and continues increasing, the solver stops -## the search. This parameter is used in the dual simplex only. +## Upper limit of the objective function. If the objective function reaches +## this limit and continues increasing, the solver stops the search. This +## parameter is used in the dual simplex only. ## ## @item tolint (default: 1e-5) ## Relative tolerance used to check if the current basic solution is integer -## feasible. It is not recommended that you change this parameter unless -## you have a detailed understanding of its purpose. +## feasible. It is not recommended that you change this parameter unless you +## have a detailed understanding of its purpose. ## ## @item tolobj (default: 1e-7) -## Relative tolerance used to check if the value of the objective function -## is not better than in the best known integer feasible solution. It is -## not recommended that you change this parameter unless you have a -## detailed understanding of its purpose. +## Relative tolerance used to check if the value of the objective function is +## not better than in the best known integer feasible solution. It is not +## recommended that you change this parameter unless you have a detailed +## understanding of its purpose. ## @end table ## @end table ##