naginterfaces.library.mip.handle_​solve_​milp

naginterfaces.library.mip.handle_solve_milp(handle, x=None, monit=None, data=None, io_manager=None)

handle_solve_milp is a solver from the NAG optimization modelling suite for large-scale Mixed Integer Linear Programming (MILP) problems. It is a branch-and-cut method optimization solver based on the HiGHS software package.

Note: this function uses optional algorithmic parameters, see also: opt.handle_opt_set, opt.handle_opt_get.

For full information please refer to the NAG Library document for h02bk

https://support.nag.com/numeric/nl/nagdoc_30/flhtml/h/h02bkf.html

Parameters

handleHandle

The handle to the problem. It needs to be initialized (e.g., by opt.handle_init) and to hold a problem formulation compatible with handle_solve_milp. It must not be changed between calls to the NAG optimization modelling suite.

xNone or float, array-like, shape $\left(\text{nvar}\right)$, optional

The input of $x$ is reserved for future releases of the NAG Library and it is ignored at the moment.

monitNone or callable monit(handle, rinfo, stats, data=None), optional

Note: if this argument is None then a NAG-supplied facility will be used.

$monit$ is reserved for future releases of the NAG Library which will allow you to monitor the progress of the optimization.

It will never be called in the current implementation and $monit$ may be None.

Parameters

handleHandle

The handle to the problem as provided on entry to handle_solve_milp. It may be used to query the model during the solve, and extract the current approximation of the solution by opt.handle_set_get_real.

rinfofloat, ndarray, shape $\left(100\right)$

Error measures and various indicators at the end of the current iteration as described in $rinfo$.

statsfloat, ndarray, shape $\left(100\right)$

Solver statistics at the end of the current iteration as described in $stats$, however, elements $2$, $3$, $5$, $9$, $10$, $11$ and $15$ refer to the quantities in the last iteration rather than accumulated over all iterations through the whole algorithm run.

dataarbitrary, optional, modifiable in place

User-communication data for callback functions.

dataarbitrary, optional

User-communication data for callback functions.

io_managerFileObjManager, optional

Manager for I/O in this routine.

Returns

xfloat, ndarray, shape $\left(\text{nvar}\right)$

The final values of the variables $x$.

rinfofloat, ndarray, shape $\left(100\right)$

Error measures and various indicators of the algorithm as given in the table below:

$0$	Value of the primal objective.
$1$	Value of the dual objective bound.
$2$	The absolute value of the gap between the primal and dual bounds, relative to the primal bound.
$3$	The maximum deviation from an integer value over all the discrete variables. This is an indication of the integrality violation.
$4$	The maximum violation of a bound on a variable.
$5$	The sum of violations of bounds by variables.
$6$–$99$	Reserved for future use.

statsfloat, ndarray, shape $\left(100\right)$

Solver statistics as given in the table below.

$0$	Total number of nodes generated.
$1$	Total number of simplex iterations performed.
$2$	Total time spent in the solver.
$3$–$99$	Reserved for future use.

Other Parameters

‘Defaults’valueless

This special keyword may be used to reset all options to their default values. Any value given with this keyword will be ignored.

‘Infinite Bound Size’float

Default $={10}^{20}$

This defines the ‘infinite’ bound $\text{bigbnd}$ in the definition of the problem constraints. Any upper bound greater than or equal to $\text{bigbnd}$ will be regarded as $+\infty$ (and similarly any lower bound less than or equal to $-\text{bigbnd}$ will be regarded as $-\infty$). Note that a modification of this option does not influence constraints which have already been defined; only the constraints formulated after the change will be affected.

Constraint: $\text{‘Infinite Bound Size'}\ge 1000$.

‘Milp Abs Gap’float

Default $={10}^{-6}$

Tolerance on absolute gap, the absolute value of the difference between the primal objective value and the dual objective bound, to determine whether optimality has been reached.

Constraint: $\text{‘Milp Abs Gap'}\ge ϵ$.

‘Milp Detect Symmetry’str

Default $=\text{'YES'}$

This argument controls whether symmetry should be detected. Symmetry arises when there are multiple equivalent solutions that have the same objective function value but different variable assignments. Identifying and handling symmetry can significantly improve the efficiency and speed of the solver, and reduce memory usage. However, it’s worth noting for smaller problems, the time spent on symmetry detection and breaking may outweigh the benefits.

Constraint: $\text{‘Milp Detect Symmetry'}=\text{'YES'}$ or $\text{'NO'}$.

‘Milp Feasibility Tol’float

Default $={10}^{-6}$

The maximum acceptable absolute violation in each constraint (bound, linear or integrality constraint) at a ‘feasible’ point; i.e., a constraint is considered satisfied if its violation does not exceed ‘Milp Feasibility Tol’ $r$. For example, if the integer variable $x_j$ is near unity then $x_j$ is considered to be integer only if $(1-r)\le x_j\le (1+r)$.

Constraint: $\text{‘Milp Feasibility Tol'}>{10}^{-10}$.

‘Milp Max Nodes’int

Default $=\text{Imax}$

The maximum number of nodes that are to be searched in the B&B tree in order to find a solution.

Constraint: $\text{‘Milp Max Nodes'}\ge 0$.

‘Milp Presolve’str

Default $=\text{'YES'}$

This argument allows you to turn the presolving of the problem off completely. If the presolver is turned off, the solver will try to handle the original problem you have given. In such a case, the presence of linear dependencies in the constraint matrix can cause numerical instabilities to occur. In normal circumstances, it is recommended to use the presolve which is the default.

Constraint: $\text{‘Milp Presolve'}=\text{'YES'}$ or $\text{'NO'}$.

‘Milp Random Seed’int

Default $=0$

Initial seed used for random selection in tasks such as primal heuristics and cut generation.

Constraint: $\text{‘Milp Random Seed'}\ge 0$.

‘Milp Rel Gap’float

Default $={10}^{-4}$

Tolerance on relative gap, to determine whether optimality has been reached.

Constraint: $\text{‘Milp Rel Gap'}\ge ϵ$.

‘Milp Small Matrix Value’float

Default $={10}^{-9}$

Lower limit on the absolute value of the linear constraint coefficients in the matrix $A$ defined in [equation]. Values smaller than this will be treated as zero.

Constraint: $\text{‘Milp Small Matrix Value'}\ge {10}^{-12}$.

‘Monitoring File’int

Default $=-1$

If $i\ge 0$, the unit number for the secondary (monitoring) output. If set to $-1$, no secondary output is provided. The following information is output to the unit:

• a listing of the options if set by ‘Print Options’;

• problem statistics, the iteration log and the final status as set by ‘Monitoring Level’;

• the solution if set by ‘Print Solution’.

Constraint: $\text{‘Monitoring File'}\ge -1$.

‘Monitoring Level’int

Default $=4$

This argument sets the amount of information detail that will be printed by the solver to the secondary output. The meaning of the levels is the same as with ‘Print Level’.

Constraint: $0\le \text{‘Monitoring Level'}\le 5$.

‘Print File’int

Default $=\text{advisory message unit number}$

If $i\ge 0$, the unit number for the primary output of the solver. If $\text{‘Print File'}=-1$, the primary output is completely turned off independently of other settings. The default value is the advisory message unit number at the time of the options initialization, e.g., at the initialization of the handle. The following information is output to the unit:

• a listing of options if set by ‘Print Options’;

• problem statistics, the iteration log and the final status from the solver as set by ‘Print Level’;

• the solution if set by ‘Print Solution’.

Constraint: $\text{‘Print File'}\ge -1$.

‘Print Level’int

Default $=2$

This argument defines how detailed information should be printed by the solver to the primary output.

$i$	Output
$0$	No output from the solver
$1$	The Header and Summary
$2$, $3$, $4$, $5$	Additionally, the Iteration log

Constraint: $0\le \text{‘Print Level'}\le 5$.

‘Print Options’str

Default $=\text{'YES'}$

If $\text{‘Print Options'}=\text{'YES'}$, a listing of options will be printed to the primary and secondary output.

Constraint: $\text{‘Print Options'}=\text{'YES'}$ or $\text{'NO'}$.

‘Print Solution’str

Default $=\text{'NO'}$

If $\text{‘Print Solution'}=\text{'YES'}$, the final values of the primal variables are printed on the primary and secondary outputs.

Constraint: $\text{‘Print Solution'}=\text{'YES'}$ or $\text{'NO'}$.

‘Task’str

Default $=\text{'MINIMIZE'}$

This argument specifies the required direction of the optimization. If $\text{‘Task'}=\text{'FEASIBLE POINT'}$, the objective function (if set) is ignored and the algorithm stops as soon as a feasible point is found with respect to the given tolerance. If no objective function is set, ‘Task’ reverts to ‘FEASIBLE POINT’ automatically.

Constraint: $\text{‘Task'}=\text{'MINIMIZE'}$, $\text{'MAXIMIZE'}$ or $\text{'FEASIBLE POINT'}$.

‘Time Limit’float

Default $={10}^6$

This argument specifies a limit in seconds that the solver can use to solve one problem. If during the convergence check this limit is exceeded, the solver will terminate with $errno$ = 23 error message.

Constraint: $\text{‘Time Limit'}>0$.

Raises

NagValueError

(errno $1$)

$handle$ has not been initialized.

(errno $1$)

$handle$ does not belong to the NAG optimization modelling suite, has not been initialized properly or is corrupted.

(errno $1$)

$handle$ has not been initialized properly or is corrupted.

(errno $2$)

This solver does not support the model defined in the handle.

(errno $2$)

The problem is already being solved.

(errno $4$)

On entry, $\text{nvar}=⟨value⟩$, expected $value=⟨value⟩$.

Constraint: $\text{nvar}$ must match the current number of variables of the model in the $handle$.

(errno $51$)

The problem was found to be primal infeasible.

(errno $52$)

The problem was found to be dual infeasible.

(errno $53$)

The problem seems to be primal or dual infeasible, the algorithm was stopped.

Warns

NagAlgorithmicWarning

(errno $22$)

Maximum number of nodes exceeded.

NagAlgorithmicMajorWarning

(errno $23$)

The solver terminated after the maximum time allowed was exhausted.

(errno $27$)

No feasible solution was found for the number of nodes investigated in the B&B tree.

Notes

handle_solve_milp solves a large-scale MILP problem in the following form:

$$\begin{array}{c}\begin{array}{cc}{minimize}_{x\in R^n}& c^{T}x\\ \text{subject to}& l_A\le Ax\le u_A\text{,}\\ & l_x\le x\le u_x\text{,}\\ & x\in P\text{,}\end{array}\end{array}$$

where $P=Z^{n_{\text{int}}}\times R^{n_l}$ is a Cartesian product of $n_{\text{int}}$-dimensional integer space and $n_l$-dimensional real space, and $n=n_{\text{int}}+n_l$ is the number of decision variables. Here $c$, $x$, $l_x$, $u_x$ are $n$-dimensional vectors, $A$ is an $m\times n$ sparse matrix and $l_A$, $u_A$ are $m$-dimensional vectors.

handle_solve_milp solves mixed integer linear programming problems stored as a handle. The handle points to an internal data structure which defines the problem and serves as a means of communication for functions in the NAG optimization modelling suite. First, the problem handle is initialized by calling opt.handle_init. Then some of the functions opt.handle_set_linobj, opt.handle_set_quadobj, opt.handle_set_simplebounds or opt.handle_set_linconstr may be called to formulate the objective function, bounds of the variables, and the block of linear constraints, respectively. Marking a set of variables as being integer-valued is achieved by calling opt.handle_set_property. Once the problem is fully set, the handle may be passed to the solver. When the handle is not needed anymore, opt.handle_free should be called to destroy it and deallocate the memory held within. See the E04 Introduction for more details about the NAG optimization modelling suite.

The solver method can be modified by various options (see Other Parameters) which can be set by opt.handle_opt_set and opt.handle_opt_set_file anytime between the initialization of the handle by opt.handle_init and a call to the solver. Once the solver has finished, options may be modified for the next solve. The solver may be called repeatedly with various options.

The option ‘Task’ may be used to switch the problem to maximization or to ignore the objective function and find only a feasible point.

Several options may have significant impact on the performance of the solver. Even if the defaults were chosen to suit the majority of problems, it is recommended to experiment in order to find the most suitable set of options for a particular problem, see Other Parameters for further details.

References

Dakin, R J, 1965, A tree search algorithm for mixed integer programming problems, Comput. J. (8), 250–255

Huangfu, Q, and Hall, J.A. J., 2018, Parallelizing the dual revised simplex method, Mathematical Programming Computation (10(1)), 119–142

Mitra, G, 1973, Investigation of some branch and bound strategies for the solution of mixed integer linear programs, Math. Programming (4), 155–170

Taha, H A, 1987, Operations Research: An Introduction, Macmillan, New York

See also

naginterfaces.library.examples.mip.handle_solve_milp_ex.main()