Attributes
Attributes API. More...
#include <xpress.hpp>
Public Member Functions |
|
auto | getActiveNodes () const -> int |
Get the value for attribute ActiveNodes . |
|
auto | getAlgorithm () const -> int |
Get the value for attribute Algorithm . |
|
auto | getAttentionLevel () const -> double |
Get the value for attribute AttentionLevel . |
|
auto | getAvailableMemory () const -> XPRSint64 |
Get the value for attribute AvailableMemory . |
|
auto | getBarAASize () const -> XPRSint64 |
Get the value for attribute BarAASize . |
|
auto | getBarCGap () const -> double |
Get the value for attribute BarCGap . |
|
auto | getBarCondA () const -> double |
Get the value for attribute BarCondA . |
|
auto | getBarCondD () const -> double |
Get the value for attribute BarCondD . |
|
auto | getBarCrossover () const -> int |
Get the value for attribute BarCrossover . |
|
auto | getBarDenseCol () const -> int |
Get the value for attribute BarDenseCol . |
|
auto | getBarDualInf () const -> double |
Get the value for attribute BarDualInf . |
|
auto | getBarDualObj () const -> double |
Get the value for attribute BarDualObj . |
|
auto | getBarIter () const -> int |
Get the value for attribute BarIter . |
|
auto | getBarLSize () const -> XPRSint64 |
Get the value for attribute BarLSize . |
|
auto | getBarPrimalInf () const -> double |
Get the value for attribute BarPrimalInf . |
|
auto | getBarPrimalObj () const -> double |
Get the value for attribute BarPrimalObj . |
|
auto | getBarSing () const -> int |
Get the value for attribute BarSing . |
|
auto | getBarSingR () const -> int |
Get the value for attribute BarSingR . |
|
auto | getBestBound () const -> double |
Get the value for attribute BestBound . |
|
auto | getBoundName () const -> std::string |
Get the value for attribute BoundName . |
|
auto | getBranchValue () const -> double |
Get the value for attribute BranchValue . |
|
auto | getBranchVar () const -> int |
Get the value for attribute BranchVar . |
|
auto | getCallbackCount_CutMgr () const -> int |
Get the value for attribute CallbackCount_CutMgr . |
|
auto | getCallbackCount_OptNode () const -> int |
Get the value for attribute CallbackCount_OptNode . |
|
auto | getChecksOnMaxCutTime () const -> int |
Get the value for attribute ChecksOnMaxCutTime . |
|
auto | getChecksOnMaxTime () const -> int |
Get the value for attribute ChecksOnMaxTime . |
|
auto | getCols () const -> int |
Get the value for attribute Cols . |
|
auto | getComputeExecutions () const -> int |
Get the value for attribute ComputeExecutions . |
|
auto | getConeElems () const -> int |
Get the value for attribute ConeElems . |
|
auto | getCones () const -> int |
Get the value for attribute Cones . |
|
auto | getCoresDetected () const -> int |
Get the value for attribute CoresDetected . |
|
auto | getCoresPerCPUDetected () const -> int |
Get the value for attribute CoresPerCPUDetected . |
|
auto | getCpiScaleFactor () const -> double |
Get the value for attribute CpiScaleFactor . |
|
auto | getCPUsDetected () const -> int |
Get the value for attribute CPUsDetected . |
|
auto | getCrossoverIter () const -> int |
Get the value for attribute CrossoverIter . |
|
auto | getCurrentMemory () const -> XPRSint64 |
Get the value for attribute CurrentMemory . |
|
auto | getCurrentNode () const -> int |
Get the value for attribute CurrentNode . |
|
auto | getCurrMipCutOff () const -> double |
Get the value for attribute CurrMipCutOff . |
|
auto | getCuts () const -> int |
Get the value for attribute Cuts . |
|
auto | getDualInfeas () const -> int |
Get the value for attribute DualInfeas . |
|
auto | getElems () const -> XPRSint64 |
Get the value for attribute Elems . |
|
auto | getErrorCode () const -> int |
Get the value for attribute ErrorCode . |
|
auto | getGenConCols () const -> XPRSint64 |
Get the value for attribute GenConCols . |
|
auto | getGenCons () const -> int |
Get the value for attribute GenCons . |
|
auto | getGenConVals () const -> XPRSint64 |
Get the value for attribute GenConVals . |
|
auto | getGlobalBoundingboxApplied () const -> int |
Get the value for attribute GlobalBoundingboxApplied . |
|
auto | getGlobalNlpInfeas () const -> int |
Get the value for attribute GlobalNlpInfeas . |
|
auto | getIISSolStatus () const -> xpress::IISSolStatus |
Get the value for attribute IISSolStatus . |
|
auto | getIndicators () const -> int |
Get the value for attribute Indicators . |
|
auto | getInputCols () const -> int |
Get the value for attribute InputCols . |
|
auto | getInputRows () const -> int |
Get the value for attribute InputRows . |
|
auto | getLocalSolverSelected () const -> int |
Get the value for attribute LocalSolverSelected . |
|
auto | getLpObjVal () const -> double |
Get the value for attribute LpObjVal . |
|
auto | getLpStatus () const -> xpress::LPStatus |
Get the value for attribute LpStatus . |
|
auto | getMatrixName () const -> std::string |
Get the value for attribute MatrixName . |
|
auto | getMaxAbsDualInfeas () const -> double |
Get the value for attribute MaxAbsDualInfeas . |
|
auto | getMaxAbsPrimalInfeas () const -> double |
Get the value for attribute MaxAbsPrimalInfeas . |
|
auto | getMaxKappa () const -> double |
Get the value for attribute MaxKappa . |
|
auto | getMaxMipInfeas () const -> double |
Get the value for attribute MaxMipInfeas . |
|
auto | getMaxProbNameLength () const -> int |
Get the value for attribute MaxProbNameLength . |
|
auto | getMaxRelDualInfeas () const -> double |
Get the value for attribute MaxRelDualInfeas . |
|
auto | getMaxRelPrimalInfeas () const -> double |
Get the value for attribute MaxRelPrimalInfeas . |
|
auto | getMemoryLimitDetected () const -> XPRSint64 |
Get the value for attribute MemoryLimitDetected . |
|
auto | getMipBestObjVal () const -> double |
Get the value for attribute MipBestObjVal . |
|
auto | getMipEnts () const -> int |
Get the value for attribute MipEnts . |
|
auto | getMipInfeas () const -> int |
Get the value for attribute MipInfeas . |
|
auto | getMipObjVal () const -> double |
Get the value for attribute MipObjVal . |
|
auto | getMipSolNode () const -> int |
Get the value for attribute MipSolNode . |
|
auto | getMipSols () const -> int |
Get the value for attribute MipSols . |
|
auto | getMipSolTime () const -> double |
Get the value for attribute MipSolTime . |
|
auto | getMipStatus () const -> xpress::MIPStatus |
Get the value for attribute MipStatus . |
|
auto | getMipThreadID () const -> int |
Get the value for attribute MipThreadID . |
|
auto | getMseDiversitySum () const -> double |
Get the value for attribute MseDiversitySum . |
|
auto | getMseMetric_Diversity () const -> int |
Get the value for attribute MseMetric_Diversity . |
|
auto | getMseMetric_MipObject () const -> int |
Get the value for attribute MseMetric_MipObject . |
|
auto | getMseMetric_ModObject () const -> int |
Get the value for attribute MseMetric_ModObject . |
|
auto | getMseSolutions () const -> int |
Get the value for attribute MseSolutions . |
|
auto | getMspPrb_FeasibleSols () const -> int |
Get the value for attribute MspPrb_FeasibleSols . |
|
auto | getMspPrb_ValidSols () const -> int |
Get the value for attribute MspPrb_ValidSols . |
|
auto | getMspSol_BitFieldsSys () const -> int |
Get the value for attribute MspSol_BitFieldsSys . |
|
auto | getMspSol_Cols () const -> int |
Get the value for attribute MspSol_Cols . |
|
auto | getMspSol_IsReProcessedUserSolution () const -> int |
Get the value for attribute MspSol_IsReProcessedUserSolution . |
|
auto | getMspSol_IsUserSolution () const -> int |
Get the value for attribute MspSol_IsUserSolution . |
|
auto | getMspSol_NonZeros () const -> int |
Get the value for attribute MspSol_NonZeros . |
|
auto | getMspSolPrb_InfCnt_Mip () const -> int |
Get the value for attribute MspSolPrb_InfCnt_Mip . |
|
auto | getMspSolPrb_InfCnt_Primal () const -> int |
Get the value for attribute MspSolPrb_InfCnt_Primal . |
|
auto | getMspSolPrb_InfeasCount () const -> int |
Get the value for attribute MspSolPrb_InfeasCount . |
|
auto | getMspSolPrb_InfSum_Mip () const -> double |
Get the value for attribute MspSolPrb_InfSum_Mip . |
|
auto | getMspSolPrb_InfSum_Primal () const -> double |
Get the value for attribute MspSolPrb_InfSum_Primal . |
|
auto | getMspSolPrb_Obj () const -> double |
Get the value for attribute MspSolPrb_Obj . |
|
auto | getMspSolutions () const -> int |
Get the value for attribute MspSolutions . |
|
auto | getNameLength () const -> int |
Get the value for attribute NameLength . |
|
auto | getNlpEqualsColumn () const -> int |
Get the value for attribute NlpEqualsColumn . |
|
auto | getNlpIfs () const -> int |
Get the value for attribute NlpIfs . |
|
auto | getNlpImplicitVariables () const -> int |
Get the value for attribute NlpImplicitVariables . |
|
auto | getNlpJobID () const -> int |
Get the value for attribute NlpJobID . |
|
auto | getNlpKeepBestIter () const -> int |
Get the value for attribute NlpKeepBestIter . |
|
auto | getNlpModelCols () const -> int |
Get the value for attribute NlpModelCols . |
|
auto | getNlpModelRows () const -> int |
Get the value for attribute NlpModelRows . |
|
auto | getNlpObjVal () const -> double |
Get the value for attribute NlpObjVal . |
|
auto | getNlpOptTime () const -> double |
Get the value for attribute NlpOptTime . |
|
auto | getNlpOriginalCols () const -> int |
Get the value for attribute NlpOriginalCols . |
|
auto | getNlpOriginalRows () const -> int |
Get the value for attribute NlpOriginalRows . |
|
auto | getNlpPresolveEliminations () const -> int |
Get the value for attribute NlpPresolveEliminations . |
|
auto | getNlpStatus () const -> int |
Get the value for attribute NlpStatus . |
|
auto | getNlpStopStatus () const -> int |
Get the value for attribute NlpStopStatus . |
|
auto | getNlpUFs () const -> int |
Get the value for attribute NlpUFs . |
|
auto | getNlpUseDerivatives () const -> int |
Get the value for attribute NlpUseDerivatives . |
|
auto | getNlpUserFuncCalls () const -> int |
Get the value for attribute NlpUserFuncCalls . |
|
auto | getNlpValidationIndex_A () const -> double |
Get the value for attribute NlpValidationIndex_A . |
|
auto | getNlpValidationIndex_K () const -> double |
Get the value for attribute NlpValidationIndex_K . |
|
auto | getNlpValidationIndex_R () const -> double |
Get the value for attribute NlpValidationIndex_R . |
|
auto | getNlpVariables () const -> int |
Get the value for attribute NlpVariables . |
|
auto | getNodeDepth () const -> int |
Get the value for attribute NodeDepth . |
|
auto | getNodes () const -> int |
Get the value for attribute Nodes . |
|
auto | getNonLinearConstraints () const -> int |
Get the value for attribute NonLinearConstraints . |
|
auto | getNumIIS () const -> int |
Get the value for attribute NumIIS . |
|
auto | getObjectives () const -> int |
Get the value for attribute Objectives . |
|
auto | getObjName () const -> std::string |
Get the value for attribute ObjName . |
|
auto | getObjRhs () const -> double |
Get the value for attribute ObjRhs . |
|
auto | getOBJSense () const -> double |
Get the value for attribute OBJSense . |
|
auto | getObjsToSolve () const -> int |
Get the value for attribute ObjsToSolve . |
|
auto | getObjVal () const -> double |
Get the value for attribute ObjVal . |
|
auto | getObservedPrimalIntegral () const -> double |
Get the value for attribute ObservedPrimalIntegral . |
|
auto | getOptimizeTypeUsed () const -> xpress::OptimizeType |
Get the value for attribute OptimizeTypeUsed . |
|
auto | getOriginalCols () const -> int |
Get the value for attribute OriginalCols . |
|
auto | getOriginalGenconCols () const -> XPRSint64 |
Get the value for attribute OriginalGenconCols . |
|
auto | getOriginalGencons () const -> int |
Get the value for attribute OriginalGencons . |
|
auto | getOriginalGenconVals () const -> XPRSint64 |
Get the value for attribute OriginalGenconVals . |
|
auto | getOriginalIndicators () const -> int |
Get the value for attribute OriginalIndicators . |
|
auto | getOriginalMipEnts () const -> int |
Get the value for attribute OriginalMipEnts . |
|
auto | getOriginalPwlpoints () const -> XPRSint64 |
Get the value for attribute OriginalPwlpoints . |
|
auto | getOriginalPwls () const -> int |
Get the value for attribute OriginalPwls . |
|
auto | getOriginalQCElems () const -> int |
Get the value for attribute OriginalQCElems . |
|
auto | getOriginalQConstraints () const -> int |
Get the value for attribute OriginalQConstraints . |
|
auto | getOriginalQElems () const -> int |
Get the value for attribute OriginalQElems . |
|
auto | getOriginalRows () const -> int |
Get the value for attribute OriginalRows . |
|
auto | getOriginalSetMembers () const -> XPRSint64 |
Get the value for attribute OriginalSetMembers . |
|
auto | getOriginalSets () const -> int |
Get the value for attribute OriginalSets . |
|
auto | getParentNode () const -> int |
Get the value for attribute ParentNode . |
|
auto | getPeakMemory () const -> XPRSint64 |
Get the value for attribute PeakMemory . |
|
auto | getPeakTotalTreeMemoryUsage () const -> int |
Get the value for attribute PeakTotalTreeMemoryUsage . |
|
auto | getPenaltyValue () const -> double |
Get the value for attribute PenaltyValue . |
|
auto | getPhysicalCoresDetected () const -> int |
Get the value for attribute PhysicalCoresDetected . |
|
auto | getPhysicalCoresPerCPUDetected () const -> int |
Get the value for attribute PhysicalCoresPerCPUDetected . |
|
auto | getPredictedAttLevel () const -> double |
Get the value for attribute PredictedAttLevel . |
|
auto | getPresolveIndex () const -> int |
Get the value for attribute PresolveIndex . |
|
auto | getPresolveState () const -> int |
Get the value for attribute PresolveState . |
|
auto | getPrimalDualIntegral () const -> double |
Get the value for attribute PrimalDualIntegral . |
|
auto | getPrimalInfeas () const -> int |
Get the value for attribute PrimalInfeas . |
|
auto | getPwlCons () const -> int |
Get the value for attribute PwlCons . |
|
auto | getPwlPoints () const -> XPRSint64 |
Get the value for attribute PwlPoints . |
|
auto | getQCElems () const -> int |
Get the value for attribute QCElems . |
|
auto | getQConstraints () const -> int |
Get the value for attribute QConstraints . |
|
auto | getQElems () const -> int |
Get the value for attribute QElems . |
|
auto | getRangeName () const -> std::string |
Get the value for attribute RangeName . |
|
auto | getRestarts () const -> int |
Get the value for attribute Restarts . |
|
auto | getRhsName () const -> std::string |
Get the value for attribute RhsName . |
|
auto | getRows () const -> int |
Get the value for attribute Rows . |
|
auto | getSetMembers () const -> XPRSint64 |
Get the value for attribute SetMembers . |
|
auto | getSets () const -> int |
Get the value for attribute Sets . |
|
auto | getSimplexIter () const -> int |
Get the value for attribute SimplexIter . |
|
auto | getSlpCoefficients () const -> int |
Get the value for attribute SlpCoefficients . |
|
auto | getSlpCurrentDeltaCost () const -> double |
Get the value for attribute SlpCurrentDeltaCost . |
|
auto | getSlpCurrentErrorCost () const -> double |
Get the value for attribute SlpCurrentErrorCost . |
|
auto | getSlpDeltas () const -> int |
Get the value for attribute SlpDeltas . |
|
auto | getSlpECFCount () const -> int |
Get the value for attribute SlpECFCount . |
|
auto | getSlpErrorCosts () const -> double |
Get the value for attribute SlpErrorCosts . |
|
auto | getSlpIter () const -> int |
Get the value for attribute SlpIter . |
|
auto | getSlpMinusPenaltyErrors () const -> int |
Get the value for attribute SlpMinusPenaltyErrors . |
|
auto | getSlpMipIter () const -> int |
Get the value for attribute SlpMipIter . |
|
auto | getSlpMipNodes () const -> int |
Get the value for attribute SlpMipNodes . |
|
auto | getSlpMipSols () const -> int |
Get the value for attribute SlpMipSols . |
|
auto | getSlpNonConstantCoeffs () const -> int |
Get the value for attribute SlpNonConstantCoeffs . |
|
auto | getSlpPenaltyDeltaColumn () const -> int |
Get the value for attribute SlpPenaltyDeltaColumn . |
|
auto | getSlpPenaltyDeltaRow () const -> int |
Get the value for attribute SlpPenaltyDeltaRow . |
|
auto | getSlpPenaltyDeltas () const -> int |
Get the value for attribute SlpPenaltyDeltas . |
|
auto | getSlpPenaltyDeltaTotal () const -> double |
Get the value for attribute SlpPenaltyDeltaTotal . |
|
auto | getSlpPenaltyDeltaValue () const -> double |
Get the value for attribute SlpPenaltyDeltaValue . |
|
auto | getSlpPenaltyErrorColumn () const -> int |
Get the value for attribute SlpPenaltyErrorColumn . |
|
auto | getSlpPenaltyErrorRow () const -> int |
Get the value for attribute SlpPenaltyErrorRow . |
|
auto | getSlpPenaltyErrors () const -> int |
Get the value for attribute SlpPenaltyErrors . |
|
auto | getSlpPenaltyErrorTotal () const -> double |
Get the value for attribute SlpPenaltyErrorTotal . |
|
auto | getSlpPenaltyErrorValue () const -> double |
Get the value for attribute SlpPenaltyErrorValue . |
|
auto | getSlpPlusPenaltyErrors () const -> int |
Get the value for attribute SlpPlusPenaltyErrors . |
|
auto | getSlpSbxConverged () const -> int |
Get the value for attribute SlpSbxConverged . |
|
auto | getSlpStatus () const -> int |
Get the value for attribute SlpStatus . |
|
auto | getSlpTolSets () const -> int |
Get the value for attribute SlpTolSets . |
|
auto | getSlpUCConstrainedCount () const -> int |
Get the value for attribute SlpUCConstrainedCount . |
|
auto | getSlpUnConverged () const -> int |
Get the value for attribute SlpUnConverged . |
|
auto | getSlpZeroesReset () const -> int |
Get the value for attribute SlpZeroesReset . |
|
auto | getSlpZeroesRetained () const -> int |
Get the value for attribute SlpZeroesRetained . |
|
auto | getSlpZeroesTotal () const -> int |
Get the value for attribute SlpZeroesTotal . |
|
auto | getSolStatus () const -> xpress::SolStatus |
Get the value for attribute SolStatus . |
|
auto | getSolvedObjs () const -> int |
Get the value for attribute SolvedObjs . |
|
auto | getSolveStatus () const -> xpress::SolveStatus |
Get the value for attribute SolveStatus . |
|
auto | getSpareCols () const -> int |
Get the value for attribute SpareCols . |
|
auto | getSpareElems () const -> XPRSint64 |
Get the value for attribute SpareElems . |
|
auto | getSpareMipEnts () const -> int |
Get the value for attribute SpareMipEnts . |
|
auto | getSpareRows () const -> int |
Get the value for attribute SpareRows . |
|
auto | getSpareSetElems () const -> XPRSint64 |
Get the value for attribute SpareSetElems . |
|
auto | getSpareSets () const -> int |
Get the value for attribute SpareSets . |
|
auto | getStopStatus () const -> int |
Get the value for attribute StopStatus . |
|
auto | getSumPrimalInf () const -> double |
Get the value for attribute SumPrimalInf . |
|
auto | getSystemMemory () const -> XPRSint64 |
Get the value for attribute SystemMemory . |
|
auto | getTime () const -> double |
Get the value for attribute Time . |
|
auto | getTotalMemory () const -> XPRSint64 |
Get the value for attribute TotalMemory . |
|
auto | getTreeCompletion () const -> double |
Get the value for attribute TreeCompletion . |
|
auto | getTreeFileSize () const -> int |
Get the value for attribute TreeFileSize . |
|
auto | getTreeFileUsage () const -> int |
Get the value for attribute TreeFileUsage . |
|
auto | getTreeMemoryUsage () const -> int |
Get the value for attribute TreeMemoryUsage . |
|
auto | getTreeRestarts () const -> int |
Get the value for attribute TreeRestarts . |
|
auto | getUUID () const -> std::string |
Get the value for attribute UUID . |
|
auto | getXpressVersion () const -> std::string |
Get the value for attribute XpressVersion . |
|
Detailed Description
Attributes API.
Member Function Documentation
getActiveNodes()
|
inline |
Get the value for attribute ActiveNodes
.
Number of outstanding nodes.
- Returns
-
The current value for
ActiveNodes
.
getAlgorithm()
|
inline |
Get the value for attribute Algorithm
.
The algorithm the optimizer currently is running / was running just before completition.
- Returns
-
The current value for
Algorithm
.
getAttentionLevel()
|
inline |
Get the value for attribute AttentionLevel
.
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.
- Returns
-
The current value for
AttentionLevel
.
getAvailableMemory()
|
inline |
Get the value for attribute AvailableMemory
.
The amount of heap memory detected by Xpress as free.
- Returns
-
The current value for
AvailableMemory
.
getBarAASize()
|
inline |
Get the value for attribute BarAASize
.
Number of nonzeros in AAT.
- Returns
-
The current value for
BarAASize
.
getBarCGap()
|
inline |
Get the value for attribute BarCGap
.
Convergence criterion for the Newton barrier algorithm.
- Returns
-
The current value for
BarCGap
.
getBarCondA()
|
inline |
Get the value for attribute BarCondA
.
Absolute condition measure calculated in the last iteration of the barrier algorithm.
- Returns
-
The current value for
BarCondA
.
getBarCondD()
|
inline |
Get the value for attribute BarCondD
.
Condition measure calculated in the last iteration of the barrier algorithm.
- Returns
-
The current value for
BarCondD
.
getBarCrossover()
|
inline |
Get the value for attribute BarCrossover
.
Indicates whether or not the basis crossover phase has been entered.
- Returns
-
The current value for
BarCrossover
.
getBarDenseCol()
|
inline |
Get the value for attribute BarDenseCol
.
Number of dense columns found in the matrix.
- Returns
-
The current value for
BarDenseCol
.
getBarDualInf()
|
inline |
Get the value for attribute BarDualInf
.
Sum of the dual infeasibilities for the Newton barrier algorithm.
- Returns
-
The current value for
BarDualInf
.
getBarDualObj()
|
inline |
Get the value for attribute BarDualObj
.
Dual objective value calculated by the Newton barrier algorithm.
- Returns
-
The current value for
BarDualObj
.
getBarIter()
|
inline |
Get the value for attribute BarIter
.
Number of Newton barrier iterations.
- Returns
-
The current value for
BarIter
.
getBarLSize()
|
inline |
Get the value for attribute BarLSize
.
Number of nonzeros in L resulting from the Cholesky factorization.
- Returns
-
The current value for
BarLSize
.
getBarPrimalInf()
|
inline |
Get the value for attribute BarPrimalInf
.
Sum of the primal infeasibilities for the Newton barrier algorithm.
- Returns
-
The current value for
BarPrimalInf
.
getBarPrimalObj()
|
inline |
Get the value for attribute BarPrimalObj
.
Primal objective value calculated by the Newton barrier algorithm.
- Returns
-
The current value for
BarPrimalObj
.
getBarSing()
|
inline |
Get the value for attribute BarSing
.
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.
- Returns
-
The current value for
BarSing
.
getBarSingR()
|
inline |
Get the value for attribute BarSingR
.
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.
- Returns
-
The current value for
BarSingR
.
getBestBound()
|
inline |
Get the value for attribute BestBound
.
Value of the best bound determined so far by the MIP search.
- Returns
-
The current value for
BestBound
.
getBoundName()
|
inline |
Get the value for attribute BoundName
.
Active bound name.
- Returns
-
The current value for
BoundName
.
getBranchValue()
|
inline |
Get the value for attribute BranchValue
.
The value of the branching variable at a node of the Branch and Bound tree.
- Returns
-
The current value for
BranchValue
.
getBranchVar()
|
inline |
Get the value for attribute BranchVar
.
The branching variable at a node of the Branch and Bound tree.
- Returns
-
The current value for
BranchVar
.
getCallbackCount_CutMgr()
|
inline |
Get the value for attribute CallbackCount_CutMgr
.
This attribute counts the number of times the cut manager callback set by XPRSaddcbcutmgr
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.
- Returns
-
The current value for
CallbackCount_CutMgr
.
getCallbackCount_OptNode()
|
inline |
Get the value for attribute CallbackCount_OptNode
.
This attribute counts the number of times the optimal node callback set by XPRSaddcboptnode
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.
- Returns
-
The current value for
CallbackCount_OptNode
.
getChecksOnMaxCutTime()
|
inline |
Get the value for attribute ChecksOnMaxCutTime
.
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 XPRSmipoptimize
. 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.
- Returns
-
The current value for
ChecksOnMaxCutTime
.
getChecksOnMaxTime()
|
inline |
Get the value for attribute ChecksOnMaxTime
.
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 XPRSmipoptimize
. 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.
- Returns
-
The current value for
ChecksOnMaxTime
.
getCols()
|
inline |
Get the value for attribute Cols
.
Number of columns (i.e. variables) in the matrix.
- Returns
-
The current value for
Cols
.
getComputeExecutions()
|
inline |
Get the value for attribute ComputeExecutions
.
The number of solves executed on a compute server.
- Returns
-
The current value for
ComputeExecutions
.
getConeElems()
|
inline |
Get the value for attribute ConeElems
.
Number of second order cone coefficients in the problem.
- Returns
-
The current value for
ConeElems
.
getCones()
|
inline |
Get the value for attribute Cones
.
Number of second order and rotated second order cones in the problem.
- Returns
-
The current value for
Cones
.
getCoresDetected()
|
inline |
Get the value for attribute CoresDetected
.
Number of logical cores detected by the optimizer, which is the total number of threads the hardware can execute across all CPUs.
- Returns
-
The current value for
CoresDetected
.
getCoresPerCPUDetected()
|
inline |
Get the value for attribute CoresPerCPUDetected
.
Number of logical cores per CPU unit detected by the optimizer, which is the number of threads each CPU can execute.
- Returns
-
The current value for
CoresPerCPUDetected
.
getCpiScaleFactor()
|
inline |
Get the value for attribute CpiScaleFactor
.
scale factor from primal integral computation.
- Returns
-
The current value for
CpiScaleFactor
.
getCPUsDetected()
|
inline |
Get the value for attribute CPUsDetected
.
Number of CPU units detected by the optimizer.
- Returns
-
The current value for
CPUsDetected
.
getCrossoverIter()
|
inline |
Get the value for attribute CrossoverIter
.
Number of simplex iterations performed in crossover.
- Returns
-
The current value for
CrossoverIter
.
getCurrentMemory()
|
inline |
Get the value for attribute CurrentMemory
.
The amount of dynamically allocated heap memory by the problem being solved.
- Returns
-
The current value for
CurrentMemory
.
getCurrentNode()
|
inline |
Get the value for attribute CurrentNode
.
The unique identifier of the current node in the tree search.
- Returns
-
The current value for
CurrentNode
.
getCurrMipCutOff()
|
inline |
Get the value for attribute CurrMipCutOff
.
The current MIP cut off.
- Returns
-
The current value for
CurrMipCutOff
.
getCuts()
|
inline |
Get the value for attribute Cuts
.
Number of cuts being added to the matrix.
- Returns
-
The current value for
Cuts
.
getDualInfeas()
|
inline |
Get the value for attribute DualInfeas
.
Number of dual infeasibilities.
- Returns
-
The current value for
DualInfeas
.
getElems()
|
inline |
Get the value for attribute Elems
.
Number of matrix nonzeros (elements).
- Returns
-
The current value for
Elems
.
getErrorCode()
|
inline |
Get the value for attribute ErrorCode
.
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 XPRSgetlasterror
, and all messages may be intercepted using the user output callback function; see XPRSaddcbmessage
.
- Returns
-
The current value for
ErrorCode
.
getGenConCols()
|
inline |
Get the value for attribute GenConCols
.
Number of input variables in general constraints (i.e. MIN/MAX/AND/OR/ABS constraints) in the problem.
- Returns
-
The current value for
GenConCols
.
getGenCons()
|
inline |
Get the value for attribute GenCons
.
The number of general constraints (i.e. MIN/MAX/AND/OR/ABS constraints) in the problem.
- Returns
-
The current value for
GenCons
.
getGenConVals()
|
inline |
Get the value for attribute GenConVals
.
Number of constant values in general constraints (MIN/MAX constraints) in the problem.
- Returns
-
The current value for
GenConVals
.
getGlobalBoundingboxApplied()
|
inline |
Get the value for attribute GlobalBoundingboxApplied
.
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.
- Returns
-
The current value for
GlobalBoundingboxApplied
.
getGlobalNlpInfeas()
|
inline |
Get the value for attribute GlobalNlpInfeas
.
Number of nonlinear infeasibilities at the current node of a global solve, measured as the number of violated atomic formulas.
- Returns
-
The current value for
GlobalNlpInfeas
.
getIISSolStatus()
|
inline |
Get the value for attribute IISSolStatus
.
IIS solution status.
- Returns
-
The current value for
IISSolStatus
.
getIndicators()
|
inline |
Get the value for attribute Indicators
.
Number of indicator constrains in the problem.
- Returns
-
The current value for
Indicators
.
getInputCols()
|
inline |
Get the value for attribute InputCols
.
Number of columns (i.e. variables) in the original matrix before nonlinear reformulations.
- Returns
-
The current value for
InputCols
.
getInputRows()
|
inline |
Get the value for attribute InputRows
.
Number of rows (i.e. constraints) in the original matrix before nonlinear reformulations.
- Returns
-
The current value for
InputRows
.
getLocalSolverSelected()
|
inline |
Get the value for attribute LocalSolverSelected
.
- Returns
-
The current value for
LocalSolverSelected
.
getLpObjVal()
|
inline |
Get the value for attribute LpObjVal
.
Value of the objective function of the last LP solved.
- Returns
-
The current value for
LpObjVal
.
getLpStatus()
|
inline |
Get the value for attribute LpStatus
.
LP solution status.
- Returns
-
The current value for
LpStatus
.
getMatrixName()
|
inline |
Get the value for attribute MatrixName
.
The matrix name.
- Returns
-
The current value for
MatrixName
.
getMaxAbsDualInfeas()
|
inline |
Get the value for attribute MaxAbsDualInfeas
.
Maximum calculated absolute dual infeasibility in the unscaled original problem.
- Returns
-
The current value for
MaxAbsDualInfeas
.
getMaxAbsPrimalInfeas()
|
inline |
Get the value for attribute MaxAbsPrimalInfeas
.
Maximum calculated absolute primal infeasibility in the unscaled original problem.
- Returns
-
The current value for
MaxAbsPrimalInfeas
.
getMaxKappa()
|
inline |
Get the value for attribute MaxKappa
.
Largest basis condition number (also known as kappa) calculated through all nodes sampled by MIPKAPPAFREQ
.
- Returns
-
The current value for
MaxKappa
.
getMaxMipInfeas()
|
inline |
Get the value for attribute MaxMipInfeas
.
Maximum integer fractionality in the solution.
- Returns
-
The current value for
MaxMipInfeas
.
getMaxProbNameLength()
|
inline |
Get the value for attribute MaxProbNameLength
.
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).
- Returns
-
The current value for
MaxProbNameLength
.
getMaxRelDualInfeas()
|
inline |
Get the value for attribute MaxRelDualInfeas
.
Maximum calculated relative dual infeasibility in the unscaled original problem.
- Returns
-
The current value for
MaxRelDualInfeas
.
getMaxRelPrimalInfeas()
|
inline |
Get the value for attribute MaxRelPrimalInfeas
.
Maximum calculated relative primal infeasibility in the unscaled original problem.
- Returns
-
The current value for
MaxRelPrimalInfeas
.
getMemoryLimitDetected()
|
inline |
Get the value for attribute MemoryLimitDetected
.
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).
- Returns
-
The current value for
MemoryLimitDetected
.
getMipBestObjVal()
|
inline |
Get the value for attribute MipBestObjVal
.
Objective function value of the best integer solution found.
- Returns
-
The current value for
MipBestObjVal
.
getMipEnts()
|
inline |
Get the value for attribute MipEnts
.
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.
- Returns
-
The current value for
MipEnts
.
getMipInfeas()
|
inline |
Get the value for attribute MipInfeas
.
Number of integer infeasibilities, including violations of special ordered sets, at the current node.
- Returns
-
The current value for
MipInfeas
.
getMipObjVal()
|
inline |
Get the value for attribute MipObjVal
.
Objective function value of the last integer solution found.
- Returns
-
The current value for
MipObjVal
.
getMipSolNode()
|
inline |
Get the value for attribute MipSolNode
.
Node at which the last integer feasible solution was found.
- Returns
-
The current value for
MipSolNode
.
getMipSols()
|
inline |
Get the value for attribute MipSols
.
Number of integer solutions that have been found.
- Returns
-
The current value for
MipSols
.
getMipSolTime()
|
inline |
Get the value for attribute MipSolTime
.
Time at which the last integer feasible solution was found.
- Returns
-
The current value for
MipSolTime
.
getMipStatus()
|
inline |
Get the value for attribute MipStatus
.
(MIP) solution status.
- Returns
-
The current value for
MipStatus
.
getMipThreadID()
|
inline |
Get the value for attribute MipThreadID
.
The ID for the MIP thread.
- Returns
-
The current value for
MipThreadID
.
getMseDiversitySum()
|
inline |
Get the value for attribute MseDiversitySum
.
- Returns
-
The current value for
MseDiversitySum
.
getMseMetric_Diversity()
|
inline |
Get the value for attribute MseMetric_Diversity
.
- Returns
-
The current value for
MseMetric_Diversity
.
getMseMetric_MipObject()
|
inline |
Get the value for attribute MseMetric_MipObject
.
- Returns
-
The current value for
MseMetric_MipObject
.
getMseMetric_ModObject()
|
inline |
Get the value for attribute MseMetric_ModObject
.
- Returns
-
The current value for
MseMetric_ModObject
.
getMseSolutions()
|
inline |
Get the value for attribute MseSolutions
.
- Returns
-
The current value for
MseSolutions
.
getMspPrb_FeasibleSols()
|
inline |
Get the value for attribute MspPrb_FeasibleSols
.
- Returns
-
The current value for
MspPrb_FeasibleSols
.
getMspPrb_ValidSols()
|
inline |
Get the value for attribute MspPrb_ValidSols
.
- Returns
-
The current value for
MspPrb_ValidSols
.
getMspSol_BitFieldsSys()
|
inline |
Get the value for attribute MspSol_BitFieldsSys
.
- Returns
-
The current value for
MspSol_BitFieldsSys
.
getMspSol_Cols()
|
inline |
Get the value for attribute MspSol_Cols
.
- Returns
-
The current value for
MspSol_Cols
.
getMspSol_IsReProcessedUserSolution()
|
inline |
Get the value for attribute MspSol_IsReProcessedUserSolution
.
- Returns
-
The current value for
MspSol_IsReProcessedUserSolution
.
getMspSol_IsUserSolution()
|
inline |
Get the value for attribute MspSol_IsUserSolution
.
- Returns
-
The current value for
MspSol_IsUserSolution
.
getMspSol_NonZeros()
|
inline |
Get the value for attribute MspSol_NonZeros
.
- Returns
-
The current value for
MspSol_NonZeros
.
getMspSolPrb_InfCnt_Mip()
|
inline |
Get the value for attribute MspSolPrb_InfCnt_Mip
.
- Returns
-
The current value for
MspSolPrb_InfCnt_Mip
.
getMspSolPrb_InfCnt_Primal()
|
inline |
Get the value for attribute MspSolPrb_InfCnt_Primal
.
- Returns
-
The current value for
MspSolPrb_InfCnt_Primal
.
getMspSolPrb_InfeasCount()
|
inline |
Get the value for attribute MspSolPrb_InfeasCount
.
- Returns
-
The current value for
MspSolPrb_InfeasCount
.
getMspSolPrb_InfSum_Mip()
|
inline |
Get the value for attribute MspSolPrb_InfSum_Mip
.
- Returns
-
The current value for
MspSolPrb_InfSum_Mip
.
getMspSolPrb_InfSum_Primal()
|
inline |
Get the value for attribute MspSolPrb_InfSum_Primal
.
- Returns
-
The current value for
MspSolPrb_InfSum_Primal
.
getMspSolPrb_Obj()
|
inline |
Get the value for attribute MspSolPrb_Obj
.
- Returns
-
The current value for
MspSolPrb_Obj
.
getMspSolutions()
|
inline |
Get the value for attribute MspSolutions
.
- Returns
-
The current value for
MspSolutions
.
getNameLength()
|
inline |
Get the value for attribute NameLength
.
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).
- Returns
-
The current value for
NameLength
.
getNlpEqualsColumn()
|
inline |
Get the value for attribute NlpEqualsColumn
.
Index of the reserved "=" column
- Returns
-
The current value for
NlpEqualsColumn
.
getNlpIfs()
|
inline |
Get the value for attribute NlpIfs
.
Number of internal functions
- Returns
-
The current value for
NlpIfs
.
getNlpImplicitVariables()
|
inline |
Get the value for attribute NlpImplicitVariables
.
Number of SLP variables appearing only in coefficients
- Returns
-
The current value for
NlpImplicitVariables
.
getNlpJobID()
|
inline |
Get the value for attribute NlpJobID
.
Unique identifier for the current job
- Returns
-
The current value for
NlpJobID
.
getNlpKeepBestIter()
|
inline |
Get the value for attribute NlpKeepBestIter
.
The iteration in which the returned solution has been found.
- Returns
-
The current value for
NlpKeepBestIter
.
getNlpModelCols()
|
inline |
Get the value for attribute NlpModelCols
.
Number of model columns in the problem
- Returns
-
The current value for
NlpModelCols
.
getNlpModelRows()
|
inline |
Get the value for attribute NlpModelRows
.
Number of model rows in the problem
- Returns
-
The current value for
NlpModelRows
.
getNlpObjVal()
|
inline |
Get the value for attribute NlpObjVal
.
Objective function value excluding any penalty costs
- Returns
-
The current value for
NlpObjVal
.
getNlpOptTime()
|
inline |
Get the value for attribute NlpOptTime
.
Time spent in optimization
- Returns
-
The current value for
NlpOptTime
.
getNlpOriginalCols()
|
inline |
Get the value for attribute NlpOriginalCols
.
Number of model columns in the extended original problem
- Returns
-
The current value for
NlpOriginalCols
.
getNlpOriginalRows()
|
inline |
Get the value for attribute NlpOriginalRows
.
Number of model rows in the extended original problem
- Returns
-
The current value for
NlpOriginalRows
.
getNlpPresolveEliminations()
|
inline |
Get the value for attribute NlpPresolveEliminations
.
Number of SLP variables eliminated by XSLPpresolve
- Returns
-
The current value for
NlpPresolveEliminations
.
getNlpStatus()
|
inline |
Get the value for attribute NlpStatus
.
Bitmap holding the problem convergence status
- Returns
-
The current value for
NlpStatus
.
getNlpStopStatus()
|
inline |
Get the value for attribute NlpStopStatus
.
Status of the optimization process.
- Returns
-
The current value for
NlpStopStatus
.
getNlpUFs()
|
inline |
Get the value for attribute NlpUFs
.
Number of user functions
- Returns
-
The current value for
NlpUFs
.
getNlpUseDerivatives()
|
inline |
Get the value for attribute NlpUseDerivatives
.
Indicates whether numeric or analytic derivatives were used to create the linear approximations and solve the problem
- Returns
-
The current value for
NlpUseDerivatives
.
getNlpUserFuncCalls()
|
inline |
Get the value for attribute NlpUserFuncCalls
.
Number of calls made to user functions
- Returns
-
The current value for
NlpUserFuncCalls
.
getNlpValidationIndex_A()
|
inline |
Get the value for attribute NlpValidationIndex_A
.
Absolute validation index
- Returns
-
The current value for
NlpValidationIndex_A
.
getNlpValidationIndex_K()
|
inline |
Get the value for attribute NlpValidationIndex_K
.
Relative first order optimality validation index
- Returns
-
The current value for
NlpValidationIndex_K
.
getNlpValidationIndex_R()
|
inline |
Get the value for attribute NlpValidationIndex_R
.
Relative validation index
- Returns
-
The current value for
NlpValidationIndex_R
.
getNlpVariables()
|
inline |
Get the value for attribute NlpVariables
.
Number of SLP variables
- Returns
-
The current value for
NlpVariables
.
getNodeDepth()
|
inline |
Get the value for attribute NodeDepth
.
Depth of the current node.
- Returns
-
The current value for
NodeDepth
.
getNodes()
|
inline |
Get the value for attribute Nodes
.
Number of nodes solved so far in the MIP search. A node is counted as solved when it is either dropped or branched on.
- Returns
-
The current value for
Nodes
.
getNonLinearConstraints()
|
inline |
Get the value for attribute NonLinearConstraints
.
Number of nonlinear constraints in the problem
- Returns
-
The current value for
NonLinearConstraints
.
getNumIIS()
|
inline |
Get the value for attribute NumIIS
.
Number of IISs found. You should first query the IISSOLSTATUS
attribute to make sure that the IIS procedure terminated successfully.
- Returns
-
The current value for
NumIIS
.
getObjectives()
|
inline |
Get the value for attribute Objectives
.
Number of objectives in the problem.
- Returns
-
The current value for
Objectives
.
getObjName()
|
inline |
Get the value for attribute ObjName
.
- Returns
-
The current value for
ObjName
.
getObjRhs()
|
inline |
Get the value for attribute ObjRhs
.
Fixed part of the objective function.
- Returns
-
The current value for
ObjRhs
.
getOBJSense()
|
inline |
Get the value for attribute OBJSense
.
Sense of the optimization being performed.
- Returns
-
The current value for
OBJSense
.
getObjsToSolve()
|
inline |
Get the value for attribute ObjsToSolve
.
Number of objectives that will be solved during the current multi-objective solve.
- Returns
-
The current value for
ObjsToSolve
.
getObjVal()
|
inline |
Get the value for attribute ObjVal
.
Value of the objective function of the last problem solved with XPRSoptimize.
- Returns
-
The current value for
ObjVal
.
getObservedPrimalIntegral()
|
inline |
Get the value for attribute ObservedPrimalIntegral
.
Value of the (observed) primal integral.
- Returns
-
The current value for
ObservedPrimalIntegral
.
getOptimizeTypeUsed()
|
inline |
Get the value for attribute OptimizeTypeUsed
.
The type of solver used in the last call to XPRSoptimize
, XPRSmipoptimize
, XPRSlpoptimize
or XPRSnlpoptimize
.
- Returns
-
The current value for
OptimizeTypeUsed
.
getOriginalCols()
|
inline |
Get the value for attribute OriginalCols
.
Number of columns (i.e. variables) in the original matrix before presolving.
- Returns
-
The current value for
OriginalCols
.
getOriginalGenconCols()
|
inline |
Get the value for attribute OriginalGenconCols
.
Number of input variables in general constraints in the original problem before presolving.
- Returns
-
The current value for
OriginalGenconCols
.
getOriginalGencons()
|
inline |
Get the value for attribute OriginalGencons
.
Number of general constraints in the original problem before presolving.
- Returns
-
The current value for
OriginalGencons
.
getOriginalGenconVals()
|
inline |
Get the value for attribute OriginalGenconVals
.
Number of constant values in general constraints in the original problem before presolving.
- Returns
-
The current value for
OriginalGenconVals
.
getOriginalIndicators()
|
inline |
Get the value for attribute OriginalIndicators
.
Number of indicator constraints in the original matrix before presolving.
- Returns
-
The current value for
OriginalIndicators
.
getOriginalMipEnts()
|
inline |
Get the value for attribute OriginalMipEnts
.
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.
- Returns
-
The current value for
OriginalMipEnts
.
getOriginalPwlpoints()
|
inline |
Get the value for attribute OriginalPwlpoints
.
Number of breakpoints of piecewise linear constraints in the original problem before presolving.
- Returns
-
The current value for
OriginalPwlpoints
.
getOriginalPwls()
|
inline |
Get the value for attribute OriginalPwls
.
Number of piecewise linear constraints in the original problem before presolving.
- Returns
-
The current value for
OriginalPwls
.
getOriginalQCElems()
|
inline |
Get the value for attribute OriginalQCElems
.
Number of quadratic row coefficients in the original matrix before presolving.
- Returns
-
The current value for
OriginalQCElems
.
getOriginalQConstraints()
|
inline |
Get the value for attribute OriginalQConstraints
.
Number of rows with quadratic coefficients in the original matrix before presolving.
- Returns
-
The current value for
OriginalQConstraints
.
getOriginalQElems()
|
inline |
Get the value for attribute OriginalQElems
.
Number of quadratic non-zeros in the original objective before presolving.
- Returns
-
The current value for
OriginalQElems
.
getOriginalRows()
|
inline |
Get the value for attribute OriginalRows
.
Number of rows (i.e. constraints) in the original matrix before presolving.
- Returns
-
The current value for
OriginalRows
.
getOriginalSetMembers()
|
inline |
Get the value for attribute OriginalSetMembers
.
Number of variables within special ordered sets (set members) in the original matrix before presolving.
- Returns
-
The current value for
OriginalSetMembers
.
getOriginalSets()
|
inline |
Get the value for attribute OriginalSets
.
Number of special ordered sets in the original matrix before presolving.
- Returns
-
The current value for
OriginalSets
.
getParentNode()
|
inline |
Get the value for attribute ParentNode
.
The parent node of the current node in the tree search.
- Returns
-
The current value for
ParentNode
.
getPeakMemory()
|
inline |
Get the value for attribute PeakMemory
.
An estimate of the peak amount of dynamically allocated heap memory by the problem.
- Returns
-
The current value for
PeakMemory
.
getPeakTotalTreeMemoryUsage()
|
inline |
Get the value for attribute PeakTotalTreeMemoryUsage
.
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.
- Returns
-
The current value for
PeakTotalTreeMemoryUsage
.
getPenaltyValue()
|
inline |
Get the value for attribute PenaltyValue
.
The weighted sum of violations in the solution to the relaxed problem identified by the infeasibility repair function.
- Returns
-
The current value for
PenaltyValue
.
getPhysicalCoresDetected()
|
inline |
Get the value for attribute PhysicalCoresDetected
.
The total number of physical cores across all CPUs detected by the optimizer.
- Returns
-
The current value for
PhysicalCoresDetected
.
getPhysicalCoresPerCPUDetected()
|
inline |
Get the value for attribute PhysicalCoresPerCPUDetected
.
The number of physical cores per CPU detected by the optimizer.
- Returns
-
The current value for
PhysicalCoresPerCPUDetected
.
getPredictedAttLevel()
|
inline |
Get the value for attribute PredictedAttLevel
.
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.
- Returns
-
The current value for
PredictedAttLevel
.
getPresolveIndex()
|
inline |
Get the value for attribute PresolveIndex
.
Presolve: The row or column index on which presolve detected a problem to be infeasible or unbounded.
- Returns
-
The current value for
PresolveIndex
.
getPresolveState()
|
inline |
Get the value for attribute PresolveState
.
Problem status as a bit map.
- Returns
-
The current value for
PresolveState
.
getPrimalDualIntegral()
|
inline |
Get the value for attribute PrimalDualIntegral
.
Value of the primal-dual integral.
- Returns
-
The current value for
PrimalDualIntegral
.
getPrimalInfeas()
|
inline |
Get the value for attribute PrimalInfeas
.
Number of primal infeasibilities.
- Returns
-
The current value for
PrimalInfeas
.
getPwlCons()
|
inline |
Get the value for attribute PwlCons
.
Number of piecewise linear constraints in the problem.
- Returns
-
The current value for
PwlCons
.
getPwlPoints()
|
inline |
Get the value for attribute PwlPoints
.
Number of breakpoints of piecewise linear constraints in the problem.
- Returns
-
The current value for
PwlPoints
.
getQCElems()
|
inline |
Get the value for attribute QCElems
.
Number of quadratic row coefficients in the matrix.
- Returns
-
The current value for
QCElems
.
getQConstraints()
|
inline |
Get the value for attribute QConstraints
.
Number of rows with quadratic coefficients in the matrix.
- Returns
-
The current value for
QConstraints
.
getQElems()
|
inline |
Get the value for attribute QElems
.
Number of quadratic non-zeros in the objective.
- Returns
-
The current value for
QElems
.
getRangeName()
|
inline |
Get the value for attribute RangeName
.
Active range name.
- Returns
-
The current value for
RangeName
.
getRestarts()
|
inline |
Get the value for attribute Restarts
.
Total number of restarts performed.
- Returns
-
The current value for
Restarts
.
getRhsName()
|
inline |
Get the value for attribute RhsName
.
Active right hand side name.
- Returns
-
The current value for
RhsName
.
getRows()
|
inline |
Get the value for attribute Rows
.
Number of rows (i.e. constraints) in the matrix.
- Returns
-
The current value for
Rows
.
getSetMembers()
|
inline |
Get the value for attribute SetMembers
.
Number of variables within special ordered sets (set members) in the matrix.
- Returns
-
The current value for
SetMembers
.
getSets()
|
inline |
Get the value for attribute Sets
.
Number of special ordered sets in the matrix.
- Returns
-
The current value for
Sets
.
getSimplexIter()
|
inline |
Get the value for attribute SimplexIter
.
Number of simplex iterations performed.
- Returns
-
The current value for
SimplexIter
.
getSlpCoefficients()
|
inline |
Get the value for attribute SlpCoefficients
.
Number of nonlinear coefficients
- Returns
-
The current value for
SlpCoefficients
.
getSlpCurrentDeltaCost()
|
inline |
Get the value for attribute SlpCurrentDeltaCost
.
Current value of penalty cost multiplier for penalty delta vectors
- Returns
-
The current value for
SlpCurrentDeltaCost
.
getSlpCurrentErrorCost()
|
inline |
Get the value for attribute SlpCurrentErrorCost
.
Current value of penalty cost multiplier for penalty error vectors
- Returns
-
The current value for
SlpCurrentErrorCost
.
getSlpDeltas()
|
inline |
Get the value for attribute SlpDeltas
.
Number of delta vectors created during augmentation
- Returns
-
The current value for
SlpDeltas
.
getSlpECFCount()
|
inline |
Get the value for attribute SlpECFCount
.
Number of infeasible constraints found at the point of linearization
- Returns
-
The current value for
SlpECFCount
.
getSlpErrorCosts()
|
inline |
Get the value for attribute SlpErrorCosts
.
Total penalty costs in the solution
- Returns
-
The current value for
SlpErrorCosts
.
getSlpIter()
|
inline |
Get the value for attribute SlpIter
.
SLP iteration count
- Returns
-
The current value for
SlpIter
.
getSlpMinusPenaltyErrors()
|
inline |
Get the value for attribute SlpMinusPenaltyErrors
.
Number of negative penalty error vectors
- Returns
-
The current value for
SlpMinusPenaltyErrors
.
getSlpMipIter()
|
inline |
Get the value for attribute SlpMipIter
.
Total number of SLP iterations in MISLP
- Returns
-
The current value for
SlpMipIter
.
getSlpMipNodes()
|
inline |
Get the value for attribute SlpMipNodes
.
Number of nodes explored in MISLP. This includes any nodes for which a non-linear solve has been carried out.
- Returns
-
The current value for
SlpMipNodes
.
getSlpMipSols()
|
inline |
Get the value for attribute SlpMipSols
.
Number of integer solutions found in MISLP. This includes solutions found during the tree search or any heuristics.
- Returns
-
The current value for
SlpMipSols
.
getSlpNonConstantCoeffs()
|
inline |
Get the value for attribute SlpNonConstantCoeffs
.
Number of coefficients in the augmented problem that might change between SLP iterations
- Returns
-
The current value for
SlpNonConstantCoeffs
.
getSlpPenaltyDeltaColumn()
|
inline |
Get the value for attribute SlpPenaltyDeltaColumn
.
Index of column costing the penalty delta row
- Returns
-
The current value for
SlpPenaltyDeltaColumn
.
getSlpPenaltyDeltaRow()
|
inline |
Get the value for attribute SlpPenaltyDeltaRow
.
Index of equality row holding the penalties for delta vectors
- Returns
-
The current value for
SlpPenaltyDeltaRow
.
getSlpPenaltyDeltas()
|
inline |
Get the value for attribute SlpPenaltyDeltas
.
Number of penalty delta vectors
- Returns
-
The current value for
SlpPenaltyDeltas
.
getSlpPenaltyDeltaTotal()
|
inline |
Get the value for attribute SlpPenaltyDeltaTotal
.
Total activity of penalty delta vectors
- Returns
-
The current value for
SlpPenaltyDeltaTotal
.
getSlpPenaltyDeltaValue()
|
inline |
Get the value for attribute SlpPenaltyDeltaValue
.
Total penalty cost attributed to penalty delta vectors
- Returns
-
The current value for
SlpPenaltyDeltaValue
.
getSlpPenaltyErrorColumn()
|
inline |
Get the value for attribute SlpPenaltyErrorColumn
.
Index of column costing the penalty error row
- Returns
-
The current value for
SlpPenaltyErrorColumn
.
getSlpPenaltyErrorRow()
|
inline |
Get the value for attribute SlpPenaltyErrorRow
.
Index of equality row holding the penalties for penalty error vectors
- Returns
-
The current value for
SlpPenaltyErrorRow
.
getSlpPenaltyErrors()
|
inline |
Get the value for attribute SlpPenaltyErrors
.
Number of penalty error vectors
- Returns
-
The current value for
SlpPenaltyErrors
.
getSlpPenaltyErrorTotal()
|
inline |
Get the value for attribute SlpPenaltyErrorTotal
.
Total activity of penalty error vectors
- Returns
-
The current value for
SlpPenaltyErrorTotal
.
getSlpPenaltyErrorValue()
|
inline |
Get the value for attribute SlpPenaltyErrorValue
.
Total penalty cost attributed to penalty error vectors
- Returns
-
The current value for
SlpPenaltyErrorValue
.
getSlpPlusPenaltyErrors()
|
inline |
Get the value for attribute SlpPlusPenaltyErrors
.
Number of positive penalty error vectors
- Returns
-
The current value for
SlpPlusPenaltyErrors
.
getSlpSbxConverged()
|
inline |
Get the value for attribute SlpSbxConverged
.
Number of step-bounded variables converged only on extended criteria
- Returns
-
The current value for
SlpSbxConverged
.
getSlpStatus()
|
inline |
Get the value for attribute SlpStatus
.
Bitmap holding the problem convergence status
- Returns
-
The current value for
SlpStatus
.
getSlpTolSets()
|
inline |
Get the value for attribute SlpTolSets
.
Number of tolerance sets.
- Returns
-
The current value for
SlpTolSets
.
getSlpUCConstrainedCount()
|
inline |
Get the value for attribute SlpUCConstrainedCount
.
Number of unconverged variables with coefficients in constraining rows
- Returns
-
The current value for
SlpUCConstrainedCount
.
getSlpUnConverged()
|
inline |
Get the value for attribute SlpUnConverged
.
Number of unconverged values
- Returns
-
The current value for
SlpUnConverged
.
getSlpZeroesReset()
|
inline |
Get the value for attribute SlpZeroesReset
.
Number of placeholder entries set to zero
- Returns
-
The current value for
SlpZeroesReset
.
getSlpZeroesRetained()
|
inline |
Get the value for attribute SlpZeroesRetained
.
Number of potentially zero placeholders left untouched
- Returns
-
The current value for
SlpZeroesRetained
.
getSlpZeroesTotal()
|
inline |
Get the value for attribute SlpZeroesTotal
.
Number of potential zero placeholder entries
- Returns
-
The current value for
SlpZeroesTotal
.
getSolStatus()
|
inline |
Get the value for attribute SolStatus
.
Status of the solution of the last problem solved with XPRSoptimize.
- Returns
-
The current value for
SolStatus
.
getSolvedObjs()
|
inline |
Get the value for attribute SolvedObjs
.
Number of objectives that have been solved so far during a multi-objective solve.
- Returns
-
The current value for
SolvedObjs
.
getSolveStatus()
|
inline |
Get the value for attribute SolveStatus
.
Status of the solve of the last problem solved with XPRSoptimize.
- Returns
-
The current value for
SolveStatus
.
getSpareCols()
|
inline |
Get the value for attribute SpareCols
.
Number of spare columns in the matrix.
- Returns
-
The current value for
SpareCols
.
getSpareElems()
|
inline |
Get the value for attribute SpareElems
.
Number of spare matrix elements in the matrix.
- Returns
-
The current value for
SpareElems
.
getSpareMipEnts()
|
inline |
Get the value for attribute SpareMipEnts
.
Number of spare MIP entities in the matrix.
- Returns
-
The current value for
SpareMipEnts
.
getSpareRows()
|
inline |
Get the value for attribute SpareRows
.
Number of spare rows in the matrix.
- Returns
-
The current value for
SpareRows
.
getSpareSetElems()
|
inline |
Get the value for attribute SpareSetElems
.
Number of spare set elements in the matrix.
- Returns
-
The current value for
SpareSetElems
.
getSpareSets()
|
inline |
Get the value for attribute SpareSets
.
Number of spare sets in the matrix.
- Returns
-
The current value for
SpareSets
.
getStopStatus()
|
inline |
Get the value for attribute StopStatus
.
Status of the optimization process.
- Returns
-
The current value for
StopStatus
.
getSumPrimalInf()
|
inline |
Get the value for attribute SumPrimalInf
.
Scaled sum of primal infeasibilities.
- Returns
-
The current value for
SumPrimalInf
.
getSystemMemory()
|
inline |
Get the value for attribute SystemMemory
.
The amount of non problem specific memory used by the solver.
- Returns
-
The current value for
SystemMemory
.
getTime()
|
inline |
Get the value for attribute Time
.
Time spent solving the problem as measured by the optimizer.
- Returns
-
The current value for
Time
.
getTotalMemory()
|
inline |
Get the value for attribute TotalMemory
.
The amount of dynamically allocated heap memory by the optimizer, including all problems currently exsisting.
- Returns
-
The current value for
TotalMemory
.
getTreeCompletion()
|
inline |
Get the value for attribute TreeCompletion
.
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.
- Returns
-
The current value for
TreeCompletion
.
getTreeFileSize()
|
inline |
Get the value for attribute TreeFileSize
.
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).
- Returns
-
The current value for
TreeFileSize
.
getTreeFileUsage()
|
inline |
Get the value for attribute TreeFileUsage
.
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.
- Returns
-
The current value for
TreeFileUsage
.
getTreeMemoryUsage()
|
inline |
Get the value for attribute TreeMemoryUsage
.
The amount of physical memory, in megabytes, currently being used to store the branch-and-bound search tree.
- Returns
-
The current value for
TreeMemoryUsage
.
getTreeRestarts()
|
inline |
Get the value for attribute TreeRestarts
.
Number of in-tree restarts performed.
- Returns
-
The current value for
TreeRestarts
.
getUUID()
|
inline |
Get the value for attribute UUID
.
Universally Unique Identifier for the problem instance.
- Returns
-
The current value for
UUID
.
getXpressVersion()
|
inline |
Get the value for attribute XpressVersion
.
The Xpress version number.
- Returns
-
The current value for
XpressVersion
.
The documentation for this class was generated from the following file:
- xpress.hpp
© 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.