Initializing help system before first use

XPRSattribute Enumeration

Namespace:   Optimizer
Assembly:  xprsdn (in xprsdn.dll) Version: 44.01.01
Syntax
C# 
public enum XPRSattribute
Members
  Member name Value Description
Rows 1001 Number of rows (i.e. constraints) in the matrix.
Sets 1004 Number of special ordered sets in the matrix.
SetMembers 1005 Number of variables within special ordered sets (set members) in the matrix.
Elems 1006 Number of matrix nonzeros (elements).
PrimalInfeas 1007 Number of primal infeasibilities.
DualInfeas 1008 Number of dual infeasibilities.
SimplexIter 1009 Number of simplex iterations performed.
LPStatus 1010 LP solution status.
MIPStatus 1011 (MIP) solution status.
Cuts 1012 Number of cuts being added to the matrix.
Nodes 1013 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 1014 Depth of the current node.
ActiveNodes 1015 Number of outstanding nodes.
MIPSolNode 1016 Node at which the last integer feasible solution was found.
MIPSols 1017 Number of integer solutions that have been found.
Cols 1018 Number of columns (i.e. variables) in the matrix.
SpareRows 1019 Number of spare rows in the matrix.
SpareCols 1020 Number of spare columns in the matrix.
SpareElems 1021 Number of spare matrix elements in the matrix.
SpareMIPEnts 1022 Number of spare MIP entities in the matrix.
ErrorCode 1023 The most recent Optimizer error number that occurred. This is useful to determine the precise error or warning 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 and warnings that 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 1024 Number of integer infeasibilities, including violations of special ordered sets, at the current node.
PresolveState 1026 Problem status as a bit map.
ParentNode 1027 The parent node of the current node in the tree search.
NameLength 1028 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 1030 Number of quadratic non-zeros in the objective.
NumIIS 1031 Number of IISs found. You should first query the IISSOLSTATUS attribute to make sure that the IIS procedure terminated successfully.
MIPEnts 1032 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 1036 The branching variable at a node of the Branch and Bound tree.
MIPThreadID 1037 The ID for the MIP thread.
Algorithm 1049 The algorithm the optimizer currently is running / was running just before completition.
CrossoverIter 1051 Number of simplex iterations performed in crossover.
SolStatus 1053 Status of the solution of the last problem solved with optimize.
OriginalRows 1124 Number of rows (i.e. constraints) in the original matrix before presolving.
CallbackCount_OptNode 1136 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 1137 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 1148 The amount of non problem specific memory used by the solver.
OriginalQElems 1157 Number of quadratic non-zeros in the original objective before presolving.
MaxProbNameLength 1158 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 1179 Status of the optimization process.
OriginalMIPEnts 1191 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 1194 Number of special ordered sets in the original matrix before presolving.
OriginalSetMembers 1195 Number of variables within special ordered sets (set members) in the original matrix before presolving.
SpareSets 1203 Number of spare sets in the matrix.
SpareSetElems 1204 Number of spare set elements in the matrix.
ChecksOnMaxTime 1208 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 1209 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 1214 Number of columns (i.e. variables) in the original matrix before presolving.
QCElems 1232 Number of quadratic row coefficients in the matrix.
QConstraints 1234 Number of rows with quadratic coefficients in the matrix.
OriginalQCElems 1237 Number of quadratic row coefficients in the original matrix before presolving.
OriginalQConstraints 1239 Number of rows with quadratic coefficients in the original matrix before presolving.
PeakTotalTreeMemoryUsage 1240 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 1248 The unique identifier of the current node in the tree search.
TreeMemoryUsage 1251 The amount of physical memory, in megabytes, currently being used to store the branch-and-bound search tree.
TreeFileSize 1252 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 1253 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 1254 Number of indicator constrains in the problem.
OriginalIndicators 1255 Number of indicator constraints in the original matrix before presolving.
CoresPerCPUDetected 1258 Number of logical cores per CPU unit detected by the optimizer, which is the number of threads each CPU can execute.
CPUsDetected 1259 Number of CPU units detected by the optimizer.
CoresDetected 1260 Number of logical cores detected by the optimizer, which is the total number of threads the hardware can execute across all CPUs.
PhysicalCoresDetected 1261 The total number of physical cores across all CPUs detected by the optimizer.
PhysicalCoresPerCPUDetected 1262 The number of physical cores per CPU detected by the optimizer.
OptimizeTypeUsed 1268 The type of solver used in the last call to optimize, mipOptimize, lpOptimize or nlpOptimize.
BarSing 1281 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 1282 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 1284 Presolve: The row or column index on which presolve detected a problem to be infeasible or unbounded.
CurrentMemory 1285 The amount of dynamically allocated heap memory by the problem being solved.
PeakMemory 1286 An estimate of the peak amount of dynamically allocated heap memory by the problem.
Cones 1307 Number of second order and rotated second order cones in the problem.
ConeElems 1308 Number of second order cone coefficients in the problem.
TotalMemory 1322 The amount of dynamically allocated heap memory by the optimizer, including all problems currently exsisting.
AvailableMemory 1324 The amount of heap memory detected by Xpress as free.
PwlCons 1325 Number of piecewise linear constraints in the problem.
PwlPoints 1326 Number of breakpoints of piecewise linear constraints in the problem.
GenCons 1327 The number of general constraints (i.e. MIN/MAX/AND/OR/ABS constraints) in the problem.
GenConCols 1328 Number of input variables in general constraints (i.e. MIN/MAX/AND/OR/ABS constraints) in the problem.
GenConVals 1329 Number of constant values in general constraints (MIN/MAX constraints) in the problem.
TreeRestarts 1335 Number of in-tree restarts performed.
OriginalPwls 1336 Number of piecewise linear constraints in the original problem before presolving.
OriginalPwlpoints 1337 Number of breakpoints of piecewise linear constraints in the original problem before presolving.
OriginalGencons 1338 Number of general constraints in the original problem before presolving.
OriginalGenconCols 1339 Number of input variables in general constraints in the original problem before presolving.
OriginalGenconVals 1340 Number of constant values in general constraints in the original problem before presolving.
ComputeExecutions 1356 The number of solves executed on a compute server.
MemoryLimitDetected 1380 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 1381 Total number of restarts performed.
SolveStatus 1394 Status of the solve of the last problem solved with optimize.
GlobalBoundingboxApplied 1396 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 1397 Number of objectives in the problem.
SolvedObjs 1399 Number of objectives that have been solved so far during a multi-objective solve.
ObjsToSolve 1400 Number of objectives that will be solved during the current multi-objective solve.
GlobalNLPInfeas 1403 Number of nonlinear infeasibilities at the current node of a global solve, measured as the number of violated atomic formulas.
IISSolStatus 1406 IIS solution status.
InputRows 1408 Number of rows (i.e. constraints) in the original matrix before nonlinear reformulations.
InputCols 1409 Number of columns (i.e. variables) in the original matrix before nonlinear reformulations.
MIPSolTime 1371 Time at which the last integer feasible solution was found.
Time 1122 Time spent solving the problem as measured by the optimizer.
LPObjVal 2001 Value of the objective function of the last LP solved.
SumPrimalInf 2002 Scaled sum of primal infeasibilities.
MIPObjVal 2003 Objective function value of the last integer solution found.
BestBound 2004 Value of the best bound determined so far by the MIP search.
ObjRHS 2005 Fixed part of the objective function.
MIPBestObjVal 2006 Objective function value of the best integer solution found.
OBJSense 2008 Sense of the optimization being performed.
BranchValue 2009 The value of the branching variable at a node of the Branch and Bound tree.
PenaltyValue 2061 The weighted sum of violations in the solution to the relaxed problem identified by the infeasibility repair function.
CurrMipCutOff 2062 The current MIP cut off.
BarCondA 2063 Absolute condition measure calculated in the last iteration of the barrier algorithm.
BarCondD 2064 Condition measure calculated in the last iteration of the barrier algorithm.
MaxAbsPrimalInfeas 2073 Maximum calculated absolute primal infeasibility in the unscaled original problem.
MaxRelPrimalInfeas 2074 Maximum calculated relative primal infeasibility in the unscaled original problem.
MaxAbsDualInfeas 2075 Maximum calculated absolute dual infeasibility in the unscaled original problem.
MaxRelDualInfeas 2076 Maximum calculated relative dual infeasibility in the unscaled original problem.
PrimalDualIntegral 2079 Value of the primal-dual integral.
MaxMipInfeas 2083 Maximum integer fractionality in the solution.
AttentionLevel 2097 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 2098 Largest basis condition number (also known as kappa) calculated through all nodes sampled by MIPKAPPAFREQ.
TreeCompletion 2104 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 2105 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 2106 Value of the (observed) primal integral.
CpiScaleFactor 2117 scale factor from primal integral computation.
ObjVal 2118 Value of the objective function of the last problem solved with optimize.
MatrixName 3001 The matrix name.
BoundName 3002 Active bound name.
ObjName 3003
RHSName 3004 Active right hand side name.
RangeName 3005 Active range name.
XpressVersion 3010 The Xpress version number.
UUID 3011 Universally Unique Identifier for the problem instance.
BarPrimalObj 4001 Primal objective value calculated by the Newton barrier algorithm.
BarDualObj 4002 Dual objective value calculated by the Newton barrier algorithm.
BarPrimalInf 4003 Sum of the primal infeasibilities for the Newton barrier algorithm.
BarDualInf 4004 Sum of the dual infeasibilities for the Newton barrier algorithm.
BarCGap 4005 Convergence criterion for the Newton barrier algorithm.
BarIter 5001 Number of Newton barrier iterations.
BarAASize 5002 Number of nonzeros in AAT.
BarLSize 5003 Number of nonzeros in L resulting from the Cholesky factorization.
BarDenseCol 5004 Number of dense columns found in the matrix.
BarCrossover 5005 Indicates whether or not the basis crossover phase has been entered.
Msp_Solutions 6208
Msp_Prb_ValidSols 6300
Msp_Prb_FeasibleSols 6301
Msp_Sol_Cols 6400
Msp_Sol_NonZeros 6401
Msp_Sol_IsUserSolution 6404
Msp_Sol_IsReProcessedUserSolution 6405
Msp_Sol_BitFieldsSys 6407
Msp_SolPrb_Obj 6500
Msp_SolPrb_InfeasCount 6501
Msp_SolPrb_InfSum_Primal 6502
Msp_SolPrb_InfCnt_Primal 6503
Msp_SolPrb_InfSum_Mip 6504
Msp_SolPrb_InfCnt_Mip 6505
Mse_Solutions 6600
Mse_Metric_MipObject 6604
Mse_Metric_Diversity 6605
Mse_Metric_ModObject 6606
Mse_DiversitySum 6608
NlpOptTime 12147 Time spent in optimization
NlpValidationIndex_A 12167 Absolute validation index
NlpValidationIndex_R 12168 Relative validation index
NlpObjVal 12179 Objective function value excluding any penalty costs
SlpErrorCosts 12153 Total penalty costs in the solution
NlpOriginalRows 11999 Number of model rows in the extended original problem
NlpOriginalCols 12000 Number of model columns in the extended original problem
NlpUFs 12007 Number of user functions
NlpIfs 12008 Number of internal functions
NlpEqualsColumn 12013 Index of the reserved "=" column
NlpVariables 12014 Number of SLP variables
NlpImplicitVariables 12015 Number of SLP variables appearing only in coefficients
NonLinearConstraints 12026 Number of nonlinear constraints in the problem
NlpUserFuncCalls 12031 Number of calls made to user functions
NlpUseDerivatives 12037 Indicates whether numeric or analytic derivatives were used to create the linear approximations and solve the problem
NlpKeepBestIter 12042 The iteration in which the returned solution has been found.
NlpStatus 12044 Bitmap holding the problem convergence status
LocalSolverSelected 12075
NlpModelRows 12079 Number of model rows in the problem
NlpModelCols 12080 Number of model columns in the problem
NlpJobID 12081 Unique identifier for the current job
NlpStopStatus 12089 Status of the optimization process.
NlpPresolveEliminations 12090 Number of SLP variables eliminated by XSLPpresolve
SlpIter 12001 SLP iteration count
SlpStatus 12002 Bitmap holding the problem convergence status
SlpUnConverged 12003 Number of unconverged values
SlpSbxConverged 12004 Number of step-bounded variables converged only on extended criteria
SlpPenaltyDeltaRow 12009 Index of equality row holding the penalties for delta vectors
SlpPenaltyDeltaColumn 12010 Index of column costing the penalty delta row
SlpPenaltyErrorRow 12011 Index of equality row holding the penalties for penalty error vectors
SlpPenaltyErrorColumn 12012 Index of column costing the penalty error row
SlpCoefficients 12016 Number of nonlinear coefficients
SlpPenaltyDeltas 12017 Number of penalty delta vectors
SlpPenaltyErrors 12018 Number of penalty error vectors
SlpPlusPenaltyErrors 12019 Number of positive penalty error vectors
SlpMinusPenaltyErrors 12020 Number of negative penalty error vectors
SlpUCConstrainedCount 12021 Number of unconverged variables with coefficients in constraining rows
SlpMipNodes 12022 Number of nodes explored in MISLP. This includes any nodes for which a non-linear solve has been carried out.
SlpMipIter 12023 Total number of SLP iterations in MISLP
SlpTolSets 12028 Number of tolerance sets.
SlpECFCount 12035 Number of infeasible constraints found at the point of linearization
SlpDeltas 12041 Number of delta vectors created during augmentation
SlpZeroesReset 12046 Number of placeholder entries set to zero
SlpZeroesTotal 12047 Number of potential zero placeholder entries
SlpZeroesRetained 12048 Number of potentially zero placeholders left untouched
SlpNonConstantCoeffs 12058 Number of coefficients in the augmented problem that might change between SLP iterations
SlpMipSols 12088 Number of integer solutions found in MISLP. This includes solutions found during the tree search or any heuristics.
NlpValidationIndex_K 12718 Relative first order optimality validation index
SlpCurrentDeltaCost 12701 Current value of penalty cost multiplier for penalty delta vectors
SlpCurrentErrorCost 12702 Current value of penalty cost multiplier for penalty error vectors
SlpPenaltyErrorTotal 12704 Total activity of penalty error vectors
SlpPenaltyErrorValue 12705 Total penalty cost attributed to penalty error vectors
SlpPenaltyDeltaTotal 12706 Total activity of penalty delta vectors
SlpPenaltyDeltaValue 12707 Total penalty cost attributed to penalty delta vectors
See Also
Parent Topic Optimizer

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