XPRSprob.Attributes

Method Detail

• getRows

  public int getRows()

  Retrieves the value of the attribute XPRSconstants.ROWS. Number of rows (i.e. constraints) in the matrix.

  This attribute is used in the following examples:

  • GlobalObjectiveParametrics
  • GlobalRHSParametrics
  • LoadLP
  • Repair
  • Tableau
  • Trimloss

• getSets

  public int getSets()

  Retrieves the value of the attribute XPRSconstants.SETS. Number of special ordered sets in the matrix.

  This attribute is used in the following examples:

  • Repair

• getSetMembers

  public long getSetMembers()

  Retrieves the value of the attribute XPRSconstants.SETMEMBERS. Number of variables within special ordered sets (set members) in the matrix.

• getElems

  public long getElems()

  Retrieves the value of the attribute XPRSconstants.ELEMS. Number of matrix nonzeros (elements).

• getPrimalInfeas

  public int getPrimalInfeas()

  Retrieves the value of the attribute XPRSconstants.PRIMALINFEAS. Number of primal infeasibilities.

• getDualInfeas

  public int getDualInfeas()

  Retrieves the value of the attribute XPRSconstants.DUALINFEAS. Number of dual infeasibilities.

• getSimplexIter

  public int getSimplexIter()

  Retrieves the value of the attribute XPRSconstants.SIMPLEXITER. Number of simplex iterations performed.

  This attribute is used in the following examples:

  • Tableau

• getLPStatus

  public XPRSenumerations.LPStatus getLPStatus()

  Retrieves the value of the attribute XPRSconstants.LPSTATUS. LP solution status. (Values are from the enumeration XPRSenumerations.LPStatus)

  This attribute is used in the following examples:

  • Knapsack

• getMIPStatus

  public XPRSenumerations.MIPStatus getMIPStatus()

  Retrieves the value of the attribute XPRSconstants.MIPSTATUS. (MIP) solution status. (Values are from the enumeration XPRSenumerations.MIPStatus)

  This attribute is used in the following examples:

  • FixBV
  • GlobalRHSParametrics
  • SaveSol
  • Trimloss

• getCuts

  public int getCuts()

  Retrieves the value of the attribute XPRSconstants.CUTS. Number of cuts being added to the matrix.

• getNodes

  public int getNodes()

  Retrieves the value of the attribute XPRSconstants.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.

  This attribute is used in the following examples:

  • FixBV
  • SaveSol

• getNodeDepth

  public int getNodeDepth()

  Retrieves the value of the attribute XPRSconstants.NODEDEPTH. Depth of the current node.

• getActiveNodes

  public int getActiveNodes()

  Retrieves the value of the attribute XPRSconstants.ACTIVENODES. Number of outstanding nodes.

  This attribute is used in the following examples:

  • SaveSol

• getMIPSolNode

  public int getMIPSolNode()

  Retrieves the value of the attribute XPRSconstants.MIPSOLNODE. Node at which the last integer feasible solution was found.

  This attribute is used in the following examples:

  • SaveSol

• getMIPSols

  public int getMIPSols()

  Retrieves the value of the attribute XPRSconstants.MIPSOLS. Number of integer solutions that have been found.

  This attribute is used in the following examples:

  • AddMipSol
  • SaveSol

• getCols

  public int getCols()

  Retrieves the value of the attribute XPRSconstants.COLS. Number of columns (i.e. variables) in the matrix.

  This attribute is used in the following examples:

  • AddMipSol
  • GlobalObjectiveParametrics
  • GlobalRHSParametrics
  • Knapsack
  • MipSolEnum
  • MostViolated
  • Polygon
  • PolygonMap
  • PolygonMapDelta
  • PolygonMultiMap
  • PolygonMultiMapDelta
  • PolygonVecMap
  • PolygonVecMapDelta
  • Repair
  • RoundInt
  • SaveSol
  • Tableau
  • Trimloss

• getSpareRows

  public int getSpareRows()

  Retrieves the value of the attribute XPRSconstants.SPAREROWS. Number of spare rows in the matrix.

  This attribute is used in the following examples:

  • Tableau

• getSpareCols

  public int getSpareCols()

  Retrieves the value of the attribute XPRSconstants.SPARECOLS. Number of spare columns in the matrix.

• getSpareElems

  public long getSpareElems()

  Retrieves the value of the attribute XPRSconstants.SPAREELEMS. Number of spare matrix elements in the matrix.

• getSpareMIPEnts

  public int getSpareMIPEnts()

  Retrieves the value of the attribute XPRSconstants.SPAREMIPENTS. Number of spare MIP entities in the matrix.

• getErrorCode

  public int getErrorCode()

  Retrieves the value of the attribute XPRSconstants.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 getLastError, and all messages may be intercepted using the user output callback function; see addCbMessage.

• getMIPInfeas

  public int getMIPInfeas()

  Retrieves the value of the attribute XPRSconstants.MIPINFEAS. Number of integer infeasibilities, including violations of special ordered sets, at the current node.

  This attribute is used in the following examples:

  • AddMipSol
  • Knapsack

• getPresolveState

  public int getPresolveState()

  Retrieves the value of the attribute XPRSconstants.PRESOLVESTATE. Problem status as a bit map. (Values are from the enumeration XPRSenumerations.PresolveState)

• getParentNode

  public int getParentNode()

  Retrieves the value of the attribute XPRSconstants.PARENTNODE. The parent node of the current node in the tree search.

• getNameLength

  public int getNameLength()

  Retrieves the value of the attribute XPRSconstants.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).

• getQElems

  public int getQElems()

  Retrieves the value of the attribute XPRSconstants.QELEMS. Number of quadratic non-zeros in the objective.

• getNumIIS

  public int getNumIIS()

  Retrieves the value of the attribute XPRSconstants.NUMIIS. Number of IISs found. You should first query the IISSOLSTATUS attribute to make sure that the IIS procedure terminated successfully.

• getMIPEnts

  public int getMIPEnts()

  Retrieves the value of the attribute XPRSconstants.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.

  This attribute is used in the following examples:

  • AddMipSol
  • FixBV
  • Repair

• getBranchVar

  public int getBranchVar()

  Retrieves the value of the attribute XPRSconstants.BRANCHVAR. The branching variable at a node of the Branch and Bound tree.

• getMIPThreadID

  public int getMIPThreadID()

  Retrieves the value of the attribute XPRSconstants.MIPTHREADID. The ID for the MIP thread.

  This attribute is used in the following examples:

  • MostViolated

• getAlgorithm

  public int getAlgorithm()

  Retrieves the value of the attribute XPRSconstants.ALGORITHM. The algorithm the optimizer currently is running / was running just before completition.

• getCrossoverIter

  public int getCrossoverIter()

  Retrieves the value of the attribute XPRSconstants.CROSSOVERITER. Number of simplex iterations performed in crossover.

• getSolStatus

  public XPRSenumerations.SolStatus getSolStatus()

  Retrieves the value of the attribute XPRSconstants.SOLSTATUS. Status of the solution of the last problem solved with optimize. (Values are from the enumeration XPRSenumerations.SolStatus)

  This attribute is used in the following examples:

  • AddMipSol
  • FixBV
  • GlobalObjectiveParametrics
  • GlobalRHSParametrics
  • GoalProg
  • Knapsack
  • LoadLP
  • MipSolEnum
  • MipSolPool
  • MostViolated
  • SaveSol
  • TSP
  • Tableau
  • Trimloss

• getOriginalRows

  public int getOriginalRows()

  Retrieves the value of the attribute XPRSconstants.ORIGINALROWS. Number of rows (i.e. constraints) in the original matrix before presolving.

  This attribute is used in the following examples:

  • Repair

• getCallbackCount_OptNode

  public int getCallbackCount_OptNode()

  Retrieves the value of the attribute XPRSconstants.CALLBACKCOUNT_OPTNODE. 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.

  This attribute is used in the following examples:

  • AddMipSol

• getCallbackCount_CutMgr

  public int getCallbackCount_CutMgr()

  Retrieves the value of the attribute XPRSconstants.CALLBACKCOUNT_CUTMGR. 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.

• getSystemMemory

  public long getSystemMemory()

  Retrieves the value of the attribute XPRSconstants.SYSTEMMEMORY. The amount of non problem specific memory used by the solver.

• getOriginalQElems

  public int getOriginalQElems()

  Retrieves the value of the attribute XPRSconstants.ORIGINALQELEMS. Number of quadratic non-zeros in the original objective before presolving.

• getMaxProbNameLength

  public int getMaxProbNameLength()

  Retrieves the value of the attribute XPRSconstants.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).

• getStopStatus

  public int getStopStatus()

  Retrieves the value of the attribute XPRSconstants.STOPSTATUS. Status of the optimization process.

  This attribute is used in the following examples:

  • AddMipSol
  • FixBV
  • GlobalObjectiveParametrics
  • GlobalRHSParametrics
  • GoalProg
  • Knapsack
  • LoadLP
  • MipSolEnum
  • MipSolPool
  • MostViolated
  • SaveSol
  • TSP
  • Tableau
  • Trimloss

• getOriginalMIPEnts

  public int getOriginalMIPEnts()

  Retrieves the value of the attribute XPRSconstants.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.

• getOriginalSets

  public int getOriginalSets()

  Retrieves the value of the attribute XPRSconstants.ORIGINALSETS. Number of special ordered sets in the original matrix before presolving.

• getOriginalSetMembers

  public long getOriginalSetMembers()

  Retrieves the value of the attribute XPRSconstants.ORIGINALSETMEMBERS. Number of variables within special ordered sets (set members) in the original matrix before presolving.

• getSpareSets

  public int getSpareSets()

  Retrieves the value of the attribute XPRSconstants.SPARESETS. Number of spare sets in the matrix.

• getSpareSetElems

  public long getSpareSetElems()

  Retrieves the value of the attribute XPRSconstants.SPARESETELEMS. Number of spare set elements in the matrix.

• getChecksOnMaxTime

  public int getChecksOnMaxTime()

  Retrieves the value of the attribute XPRSconstants.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 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.

• getChecksOnMaxCutTime

  public int getChecksOnMaxCutTime()

  Retrieves the value of the attribute XPRSconstants.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 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.

• getOriginalCols

  public int getOriginalCols()

  Retrieves the value of the attribute XPRSconstants.ORIGINALCOLS. Number of columns (i.e. variables) in the original matrix before presolving.

  This attribute is used in the following examples:

  • Repair

• getQCElems

  public int getQCElems()

  Retrieves the value of the attribute XPRSconstants.QCELEMS. Number of quadratic row coefficients in the matrix.

• getQConstraints

  public int getQConstraints()

  Retrieves the value of the attribute XPRSconstants.QCONSTRAINTS. Number of rows with quadratic coefficients in the matrix.

• getOriginalQCElems

  public int getOriginalQCElems()

  Retrieves the value of the attribute XPRSconstants.ORIGINALQCELEMS. Number of quadratic row coefficients in the original matrix before presolving.

• getOriginalQConstraints

  public int getOriginalQConstraints()

  Retrieves the value of the attribute XPRSconstants.ORIGINALQCONSTRAINTS. Number of rows with quadratic coefficients in the original matrix before presolving.

• getPeakTotalTreeMemoryUsage

  public int getPeakTotalTreeMemoryUsage()

  Retrieves the value of the attribute XPRSconstants.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.

• getCurrentNode

  public int getCurrentNode()

  Retrieves the value of the attribute XPRSconstants.CURRENTNODE. The unique identifier of the current node in the tree search.

  This attribute is used in the following examples:

  • Knapsack
  • RoundInt
  • SaveSol

• getTreeMemoryUsage

  public int getTreeMemoryUsage()

  Retrieves the value of the attribute XPRSconstants.TREEMEMORYUSAGE. The amount of physical memory, in megabytes, currently being used to store the branch-and-bound search tree.

• getTreeFileSize

  public int getTreeFileSize()

  Retrieves the value of the attribute XPRSconstants.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).

• getTreeFileUsage

  public int getTreeFileUsage()

  Retrieves the value of the attribute XPRSconstants.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.

• getIndicators

  public int getIndicators()

  Retrieves the value of the attribute XPRSconstants.INDICATORS. Number of indicator constrains in the problem.

• getOriginalIndicators

  public int getOriginalIndicators()

  Retrieves the value of the attribute XPRSconstants.ORIGINALINDICATORS. Number of indicator constraints in the original matrix before presolving.

• getCoresPerCPUDetected

  public int getCoresPerCPUDetected()

  Retrieves the value of the attribute XPRSconstants.CORESPERCPUDETECTED. Number of logical cores per CPU unit detected by the optimizer, which is the number of threads each CPU can execute.

• getCPUsDetected

  public int getCPUsDetected()

  Retrieves the value of the attribute XPRSconstants.CPUSDETECTED. Number of CPU units detected by the optimizer.

• getCoresDetected

  public int getCoresDetected()

  Retrieves the value of the attribute XPRSconstants.CORESDETECTED. Number of logical cores detected by the optimizer, which is the total number of threads the hardware can execute across all CPUs.

  This attribute is used in the following examples:

  • MostViolated

• getPhysicalCoresDetected

  public int getPhysicalCoresDetected()

  Retrieves the value of the attribute XPRSconstants.PHYSICALCORESDETECTED. The total number of physical cores across all CPUs detected by the optimizer.

• getPhysicalCoresPerCPUDetected

  public int getPhysicalCoresPerCPUDetected()

  Retrieves the value of the attribute XPRSconstants.PHYSICALCORESPERCPUDETECTED. The number of physical cores per CPU detected by the optimizer.

• getOptimizeTypeUsed

  public XPRSenumerations.OptimizeType getOptimizeTypeUsed()

  Retrieves the value of the attribute XPRSconstants.OPTIMIZETYPEUSED. The type of solver used in the last call to optimize, mipOptimize, lpOptimize or nlpOptimize. (Values are from the enumeration XPRSenumerations.OptimizeType)

• getBarSing

  public int getBarSing()

  Retrieves the value of the attribute XPRSconstants.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.

• getBarSingR

  public int getBarSingR()

  Retrieves the value of the attribute XPRSconstants.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.

• getPresolveIndex

  public int getPresolveIndex()

  Retrieves the value of the attribute XPRSconstants.PRESOLVEINDEX. Presolve: The row or column index on which presolve detected a problem to be infeasible or unbounded.

• getCurrentMemory

  public long getCurrentMemory()

  Retrieves the value of the attribute XPRSconstants.CURRENTMEMORY. The amount of dynamically allocated heap memory by the problem being solved.

• getPeakMemory

  public long getPeakMemory()

  Retrieves the value of the attribute XPRSconstants.PEAKMEMORY. An estimate of the peak amount of dynamically allocated heap memory by the problem.

• getCones

  public int getCones()

  Retrieves the value of the attribute XPRSconstants.CONES. Number of second order and rotated second order cones in the problem.

• getConeElems

  public int getConeElems()

  Retrieves the value of the attribute XPRSconstants.CONEELEMS. Number of second order cone coefficients in the problem.

• getTotalMemory

  public long getTotalMemory()

  Retrieves the value of the attribute XPRSconstants.TOTALMEMORY. The amount of dynamically allocated heap memory by the optimizer, including all problems currently exsisting.

• getAvailableMemory

  public long getAvailableMemory()

  Retrieves the value of the attribute XPRSconstants.AVAILABLEMEMORY. The amount of heap memory detected by Xpress as free.

• getPwlCons

  public int getPwlCons()

  Retrieves the value of the attribute XPRSconstants.PWLCONS. Number of piecewise linear constraints in the problem.

• getPwlPoints

  public long getPwlPoints()

  Retrieves the value of the attribute XPRSconstants.PWLPOINTS. Number of breakpoints of piecewise linear constraints in the problem.

• getGenCons

  public int getGenCons()

  Retrieves the value of the attribute XPRSconstants.GENCONS. The number of general constraints (i.e. MIN/MAX/AND/OR/ABS constraints) in the problem.

• getGenConCols

  public long getGenConCols()

  Retrieves the value of the attribute XPRSconstants.GENCONCOLS. Number of input variables in general constraints (i.e. MIN/MAX/AND/OR/ABS constraints) in the problem.

• getGenConVals

  public long getGenConVals()

  Retrieves the value of the attribute XPRSconstants.GENCONVALS. Number of constant values in general constraints (MIN/MAX constraints) in the problem.

• getTreeRestarts

  public int getTreeRestarts()

  Retrieves the value of the attribute XPRSconstants.TREERESTARTS. Number of in-tree restarts performed.

• getOriginalPwls

  public int getOriginalPwls()

  Retrieves the value of the attribute XPRSconstants.ORIGINALPWLS. Number of piecewise linear constraints in the original problem before presolving.

• getOriginalPwlpoints

  public long getOriginalPwlpoints()

  Retrieves the value of the attribute XPRSconstants.ORIGINALPWLPOINTS. Number of breakpoints of piecewise linear constraints in the original problem before presolving.

• getOriginalGencons

  public int getOriginalGencons()

  Retrieves the value of the attribute XPRSconstants.ORIGINALGENCONS. Number of general constraints in the original problem before presolving.

• getOriginalGenconCols

  public long getOriginalGenconCols()

  Retrieves the value of the attribute XPRSconstants.ORIGINALGENCONCOLS. Number of input variables in general constraints in the original problem before presolving.

• getOriginalGenconVals

  public long getOriginalGenconVals()

  Retrieves the value of the attribute XPRSconstants.ORIGINALGENCONVALS. Number of constant values in general constraints in the original problem before presolving.

• getComputeExecutions

  public int getComputeExecutions()

  Retrieves the value of the attribute XPRSconstants.COMPUTEEXECUTIONS. The number of solves executed on a compute server.

• getMemoryLimitDetected

  public long getMemoryLimitDetected()

  Retrieves the value of the attribute XPRSconstants.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).

• getRestarts

  public int getRestarts()

  Retrieves the value of the attribute XPRSconstants.RESTARTS. Total number of restarts performed.

• getSolveStatus

  public XPRSenumerations.SolveStatus getSolveStatus()

  Retrieves the value of the attribute XPRSconstants.SOLVESTATUS. Status of the solve of the last problem solved with optimize. (Values are from the enumeration XPRSenumerations.SolveStatus)

  This attribute is used in the following examples:

  • AddMipSol
  • FixBV
  • GlobalObjectiveParametrics
  • GlobalRHSParametrics
  • GoalProg
  • Knapsack
  • LoadLP
  • MipSolEnum
  • MipSolPool
  • MostViolated
  • SaveSol
  • TSP
  • Tableau
  • Trimloss

• getGlobalBoundingboxApplied

  public int getGlobalBoundingboxApplied()

  Retrieves the value of the attribute XPRSconstants.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.

• getObjectives

  public int getObjectives()

  Retrieves the value of the attribute XPRSconstants.OBJECTIVES. Number of objectives in the problem.

• getSolvedObjs

  public int getSolvedObjs()

  Retrieves the value of the attribute XPRSconstants.SOLVEDOBJS. Number of objectives that have been solved so far during a multi-objective solve.

• getObjsToSolve

  public int getObjsToSolve()

  Retrieves the value of the attribute XPRSconstants.OBJSTOSOLVE. Number of objectives that will be solved during the current multi-objective solve.

• getGlobalNLPInfeas

  public int getGlobalNLPInfeas()

  Retrieves the value of the attribute XPRSconstants.GLOBALNLPINFEAS. Number of nonlinear infeasibilities at the current node of a global solve, measured as the number of violated atomic formulas.

• getIISSolStatus

  public XPRSenumerations.IISSolStatus getIISSolStatus()

  Retrieves the value of the attribute XPRSconstants.IISSOLSTATUS. IIS solution status. (Values are from the enumeration XPRSenumerations.IISSolStatus)

  This attribute is used in the following examples:

  • IISExample

• getInputRows

  public int getInputRows()

  Retrieves the value of the attribute XPRSconstants.INPUTROWS. Number of rows (i.e. constraints) in the original matrix before nonlinear reformulations.

• getInputCols

  public int getInputCols()

  Retrieves the value of the attribute XPRSconstants.INPUTCOLS. Number of columns (i.e. variables) in the original matrix before nonlinear reformulations.

• getMIPSolTime

  public double getMIPSolTime()

  Retrieves the value of the attribute XPRSconstants.MIPSOLTIME. Time at which the last integer feasible solution was found.

• getTime

  public double getTime()

  Retrieves the value of the attribute XPRSconstants.TIME. Time spent solving the problem as measured by the optimizer.

• getLPObjVal

  public double getLPObjVal()

  Retrieves the value of the attribute XPRSconstants.LPOBJVAL. Value of the objective function of the last LP solved.

  This attribute is used in the following examples:

  • Knapsack
  • LoadLP
  • RoundInt
  • Tableau

• getSumPrimalInf

  public double getSumPrimalInf()

  Retrieves the value of the attribute XPRSconstants.SUMPRIMALINF. Scaled sum of primal infeasibilities.

• getMIPObjVal

  public double getMIPObjVal()

  Retrieves the value of the attribute XPRSconstants.MIPOBJVAL. Objective function value of the last integer solution found.

  This attribute is used in the following examples:

  • AddMipSol
  • FixBV
  • GlobalObjectiveParametrics
  • GlobalRHSParametrics
  • Knapsack
  • MipSolEnum
  • MipSolPool
  • MostViolated
  • SaveSol
  • Trimloss

• getBestBound

  public double getBestBound()

  Retrieves the value of the attribute XPRSconstants.BESTBOUND. Value of the best bound determined so far by the MIP search.

  This attribute is used in the following examples:

  • SaveSol

• getObjRHS

  public double getObjRHS()

  Retrieves the value of the attribute XPRSconstants.OBJRHS. Fixed part of the objective function.

• getMIPBestObjVal

  public double getMIPBestObjVal()

  Retrieves the value of the attribute XPRSconstants.MIPBESTOBJVAL. Objective function value of the best integer solution found.

  This attribute is used in the following examples:

  • AddMipSol
  • FixBV
  • GlobalObjectiveParametrics
  • GlobalRHSParametrics
  • Knapsack
  • MipSolEnum
  • MipSolPool
  • MostViolated
  • SaveSol
  • TSP
  • Trimloss

• getOBJSense

  public double getOBJSense()

  Retrieves the value of the attribute XPRSconstants.OBJSENSE. Sense of the optimization being performed.

• getBranchValue

  public double getBranchValue()

  Retrieves the value of the attribute XPRSconstants.BRANCHVALUE. The value of the branching variable at a node of the Branch and Bound tree.

• getPenaltyValue

  public double getPenaltyValue()

  Retrieves the value of the attribute XPRSconstants.PENALTYVALUE. The weighted sum of violations in the solution to the relaxed problem identified by the infeasibility repair function.

• getCurrMipCutOff

  public double getCurrMipCutOff()

  Retrieves the value of the attribute XPRSconstants.CURRMIPCUTOFF. The current MIP cut off.

• getBarCondA

  public double getBarCondA()

  Retrieves the value of the attribute XPRSconstants.BARCONDA. Absolute condition measure calculated in the last iteration of the barrier algorithm.

• getBarCondD

  public double getBarCondD()

  Retrieves the value of the attribute XPRSconstants.BARCONDD. Condition measure calculated in the last iteration of the barrier algorithm.

• getMaxAbsPrimalInfeas

  public double getMaxAbsPrimalInfeas()

  Retrieves the value of the attribute XPRSconstants.MAXABSPRIMALINFEAS. Maximum calculated absolute primal infeasibility in the unscaled original problem.

• getMaxRelPrimalInfeas

  public double getMaxRelPrimalInfeas()

  Retrieves the value of the attribute XPRSconstants.MAXRELPRIMALINFEAS. Maximum calculated relative primal infeasibility in the unscaled original problem.

• getMaxAbsDualInfeas

  public double getMaxAbsDualInfeas()

  Retrieves the value of the attribute XPRSconstants.MAXABSDUALINFEAS. Maximum calculated absolute dual infeasibility in the unscaled original problem.

• getMaxRelDualInfeas

  public double getMaxRelDualInfeas()

  Retrieves the value of the attribute XPRSconstants.MAXRELDUALINFEAS. Maximum calculated relative dual infeasibility in the unscaled original problem.

• getPrimalDualIntegral

  public double getPrimalDualIntegral()

  Retrieves the value of the attribute XPRSconstants.PRIMALDUALINTEGRAL. Value of the primal-dual integral.

• getMaxMipInfeas

  public double getMaxMipInfeas()

  Retrieves the value of the attribute XPRSconstants.MAXMIPINFEAS. Maximum integer fractionality in the solution.

• getAttentionLevel

  public double getAttentionLevel()

  Retrieves the value of the attribute XPRSconstants.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.

• getMaxKappa

  public double getMaxKappa()

  Retrieves the value of the attribute XPRSconstants.MAXKAPPA. Largest basis condition number (also known as kappa) calculated through all nodes sampled by MIPKAPPAFREQ.

• getTreeCompletion

  public double getTreeCompletion()

  Retrieves the value of the attribute XPRSconstants.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.

• getPredictedAttLevel

  public double getPredictedAttLevel()

  Retrieves the value of the attribute XPRSconstants.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.

• getObservedPrimalIntegral

  public double getObservedPrimalIntegral()

  Retrieves the value of the attribute XPRSconstants.OBSERVEDPRIMALINTEGRAL. Value of the (observed) primal integral.

• getCpiScaleFactor

  public double getCpiScaleFactor()

  Retrieves the value of the attribute XPRSconstants.CPISCALEFACTOR. scale factor from primal integral computation.

• getObjVal

  public double getObjVal()

  Retrieves the value of the attribute XPRSconstants.OBJVAL. Value of the objective function of the last problem solved with optimize.

  This attribute is used in the following examples:

  • AddMipSol
  • FixBV
  • GlobalObjectiveParametrics
  • GlobalRHSParametrics
  • Knapsack
  • LoadLP
  • MipSolEnum
  • MipSolPool
  • MostViolated
  • Polygon
  • PolygonMap
  • PolygonMapDelta
  • PolygonMultiMap
  • PolygonMultiMapDelta
  • PolygonVecMap
  • PolygonVecMapDelta
  • SaveSol
  • Trimloss

• getMatrixName

  public java.lang.String getMatrixName()

  Retrieves the value of the attribute XPRSconstants.MATRIXNAME. The matrix name.

• getBoundName

  public java.lang.String getBoundName()

  Retrieves the value of the attribute XPRSconstants.BOUNDNAME. Active bound name.

• getObjName

  @Deprecated
  public java.lang.String getObjName()

  Deprecated.
  Retrieves the value of the attribute XPRSconstants.OBJNAME.

• getRHSName

  public java.lang.String getRHSName()

  Retrieves the value of the attribute XPRSconstants.RHSNAME. Active right hand side name.

• getRangeName

  public java.lang.String getRangeName()

  Retrieves the value of the attribute XPRSconstants.RANGENAME. Active range name.

• getXpressVersion

  public java.lang.String getXpressVersion()

  Retrieves the value of the attribute XPRSconstants.XPRESSVERSION. The Xpress version number.

• getUUID

  public java.lang.String getUUID()

  Retrieves the value of the attribute XPRSconstants.UUID. Universally Unique Identifier for the problem instance.

• getBarPrimalObj

  public double getBarPrimalObj()

  Retrieves the value of the attribute XPRSconstants.BARPRIMALOBJ. Primal objective value calculated by the Newton barrier algorithm.

• getBarDualObj

  public double getBarDualObj()

  Retrieves the value of the attribute XPRSconstants.BARDUALOBJ. Dual objective value calculated by the Newton barrier algorithm.

• getBarPrimalInf

  public double getBarPrimalInf()

  Retrieves the value of the attribute XPRSconstants.BARPRIMALINF. Sum of the primal infeasibilities for the Newton barrier algorithm.

• getBarDualInf

  public double getBarDualInf()

  Retrieves the value of the attribute XPRSconstants.BARDUALINF. Sum of the dual infeasibilities for the Newton barrier algorithm.

• getBarCGap

  public double getBarCGap()

  Retrieves the value of the attribute XPRSconstants.BARCGAP. Convergence criterion for the Newton barrier algorithm.

• getBarIter

  public int getBarIter()

  Retrieves the value of the attribute XPRSconstants.BARITER. Number of Newton barrier iterations.

• getBarAASize

  public long getBarAASize()

  Retrieves the value of the attribute XPRSconstants.BARAASIZE. Number of nonzeros in AA ^T.

• getBarLSize

  public long getBarLSize()

  Retrieves the value of the attribute XPRSconstants.BARLSIZE. Number of nonzeros in L resulting from the Cholesky factorization.

• getBarDenseCol

  public int getBarDenseCol()

  Retrieves the value of the attribute XPRSconstants.BARDENSECOL. Number of dense columns found in the matrix.

• getBarCrossover

  public int getBarCrossover()

  Retrieves the value of the attribute XPRSconstants.BARCROSSOVER. Indicates whether or not the basis crossover phase has been entered.

• getNlpOptTime

  public double getNlpOptTime()

  Retrieves the value of the attribute XPRSconstants.NLPOPTTIME. Time spent in optimization

• getNlpValidationIndex_A

  public double getNlpValidationIndex_A()

  Retrieves the value of the attribute XPRSconstants.NLPVALIDATIONINDEX_A. Absolute validation index

• getNlpValidationIndex_R

  public double getNlpValidationIndex_R()

  Retrieves the value of the attribute XPRSconstants.NLPVALIDATIONINDEX_R. Relative validation index

• getNlpObjVal

  public double getNlpObjVal()

  Retrieves the value of the attribute XPRSconstants.NLPOBJVAL. Objective function value excluding any penalty costs

• getSlpErrorCosts

  public double getSlpErrorCosts()

  Retrieves the value of the attribute XPRSconstants.SLPERRORCOSTS. Total penalty costs in the solution

• getNlpOriginalRows

  public int getNlpOriginalRows()

  Retrieves the value of the attribute XPRSconstants.NLPORIGINALROWS. Number of model rows in the extended original problem

• getNlpOriginalCols

  public int getNlpOriginalCols()

  Retrieves the value of the attribute XPRSconstants.NLPORIGINALCOLS. Number of model columns in the extended original problem

• getNlpUFs

  public int getNlpUFs()

  Retrieves the value of the attribute XPRSconstants.NLPUFS. Number of user functions

• getNlpIfs

  public int getNlpIfs()

  Retrieves the value of the attribute XPRSconstants.NLPIFS. Number of internal functions

• getNlpEqualsColumn

  public int getNlpEqualsColumn()

  Retrieves the value of the attribute XPRSconstants.NLPEQUALSCOLUMN. Index of the reserved "=" column

• getNlpVariables

  public int getNlpVariables()

  Retrieves the value of the attribute XPRSconstants.NLPVARIABLES. Number of SLP variables

• getNlpImplicitVariables

  public int getNlpImplicitVariables()

  Retrieves the value of the attribute XPRSconstants.NLPIMPLICITVARIABLES. Number of SLP variables appearing only in coefficients

• getNonLinearConstraints

  public int getNonLinearConstraints()

  Retrieves the value of the attribute XPRSconstants.NONLINEARCONSTRAINTS. Number of nonlinear constraints in the problem

• getNlpUserFuncCalls

  public int getNlpUserFuncCalls()

  Retrieves the value of the attribute XPRSconstants.NLPUSERFUNCCALLS. Number of calls made to user functions

• getNlpUseDerivatives

  public int getNlpUseDerivatives()

  Retrieves the value of the attribute XPRSconstants.NLPUSEDERIVATIVES. Indicates whether numeric or analytic derivatives were used to create the linear approximations and solve the problem

• getNlpKeepBestIter

  public int getNlpKeepBestIter()

  Retrieves the value of the attribute XPRSconstants.NLPKEEPBESTITER. The iteration in which the returned solution has been found.

• getNlpStatus

  public int getNlpStatus()

  Retrieves the value of the attribute XPRSconstants.NLPSTATUS. Bitmap holding the problem convergence status

• getLocalSolverSelected

  public int getLocalSolverSelected()

  Retrieves the value of the attribute XPRSconstants.LOCALSOLVERSELECTED.

• getNlpModelRows

  public int getNlpModelRows()

  Retrieves the value of the attribute XPRSconstants.NLPMODELROWS. Number of model rows in the problem

• getNlpModelCols

  public int getNlpModelCols()

  Retrieves the value of the attribute XPRSconstants.NLPMODELCOLS. Number of model columns in the problem

• getNlpJobID

  public int getNlpJobID()

  Retrieves the value of the attribute XPRSconstants.NLPJOBID. Unique identifier for the current job

• getNlpStopStatus

  public int getNlpStopStatus()

  Retrieves the value of the attribute XPRSconstants.NLPSTOPSTATUS. Status of the optimization process.

• getNlpPresolveEliminations

  public int getNlpPresolveEliminations()

  Retrieves the value of the attribute XPRSconstants.NLPPRESOLVEELIMINATIONS. Number of SLP variables eliminated by XSLPpresolve

• getSlpIter

  public int getSlpIter()

  Retrieves the value of the attribute XPRSconstants.SLPITER. SLP iteration count

• getSlpStatus

  public int getSlpStatus()

  Retrieves the value of the attribute XPRSconstants.SLPSTATUS. Bitmap holding the problem convergence status

• getSlpUnConverged

  public int getSlpUnConverged()

  Retrieves the value of the attribute XPRSconstants.SLPUNCONVERGED. Number of unconverged values

• getSlpSbxConverged

  public int getSlpSbxConverged()

  Retrieves the value of the attribute XPRSconstants.SLPSBXCONVERGED. Number of step-bounded variables converged only on extended criteria

• getSlpPenaltyDeltaRow

  public int getSlpPenaltyDeltaRow()

  Retrieves the value of the attribute XPRSconstants.SLPPENALTYDELTAROW. Index of equality row holding the penalties for delta vectors

• getSlpPenaltyDeltaColumn

  public int getSlpPenaltyDeltaColumn()

  Retrieves the value of the attribute XPRSconstants.SLPPENALTYDELTACOLUMN. Index of column costing the penalty delta row

• getSlpPenaltyErrorRow

  public int getSlpPenaltyErrorRow()

  Retrieves the value of the attribute XPRSconstants.SLPPENALTYERRORROW. Index of equality row holding the penalties for penalty error vectors

• getSlpPenaltyErrorColumn

  public int getSlpPenaltyErrorColumn()

  Retrieves the value of the attribute XPRSconstants.SLPPENALTYERRORCOLUMN. Index of column costing the penalty error row

• getSlpCoefficients

  public int getSlpCoefficients()

  Retrieves the value of the attribute XPRSconstants.SLPCOEFFICIENTS. Number of nonlinear coefficients

• getSlpPenaltyDeltas

  public int getSlpPenaltyDeltas()

  Retrieves the value of the attribute XPRSconstants.SLPPENALTYDELTAS. Number of penalty delta vectors

• getSlpPenaltyErrors

  public int getSlpPenaltyErrors()

  Retrieves the value of the attribute XPRSconstants.SLPPENALTYERRORS. Number of penalty error vectors

• getSlpPlusPenaltyErrors

  public int getSlpPlusPenaltyErrors()

  Retrieves the value of the attribute XPRSconstants.SLPPLUSPENALTYERRORS. Number of positive penalty error vectors

• getSlpMinusPenaltyErrors

  public int getSlpMinusPenaltyErrors()

  Retrieves the value of the attribute XPRSconstants.SLPMINUSPENALTYERRORS. Number of negative penalty error vectors

• getSlpUCConstrainedCount

  public int getSlpUCConstrainedCount()

  Retrieves the value of the attribute XPRSconstants.SLPUCCONSTRAINEDCOUNT. Number of unconverged variables with coefficients in constraining rows

• getSlpMipNodes

  public int getSlpMipNodes()

  Retrieves the value of the attribute XPRSconstants.SLPMIPNODES. Number of nodes explored in MISLP. This includes any nodes for which a non-linear solve has been carried out.

• getSlpMipIter

  public int getSlpMipIter()

  Retrieves the value of the attribute XPRSconstants.SLPMIPITER. Total number of SLP iterations in MISLP

• getSlpTolSets

  public int getSlpTolSets()

  Retrieves the value of the attribute XPRSconstants.SLPTOLSETS. Number of tolerance sets.

• getSlpECFCount

  public int getSlpECFCount()

  Retrieves the value of the attribute XPRSconstants.SLPECFCOUNT. Number of infeasible constraints found at the point of linearization

• getSlpDeltas

  public int getSlpDeltas()

  Retrieves the value of the attribute XPRSconstants.SLPDELTAS. Number of delta vectors created during augmentation

• getSlpZeroesReset

  public int getSlpZeroesReset()

  Retrieves the value of the attribute XPRSconstants.SLPZEROESRESET. Number of placeholder entries set to zero

• getSlpZeroesTotal

  public int getSlpZeroesTotal()

  Retrieves the value of the attribute XPRSconstants.SLPZEROESTOTAL. Number of potential zero placeholder entries

• getSlpZeroesRetained

  public int getSlpZeroesRetained()

  Retrieves the value of the attribute XPRSconstants.SLPZEROESRETAINED. Number of potentially zero placeholders left untouched

• getSlpNonConstantCoeffs

  public int getSlpNonConstantCoeffs()

  Retrieves the value of the attribute XPRSconstants.SLPNONCONSTANTCOEFFS. Number of coefficients in the augmented problem that might change between SLP iterations

• getSlpMipSols

  public int getSlpMipSols()

  Retrieves the value of the attribute XPRSconstants.SLPMIPSOLS. Number of integer solutions found in MISLP. This includes solutions found during the tree search or any heuristics.

• getNlpValidationIndex_K

  public double getNlpValidationIndex_K()

  Retrieves the value of the attribute XPRSconstants.NLPVALIDATIONINDEX_K. Relative first order optimality validation index

• getSlpCurrentDeltaCost

  public double getSlpCurrentDeltaCost()

  Retrieves the value of the attribute XPRSconstants.SLPCURRENTDELTACOST. Current value of penalty cost multiplier for penalty delta vectors

• getSlpCurrentErrorCost

  public double getSlpCurrentErrorCost()

  Retrieves the value of the attribute XPRSconstants.SLPCURRENTERRORCOST. Current value of penalty cost multiplier for penalty error vectors

• getSlpPenaltyErrorTotal

  public double getSlpPenaltyErrorTotal()

  Retrieves the value of the attribute XPRSconstants.SLPPENALTYERRORTOTAL. Total activity of penalty error vectors

• getSlpPenaltyErrorValue

  public double getSlpPenaltyErrorValue()

  Retrieves the value of the attribute XPRSconstants.SLPPENALTYERRORVALUE. Total penalty cost attributed to penalty error vectors

• getSlpPenaltyDeltaTotal

  public double getSlpPenaltyDeltaTotal()

  Retrieves the value of the attribute XPRSconstants.SLPPENALTYDELTATOTAL. Total activity of penalty delta vectors

• getSlpPenaltyDeltaValue

  public double getSlpPenaltyDeltaValue()

  Retrieves the value of the attribute XPRSconstants.SLPPENALTYDELTAVALUE. Total penalty cost attributed to penalty delta vectors