Initializing help system before first use

problem.loadproblem

Purpose
Load an optimization problem, possibly with quadratic objective and/or constraints, and integer variables.
Synopsis
problem.loadproblem(probname, rowtype, rhs, rng, objcoef, start, collen, rowind, rowcoef, lb, ub, objqcol1, objqcol2, objqcoef, qrowind, nrowqcoefs, rowqcol1, rowqcol2, rowqcoef, coltype, entind, limit, settype, setstart, setind, refval, colnames, rownames, unlinked=False)
Arguments
probname 
A string of up to 200 characters containing the problem name.
rowtype 
Character array containing the row types:
indicates a <= constraint;
indicates an = constraint;
indicates a >= constraint;
indicates a range constraint;
indicates a nonbinding constraint.
rhs 
Array containing the right hand side coefficients of the rows. The right hand side value for a range row gives the upper bound on the row.
rng 
Array containing the range values for range rows. Values for all other rows will be ignored. May be None if there are no ranged constraints. The lower bound on a range row is the right hand side value minus the range value. The sign of the range value is ignored - the absolute value is used in all cases.
objcoef 
Array containing the objective function coefficients.
start 
Array containing the offsets in the rowind and rowcoef arrays of the start of the elements for each column. This array is of length equal to the number ncol of added variables or, if collen is None, ncol+1. If collen is None the extra entry of start, start[ncol], contains the position in the rowind and rowcoef arrays at which an extra column would start, if it were present.
collen 
Array containing the number of nonzero elements in each column. May be None if all elements are contiguous and start[ncol] contains the offset where the elements for column ncol+1 would start. This array is not required if the nonzero coefficients in the rowind and rowcoef arrays are continuous, and the start array has ncol+1 entries as described above. It may be None if not required.
rowind 
Array containing the row indices for the nonzero elements in each column. If the indices are input contiguously, with the columns in ascending order, the length of the rowind is start[ncol-1]+collen[ncol-1] or, if collen is None, start[ncol].
rowcoef 
Array containing the nonzero element values; length as for rowind.
lb 
Array containing the lower bounds on the columns. Use -xpress.infinity to represent a lower bound of minus infinity.
ub 
Array containing the upper bounds on the columns. Use xpress.infinity to represent an upper bound of plus infinity.
objqcol1 
(optional) Array with the first variable in each quadratic term.
objqcol2 
(optional) Array with the second variable in each quadratic term.
objqcoef 
(optional) Array with the quadratic coefficients.
qrowind 
(optional) Integer containing the indices of rows with quadratic matrices in them. Note that the rows are expected to be defined in rowtype as type L.
nrowqcoefs 
(optional) Array containing the number of nonzeros in each quadratic constraint matrix.
rowqcol1 
(optional) Array with a number of elements equal to the sum of the elements in nrowqcoefs (i.e. the total number of quadratic matrix elements in all the constraints). It contains the first column indices of the quadratic matrices. Indices for the first matrix are listed from 0 to nrowqcoefs[0]-1, for the second matrix from nrowqcoefs[0] to nrowqcoefs[0]+ nrowqcoefs[1]-1, etc.
rowqcol2 
(optional) Array containing the second index for the quadratic constraint matrices.
rowqcoef 
(optional) Array containing the coefficients for the quadratic constraint matrices.
coltype 
Character array containing the entity types:
binary variables;
integer variables;
partial integer variables;
semi-continuous variables;
semi-continuous integer variables.
entind 
(optional) Array containing the variables of the MIP entities.
limit 
(optional) Array containing the integer limits for the partial integer variables and lower bounds for semi-continuous and semi-continuous integer variables (any entries in the positions corresponding to binary and integer variables will be ignored). May be None if not required.
settype 
(optional) Character array of length equal to the number of sets specified, problem.attributes.nsets, and specifies the set types:
SOS1 type sets;
SOS2 type sets.
May be None if not required.
setstart 
(optional) Array containing the offsets in the setind and refval arrays indicating the start of the sets. This array is of length nsets+1, the last member containing the offset where set nsets+1 would start. May be None if not required.
setind 
(optional) Array of length setstart[nsets]-1 containing the columns in each set. May be None if not required.
refval 
(optional) Array of length setstart[nsets]-1 containing the reference row entries for each member of the sets. May be None if not required.
colnames 
(optional) Array of containing the column names for all variables added.
rownames 
(optional) Array of containing the row names for all constraints added.
unlinked 
(optional) If True, unlinked variables and constraints will be created (deprecated).
Further information
1. The objective function is of the form cTx+ 1/2 xTQx where Q is positive semi-definite for minimization problems and negative semi-definite for maximization problems. If this is not the case the optimization algorithms may converge to a local optimum or may not converge at all. Note that only the upper or lower triangular part of the Q matrix is specified.
2. All Q matrices in the constraints must be positive semi-definite. Note that only the upper or lower triangular part of the Q matrix is specified for constraints as well.
3. If indices are specified, both row and column indices are from 0 to rows-1 and 0 to cols-1 respectively.
4. Semi-continuous lower bounds are taken from the dlim array. If this is None then they are given a default value of 1.0. If a semi-continuous variable has a positive lower bound then this will be used as the semi-continuous lower bound and the lower bound on the variable will be set to zero.
Related topics

© 2001-2024 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.