Initializing help system before first use

XPRSattribute Enumeration


Namespace:  Optimizer
Assembly: xprsdn (in xprsdn.dll) Version: 45.01.02+1f9fd7ff9a8620394fec1839699751312debed40
Syntax
C# 
public enum XPRSattribute
Members
Member name Value Description
Rows 1,001 Number of rows (i.e. constraints) in the matrix.
Sets 1,004 Number of special ordered sets in the matrix.
SetMembers 1,005 Number of variables within special ordered sets (set members) in the matrix.
Elems 1,006 Number of matrix nonzeros (elements).
PrimalInfeas 1,007 Number of primal infeasibilities.
DualInfeas 1,008 Number of dual infeasibilities.
SimplexIter 1,009 Number of simplex iterations performed.
LPStatus 1,010 LP solution status.
MIPStatus 1,011 (MIP) solution status.
Cuts 1,012 Number of cuts being added to the matrix.
Nodes 1,013 Number of nodes solved so far in the MIP search. A node is counted as solved when it is either dropped or branched on.
NodeDepth 1,014 Depth of the current node.
ActiveNodes 1,015 Number of outstanding nodes.
MIPSolNode 1,016 Node at which the last integer feasible solution was found.
MIPSols 1,017 Number of integer solutions that have been found.
Cols 1,018 Number of columns (i.e. variables) in the matrix.
SpareRows 1,019 Number of spare rows in the matrix.
SpareCols 1,020 Number of spare columns in the matrix.
SpareElems 1,021 Number of spare matrix elements in the matrix.
SpareMIPEnts 1,022 Number of spare MIP entities in the matrix.
ErrorCode 1,023 The most recent Optimizer error number that occurred. This is useful to determine the precise error that has occurred, after an Optimizer function has signalled an error by returning a non-zero value. The return value itself is not the error number. Refer to the section for a list of possible error numbers, the errors they indicate, and advice on what they mean and how to resolve them. A short error message may be obtained using getLastError, and all messages may be intercepted using the user output callback function; see addCbMessage.
MIPInfeas 1,024 Number of integer infeasibilities, including violations of special ordered sets, at the current node.
PresolveState 1,026 Problem status as a bit-vector (compare Section ).
ParentNode 1,027 The parent node of the current node in the tree search.
NameLength 1,028 The length (in 8 character units) of row and column names in the matrix. To allocate a character array to store names, you must allow 8*NAMELENGTH+1 characters per name (the +1 allows for the string terminator character).
QElems 1,030 Number of quadratic non-zeros in the objective.
NumIIS 1,031 Number of IISs found. You should first query the IISSOLSTATUS attribute to make sure that the IIS procedure terminated successfully.
MIPEnts 1,032 Number of MIP entities (i.e. binary, integer, semi-continuous, partial integer, and semi-continuous integer variables) but excluding the number of special ordered sets.
BranchVar 1,036 The branching variable at a node of the Branch and Bound tree.
MIPThreadID 1,037 The ID for the MIP thread.
Algorithm 1,049 The algorithm the optimizer currently is running / was running just before completition.
CrossoverIter 1,051 Number of simplex iterations performed in crossover.
SolStatus 1,053 Status of the solution of the last problem solved with optimize.
CutRounds 1,121 Number of rounds of cuts applied to the current node of a branch-and-bound search.
Time 1,122 Time spent solving the problem as measured by the optimizer.
OriginalRows 1,124 Number of rows (i.e. constraints) in the original matrix before presolving.
CallbackCount_OptNode 1,136 This attribute counts the number of times the optimal node callback set by addCbOptnode has been called for the current node, including the current callback call. The value of this attribute should only be used from within the optimal node callback.
CallbackCount_CutMgr 1,137 This attribute counts the number of times the cut manager callback set by addCbCutmgr has been called for the current node, including the current callback call. The value of this attribute should only be used from within the cut manager callback.
SystemMemory 1,148 The amount of non problem specific memory used by the solver.
OriginalQElems 1,157 Number of quadratic non-zeros in the original objective before presolving.
MaxProbNameLength 1,158 Maximum size of the problem name and also the maximum allowed length of the file or path string for any function that accepts such an argument (not including the null terminator).
StopStatus 1,179 Status of the optimization process.
OriginalMIPEnts 1,191 Number of MIP entities (i.e. binary, integer, semi-continuous, partial integer, and semi-continuous integer variables) but excluding the number of special ordered sets in the original matrix before presolving.
OriginalSets 1,194 Number of special ordered sets in the original matrix before presolving.
OriginalSetMembers 1,195 Number of variables within special ordered sets (set members) in the original matrix before presolving.
SpareSets 1,203 Number of spare sets in the matrix.
SpareSetElems 1,204 Number of spare set elements in the matrix.
ChecksOnMaxTime 1,208 This attribute is used to set the value of the MAXCHECKSONMAXTIME control. Its value is the number of times the optimizer checked the MAXTIME criterion during the last call to the optimization routine mipOptimize. If a run terminates on the MAXTIME criterion then the attribute is the negative of the number of times the optimizer checked the MAXTIME criterion up to and including the check when the termination was activated. Note that the attribute is set to zero at the beginning of each call to an optimization routine.
ChecksOnMaxCutTime 1,209 This attribute is used to set the value of the MAXCHECKSONMAXCUTTIME control. Its value is the number of times the optimizer checked the MAXCUTTIME criterion during the last call to the optimization routine mipOptimize. If a run terminates cutting operations on the MAXCUTTIME criterion then the attribute is the negative of the number of times the optimizer checked the MAXCUTTIME criterion up to and including the check when the termination was activated. Note that the attribute is set to zero at the beginning of each call to an optimization routine.
OriginalCols 1,214 Number of columns (i.e. variables) in the original matrix before presolving.
QCElems 1,232 Number of quadratic row coefficients in the matrix.
QConstraints 1,234 Number of rows with quadratic coefficients in the matrix.
OriginalQCElems 1,237 Number of quadratic row coefficients in the original matrix before presolving.
OriginalQConstraints 1,239 Number of rows with quadratic coefficients in the original matrix before presolving.
PeakTotalTreeMemoryUsage 1,240 The peak size, in megabytes, that the branch-and-bound search tree reached during the solve. Note that this value will include the uncompressed size of any compressed data and the size of any data saved to the tree file.
CurrentNode 1,248 The unique identifier of the current node in the tree search.
TreeMemoryUsage 1,251 The amount of physical memory, in megabytes, currently being used to store the branch-and-bound search tree.
TreeFileSize 1,252 The allocated size of the tree file, in megabytes. Because data can be removed from the tree file during the branch and bound search, the size of the tree file is usually greater than the amount of data currently within it (represented by the TREEFILEUSAGE attribute).
TreeFileUsage 1,253 The number of megabytes of data from the branch-and-bound tree that have been saved to the tree file. Note that the actual allocated size of the tree file (represented by the TREEFILESIZE attribute) may be greater than this value.
Indicators 1,254 Number of indicator constrains in the problem.
OriginalIndicators 1,255 Number of indicator constraints in the original matrix before presolving.
CoresPerCPUDetected 1,258 Number of logical cores per CPU unit detected by the optimizer, which is the number of threads each CPU can execute.
CPUsDetected 1,259 Number of CPU units detected by the optimizer.
CoresDetected 1,260 Number of logical cores detected by the optimizer, which is the total number of threads the hardware can execute across all CPUs.
PhysicalCoresDetected 1,261 The total number of physical cores across all CPUs detected by the optimizer.
PhysicalCoresPerCPUDetected 1,262 The number of physical cores per CPU detected by the optimizer.
OptimizeTypeUsed 1,268 The type of solver used in the last call to optimize, mipOptimize, lpOptimize or nlpOptimize.
BarSing 1,281 Number of linearly dependent binding constraints at the optimal barrier solution. These results in singularities in the Cholesky decomposition during the barrier that may cause numerical troubles. Larger dependence means more chance for numerical difficulties.
BarSingR 1,282 Regularized number of linearly dependent binding constraints at the optimal barrier solution. These results in singularities in the Cholesky decomposition during the barrier that may cause numerical troubles. Larger dependence means more chance for numerical difficulties.
PresolveIndex 1,284 Presolve: The row or column index on which presolve detected a problem to be infeasible or unbounded.
CurrentMemory 1,285 The amount of dynamically allocated heap memory by the problem being solved.
PeakMemory 1,286 An estimate of the peak amount of dynamically allocated heap memory by the problem.
Cones 1,307 Number of second order and rotated second order cones in the problem.
ConeElems 1,308 Number of second order cone coefficients in the problem.
TotalMemory 1,322 The amount of dynamically allocated heap memory by the optimizer, including all problems currently exsisting.
AvailableMemory 1,324 The amount of heap memory detected by Xpress as free.
PwlCons 1,325 Number of piecewise linear constraints in the problem.
PwlPoints 1,326 Number of breakpoints of piecewise linear constraints in the problem.
GenCons 1,327 The number of general constraints (i.e. MIN/MAX/AND/OR/ABS constraints) in the problem.
GenConCols 1,328 Number of input variables in general constraints (i.e. MIN/MAX/AND/OR/ABS constraints) in the problem.
GenConVals 1,329 Number of constant values in general constraints (MIN/MAX constraints) in the problem.
TreeRestarts 1,335 Number of in-tree restarts performed.
OriginalPwls 1,336 Number of piecewise linear constraints in the original problem before presolving.
OriginalPwlpoints 1,337 Number of breakpoints of piecewise linear constraints in the original problem before presolving.
OriginalGencons 1,338 Number of general constraints in the original problem before presolving.
OriginalGenconCols 1,339 Number of input variables in general constraints in the original problem before presolving.
OriginalGenconVals 1,340 Number of constant values in general constraints in the original problem before presolving.
ComputeExecutions 1,356 The number of solves executed on a compute server.
MIPSolTime 1,371 Time at which the last integer feasible solution was found.
MemoryLimitDetected 1,380 The detected amount of memory accessible to the solver process, in megabytes. This is the minimum of physical memory, virtual memory limitations, and detected container limitations (Linux only).
Restarts 1,381 Total number of restarts performed.
SolveStatus 1,394 Status of the solve of the last problem solved with optimize.
GlobalBoundingboxApplied 1,396 Whether a bounding box equal to the absolute value of the GLOBALBOUNDINGBOX control was applied to the problem after the initial solve came back infeasible and if so, to which variables.
Objectives 1,397 Number of objectives in the problem.
SolvedObjs 1,399 Number of objectives that have been solved so far during a multi-objective solve.
ObjsToSolve 1,400 Number of objectives that will be solved during the current multi-objective solve.
GlobalNLPInfeas 1,403 Number of nonlinear infeasibilities at the current node of a global solve, measured as the number of violated atomic formulas.
IISSolStatus 1,406 IIS solution status.
InputRows 1,408 Number of rows (i.e. constraints) in the original matrix before nonlinear reformulations.
InputCols 1,409 Number of columns (i.e. variables) in the original matrix before nonlinear reformulations.
LPObjVal 2,001 Value of the objective function of the last LP solved.
SumPrimalInf 2,002 Scaled sum of primal infeasibilities.
MIPObjVal 2,003 Objective function value of the last integer solution found.
BestBound 2,004 Value of the best bound determined so far by the MIP search.
ObjRHS 2,005 Fixed part of the objective function.
MIPBestObjVal 2,006 Objective function value of the best integer solution found.
OBJSense 2,008 Sense of the optimization being performed.
BranchValue 2,009 The value of the branching variable at a node of the Branch and Bound tree.
PenaltyValue 2,061 The weighted sum of violations in the solution to the relaxed problem identified by the infeasibility repair function.
CurrMipCutOff 2,062 The current MIP cut off.
BarCondA 2,063 Absolute condition measure calculated in the last iteration of the barrier algorithm.
BarCondD 2,064 Condition measure calculated in the last iteration of the barrier algorithm.
MaxAbsPrimalInfeas 2,073 Maximum calculated absolute primal infeasibility in the unscaled original problem.
MaxRelPrimalInfeas 2,074 Maximum calculated relative primal infeasibility in the unscaled original problem.
MaxAbsDualInfeas 2,075 Maximum calculated absolute dual infeasibility in the unscaled original problem.
MaxRelDualInfeas 2,076 Maximum calculated relative dual infeasibility in the unscaled original problem.
PrimalDualIntegral 2,079 Value of the primal-dual integral.
MaxMipInfeas 2,083 Maximum integer fractionality in the solution.
AttentionLevel 2,097 A measure between 0 and 1 for how numerically unstable the problem is. The attention level is based on a weighted combination of the number of basis condition numbers exceeding certain thresholds. It considers all nodes sampled by MIPKAPPAFREQ, with a setting of 1 being the most frequent sampling rate. The higher the attention level, the worse conditioned is the problem.
MaxKappa 2,098 Largest basis condition number (also known as kappa) calculated through all nodes sampled by MIPKAPPAFREQ.
TreeCompletion 2,104 Estimation of the relative completion of the search tree as fraction between 0 and 1. Its accuracy mainly depends on the level of degeneracy of a problem and the balancedness of the search tree.
PredictedAttLevel 2,105 A measure between 0 and 1 to predict how numerically unstable the current MIP solve can be expected to be. After the root LP solve, a machine learning model is used to predict the actual ATTENTIONLEVEL which will only be computed if MIPKAPPAFREQ is set to a nonzero value. If the predicted attention level exceeds a value of 0.1, a message will be printed to the log.
ObservedPrimalIntegral 2,106 Value of the (observed) primal integral.
CpiScaleFactor 2,117 scale factor from primal integral computation.
ObjVal 2,118 Value of the objective function of the last problem solved with optimize.
Work 2,120 Amount of deterministic algorithmic "work" spent since the invocation of the search process. Work is measured in work units. In contrast with TIME, WORK is deterministic. It is also independent of the platform and hardware used. At the end of a search, the optimizer reports both the accumulated total work as well as the speed at which WORK has been accumulated (measured in work units per second) in the log file. The accumulation of work depends on the size of the model being solved, the involved algorithms, and the stage of the search.
MatrixName 3,001 The matrix name.
BoundName 3,002 Active bound name.
ObjName 3,003  
RHSName 3,004 Active right hand side name.
RangeName 3,005 Active range name.
XpressVersion 3,010 The Xpress version number.
UUID 3,011 Universally Unique Identifier for the problem instance.
BarPrimalObj 4,001 Primal objective value calculated by the Newton barrier algorithm.
BarDualObj 4,002 Dual objective value calculated by the Newton barrier algorithm.
BarPrimalInf 4,003 Sum of the primal infeasibilities for the Newton barrier algorithm.
BarDualInf 4,004 Sum of the dual infeasibilities for the Newton barrier algorithm.
BarCGap 4,005 Convergence criterion for the Newton barrier algorithm.
BarIter 5,001 Number of Newton barrier iterations.
BarAASize 5,002 Number of nonzeros in AA^T.
BarLSize 5,003 Number of nonzeros in L resulting from the Cholesky factorization.
BarDenseCol 5,004 Number of dense columns found in the matrix.
BarCrossover 5,005 Indicates whether or not the basis crossover phase has been entered.
Msp_Solutions 6,208  
Msp_Prb_ValidSols 6,300  
Msp_Prb_FeasibleSols 6,301  
Msp_Sol_Cols 6,400  
Msp_Sol_NonZeros 6,401  
Msp_Sol_IsUserSolution 6,404  
Msp_Sol_IsReProcessedUserSolution 6,405  
Msp_Sol_BitFieldsSys 6,407  
Msp_SolPrb_Obj 6,500  
Msp_SolPrb_InfeasCount 6,501  
Msp_SolPrb_InfSum_Primal 6,502  
Msp_SolPrb_InfCnt_Primal 6,503  
Msp_SolPrb_InfSum_Mip 6,504  
Msp_SolPrb_InfCnt_Mip 6,505  
Mse_Solutions 6,600  
Mse_Metric_MipObject 6,604  
Mse_Metric_Diversity 6,605  
Mse_Metric_ModObject 6,606  
Mse_DiversitySum 6,608  
NlpOriginalRows 11,999 Number of model rows in the extended original problem
NlpOriginalCols 12,000 Number of model columns in the extended original problem
SlpIter 12,001 SLP iteration count
SlpStatus 12,002 Bitmap holding the problem convergence status
SlpUnConverged 12,003 Number of unconverged values
SlpSbxConverged 12,004 Number of step-bounded variables converged only on extended criteria
NlpUFs 12,007 Number of user functions
NlpIfs 12,008 Number of internal functions
SlpPenaltyDeltaRow 12,009 Index of equality row holding the penalties for delta vectors
SlpPenaltyDeltaColumn 12,010 Index of column costing the penalty delta row
SlpPenaltyErrorRow 12,011 Index of equality row holding the penalties for penalty error vectors
SlpPenaltyErrorColumn 12,012 Index of column costing the penalty error row
NlpEqualsColumn 12,013 Index of the reserved "=" column
NlpVariables 12,014 Number of SLP variables
NlpImplicitVariables 12,015 Number of SLP variables appearing only in coefficients
SlpCoefficients 12,016 Number of nonlinear coefficients
SlpPenaltyDeltas 12,017 Number of penalty delta vectors
SlpPenaltyErrors 12,018 Number of penalty error vectors
SlpPlusPenaltyErrors 12,019 Number of positive penalty error vectors
SlpMinusPenaltyErrors 12,020 Number of negative penalty error vectors
SlpUCConstrainedCount 12,021 Number of unconverged variables with coefficients in constraining rows
SlpMipNodes 12,022 Number of nodes explored in MISLP. This includes any nodes for which a non-linear solve has been carried out.
SlpMipIter 12,023 Total number of SLP iterations in MISLP
NonLinearConstraints 12,026 Number of nonlinear constraints in the problem
SlpTolSets 12,028 Number of tolerance sets.
NlpUserFuncCalls 12,031 Number of calls made to user functions
SlpECFCount 12,035 Number of infeasible constraints found at the point of linearization
NlpUseDerivatives 12,037 Indicates whether numeric or analytic derivatives were used to create the linear approximations and solve the problem
SlpDeltas 12,041 Number of delta vectors created during augmentation
NlpKeepBestIter 12,042 The iteration in which the returned solution has been found.
NlpStatus 12,044 The solution status of the problem.
SlpZeroesReset 12,046 Number of placeholder entries set to zero
SlpZeroesTotal 12,047 Number of potential zero placeholder entries
SlpZeroesRetained 12,048 Number of potentially zero placeholders left untouched
SlpNonConstantCoeffs 12,058 Number of coefficients in the augmented problem that might change between SLP iterations
LocalSolverSelected 12,075 Includes information of which Xpress solver has been used to solve the problem
NlpModelRows 12,079 Number of model rows in the problem
NlpModelCols 12,080 Number of model columns in the problem
NlpJobID 12,081 Unique identifier for the current job
SlpMipSols 12,088 Number of integer solutions found in MISLP. This includes solutions found during the tree search or any heuristics.
NlpStopStatus 12,089 Status of the optimization process.
NlpPresolveEliminations 12,090 Number of SLP variables eliminated by XSLPpresolve
NlpOptTime 12,147 Time spent in optimization
SlpErrorCosts 12,153 Total penalty costs in the solution
NlpValidationIndex_A 12,167 Absolute validation index
NlpValidationIndex_R 12,168 Relative validation index
NlpObjVal 12,179 Objective function value excluding any penalty costs
SlpCurrentDeltaCost 12,701 Current value of penalty cost multiplier for penalty delta vectors
SlpCurrentErrorCost 12,702 Current value of penalty cost multiplier for penalty error vectors
SlpPenaltyErrorTotal 12,704 Total activity of penalty error vectors
SlpPenaltyErrorValue 12,705 Total penalty cost attributed to penalty error vectors
SlpPenaltyDeltaTotal 12,706 Total activity of penalty delta vectors
SlpPenaltyDeltaValue 12,707 Total penalty cost attributed to penalty delta vectors
NlpValidationIndex_K 12,718 Relative first order optimality validation index
See Also
Parent Topic Optimizer

© 2001-2025 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.