Initializing help system before first use

Controls

Controls API. More...

#include <xpress.hpp>

Public Member Functions

auto  getAlgAfterCrossOver () const -> int
  Get the value for control AlgAfterCrossOver.
 
auto  getAlgAfterNetwork () const -> int
  Get the value for control AlgAfterNetwork.
 
auto  getAlternativeRedCosts () const -> int
  Get the value for control AlternativeRedCosts.
 
auto  getAutoCutting () const -> int
  Get the value for control AutoCutting.
 
auto  getAutoPerturb () const -> int
  Get the value for control AutoPerturb.
 
auto  getAutoScaling () const -> int
  Get the value for control AutoScaling.
 
auto  getBackgroundMaxThreads () const -> int
  Get the value for control BackgroundMaxThreads.
 
auto  getBackgroundSelect () const -> XPRSint64
  Get the value for control BackgroundSelect.
 
auto  getBackTrack () const -> int
  Get the value for control BackTrack.
 
auto  getBacktrackTie () const -> int
  Get the value for control BacktrackTie.
 
auto  getBarAlg () const -> int
  Get the value for control BarAlg.
 
auto  getBarCores () const -> int
  Get the value for control BarCores.
 
auto  getBarCrash () const -> int
  Get the value for control BarCrash.
 
auto  getBarDualStop () const -> double
  Get the value for control BarDualStop.
 
auto  getBarFailIterLimit () const -> int
  Get the value for control BarFailIterLimit.
 
auto  getBarFreeScale () const -> double
  Get the value for control BarFreeScale.
 
auto  getBarGapStop () const -> double
  Get the value for control BarGapStop.
 
auto  getBarGapTarget () const -> double
  Get the value for control BarGapTarget.
 
auto  getBarhgExtrapolate () const -> double
  Get the value for control BarhgExtrapolate.
 
auto  getBarhgMaxRestarts () const -> int
  Get the value for control BarhgMaxRestarts.
 
auto  getBarhgOps () const -> xpress::BARHGOps
  Get the value for control BarhgOps.
 
auto  getBarIndefLimit () const -> int
  Get the value for control BarIndefLimit.
 
auto  getBarIterLimit () const -> int
  Get the value for control BarIterLimit.
 
auto  getBarKernel () const -> double
  Get the value for control BarKernel.
 
auto  getBarLargeBound () const -> double
  Get the value for control BarLargeBound.
 
auto  getBarNumStability () const -> int
  Get the value for control BarNumStability.
 
auto  getBarObjPerturb () const -> double
  Get the value for control BarObjPerturb.
 
auto  getBarObjScale () const -> double
  Get the value for control BarObjScale.
 
auto  getBarOrder () const -> xpress::BarOrder
  Get the value for control BarOrder.
 
auto  getBarOrderThreads () const -> int
  Get the value for control BarOrderThreads.
 
auto  getBarOutput () const -> int
  Get the value for control BarOutput.
 
auto  getBarPerturb () const -> double
  Get the value for control BarPerturb.
 
auto  getBarPresolveOps () const -> int
  Get the value for control BarPresolveOps.
 
auto  getBarPrimalStop () const -> double
  Get the value for control BarPrimalStop.
 
auto  getBarRefIter () const -> int
  Get the value for control BarRefIter.
 
auto  getBarRegularize () const -> int
  Get the value for control BarRegularize.
 
auto  getBarRhsScale () const -> double
  Get the value for control BarRhsScale.
 
auto  getBarSolution () const -> int
  Get the value for control BarSolution.
 
auto  getBarStart () const -> int
  Get the value for control BarStart.
 
auto  getBarStartWeight () const -> double
  Get the value for control BarStartWeight.
 
auto  getBarStepStop () const -> double
  Get the value for control BarStepStop.
 
auto  getBarThreads () const -> int
  Get the value for control BarThreads.
 
auto  getBigM () const -> double
  Get the value for control BigM.
 
auto  getBigmMethod () const -> int
  Get the value for control BigmMethod.
 
auto  getBranchChoice () const -> int
  Get the value for control BranchChoice.
 
auto  getBranchDisj () const -> int
  Get the value for control BranchDisj.
 
auto  getBranchStructural () const -> int
  Get the value for control BranchStructural.
 
auto  getBreadthFirst () const -> int
  Get the value for control BreadthFirst.
 
auto  getCacheSize () const -> int
  Get the value for control CacheSize.
 
auto  getCallbackCheckTimeDelay () const -> int
  Get the value for control CallbackCheckTimeDelay.
 
auto  getCallbackFromMasterThread () const -> int
  Get the value for control CallbackFromMasterThread.
 
auto  getCheckInputData () const -> int
  Get the value for control CheckInputData.
 
auto  getCholeskyAlg () const -> int
  Get the value for control CholeskyAlg.
 
auto  getCholeskyTol () const -> double
  Get the value for control CholeskyTol.
 
auto  getClamping () const -> int
  Get the value for control Clamping.
 
auto  getCompute () const -> int
  Get the value for control Compute.
 
auto  getComputeExecService () const -> std::string
  Get the value for control ComputeExecService.
 
auto  getComputeJobPriority () const -> int
  Get the value for control ComputeJobPriority.
 
auto  getComputeLog () const -> xpress::ComputeLog
  Get the value for control ComputeLog.
 
auto  getConcurrentThreads () const -> int
  Get the value for control ConcurrentThreads.
 
auto  getConflictCuts () const -> int
  Get the value for control ConflictCuts.
 
auto  getCoresPerCPU () const -> int
  Get the value for control CoresPerCPU.
 
auto  getCoverCuts () const -> int
  Get the value for control CoverCuts.
 
auto  getCpiAlpha () const -> double
  Get the value for control CpiAlpha.
 
auto  getCPUPlatform () const -> int
  Get the value for control CPUPlatform.
 
auto  getCPUTime () const -> int
  Get the value for control CPUTime.
 
auto  getCrash () const -> int
  Get the value for control Crash.
 
auto  getCrossOver () const -> int
  Get the value for control CrossOver.
 
auto  getCrossoverAccuracyTol () const -> double
  Get the value for control CrossoverAccuracyTol.
 
auto  getCrossOverDRP () const -> int
  Get the value for control CrossOverDRP.
 
auto  getCrossOverFeasWeight () const -> double
  Get the value for control CrossOverFeasWeight.
 
auto  getCrossoverIterLimit () const -> int
  Get the value for control CrossoverIterLimit.
 
auto  getCrossoverOps () const -> int
  Get the value for control CrossoverOps.
 
auto  getCrossOverRelPivotTol () const -> double
  Get the value for control CrossOverRelPivotTol.
 
auto  getCrossOverRelPivotTolSafe () const -> double
  Get the value for control CrossOverRelPivotTolSafe.
 
auto  getCrossoverThreads () const -> int
  Get the value for control CrossoverThreads.
 
auto  getCutDepth () const -> int
  Get the value for control CutDepth.
 
auto  getCutFactor () const -> double
  Get the value for control CutFactor.
 
auto  getCutFreq () const -> int
  Get the value for control CutFreq.
 
auto  getCutSelect () const -> int
  Get the value for control CutSelect.
 
auto  getCutStrategy () const -> int
  Get the value for control CutStrategy.
 
auto  getDefaultAlg () const -> xpress::DefaultAlg
  Get the value for control DefaultAlg.
 
auto  getDenseColLimit () const -> int
  Get the value for control DenseColLimit.
 
auto  getDeterministic () const -> int
  Get the value for control Deterministic.
 
auto  getDetLogFreq () const -> double
  Get the value for control DetLogFreq.
 
auto  getDualGradient () const -> int
  Get the value for control DualGradient.
 
auto  getDualize () const -> int
  Get the value for control Dualize.
 
auto  getDualizeOps () const -> int
  Get the value for control DualizeOps.
 
auto  getDualPerturb () const -> double
  Get the value for control DualPerturb.
 
auto  getDualStrategy () const -> int
  Get the value for control DualStrategy.
 
auto  getDualThreads () const -> int
  Get the value for control DualThreads.
 
auto  getDummyControl () const -> double
  Get the value for control DummyControl.
 
auto  getEigenValueTol () const -> double
  Get the value for control EigenValueTol.
 
auto  getElimFillIn () const -> int
  Get the value for control ElimFillIn.
 
auto  getElimTol () const -> double
  Get the value for control ElimTol.
 
auto  getEscapeNames () const -> int
  Get the value for control EscapeNames.
 
auto  getEtaTol () const -> double
  Get the value for control EtaTol.
 
auto  getExtraCols () const -> int
  Get the value for control ExtraCols.
 
auto  getExtraElems () const -> XPRSint64
  Get the value for control ExtraElems.
 
auto  getExtraMipEnts () const -> int
  Get the value for control ExtraMipEnts.
 
auto  getExtraRows () const -> int
  Get the value for control ExtraRows.
 
auto  getExtraSetElems () const -> XPRSint64
  Get the value for control ExtraSetElems.
 
auto  getExtraSets () const -> int
  Get the value for control ExtraSets.
 
auto  getFeasibilityJump () const -> int
  Get the value for control FeasibilityJump.
 
auto  getFeasibilityPump () const -> int
  Get the value for control FeasibilityPump.
 
auto  getFeasTol () const -> double
  Get the value for control FeasTol.
 
auto  getFeasTolPerturb () const -> double
  Get the value for control FeasTolPerturb.
 
auto  getFeasTolTarget () const -> double
  Get the value for control FeasTolTarget.
 
auto  getForceOutput () const -> int
  Get the value for control ForceOutput.
 
auto  getForceParallelDual () const -> int
  Get the value for control ForceParallelDual.
 
auto  getGenconsAbsTransformation () const -> int
  Get the value for control GenconsAbsTransformation.
 
auto  getGenconsDualReductions () const -> int
  Get the value for control GenconsDualReductions.
 
auto  getGlobalBoundingBox () const -> double
  Get the value for control GlobalBoundingBox.
 
auto  getGlobalLSHeurstrategy () const -> int
  Get the value for control GlobalLSHeurstrategy.
 
auto  getGlobalNlpCuts () const -> int
  Get the value for control GlobalNlpCuts.
 
auto  getGlobalNumInitNlpCuts () const -> int
  Get the value for control GlobalNumInitNlpCuts.
 
auto  getGlobalSpatialBranchCuttingEffort () const -> double
  Get the value for control GlobalSpatialBranchCuttingEffort.
 
auto  getGlobalSpatialBranchIfPreferOrig () const -> int
  Get the value for control GlobalSpatialBranchIfPreferOrig.
 
auto  getGlobalSpatialBranchPropagationEffort () const -> double
  Get the value for control GlobalSpatialBranchPropagationEffort.
 
auto  getGlobalTreeNlpCuts () const -> int
  Get the value for control GlobalTreeNlpCuts.
 
auto  getGomCuts () const -> int
  Get the value for control GomCuts.
 
auto  getHeurBeforeLp () const -> int
  Get the value for control HeurBeforeLp.
 
auto  getHeurDepth () const -> int
  Get the value for control HeurDepth.
 
auto  getHeurDiveIterLimit () const -> double
  Get the value for control HeurDiveIterLimit.
 
auto  getHeurDiveRandomize () const -> double
  Get the value for control HeurDiveRandomize.
 
auto  getHeurDiveSoftRounding () const -> int
  Get the value for control HeurDiveSoftRounding.
 
auto  getHeurDiveSpeedUp () const -> int
  Get the value for control HeurDiveSpeedUp.
 
auto  getHeurDiveStrategy () const -> int
  Get the value for control HeurDiveStrategy.
 
auto  getHeurEmphasis () const -> int
  Get the value for control HeurEmphasis.
 
auto  getHeurForceSpecialObj () const -> int
  Get the value for control HeurForceSpecialObj.
 
auto  getHeurFreq () const -> int
  Get the value for control HeurFreq.
 
auto  getHeurMaxSol () const -> int
  Get the value for control HeurMaxSol.
 
auto  getHeurNodes () const -> int
  Get the value for control HeurNodes.
 
auto  getHeursearchBackgroundSelect () const -> XPRSint64
  Get the value for control HeursearchBackgroundSelect.
 
auto  getHeurSearchCopyControls () const -> int
  Get the value for control HeurSearchCopyControls.
 
auto  getHeurSearchEffort () const -> double
  Get the value for control HeurSearchEffort.
 
auto  getHeurSearchFreq () const -> int
  Get the value for control HeurSearchFreq.
 
auto  getHeurSearchRootCutFreq () const -> int
  Get the value for control HeurSearchRootCutFreq.
 
auto  getHeurSearchRootSelect () const -> int
  Get the value for control HeurSearchRootSelect.
 
auto  getHeurSearchTargetSize () const -> double
  Get the value for control HeurSearchTargetSize.
 
auto  getHeurSearchTreeSelect () const -> int
  Get the value for control HeurSearchTreeSelect.
 
auto  getHeurSelect () const -> int
  Get the value for control HeurSelect.
 
auto  getHeurShiftProp () const -> int
  Get the value for control HeurShiftProp.
 
auto  getHeurThreads () const -> int
  Get the value for control HeurThreads.
 
auto  getHistoryCosts () const -> int
  Get the value for control HistoryCosts.
 
auto  getIfCheckConvexity () const -> int
  Get the value for control IfCheckConvexity.
 
auto  getIgnoreContainerCpuLimit () const -> int
  Get the value for control IgnoreContainerCpuLimit.
 
auto  getIgnoreContainerMemoryLimit () const -> int
  Get the value for control IgnoreContainerMemoryLimit.
 
auto  getIISLog () const -> int
  Get the value for control IISLog.
 
auto  getIISOps () const -> xpress::IISOps
  Get the value for control IISOps.
 
auto  getIndLinBigM () const -> double
  Get the value for control IndLinBigM.
 
auto  getIndPreLinBigM () const -> double
  Get the value for control IndPreLinBigM.
 
auto  getInputtol () const -> double
  Get the value for control Inputtol.
 
auto  getInvertFreq () const -> int
  Get the value for control InvertFreq.
 
auto  getInvertMin () const -> int
  Get the value for control InvertMin.
 
auto  getIOTimeout () const -> int
  Get the value for control IOTimeout.
 
auto  getKeepBasis () const -> int
  Get the value for control KeepBasis.
 
auto  getKeepNRows () const -> int
  Get the value for control KeepNRows.
 
auto  getKnitroParamAlgorithm () const -> int
  Get the value for control KnitroParamAlgorithm.
 
auto  getKnitroParamBarDirectInterval () const -> int
  Get the value for control KnitroParamBarDirectInterval.
 
auto  getKnitroParamBarFeasible () const -> int
  Get the value for control KnitroParamBarFeasible.
 
auto  getKnitroParamBarFeasModeTol () const -> double
  Get the value for control KnitroParamBarFeasModeTol.
 
auto  getKnitroParamBarInitMu () const -> double
  Get the value for control KnitroParamBarInitMu.
 
auto  getKnitroParamBarInitPt () const -> int
  Get the value for control KnitroParamBarInitPt.
 
auto  getKnitroParamBarMaxBacktrack () const -> int
  Get the value for control KnitroParamBarMaxBacktrack.
 
auto  getKnitroParamBarMaxRefactor () const -> int
  Get the value for control KnitroParamBarMaxRefactor.
 
auto  getKnitroParamBarMuRule () const -> int
  Get the value for control KnitroParamBarMuRule.
 
auto  getKnitroParamBarPenCons () const -> int
  Get the value for control KnitroParamBarPenCons.
 
auto  getKnitroParamBarPenRule () const -> int
  Get the value for control KnitroParamBarPenRule.
 
auto  getKnitroParamBarRelaxCons () const -> int
  Get the value for control KnitroParamBarRelaxCons.
 
auto  getKnitroParamBarSwitchRule () const -> int
  Get the value for control KnitroParamBarSwitchRule.
 
auto  getKnitroParamBLASOption () const -> int
  Get the value for control KnitroParamBLASOption.
 
auto  getKnitroParamDebug () const -> int
  Get the value for control KnitroParamDebug.
 
auto  getKnitroParamDelta () const -> double
  Get the value for control KnitroParamDelta.
 
auto  getKnitroParamFeastol () const -> double
  Get the value for control KnitroParamFeastol.
 
auto  getKnitroParamFeasTolAbs () const -> double
  Get the value for control KnitroParamFeasTolAbs.
 
auto  getKnitroParamGradOpt () const -> int
  Get the value for control KnitroParamGradOpt.
 
auto  getKnitroParamHessOpt () const -> int
  Get the value for control KnitroParamHessOpt.
 
auto  getKnitroParamHonorBbnds () const -> int
  Get the value for control KnitroParamHonorBbnds.
 
auto  getKnitroParamInfeasTol () const -> double
  Get the value for control KnitroParamInfeasTol.
 
auto  getKnitroParamLinSolver () const -> int
  Get the value for control KnitroParamLinSolver.
 
auto  getKnitroParamLMSize () const -> int
  Get the value for control KnitroParamLMSize.
 
auto  getKnitroParamMATerminate () const -> int
  Get the value for control KnitroParamMATerminate.
 
auto  getKnitroParamMaxCGIt () const -> int
  Get the value for control KnitroParamMaxCGIt.
 
auto  getKnitroParamMaxCrossIt () const -> int
  Get the value for control KnitroParamMaxCrossIt.
 
auto  getKnitroParamMaxIt () const -> int
  Get the value for control KnitroParamMaxIt.
 
auto  getKnitroParamMipBranchRule () const -> int
  Get the value for control KnitroParamMipBranchRule.
 
auto  getKnitroParamMipDebug () const -> int
  Get the value for control KnitroParamMipDebug.
 
auto  getKnitroParamMipGUBBranch () const -> int
  Get the value for control KnitroParamMipGUBBranch.
 
auto  getKnitroParamMipHeuristic () const -> int
  Get the value for control KnitroParamMipHeuristic.
 
auto  getKnitroParamMipHeurMaxIt () const -> int
  Get the value for control KnitroParamMipHeurMaxIt.
 
auto  getKnitroParamMipImplicatns () const -> int
  Get the value for control KnitroParamMipImplicatns.
 
auto  getKnitroParamMipIntGapAbs () const -> double
  Get the value for control KnitroParamMipIntGapAbs.
 
auto  getKnitroParamMipIntGapRel () const -> double
  Get the value for control KnitroParamMipIntGapRel.
 
auto  getKnitroParamMipKnapsack () const -> int
  Get the value for control KnitroParamMipKnapsack.
 
auto  getKnitroParamMipLpAlg () const -> int
  Get the value for control KnitroParamMipLpAlg.
 
auto  getKnitroParamMipMaxNodes () const -> int
  Get the value for control KnitroParamMipMaxNodes.
 
auto  getKnitroParamMipMethod () const -> int
  Get the value for control KnitroParamMipMethod.
 
auto  getKnitroParamMipOutInterval () const -> int
  Get the value for control KnitroParamMipOutInterval.
 
auto  getKnitroParamMipOutLevel () const -> int
  Get the value for control KnitroParamMipOutLevel.
 
auto  getKnitroParamMipPseudoint () const -> int
  Get the value for control KnitroParamMipPseudoint.
 
auto  getKnitroParamMipRootAlg () const -> int
  Get the value for control KnitroParamMipRootAlg.
 
auto  getKnitroParamMipRounding () const -> int
  Get the value for control KnitroParamMipRounding.
 
auto  getKnitroParamMipSelectRule () const -> int
  Get the value for control KnitroParamMipSelectRule.
 
auto  getKnitroParamMipStringMaxIt () const -> int
  Get the value for control KnitroParamMipStringMaxIt.
 
auto  getKnitroParamMipStrongCandLim () const -> int
  Get the value for control KnitroParamMipStrongCandLim.
 
auto  getKnitroParamMipStrongLevel () const -> int
  Get the value for control KnitroParamMipStrongLevel.
 
auto  getKnitroParamMsMaxBndRange () const -> double
  Get the value for control KnitroParamMsMaxBndRange.
 
auto  getKnitroParamMSMaxSolves () const -> int
  Get the value for control KnitroParamMSMaxSolves.
 
auto  getKnitroParamMSNumToSave () const -> int
  Get the value for control KnitroParamMSNumToSave.
 
auto  getKnitroParamMSSaveTol () const -> double
  Get the value for control KnitroParamMSSaveTol.
 
auto  getKnitroParamMSSeed () const -> int
  Get the value for control KnitroParamMSSeed.
 
auto  getKnitroParamMSStartPtRange () const -> double
  Get the value for control KnitroParamMSStartPtRange.
 
auto  getKnitroParamMSTerminate () const -> int
  Get the value for control KnitroParamMSTerminate.
 
auto  getKnitroParamMultiStart () const -> int
  Get the value for control KnitroParamMultiStart.
 
auto  getKnitroParamNewPoint () const -> int
  Get the value for control KnitroParamNewPoint.
 
auto  getKnitroParamObjRange () const -> double
  Get the value for control KnitroParamObjRange.
 
auto  getKnitroParamOptTol () const -> double
  Get the value for control KnitroParamOptTol.
 
auto  getKnitroParamOptTolAbs () const -> double
  Get the value for control KnitroParamOptTolAbs.
 
auto  getKnitroParamOutLev () const -> int
  Get the value for control KnitroParamOutLev.
 
auto  getKnitroParamParNumThreads () const -> int
  Get the value for control KnitroParamParNumThreads.
 
auto  getKnitroParamPivot () const -> double
  Get the value for control KnitroParamPivot.
 
auto  getKnitroParamPresolve () const -> int
  Get the value for control KnitroParamPresolve.
 
auto  getKnitroParamPresolveTol () const -> double
  Get the value for control KnitroParamPresolveTol.
 
auto  getKnitroParamScale () const -> int
  Get the value for control KnitroParamScale.
 
auto  getKnitroParamSOC () const -> int
  Get the value for control KnitroParamSOC.
 
auto  getKnitroParamXTol () const -> double
  Get the value for control KnitroParamXTol.
 
auto  getL1Cache () const -> int
  Get the value for control L1Cache.
 
auto  getLNPBest () const -> int
  Get the value for control LNPBest.
 
auto  getLNPIterLimit () const -> int
  Get the value for control LNPIterLimit.
 
auto  getLocalBacktrack () const -> int
  Get the value for control LocalBacktrack.
 
auto  getLocalChoice () const -> int
  Get the value for control LocalChoice.
 
auto  getLocalSolver () const -> int
  Get the value for control LocalSolver.
 
auto  getLpFlags () const -> xpress::LPFlags
  Get the value for control LpFlags.
 
auto  getLpFolding () const -> int
  Get the value for control LpFolding.
 
auto  getLpIterLimit () const -> int
  Get the value for control LpIterLimit.
 
auto  getLpLog () const -> int
  Get the value for control LpLog.
 
auto  getLpLogDelay () const -> double
  Get the value for control LpLogDelay.
 
auto  getLpLogStyle () const -> int
  Get the value for control LpLogStyle.
 
auto  getLpRefineIterLimit () const -> int
  Get the value for control LpRefineIterLimit.
 
auto  getLUPivotTol () const -> double
  Get the value for control LUPivotTol.
 
auto  getMarkowitzTol () const -> double
  Get the value for control MarkowitzTol.
 
auto  getMatrixTol () const -> double
  Get the value for control MatrixTol.
 
auto  getMaxChecksOnMaxCutTime () const -> int
  Get the value for control MaxChecksOnMaxCutTime.
 
auto  getMaxChecksOnMaxTime () const -> int
  Get the value for control MaxChecksOnMaxTime.
 
auto  getMaxCutTime () const -> double
  Get the value for control MaxCutTime.
 
auto  getMaxIIS () const -> int
  Get the value for control MaxIIS.
 
auto  getMaxImpliedBound () const -> double
  Get the value for control MaxImpliedBound.
 
auto  getMaxLocalBacktrack () const -> int
  Get the value for control MaxLocalBacktrack.
 
auto  getMaxMCoeffBufferElems () const -> int
  Get the value for control MaxMCoeffBufferElems.
 
auto  getMaxMemoryHard () const -> int
  Get the value for control MaxMemoryHard.
 
auto  getMaxMemorySoft () const -> int
  Get the value for control MaxMemorySoft.
 
auto  getMaxMipSol () const -> int
  Get the value for control MaxMipSol.
 
auto  getMaxMipTasks () const -> int
  Get the value for control MaxMipTasks.
 
auto  getMaxNode () const -> int
  Get the value for control MaxNode.
 
auto  getMaxPageLines () const -> int
  Get the value for control MaxPageLines.
 
auto  getMaxScaleFactor () const -> int
  Get the value for control MaxScaleFactor.
 
auto  getMaxStallTime () const -> double
  Get the value for control MaxStallTime.
 
auto  getMaxTime () const -> int
  Get the value for control MaxTime.
 
auto  getMaxTreeFileSize () const -> int
  Get the value for control MaxTreeFileSize.
 
auto  getMCFCutStrategy () const -> int
  Get the value for control MCFCutStrategy.
 
auto  getMipAbsCutoff () const -> double
  Get the value for control MipAbsCutoff.
 
auto  getMipAbsGapNotify () const -> double
  Get the value for control MipAbsGapNotify.
 
auto  getMipAbsGapNotifyBound () const -> double
  Get the value for control MipAbsGapNotifyBound.
 
auto  getMipAbsGapNotifyObj () const -> double
  Get the value for control MipAbsGapNotifyObj.
 
auto  getMipAbsStop () const -> double
  Get the value for control MipAbsStop.
 
auto  getMipAddCutoff () const -> double
  Get the value for control MipAddCutoff.
 
auto  getMipComponents () const -> int
  Get the value for control MipComponents.
 
auto  getMipConcurrentNodes () const -> int
  Get the value for control MipConcurrentNodes.
 
auto  getMipConcurrentSolves () const -> int
  Get the value for control MipConcurrentSolves.
 
auto  getMipDualReductions () const -> int
  Get the value for control MipDualReductions.
 
auto  getMipFracReduce () const -> int
  Get the value for control MipFracReduce.
 
auto  getMipKappaFreq () const -> int
  Get the value for control MipKappaFreq.
 
auto  getMipLog () const -> int
  Get the value for control MipLog.
 
auto  getMipPresolve () const -> int
  Get the value for control MipPresolve.
 
auto  getMipRampup () const -> int
  Get the value for control MipRampup.
 
auto  getMipRefineIterLimit () const -> int
  Get the value for control MipRefineIterLimit.
 
auto  getMipRelCutoff () const -> double
  Get the value for control MipRelCutoff.
 
auto  getMipRelGapNotify () const -> double
  Get the value for control MipRelGapNotify.
 
auto  getMipRelStop () const -> double
  Get the value for control MipRelStop.
 
auto  getMipRestart () const -> int
  Get the value for control MipRestart.
 
auto  getMipRestartFactor () const -> double
  Get the value for control MipRestartFactor.
 
auto  getMipRestartGapThreshold () const -> double
  Get the value for control MipRestartGapThreshold.
 
auto  getMipTerminationMethod () const -> int
  Get the value for control MipTerminationMethod.
 
auto  getMipThreads () const -> int
  Get the value for control MipThreads.
 
auto  getMipTol () const -> double
  Get the value for control MipTol.
 
auto  getMipTolTarget () const -> double
  Get the value for control MipTolTarget.
 
auto  getMIQCPAlg () const -> int
  Get the value for control MIQCPAlg.
 
auto  getMps18Compatible () const -> int
  Get the value for control Mps18Compatible.
 
auto  getMpsBoundName () const -> std::string
  Get the value for control MpsBoundName.
 
auto  getMpsEcho () const -> int
  Get the value for control MpsEcho.
 
auto  getMpsFormat () const -> int
  Get the value for control MpsFormat.
 
auto  getMpsNameLength () const -> int
  Get the value for control MpsNameLength.
 
auto  getMpsObjName () const -> std::string
  Get the value for control MpsObjName.
 
auto  getMpsRangeName () const -> std::string
  Get the value for control MpsRangeName.
 
auto  getMpsRhsName () const -> std::string
  Get the value for control MpsRhsName.
 
auto  getMseCallbackCullSols_Diversity () const -> int
  Get the value for control MseCallbackCullSols_Diversity.
 
auto  getMseCallbackCullSols_MipObject () const -> int
  Get the value for control MseCallbackCullSols_MipObject.
 
auto  getMseCallbackCullSols_ModObject () const -> int
  Get the value for control MseCallbackCullSols_ModObject.
 
auto  getMseOptimizeDiversity () const -> int
  Get the value for control MseOptimizeDiversity.
 
auto  getMseOutputLog () const -> int
  Get the value for control MseOutputLog.
 
auto  getMseOutputTol () const -> double
  Get the value for control MseOutputTol.
 
auto  getMsMaxBoundRange () const -> double
  Get the value for control MsMaxBoundRange.
 
auto  getMspDefaultUserSolFeasTol () const -> double
  Get the value for control MspDefaultUserSolFeasTol.
 
auto  getMspDefaultUserSolMipTol () const -> double
  Get the value for control MspDefaultUserSolMipTol.
 
auto  getMspDuplicateSolutionsPolicy () const -> int
  Get the value for control MspDuplicateSolutionsPolicy.
 
auto  getMspEnableSlackStorage () const -> int
  Get the value for control MspEnableSlackStorage.
 
auto  getMspIncludeProbNameInLogging () const -> int
  Get the value for control MspIncludeProbNameInLogging.
 
auto  getMspOutputLog () const -> int
  Get the value for control MspOutputLog.
 
auto  getMspSol_BitFieldsUsr () const -> int
  Get the value for control MspSol_BitFieldsUsr.
 
auto  getMspSol_FeasTol () const -> double
  Get the value for control MspSol_FeasTol.
 
auto  getMspSol_MipTol () const -> double
  Get the value for control MspSol_MipTol.
 
auto  getMspWriteSlxSolLogging () const -> int
  Get the value for control MspWriteSlxSolLogging.
 
auto  getMultiObjLog () const -> int
  Get the value for control MultiObjLog.
 
auto  getMultiObjOps () const -> int
  Get the value for control MultiObjOps.
 
auto  getMultiStart () const -> int
  Get the value for control MultiStart.
 
auto  getMultiStart_Log () const -> int
  Get the value for control MultiStart_Log.
 
auto  getMultiStart_MaxSolves () const -> int
  Get the value for control MultiStart_MaxSolves.
 
auto  getMultiStart_MaxTime () const -> int
  Get the value for control MultiStart_MaxTime.
 
auto  getMultiStart_PoolSize () const -> int
  Get the value for control MultiStart_PoolSize.
 
auto  getMultiStart_Seed () const -> int
  Get the value for control MultiStart_Seed.
 
auto  getMultiStart_Threads () const -> int
  Get the value for control MultiStart_Threads.
 
auto  getMutexCallBacks () const -> int
  Get the value for control MutexCallBacks.
 
auto  getNetCuts () const -> int
  Get the value for control NetCuts.
 
auto  getNetStallLimit () const -> int
  Get the value for control NetStallLimit.
 
auto  getNlpCalcThreads () const -> int
  Get the value for control NlpCalcThreads.
 
auto  getNlpDefaultIV () const -> double
  Get the value for control NlpDefaultIV.
 
auto  getNlpDerivatives () const -> int
  Get the value for control NlpDerivatives.
 
auto  getNlpDeterministic () const -> int
  Get the value for control NlpDeterministic.
 
auto  getNlpEvaluate () const -> int
  Get the value for control NlpEvaluate.
 
auto  getNlpFindIV () const -> int
  Get the value for control NlpFindIV.
 
auto  getNlpFuncEval () const -> int
  Get the value for control NlpFuncEval.
 
auto  getNlpHessian () const -> int
  Get the value for control NlpHessian.
 
auto  getNlpInfinity () const -> double
  Get the value for control NlpInfinity.
 
auto  getNlpJacobian () const -> int
  Get the value for control NlpJacobian.
 
auto  getNlpLinQuadBR () const -> int
  Get the value for control NlpLinQuadBR.
 
auto  getNlpLog () const -> int
  Get the value for control NlpLog.
 
auto  getNlpMaxTime () const -> int
  Get the value for control NlpMaxTime.
 
auto  getNlpMeritLambda () const -> double
  Get the value for control NlpMeritLambda.
 
auto  getNlpPostsolve () const -> int
  Get the value for control NlpPostsolve.
 
auto  getNlpPresolve () const -> int
  Get the value for control NlpPresolve.
 
auto  getNlpPresolve_ElimTol () const -> double
  Get the value for control NlpPresolve_ElimTol.
 
auto  getNlpPresolveLevel () const -> int
  Get the value for control NlpPresolveLevel.
 
auto  getNlpPresolveOps () const -> int
  Get the value for control NlpPresolveOps.
 
auto  getNlpPresolveZero () const -> double
  Get the value for control NlpPresolveZero.
 
auto  getNlpPrimalIntegralAlpha () const -> double
  Get the value for control NlpPrimalIntegralAlpha.
 
auto  getNlpPrimalIntegralRef () const -> double
  Get the value for control NlpPrimalIntegralRef.
 
auto  getNlpProbing () const -> int
  Get the value for control NlpProbing.
 
auto  getNlpReformulate () const -> int
  Get the value for control NlpReformulate.
 
auto  getNlpSolver () const -> int
  Get the value for control NlpSolver.
 
auto  getNlpStopOutOfRange () const -> int
  Get the value for control NlpStopOutOfRange.
 
auto  getNlpThreads () const -> int
  Get the value for control NlpThreads.
 
auto  getNlpThreadSafeUserFunc () const -> int
  Get the value for control NlpThreadSafeUserFunc.
 
auto  getNlpValidationFactor () const -> double
  Get the value for control NlpValidationFactor.
 
auto  getNlpValidationTarget_K () const -> double
  Get the value for control NlpValidationTarget_K.
 
auto  getNlpValidationTarget_R () const -> double
  Get the value for control NlpValidationTarget_R.
 
auto  getNlpValidationTol_A () const -> double
  Get the value for control NlpValidationTol_A.
 
auto  getNlpValidationTol_K () const -> double
  Get the value for control NlpValidationTol_K.
 
auto  getNlpValidationTol_R () const -> double
  Get the value for control NlpValidationTol_R.
 
auto  getNlpZero () const -> double
  Get the value for control NlpZero.
 
auto  getNodeProbingEffort () const -> double
  Get the value for control NodeProbingEffort.
 
auto  getNodeSelection () const -> int
  Get the value for control NodeSelection.
 
auto  getNumericalEmphasis () const -> int
  Get the value for control NumericalEmphasis.
 
auto  getObjScaleFactor () const -> int
  Get the value for control ObjScaleFactor.
 
auto  getOptimalityTol () const -> double
  Get the value for control OptimalityTol.
 
auto  getOptimalityTolTarget () const -> double
  Get the value for control OptimalityTolTarget.
 
auto  getOutputControls () const -> int
  Get the value for control OutputControls.
 
auto  getOutputLog () const -> int
  Get the value for control OutputLog.
 
auto  getOutputMask () const -> std::string
  Get the value for control OutputMask.
 
auto  getOutputTol () const -> double
  Get the value for control OutputTol.
 
auto  getPenalty () const -> double
  Get the value for control Penalty.
 
auto  getPivotTol () const -> double
  Get the value for control PivotTol.
 
auto  getPPFactor () const -> double
  Get the value for control PPFactor.
 
auto  getPreAnalyticcenter () const -> int
  Get the value for control PreAnalyticcenter.
 
auto  getPreBasisRed () const -> int
  Get the value for control PreBasisRed.
 
auto  getPreBndRedCone () const -> int
  Get the value for control PreBndRedCone.
 
auto  getPreBndRedQuad () const -> int
  Get the value for control PreBndRedQuad.
 
auto  getPreCliqueStrategy () const -> int
  Get the value for control PreCliqueStrategy.
 
auto  getPreCoefElim () const -> int
  Get the value for control PreCoefElim.
 
auto  getPreComponents () const -> int
  Get the value for control PreComponents.
 
auto  getPreComponentsEffort () const -> double
  Get the value for control PreComponentsEffort.
 
auto  getPreConeDecomp () const -> int
  Get the value for control PreConeDecomp.
 
auto  getPreConfiguration () const -> int
  Get the value for control PreConfiguration.
 
auto  getPreConvertObjToCons () const -> int
  Get the value for control PreConvertObjToCons.
 
auto  getPreConvertSeparable () const -> int
  Get the value for control PreConvertSeparable.
 
auto  getPreDomCol () const -> int
  Get the value for control PreDomCol.
 
auto  getPreDomRow () const -> int
  Get the value for control PreDomRow.
 
auto  getPreDupRow () const -> int
  Get the value for control PreDupRow.
 
auto  getPreElimQuad () const -> int
  Get the value for control PreElimQuad.
 
auto  getPreFolding () const -> int
  Get the value for control PreFolding.
 
auto  getPreImplications () const -> int
  Get the value for control PreImplications.
 
auto  getPreLinDep () const -> int
  Get the value for control PreLinDep.
 
auto  getPreObjCutDetect () const -> int
  Get the value for control PreObjCutDetect.
 
auto  getPrePermute () const -> int
  Get the value for control PrePermute.
 
auto  getPrePermuteSeed () const -> int
  Get the value for control PrePermuteSeed.
 
auto  getPreProbing () const -> int
  Get the value for control PreProbing.
 
auto  getPreProtectDual () const -> int
  Get the value for control PreProtectDual.
 
auto  getPresolve () const -> int
  Get the value for control Presolve.
 
auto  getPresolveMaxGrow () const -> double
  Get the value for control PresolveMaxGrow.
 
auto  getPresolveOps () const -> int
  Get the value for control PresolveOps.
 
auto  getPresolvePasses () const -> int
  Get the value for control PresolvePasses.
 
auto  getPreSort () const -> int
  Get the value for control PreSort.
 
auto  getPricingAlg () const -> int
  Get the value for control PricingAlg.
 
auto  getPrimalOps () const -> int
  Get the value for control PrimalOps.
 
auto  getPrimalPerturb () const -> double
  Get the value for control PrimalPerturb.
 
auto  getPrimalUnshift () const -> int
  Get the value for control PrimalUnshift.
 
auto  getPseudoCost () const -> double
  Get the value for control PseudoCost.
 
auto  getPwlDualReductions () const -> int
  Get the value for control PwlDualReductions.
 
auto  getPwlNonConvexTransformation () const -> int
  Get the value for control PwlNonConvexTransformation.
 
auto  getQCCuts () const -> int
  Get the value for control QCCuts.
 
auto  getQCRootAlg () const -> int
  Get the value for control QCRootAlg.
 
auto  getQSimplexOps () const -> int
  Get the value for control QSimplexOps.
 
auto  getQuadraticUnshift () const -> int
  Get the value for control QuadraticUnshift.
 
auto  getRandomSeed () const -> int
  Get the value for control RandomSeed.
 
auto  getRefactor () const -> int
  Get the value for control Refactor.
 
auto  getRefineOps () const -> int
  Get the value for control RefineOps.
 
auto  getRelaxTreeMemoryLimit () const -> double
  Get the value for control RelaxTreeMemoryLimit.
 
auto  getRelPivotTol () const -> double
  Get the value for control RelPivotTol.
 
auto  getRepairIndefiniteQ () const -> xpress::RepairIndefiniteQuadratic
  Get the value for control RepairIndefiniteQ.
 
auto  getRepairIndefiniteQMax () const -> double
  Get the value for control RepairIndefiniteQMax.
 
auto  getRepairInfeasMaxTime () const -> int
  Get the value for control RepairInfeasMaxTime.
 
auto  getRepairInfeasTimeLimit () const -> double
  Get the value for control RepairInfeasTimeLimit.
 
auto  getResourceStrategy () const -> int
  Get the value for control ResourceStrategy.
 
auto  getRLTCuts () const -> int
  Get the value for control RLTCuts.
 
auto  getRootPresolve () const -> int
  Get the value for control RootPresolve.
 
auto  getSBBest () const -> int
  Get the value for control SBBest.
 
auto  getSbEffort () const -> double
  Get the value for control SbEffort.
 
auto  getSBEstimate () const -> int
  Get the value for control SBEstimate.
 
auto  getSBIterLimit () const -> int
  Get the value for control SBIterLimit.
 
auto  getSBSelect () const -> int
  Get the value for control SBSelect.
 
auto  getScaling () const -> int
  Get the value for control Scaling.
 
auto  getSerializePreIntSol () const -> int
  Get the value for control SerializePreIntSol.
 
auto  getSifting () const -> int
  Get the value for control Sifting.
 
auto  getSiftPasses () const -> int
  Get the value for control SiftPasses.
 
auto  getSiftPresolveOps () const -> int
  Get the value for control SiftPresolveOps.
 
auto  getSiftSwitch () const -> int
  Get the value for control SiftSwitch.
 
auto  getSleepOnThreadWait () const -> int
  Get the value for control SleepOnThreadWait.
 
auto  getSlpAlgorithm () const -> int
  Get the value for control SlpAlgorithm.
 
auto  getSlpAnalyze () const -> int
  Get the value for control SlpAnalyze.
 
auto  getSlpATol_A () const -> double
  Get the value for control SlpATol_A.
 
auto  getSlpATol_R () const -> double
  Get the value for control SlpATol_R.
 
auto  getSlpAugmentation () const -> int
  Get the value for control SlpAugmentation.
 
auto  getSlpAutoSave () const -> int
  Get the value for control SlpAutoSave.
 
auto  getSlpBarCrossoverStart () const -> int
  Get the value for control SlpBarCrossoverStart.
 
auto  getSlpBarLimit () const -> int
  Get the value for control SlpBarLimit.
 
auto  getSlpBarStallingLimit () const -> int
  Get the value for control SlpBarStallingLimit.
 
auto  getSlpBarStallingObjLimit () const -> int
  Get the value for control SlpBarStallingObjLimit.
 
auto  getSlpBarStallingTol () const -> double
  Get the value for control SlpBarStallingTol.
 
auto  getSlpBarStartOps () const -> int
  Get the value for control SlpBarStartOps.
 
auto  getSlpBoundThreshold () const -> double
  Get the value for control SlpBoundThreshold.
 
auto  getSlpCascade () const -> int
  Get the value for control SlpCascade.
 
auto  getSlpCascadeNLimit () const -> int
  Get the value for control SlpCascadeNLimit.
 
auto  getSlpCascadeTol_PA () const -> double
  Get the value for control SlpCascadeTol_PA.
 
auto  getSlpCascadeTol_PR () const -> double
  Get the value for control SlpCascadeTol_PR.
 
auto  getSlpCDTol_A () const -> double
  Get the value for control SlpCDTol_A.
 
auto  getSlpCDTol_R () const -> double
  Get the value for control SlpCDTol_R.
 
auto  getSlpClampShrink () const -> double
  Get the value for control SlpClampShrink.
 
auto  getSlpClampValidationTol_A () const -> double
  Get the value for control SlpClampValidationTol_A.
 
auto  getSlpClampValidationTol_R () const -> double
  Get the value for control SlpClampValidationTol_R.
 
auto  getSlpConvergenceOps () const -> int
  Get the value for control SlpConvergenceOps.
 
auto  getSlpCTol () const -> double
  Get the value for control SlpCTol.
 
auto  getSlpCutStrategy () const -> int
  Get the value for control SlpCutStrategy.
 
auto  getSlpDamp () const -> double
  Get the value for control SlpDamp.
 
auto  getSlpDampExpand () const -> double
  Get the value for control SlpDampExpand.
 
auto  getSlpDampMax () const -> double
  Get the value for control SlpDampMax.
 
auto  getSlpDampMin () const -> double
  Get the value for control SlpDampMin.
 
auto  getSlpDampShrink () const -> double
  Get the value for control SlpDampShrink.
 
auto  getSlpDampStart () const -> int
  Get the value for control SlpDampStart.
 
auto  getSlpDefaultStepBound () const -> double
  Get the value for control SlpDefaultStepBound.
 
auto  getSlpDelayUpdateRows () const -> int
  Get the value for control SlpDelayUpdateRows.
 
auto  getSlpDelta_A () const -> double
  Get the value for control SlpDelta_A.
 
auto  getSlpDelta_Infinity () const -> double
  Get the value for control SlpDelta_Infinity.
 
auto  getSlpDelta_R () const -> double
  Get the value for control SlpDelta_R.
 
auto  getSlpDelta_X () const -> double
  Get the value for control SlpDelta_X.
 
auto  getSlpDelta_Z () const -> double
  Get the value for control SlpDelta_Z.
 
auto  getSlpDelta_Zero () const -> double
  Get the value for control SlpDelta_Zero.
 
auto  getSlpDeltaCost () const -> double
  Get the value for control SlpDeltaCost.
 
auto  getSlpDeltaCostFactor () const -> double
  Get the value for control SlpDeltaCostFactor.
 
auto  getSlpDeltaMaxCost () const -> double
  Get the value for control SlpDeltaMaxCost.
 
auto  getSlpDeltaOffset () const -> int
  Get the value for control SlpDeltaOffset.
 
auto  getSlpDeltaZLimit () const -> int
  Get the value for control SlpDeltaZLimit.
 
auto  getSlpDJTol () const -> double
  Get the value for control SlpDJTol.
 
auto  getSlpDRColDjTol () const -> double
  Get the value for control SlpDRColDjTol.
 
auto  getSlpDRColTol () const -> double
  Get the value for control SlpDRColTol.
 
auto  getSlpDRFixRange () const -> double
  Get the value for control SlpDRFixRange.
 
auto  getSlpECFCheck () const -> int
  Get the value for control SlpECFCheck.
 
auto  getSlpEcfTol_A () const -> double
  Get the value for control SlpEcfTol_A.
 
auto  getSlpEcfTol_R () const -> double
  Get the value for control SlpEcfTol_R.
 
auto  getSlpEnforceCostShrink () const -> double
  Get the value for control SlpEnforceCostShrink.
 
auto  getSlpEnforceMaxCost () const -> double
  Get the value for control SlpEnforceMaxCost.
 
auto  getSlpErrorCost () const -> double
  Get the value for control SlpErrorCost.
 
auto  getSlpErrorCostFactor () const -> double
  Get the value for control SlpErrorCostFactor.
 
auto  getSlpErrorMaxCost () const -> double
  Get the value for control SlpErrorMaxCost.
 
auto  getSlpErrorOffset () const -> int
  Get the value for control SlpErrorOffset.
 
auto  getSlpErrorTol_A () const -> double
  Get the value for control SlpErrorTol_A.
 
auto  getSlpErrorTol_P () const -> double
  Get the value for control SlpErrorTol_P.
 
auto  getSlpEscalation () const -> double
  Get the value for control SlpEscalation.
 
auto  getSlpETol_A () const -> double
  Get the value for control SlpETol_A.
 
auto  getSlpETol_R () const -> double
  Get the value for control SlpETol_R.
 
auto  getSlpEVTol_A () const -> double
  Get the value for control SlpEVTol_A.
 
auto  getSlpEVTol_R () const -> double
  Get the value for control SlpEVTol_R.
 
auto  getSlpExpand () const -> double
  Get the value for control SlpExpand.
 
auto  getSlpFeastolTarget () const -> double
  Get the value for control SlpFeastolTarget.
 
auto  getSlpFilter () const -> int
  Get the value for control SlpFilter.
 
auto  getSlpGranularity () const -> double
  Get the value for control SlpGranularity.
 
auto  getSlpGridHeurSelect () const -> int
  Get the value for control SlpGridHeurSelect.
 
auto  getSlpHeurStrategy () const -> int
  Get the value for control SlpHeurStrategy.
 
auto  getSlpInfeasLimit () const -> int
  Get the value for control SlpInfeasLimit.
 
auto  getSlpIterLimit () const -> int
  Get the value for control SlpIterLimit.
 
auto  getSlpItol_A () const -> double
  Get the value for control SlpItol_A.
 
auto  getSlpITol_R () const -> double
  Get the value for control SlpITol_R.
 
auto  getSlpLSIterLimit () const -> int
  Get the value for control SlpLSIterLimit.
 
auto  getSlpLSPatternLimit () const -> int
  Get the value for control SlpLSPatternLimit.
 
auto  getSlpLSStart () const -> int
  Get the value for control SlpLSStart.
 
auto  getSlpLSZeroLimit () const -> int
  Get the value for control SlpLSZeroLimit.
 
auto  getSlpMatrixTol () const -> double
  Get the value for control SlpMatrixTol.
 
auto  getSlpMaxWeight () const -> double
  Get the value for control SlpMaxWeight.
 
auto  getSlpMinSBFactor () const -> double
  Get the value for control SlpMinSBFactor.
 
auto  getSlpMinWeight () const -> double
  Get the value for control SlpMinWeight.
 
auto  getSlpMipAlgorithm () const -> int
  Get the value for control SlpMipAlgorithm.
 
auto  getSlpMipCutoff_A () const -> double
  Get the value for control SlpMipCutoff_A.
 
auto  getSlpMipCutoff_R () const -> double
  Get the value for control SlpMipCutoff_R.
 
auto  getSlpMipCutOffCount () const -> int
  Get the value for control SlpMipCutOffCount.
 
auto  getSlpMipCutoffLimit () const -> int
  Get the value for control SlpMipCutoffLimit.
 
auto  getSlpMipDefaultAlgorithm () const -> int
  Get the value for control SlpMipDefaultAlgorithm.
 
auto  getSlpMipErrorTol_A () const -> double
  Get the value for control SlpMipErrorTol_A.
 
auto  getSlpMipErrorTol_R () const -> double
  Get the value for control SlpMipErrorTol_R.
 
auto  getSlpMipFixStepBounds () const -> int
  Get the value for control SlpMipFixStepBounds.
 
auto  getSlpMipIterLimit () const -> int
  Get the value for control SlpMipIterLimit.
 
auto  getSlpMipLog () const -> int
  Get the value for control SlpMipLog.
 
auto  getSlpMipOCount () const -> int
  Get the value for control SlpMipOCount.
 
auto  getSlpMipOtol_A () const -> double
  Get the value for control SlpMipOtol_A.
 
auto  getSlpMipOtol_R () const -> double
  Get the value for control SlpMipOtol_R.
 
auto  getSlpMipRelaxStepBounds () const -> int
  Get the value for control SlpMipRelaxStepBounds.
 
auto  getSlpMTol_A () const -> double
  Get the value for control SlpMTol_A.
 
auto  getSlpMTol_R () const -> double
  Get the value for control SlpMTol_R.
 
auto  getSlpMVTol () const -> double
  Get the value for control SlpMVTol.
 
auto  getSlpObjThreshold () const -> double
  Get the value for control SlpObjThreshold.
 
auto  getSlpObjToPenaltyCost () const -> double
  Get the value for control SlpObjToPenaltyCost.
 
auto  getSlpOCount () const -> int
  Get the value for control SlpOCount.
 
auto  getSlpOptimalityTolTarget () const -> double
  Get the value for control SlpOptimalityTolTarget.
 
auto  getSlpOTol_A () const -> double
  Get the value for control SlpOTol_A.
 
auto  getSlpOTol_R () const -> double
  Get the value for control SlpOTol_R.
 
auto  getSlpPenaltyInfoStart () const -> int
  Get the value for control SlpPenaltyInfoStart.
 
auto  getSlpSameCount () const -> int
  Get the value for control SlpSameCount.
 
auto  getSlpSameDamp () const -> int
  Get the value for control SlpSameDamp.
 
auto  getSlpSBRowOffset () const -> int
  Get the value for control SlpSBRowOffset.
 
auto  getSlpSBStart () const -> int
  Get the value for control SlpSBStart.
 
auto  getSlpShrink () const -> double
  Get the value for control SlpShrink.
 
auto  getSlpShrinkBias () const -> double
  Get the value for control SlpShrinkBias.
 
auto  getSlpSTol_A () const -> double
  Get the value for control SlpSTol_A.
 
auto  getSlpSTol_R () const -> double
  Get the value for control SlpSTol_R.
 
auto  getSlpTraceMaskOps () const -> int
  Get the value for control SlpTraceMaskOps.
 
auto  getSlpUnFinishedLimit () const -> int
  Get the value for control SlpUnFinishedLimit.
 
auto  getSlpUpdateOffset () const -> int
  Get the value for control SlpUpdateOffset.
 
auto  getSlpVCount () const -> int
  Get the value for control SlpVCount.
 
auto  getSlpVLimit () const -> int
  Get the value for control SlpVLimit.
 
auto  getSlpVTol_A () const -> double
  Get the value for control SlpVTol_A.
 
auto  getSlpVTol_R () const -> double
  Get the value for control SlpVTol_R.
 
auto  getSlpWCount () const -> int
  Get the value for control SlpWCount.
 
auto  getSlpWTol_A () const -> double
  Get the value for control SlpWTol_A.
 
auto  getSlpWTol_R () const -> double
  Get the value for control SlpWTol_R.
 
auto  getSlpXCount () const -> int
  Get the value for control SlpXCount.
 
auto  getSlpXLimit () const -> int
  Get the value for control SlpXLimit.
 
auto  getSlpXTol_A () const -> double
  Get the value for control SlpXTol_A.
 
auto  getSlpXTol_R () const -> double
  Get the value for control SlpXTol_R.
 
auto  getSlpZeroCriterion () const -> int
  Get the value for control SlpZeroCriterion.
 
auto  getSlpZeroCriterionCount () const -> int
  Get the value for control SlpZeroCriterionCount.
 
auto  getSlpZeroCriterionStart () const -> int
  Get the value for control SlpZeroCriterionStart.
 
auto  getSolTimeLimit () const -> double
  Get the value for control SolTimeLimit.
 
auto  getSosRefTol () const -> double
  Get the value for control SosRefTol.
 
auto  getSymmetry () const -> int
  Get the value for control Symmetry.
 
auto  getSymSelect () const -> int
  Get the value for control SymSelect.
 
auto  getThreads () const -> int
  Get the value for control Threads.
 
auto  getTimeLimit () const -> double
  Get the value for control TimeLimit.
 
auto  getTrace () const -> int
  Get the value for control Trace.
 
auto  getTreeCompression () const -> int
  Get the value for control TreeCompression.
 
auto  getTreeCoverCuts () const -> int
  Get the value for control TreeCoverCuts.
 
auto  getTreeCutSelect () const -> int
  Get the value for control TreeCutSelect.
 
auto  getTreeDiagnostics () const -> int
  Get the value for control TreeDiagnostics.
 
auto  getTreeFileLogInterval () const -> int
  Get the value for control TreeFileLogInterval.
 
auto  getTreeGomCuts () const -> int
  Get the value for control TreeGomCuts.
 
auto  getTreeMemoryLimit () const -> int
  Get the value for control TreeMemoryLimit.
 
auto  getTreeMemorySavingTarget () const -> double
  Get the value for control TreeMemorySavingTarget.
 
auto  getTreeQCCuts () const -> int
  Get the value for control TreeQCCuts.
 
auto  getTunerHistory () const -> xpress::TunerHistory
  Get the value for control TunerHistory.
 
auto  getTunerMaxTime () const -> double
  Get the value for control TunerMaxTime.
 
auto  getTunerMethod () const -> xpress::TunerMethod
  Get the value for control TunerMethod.
 
auto  getTunerMethodFile () const -> std::string
  Get the value for control TunerMethodFile.
 
auto  getTunerMode () const -> xpress::TunerMode
  Get the value for control TunerMode.
 
auto  getTunerOutput () const -> int
  Get the value for control TunerOutput.
 
auto  getTunerOutputPath () const -> std::string
  Get the value for control TunerOutputPath.
 
auto  getTunerPermute () const -> int
  Get the value for control TunerPermute.
 
auto  getTunerSessionName () const -> std::string
  Get the value for control TunerSessionName.
 
auto  getTunerTarget () const -> xpress::TunerTarget
  Get the value for control TunerTarget.
 
auto  getTunerThreads () const -> int
  Get the value for control TunerThreads.
 
auto  getTunerVerbose () const -> int
  Get the value for control TunerVerbose.
 
auto  getUserSolHeuristic () const -> int
  Get the value for control UserSolHeuristic.
 
auto  getVarSelection () const -> int
  Get the value for control VarSelection.
 
auto  getVersion () const -> int
  Get the value for control Version.
 
void  setAlgAfterCrossOver (int newValue)
  Set control AlgAfterCrossOver.
 
void  setAlgAfterNetwork (int newValue)
  Set control AlgAfterNetwork.
 
void  setAlternativeRedCosts (int newValue)
  Set control AlternativeRedCosts.
 
void  setAutoCutting (int newValue)
  Set control AutoCutting.
 
void  setAutoPerturb (int newValue)
  Set control AutoPerturb.
 
void  setAutoScaling (int newValue)
  Set control AutoScaling.
 
void  setBackgroundMaxThreads (int newValue)
  Set control BackgroundMaxThreads.
 
void  setBackgroundSelect (XPRSint64 newValue)
  Set control BackgroundSelect.
 
void  setBackTrack (int newValue)
  Set control BackTrack.
 
void  setBacktrackTie (int newValue)
  Set control BacktrackTie.
 
void  setBarAlg (int newValue)
  Set control BarAlg.
 
void  setBarCores (int newValue)
  Set control BarCores.
 
void  setBarCrash (int newValue)
  Set control BarCrash.
 
void  setBarDualStop (double newValue)
  Set control BarDualStop.
 
void  setBarFailIterLimit (int newValue)
  Set control BarFailIterLimit.
 
void  setBarFreeScale (double newValue)
  Set control BarFreeScale.
 
void  setBarGapStop (double newValue)
  Set control BarGapStop.
 
void  setBarGapTarget (double newValue)
  Set control BarGapTarget.
 
void  setBarhgExtrapolate (double newValue)
  Set control BarhgExtrapolate.
 
void  setBarhgMaxRestarts (int newValue)
  Set control BarhgMaxRestarts.
 
void  setBarhgOps (xpress::BARHGOps newValue)
  Set control BarhgOps.
 
void  setBarIndefLimit (int newValue)
  Set control BarIndefLimit.
 
void  setBarIterLimit (int newValue)
  Set control BarIterLimit.
 
void  setBarKernel (double newValue)
  Set control BarKernel.
 
void  setBarLargeBound (double newValue)
  Set control BarLargeBound.
 
void  setBarNumStability (int newValue)
  Set control BarNumStability.
 
void  setBarObjPerturb (double newValue)
  Set control BarObjPerturb.
 
void  setBarObjScale (double newValue)
  Set control BarObjScale.
 
void  setBarOrder (xpress::BarOrder newValue)
  Set control BarOrder.
 
void  setBarOrderThreads (int newValue)
  Set control BarOrderThreads.
 
void  setBarOutput (int newValue)
  Set control BarOutput.
 
void  setBarPerturb (double newValue)
  Set control BarPerturb.
 
void  setBarPresolveOps (int newValue)
  Set control BarPresolveOps.
 
void  setBarPrimalStop (double newValue)
  Set control BarPrimalStop.
 
void  setBarRefIter (int newValue)
  Set control BarRefIter.
 
void  setBarRegularize (int newValue)
  Set control BarRegularize.
 
void  setBarRhsScale (double newValue)
  Set control BarRhsScale.
 
void  setBarSolution (int newValue)
  Set control BarSolution.
 
void  setBarStart (int newValue)
  Set control BarStart.
 
void  setBarStartWeight (double newValue)
  Set control BarStartWeight.
 
void  setBarStepStop (double newValue)
  Set control BarStepStop.
 
void  setBarThreads (int newValue)
  Set control BarThreads.
 
void  setBigM (double newValue)
  Set control BigM.
 
void  setBigmMethod (int newValue)
  Set control BigmMethod.
 
void  setBranchChoice (int newValue)
  Set control BranchChoice.
 
void  setBranchDisj (int newValue)
  Set control BranchDisj.
 
void  setBranchStructural (int newValue)
  Set control BranchStructural.
 
void  setBreadthFirst (int newValue)
  Set control BreadthFirst.
 
void  setCacheSize (int newValue)
  Set control CacheSize.
 
void  setCallbackCheckTimeDelay (int newValue)
  Set control CallbackCheckTimeDelay.
 
void  setCallbackFromMasterThread (int newValue)
  Set control CallbackFromMasterThread.
 
void  setCheckInputData (int newValue)
  Set control CheckInputData.
 
void  setCholeskyAlg (int newValue)
  Set control CholeskyAlg.
 
void  setCholeskyTol (double newValue)
  Set control CholeskyTol.
 
void  setClamping (int newValue)
  Set control Clamping.
 
void  setCompute (int newValue)
  Set control Compute.
 
void  setComputeExecService (std::string const &newValue)
  Set control ComputeExecService.
 
void  setComputeJobPriority (int newValue)
  Set control ComputeJobPriority.
 
void  setComputeLog (xpress::ComputeLog newValue)
  Set control ComputeLog.
 
void  setConcurrentThreads (int newValue)
  Set control ConcurrentThreads.
 
void  setConflictCuts (int newValue)
  Set control ConflictCuts.
 
void  setCoresPerCPU (int newValue)
  Set control CoresPerCPU.
 
void  setCoverCuts (int newValue)
  Set control CoverCuts.
 
void  setCpiAlpha (double newValue)
  Set control CpiAlpha.
 
void  setCPUPlatform (int newValue)
  Set control CPUPlatform.
 
void  setCPUTime (int newValue)
  Set control CPUTime.
 
void  setCrash (int newValue)
  Set control Crash.
 
void  setCrossOver (int newValue)
  Set control CrossOver.
 
void  setCrossoverAccuracyTol (double newValue)
  Set control CrossoverAccuracyTol.
 
void  setCrossOverDRP (int newValue)
  Set control CrossOverDRP.
 
void  setCrossOverFeasWeight (double newValue)
  Set control CrossOverFeasWeight.
 
void  setCrossoverIterLimit (int newValue)
  Set control CrossoverIterLimit.
 
void  setCrossoverOps (int newValue)
  Set control CrossoverOps.
 
void  setCrossOverRelPivotTol (double newValue)
  Set control CrossOverRelPivotTol.
 
void  setCrossOverRelPivotTolSafe (double newValue)
  Set control CrossOverRelPivotTolSafe.
 
void  setCrossoverThreads (int newValue)
  Set control CrossoverThreads.
 
void  setCutDepth (int newValue)
  Set control CutDepth.
 
void  setCutFactor (double newValue)
  Set control CutFactor.
 
void  setCutFreq (int newValue)
  Set control CutFreq.
 
void  setCutSelect (int newValue)
  Set control CutSelect.
 
void  setCutStrategy (int newValue)
  Set control CutStrategy.
 
void  setDefaultAlg (xpress::DefaultAlg newValue)
  Set control DefaultAlg.
 
void  setDenseColLimit (int newValue)
  Set control DenseColLimit.
 
void  setDeterministic (int newValue)
  Set control Deterministic.
 
void  setDetLogFreq (double newValue)
  Set control DetLogFreq.
 
void  setDualGradient (int newValue)
  Set control DualGradient.
 
void  setDualize (int newValue)
  Set control Dualize.
 
void  setDualizeOps (int newValue)
  Set control DualizeOps.
 
void  setDualPerturb (double newValue)
  Set control DualPerturb.
 
void  setDualStrategy (int newValue)
  Set control DualStrategy.
 
void  setDualThreads (int newValue)
  Set control DualThreads.
 
void  setDummyControl (double newValue)
  Set control DummyControl.
 
void  setEigenValueTol (double newValue)
  Set control EigenValueTol.
 
void  setElimFillIn (int newValue)
  Set control ElimFillIn.
 
void  setElimTol (double newValue)
  Set control ElimTol.
 
void  setEscapeNames (int newValue)
  Set control EscapeNames.
 
void  setEtaTol (double newValue)
  Set control EtaTol.
 
void  setExtraCols (int newValue)
  Set control ExtraCols.
 
void  setExtraElems (XPRSint64 newValue)
  Set control ExtraElems.
 
void  setExtraMipEnts (int newValue)
  Set control ExtraMipEnts.
 
void  setExtraRows (int newValue)
  Set control ExtraRows.
 
void  setExtraSetElems (XPRSint64 newValue)
  Set control ExtraSetElems.
 
void  setExtraSets (int newValue)
  Set control ExtraSets.
 
void  setFeasibilityJump (int newValue)
  Set control FeasibilityJump.
 
void  setFeasibilityPump (int newValue)
  Set control FeasibilityPump.
 
void  setFeasTol (double newValue)
  Set control FeasTol.
 
void  setFeasTolPerturb (double newValue)
  Set control FeasTolPerturb.
 
void  setFeasTolTarget (double newValue)
  Set control FeasTolTarget.
 
void  setForceOutput (int newValue)
  Set control ForceOutput.
 
void  setForceParallelDual (int newValue)
  Set control ForceParallelDual.
 
void  setGenconsAbsTransformation (int newValue)
  Set control GenconsAbsTransformation.
 
void  setGenconsDualReductions (int newValue)
  Set control GenconsDualReductions.
 
void  setGlobalBoundingBox (double newValue)
  Set control GlobalBoundingBox.
 
void  setGlobalLSHeurstrategy (int newValue)
  Set control GlobalLSHeurstrategy.
 
void  setGlobalNlpCuts (int newValue)
  Set control GlobalNlpCuts.
 
void  setGlobalNumInitNlpCuts (int newValue)
  Set control GlobalNumInitNlpCuts.
 
void  setGlobalSpatialBranchCuttingEffort (double newValue)
  Set control GlobalSpatialBranchCuttingEffort.
 
void  setGlobalSpatialBranchIfPreferOrig (int newValue)
  Set control GlobalSpatialBranchIfPreferOrig.
 
void  setGlobalSpatialBranchPropagationEffort (double newValue)
  Set control GlobalSpatialBranchPropagationEffort.
 
void  setGlobalTreeNlpCuts (int newValue)
  Set control GlobalTreeNlpCuts.
 
void  setGomCuts (int newValue)
  Set control GomCuts.
 
void  setHeurBeforeLp (int newValue)
  Set control HeurBeforeLp.
 
void  setHeurDepth (int newValue)
  Set control HeurDepth.
 
void  setHeurDiveIterLimit (double newValue)
  Set control HeurDiveIterLimit.
 
void  setHeurDiveRandomize (double newValue)
  Set control HeurDiveRandomize.
 
void  setHeurDiveSoftRounding (int newValue)
  Set control HeurDiveSoftRounding.
 
void  setHeurDiveSpeedUp (int newValue)
  Set control HeurDiveSpeedUp.
 
void  setHeurDiveStrategy (int newValue)
  Set control HeurDiveStrategy.
 
void  setHeurEmphasis (int newValue)
  Set control HeurEmphasis.
 
void  setHeurForceSpecialObj (int newValue)
  Set control HeurForceSpecialObj.
 
void  setHeurFreq (int newValue)
  Set control HeurFreq.
 
void  setHeurMaxSol (int newValue)
  Set control HeurMaxSol.
 
void  setHeurNodes (int newValue)
  Set control HeurNodes.
 
void  setHeursearchBackgroundSelect (XPRSint64 newValue)
  Set control HeursearchBackgroundSelect.
 
void  setHeurSearchCopyControls (int newValue)
  Set control HeurSearchCopyControls.
 
void  setHeurSearchEffort (double newValue)
  Set control HeurSearchEffort.
 
void  setHeurSearchFreq (int newValue)
  Set control HeurSearchFreq.
 
void  setHeurSearchRootCutFreq (int newValue)
  Set control HeurSearchRootCutFreq.
 
void  setHeurSearchRootSelect (int newValue)
  Set control HeurSearchRootSelect.
 
void  setHeurSearchTargetSize (double newValue)
  Set control HeurSearchTargetSize.
 
void  setHeurSearchTreeSelect (int newValue)
  Set control HeurSearchTreeSelect.
 
void  setHeurSelect (int newValue)
  Set control HeurSelect.
 
void  setHeurShiftProp (int newValue)
  Set control HeurShiftProp.
 
void  setHeurThreads (int newValue)
  Set control HeurThreads.
 
void  setHistoryCosts (int newValue)
  Set control HistoryCosts.
 
void  setIfCheckConvexity (int newValue)
  Set control IfCheckConvexity.
 
void  setIgnoreContainerCpuLimit (int newValue)
  Set control IgnoreContainerCpuLimit.
 
void  setIgnoreContainerMemoryLimit (int newValue)
  Set control IgnoreContainerMemoryLimit.
 
void  setIISLog (int newValue)
  Set control IISLog.
 
void  setIISOps (xpress::IISOps newValue)
  Set control IISOps.
 
void  setIndLinBigM (double newValue)
  Set control IndLinBigM.
 
void  setIndPreLinBigM (double newValue)
  Set control IndPreLinBigM.
 
void  setInputtol (double newValue)
  Set control Inputtol.
 
void  setInvertFreq (int newValue)
  Set control InvertFreq.
 
void  setInvertMin (int newValue)
  Set control InvertMin.
 
void  setIOTimeout (int newValue)
  Set control IOTimeout.
 
void  setKeepBasis (int newValue)
  Set control KeepBasis.
 
void  setKeepNRows (int newValue)
  Set control KeepNRows.
 
void  setKnitroParamAlgorithm (int newValue)
  Set control KnitroParamAlgorithm.
 
void  setKnitroParamBarDirectInterval (int newValue)
  Set control KnitroParamBarDirectInterval.
 
void  setKnitroParamBarFeasible (int newValue)
  Set control KnitroParamBarFeasible.
 
void  setKnitroParamBarFeasModeTol (double newValue)
  Set control KnitroParamBarFeasModeTol.
 
void  setKnitroParamBarInitMu (double newValue)
  Set control KnitroParamBarInitMu.
 
void  setKnitroParamBarInitPt (int newValue)
  Set control KnitroParamBarInitPt.
 
void  setKnitroParamBarMaxBacktrack (int newValue)
  Set control KnitroParamBarMaxBacktrack.
 
void  setKnitroParamBarMaxRefactor (int newValue)
  Set control KnitroParamBarMaxRefactor.
 
void  setKnitroParamBarMuRule (int newValue)
  Set control KnitroParamBarMuRule.
 
void  setKnitroParamBarPenCons (int newValue)
  Set control KnitroParamBarPenCons.
 
void  setKnitroParamBarPenRule (int newValue)
  Set control KnitroParamBarPenRule.
 
void  setKnitroParamBarRelaxCons (int newValue)
  Set control KnitroParamBarRelaxCons.
 
void  setKnitroParamBarSwitchRule (int newValue)
  Set control KnitroParamBarSwitchRule.
 
void  setKnitroParamBLASOption (int newValue)
  Set control KnitroParamBLASOption.
 
void  setKnitroParamDebug (int newValue)
  Set control KnitroParamDebug.
 
void  setKnitroParamDelta (double newValue)
  Set control KnitroParamDelta.
 
void  setKnitroParamFeastol (double newValue)
  Set control KnitroParamFeastol.
 
void  setKnitroParamFeasTolAbs (double newValue)
  Set control KnitroParamFeasTolAbs.
 
void  setKnitroParamGradOpt (int newValue)
  Set control KnitroParamGradOpt.
 
void  setKnitroParamHessOpt (int newValue)
  Set control KnitroParamHessOpt.
 
void  setKnitroParamHonorBbnds (int newValue)
  Set control KnitroParamHonorBbnds.
 
void  setKnitroParamInfeasTol (double newValue)
  Set control KnitroParamInfeasTol.
 
void  setKnitroParamLinSolver (int newValue)
  Set control KnitroParamLinSolver.
 
void  setKnitroParamLMSize (int newValue)
  Set control KnitroParamLMSize.
 
void  setKnitroParamMATerminate (int newValue)
  Set control KnitroParamMATerminate.
 
void  setKnitroParamMaxCGIt (int newValue)
  Set control KnitroParamMaxCGIt.
 
void  setKnitroParamMaxCrossIt (int newValue)
  Set control KnitroParamMaxCrossIt.
 
void  setKnitroParamMaxIt (int newValue)
  Set control KnitroParamMaxIt.
 
void  setKnitroParamMipBranchRule (int newValue)
  Set control KnitroParamMipBranchRule.
 
void  setKnitroParamMipDebug (int newValue)
  Set control KnitroParamMipDebug.
 
void  setKnitroParamMipGUBBranch (int newValue)
  Set control KnitroParamMipGUBBranch.
 
void  setKnitroParamMipHeuristic (int newValue)
  Set control KnitroParamMipHeuristic.
 
void  setKnitroParamMipHeurMaxIt (int newValue)
  Set control KnitroParamMipHeurMaxIt.
 
void  setKnitroParamMipImplicatns (int newValue)
  Set control KnitroParamMipImplicatns.
 
void  setKnitroParamMipIntGapAbs (double newValue)
  Set control KnitroParamMipIntGapAbs.
 
void  setKnitroParamMipIntGapRel (double newValue)
  Set control KnitroParamMipIntGapRel.
 
void  setKnitroParamMipKnapsack (int newValue)
  Set control KnitroParamMipKnapsack.
 
void  setKnitroParamMipLpAlg (int newValue)
  Set control KnitroParamMipLpAlg.
 
void  setKnitroParamMipMaxNodes (int newValue)
  Set control KnitroParamMipMaxNodes.
 
void  setKnitroParamMipMethod (int newValue)
  Set control KnitroParamMipMethod.
 
void  setKnitroParamMipOutInterval (int newValue)
  Set control KnitroParamMipOutInterval.
 
void  setKnitroParamMipOutLevel (int newValue)
  Set control KnitroParamMipOutLevel.
 
void  setKnitroParamMipPseudoint (int newValue)
  Set control KnitroParamMipPseudoint.
 
void  setKnitroParamMipRootAlg (int newValue)
  Set control KnitroParamMipRootAlg.
 
void  setKnitroParamMipRounding (int newValue)
  Set control KnitroParamMipRounding.
 
void  setKnitroParamMipSelectRule (int newValue)
  Set control KnitroParamMipSelectRule.
 
void  setKnitroParamMipStringMaxIt (int newValue)
  Set control KnitroParamMipStringMaxIt.
 
void  setKnitroParamMipStrongCandLim (int newValue)
  Set control KnitroParamMipStrongCandLim.
 
void  setKnitroParamMipStrongLevel (int newValue)
  Set control KnitroParamMipStrongLevel.
 
void  setKnitroParamMsMaxBndRange (double newValue)
  Set control KnitroParamMsMaxBndRange.
 
void  setKnitroParamMSMaxSolves (int newValue)
  Set control KnitroParamMSMaxSolves.
 
void  setKnitroParamMSNumToSave (int newValue)
  Set control KnitroParamMSNumToSave.
 
void  setKnitroParamMSSaveTol (double newValue)
  Set control KnitroParamMSSaveTol.
 
void  setKnitroParamMSSeed (int newValue)
  Set control KnitroParamMSSeed.
 
void  setKnitroParamMSStartPtRange (double newValue)
  Set control KnitroParamMSStartPtRange.
 
void  setKnitroParamMSTerminate (int newValue)
  Set control KnitroParamMSTerminate.
 
void  setKnitroParamMultiStart (int newValue)
  Set control KnitroParamMultiStart.
 
void  setKnitroParamNewPoint (int newValue)
  Set control KnitroParamNewPoint.
 
void  setKnitroParamObjRange (double newValue)
  Set control KnitroParamObjRange.
 
void  setKnitroParamOptTol (double newValue)
  Set control KnitroParamOptTol.
 
void  setKnitroParamOptTolAbs (double newValue)
  Set control KnitroParamOptTolAbs.
 
void  setKnitroParamOutLev (int newValue)
  Set control KnitroParamOutLev.
 
void  setKnitroParamParNumThreads (int newValue)
  Set control KnitroParamParNumThreads.
 
void  setKnitroParamPivot (double newValue)
  Set control KnitroParamPivot.
 
void  setKnitroParamPresolve (int newValue)
  Set control KnitroParamPresolve.
 
void  setKnitroParamPresolveTol (double newValue)
  Set control KnitroParamPresolveTol.
 
void  setKnitroParamScale (int newValue)
  Set control KnitroParamScale.
 
void  setKnitroParamSOC (int newValue)
  Set control KnitroParamSOC.
 
void  setKnitroParamXTol (double newValue)
  Set control KnitroParamXTol.
 
void  setL1Cache (int newValue)
  Set control L1Cache.
 
void  setLNPBest (int newValue)
  Set control LNPBest.
 
void  setLNPIterLimit (int newValue)
  Set control LNPIterLimit.
 
void  setLocalBacktrack (int newValue)
  Set control LocalBacktrack.
 
void  setLocalChoice (int newValue)
  Set control LocalChoice.
 
void  setLocalSolver (int newValue)
  Set control LocalSolver.
 
void  setLpFlags (xpress::LPFlags newValue)
  Set control LpFlags.
 
void  setLpFolding (int newValue)
  Set control LpFolding.
 
void  setLpIterLimit (int newValue)
  Set control LpIterLimit.
 
void  setLpLog (int newValue)
  Set control LpLog.
 
void  setLpLogDelay (double newValue)
  Set control LpLogDelay.
 
void  setLpLogStyle (int newValue)
  Set control LpLogStyle.
 
void  setLpRefineIterLimit (int newValue)
  Set control LpRefineIterLimit.
 
void  setLUPivotTol (double newValue)
  Set control LUPivotTol.
 
void  setMarkowitzTol (double newValue)
  Set control MarkowitzTol.
 
void  setMatrixTol (double newValue)
  Set control MatrixTol.
 
void  setMaxChecksOnMaxCutTime (int newValue)
  Set control MaxChecksOnMaxCutTime.
 
void  setMaxChecksOnMaxTime (int newValue)
  Set control MaxChecksOnMaxTime.
 
void  setMaxCutTime (double newValue)
  Set control MaxCutTime.
 
void  setMaxIIS (int newValue)
  Set control MaxIIS.
 
void  setMaxImpliedBound (double newValue)
  Set control MaxImpliedBound.
 
void  setMaxLocalBacktrack (int newValue)
  Set control MaxLocalBacktrack.
 
void  setMaxMCoeffBufferElems (int newValue)
  Set control MaxMCoeffBufferElems.
 
void  setMaxMemoryHard (int newValue)
  Set control MaxMemoryHard.
 
void  setMaxMemorySoft (int newValue)
  Set control MaxMemorySoft.
 
void  setMaxMipSol (int newValue)
  Set control MaxMipSol.
 
void  setMaxMipTasks (int newValue)
  Set control MaxMipTasks.
 
void  setMaxNode (int newValue)
  Set control MaxNode.
 
void  setMaxPageLines (int newValue)
  Set control MaxPageLines.
 
void  setMaxScaleFactor (int newValue)
  Set control MaxScaleFactor.
 
void  setMaxStallTime (double newValue)
  Set control MaxStallTime.
 
void  setMaxTime (int newValue)
  Set control MaxTime.
 
void  setMaxTreeFileSize (int newValue)
  Set control MaxTreeFileSize.
 
void  setMCFCutStrategy (int newValue)
  Set control MCFCutStrategy.
 
void  setMipAbsCutoff (double newValue)
  Set control MipAbsCutoff.
 
void  setMipAbsGapNotify (double newValue)
  Set control MipAbsGapNotify.
 
void  setMipAbsGapNotifyBound (double newValue)
  Set control MipAbsGapNotifyBound.
 
void  setMipAbsGapNotifyObj (double newValue)
  Set control MipAbsGapNotifyObj.
 
void  setMipAbsStop (double newValue)
  Set control MipAbsStop.
 
void  setMipAddCutoff (double newValue)
  Set control MipAddCutoff.
 
void  setMipComponents (int newValue)
  Set control MipComponents.
 
void  setMipConcurrentNodes (int newValue)
  Set control MipConcurrentNodes.
 
void  setMipConcurrentSolves (int newValue)
  Set control MipConcurrentSolves.
 
void  setMipDualReductions (int newValue)
  Set control MipDualReductions.
 
void  setMipFracReduce (int newValue)
  Set control MipFracReduce.
 
void  setMipKappaFreq (int newValue)
  Set control MipKappaFreq.
 
void  setMipLog (int newValue)
  Set control MipLog.
 
void  setMipPresolve (int newValue)
  Set control MipPresolve.
 
void  setMipRampup (int newValue)
  Set control MipRampup.
 
void  setMipRefineIterLimit (int newValue)
  Set control MipRefineIterLimit.
 
void  setMipRelCutoff (double newValue)
  Set control MipRelCutoff.
 
void  setMipRelGapNotify (double newValue)
  Set control MipRelGapNotify.
 
void  setMipRelStop (double newValue)
  Set control MipRelStop.
 
void  setMipRestart (int newValue)
  Set control MipRestart.
 
void  setMipRestartFactor (double newValue)
  Set control MipRestartFactor.
 
void  setMipRestartGapThreshold (double newValue)
  Set control MipRestartGapThreshold.
 
void  setMipTerminationMethod (int newValue)
  Set control MipTerminationMethod.
 
void  setMipThreads (int newValue)
  Set control MipThreads.
 
void  setMipTol (double newValue)
  Set control MipTol.
 
void  setMipTolTarget (double newValue)
  Set control MipTolTarget.
 
void  setMIQCPAlg (int newValue)
  Set control MIQCPAlg.
 
void  setMps18Compatible (int newValue)
  Set control Mps18Compatible.
 
void  setMpsBoundName (std::string const &newValue)
  Set control MpsBoundName.
 
void  setMpsEcho (int newValue)
  Set control MpsEcho.
 
void  setMpsFormat (int newValue)
  Set control MpsFormat.
 
void  setMpsNameLength (int newValue)
  Set control MpsNameLength.
 
void  setMpsObjName (std::string const &newValue)
  Set control MpsObjName.
 
void  setMpsRangeName (std::string const &newValue)
  Set control MpsRangeName.
 
void  setMpsRhsName (std::string const &newValue)
  Set control MpsRhsName.
 
void  setMseCallbackCullSols_Diversity (int newValue)
  Set control MseCallbackCullSols_Diversity.
 
void  setMseCallbackCullSols_MipObject (int newValue)
  Set control MseCallbackCullSols_MipObject.
 
void  setMseCallbackCullSols_ModObject (int newValue)
  Set control MseCallbackCullSols_ModObject.
 
void  setMseOptimizeDiversity (int newValue)
  Set control MseOptimizeDiversity.
 
void  setMseOutputLog (int newValue)
  Set control MseOutputLog.
 
void  setMseOutputTol (double newValue)
  Set control MseOutputTol.
 
void  setMsMaxBoundRange (double newValue)
  Set control MsMaxBoundRange.
 
void  setMspDefaultUserSolFeasTol (double newValue)
  Set control MspDefaultUserSolFeasTol.
 
void  setMspDefaultUserSolMipTol (double newValue)
  Set control MspDefaultUserSolMipTol.
 
void  setMspDuplicateSolutionsPolicy (int newValue)
  Set control MspDuplicateSolutionsPolicy.
 
void  setMspEnableSlackStorage (int newValue)
  Set control MspEnableSlackStorage.
 
void  setMspIncludeProbNameInLogging (int newValue)
  Set control MspIncludeProbNameInLogging.
 
void  setMspOutputLog (int newValue)
  Set control MspOutputLog.
 
void  setMspSol_BitFieldsUsr (int newValue)
  Set control MspSol_BitFieldsUsr.
 
void  setMspSol_FeasTol (double newValue)
  Set control MspSol_FeasTol.
 
void  setMspSol_MipTol (double newValue)
  Set control MspSol_MipTol.
 
void  setMspWriteSlxSolLogging (int newValue)
  Set control MspWriteSlxSolLogging.
 
void  setMultiObjLog (int newValue)
  Set control MultiObjLog.
 
void  setMultiObjOps (int newValue)
  Set control MultiObjOps.
 
void  setMultiStart (int newValue)
  Set control MultiStart.
 
void  setMultiStart_Log (int newValue)
  Set control MultiStart_Log.
 
void  setMultiStart_MaxSolves (int newValue)
  Set control MultiStart_MaxSolves.
 
void  setMultiStart_MaxTime (int newValue)
  Set control MultiStart_MaxTime.
 
void  setMultiStart_PoolSize (int newValue)
  Set control MultiStart_PoolSize.
 
void  setMultiStart_Seed (int newValue)
  Set control MultiStart_Seed.
 
void  setMultiStart_Threads (int newValue)
  Set control MultiStart_Threads.
 
void  setMutexCallBacks (int newValue)
  Set control MutexCallBacks.
 
void  setNetCuts (int newValue)
  Set control NetCuts.
 
void  setNetStallLimit (int newValue)
  Set control NetStallLimit.
 
void  setNlpCalcThreads (int newValue)
  Set control NlpCalcThreads.
 
void  setNlpDefaultIV (double newValue)
  Set control NlpDefaultIV.
 
void  setNlpDerivatives (int newValue)
  Set control NlpDerivatives.
 
void  setNlpDeterministic (int newValue)
  Set control NlpDeterministic.
 
void  setNlpEvaluate (int newValue)
  Set control NlpEvaluate.
 
void  setNlpFindIV (int newValue)
  Set control NlpFindIV.
 
void  setNlpFuncEval (int newValue)
  Set control NlpFuncEval.
 
void  setNlpHessian (int newValue)
  Set control NlpHessian.
 
void  setNlpInfinity (double newValue)
  Set control NlpInfinity.
 
void  setNlpJacobian (int newValue)
  Set control NlpJacobian.
 
void  setNlpLinQuadBR (int newValue)
  Set control NlpLinQuadBR.
 
void  setNlpLog (int newValue)
  Set control NlpLog.
 
void  setNlpMaxTime (int newValue)
  Set control NlpMaxTime.
 
void  setNlpMeritLambda (double newValue)
  Set control NlpMeritLambda.
 
void  setNlpPostsolve (int newValue)
  Set control NlpPostsolve.
 
void  setNlpPresolve (int newValue)
  Set control NlpPresolve.
 
void  setNlpPresolve_ElimTol (double newValue)
  Set control NlpPresolve_ElimTol.
 
void  setNlpPresolveLevel (int newValue)
  Set control NlpPresolveLevel.
 
void  setNlpPresolveOps (int newValue)
  Set control NlpPresolveOps.
 
void  setNlpPresolveZero (double newValue)
  Set control NlpPresolveZero.
 
void  setNlpPrimalIntegralAlpha (double newValue)
  Set control NlpPrimalIntegralAlpha.
 
void  setNlpPrimalIntegralRef (double newValue)
  Set control NlpPrimalIntegralRef.
 
void  setNlpProbing (int newValue)
  Set control NlpProbing.
 
void  setNlpReformulate (int newValue)
  Set control NlpReformulate.
 
void  setNlpSolver (int newValue)
  Set control NlpSolver.
 
void  setNlpStopOutOfRange (int newValue)
  Set control NlpStopOutOfRange.
 
void  setNlpThreads (int newValue)
  Set control NlpThreads.
 
void  setNlpThreadSafeUserFunc (int newValue)
  Set control NlpThreadSafeUserFunc.
 
void  setNlpValidationFactor (double newValue)
  Set control NlpValidationFactor.
 
void  setNlpValidationTarget_K (double newValue)
  Set control NlpValidationTarget_K.
 
void  setNlpValidationTarget_R (double newValue)
  Set control NlpValidationTarget_R.
 
void  setNlpValidationTol_A (double newValue)
  Set control NlpValidationTol_A.
 
void  setNlpValidationTol_K (double newValue)
  Set control NlpValidationTol_K.
 
void  setNlpValidationTol_R (double newValue)
  Set control NlpValidationTol_R.
 
void  setNlpZero (double newValue)
  Set control NlpZero.
 
void  setNodeProbingEffort (double newValue)
  Set control NodeProbingEffort.
 
void  setNodeSelection (int newValue)
  Set control NodeSelection.
 
void  setNumericalEmphasis (int newValue)
  Set control NumericalEmphasis.
 
void  setObjScaleFactor (int newValue)
  Set control ObjScaleFactor.
 
void  setOptimalityTol (double newValue)
  Set control OptimalityTol.
 
void  setOptimalityTolTarget (double newValue)
  Set control OptimalityTolTarget.
 
void  setOutputControls (int newValue)
  Set control OutputControls.
 
void  setOutputLog (int newValue)
  Set control OutputLog.
 
void  setOutputMask (std::string const &newValue)
  Set control OutputMask.
 
void  setOutputTol (double newValue)
  Set control OutputTol.
 
void  setPenalty (double newValue)
  Set control Penalty.
 
void  setPivotTol (double newValue)
  Set control PivotTol.
 
void  setPPFactor (double newValue)
  Set control PPFactor.
 
void  setPreAnalyticcenter (int newValue)
  Set control PreAnalyticcenter.
 
void  setPreBasisRed (int newValue)
  Set control PreBasisRed.
 
void  setPreBndRedCone (int newValue)
  Set control PreBndRedCone.
 
void  setPreBndRedQuad (int newValue)
  Set control PreBndRedQuad.
 
void  setPreCliqueStrategy (int newValue)
  Set control PreCliqueStrategy.
 
void  setPreCoefElim (int newValue)
  Set control PreCoefElim.
 
void  setPreComponents (int newValue)
  Set control PreComponents.
 
void  setPreComponentsEffort (double newValue)
  Set control PreComponentsEffort.
 
void  setPreConeDecomp (int newValue)
  Set control PreConeDecomp.
 
void  setPreConfiguration (int newValue)
  Set control PreConfiguration.
 
void  setPreConvertObjToCons (int newValue)
  Set control PreConvertObjToCons.
 
void  setPreConvertSeparable (int newValue)
  Set control PreConvertSeparable.
 
void  setPreDomCol (int newValue)
  Set control PreDomCol.
 
void  setPreDomRow (int newValue)
  Set control PreDomRow.
 
void  setPreDupRow (int newValue)
  Set control PreDupRow.
 
void  setPreElimQuad (int newValue)
  Set control PreElimQuad.
 
void  setPreFolding (int newValue)
  Set control PreFolding.
 
void  setPreImplications (int newValue)
  Set control PreImplications.
 
void  setPreLinDep (int newValue)
  Set control PreLinDep.
 
void  setPreObjCutDetect (int newValue)
  Set control PreObjCutDetect.
 
void  setPrePermute (int newValue)
  Set control PrePermute.
 
void  setPrePermuteSeed (int newValue)
  Set control PrePermuteSeed.
 
void  setPreProbing (int newValue)
  Set control PreProbing.
 
void  setPreProtectDual (int newValue)
  Set control PreProtectDual.
 
void  setPresolve (int newValue)
  Set control Presolve.
 
void  setPresolveMaxGrow (double newValue)
  Set control PresolveMaxGrow.
 
void  setPresolveOps (int newValue)
  Set control PresolveOps.
 
void  setPresolvePasses (int newValue)
  Set control PresolvePasses.
 
void  setPreSort (int newValue)
  Set control PreSort.
 
void  setPricingAlg (int newValue)
  Set control PricingAlg.
 
void  setPrimalOps (int newValue)
  Set control PrimalOps.
 
void  setPrimalPerturb (double newValue)
  Set control PrimalPerturb.
 
void  setPrimalUnshift (int newValue)
  Set control PrimalUnshift.
 
void  setPseudoCost (double newValue)
  Set control PseudoCost.
 
void  setPwlDualReductions (int newValue)
  Set control PwlDualReductions.
 
void  setPwlNonConvexTransformation (int newValue)
  Set control PwlNonConvexTransformation.
 
void  setQCCuts (int newValue)
  Set control QCCuts.
 
void  setQCRootAlg (int newValue)
  Set control QCRootAlg.
 
void  setQSimplexOps (int newValue)
  Set control QSimplexOps.
 
void  setQuadraticUnshift (int newValue)
  Set control QuadraticUnshift.
 
void  setRandomSeed (int newValue)
  Set control RandomSeed.
 
void  setRefactor (int newValue)
  Set control Refactor.
 
void  setRefineOps (int newValue)
  Set control RefineOps.
 
void  setRelaxTreeMemoryLimit (double newValue)
  Set control RelaxTreeMemoryLimit.
 
void  setRelPivotTol (double newValue)
  Set control RelPivotTol.
 
void  setRepairIndefiniteQ (xpress::RepairIndefiniteQuadratic newValue)
  Set control RepairIndefiniteQ.
 
void  setRepairIndefiniteQMax (double newValue)
  Set control RepairIndefiniteQMax.
 
void  setRepairInfeasMaxTime (int newValue)
  Set control RepairInfeasMaxTime.
 
void  setRepairInfeasTimeLimit (double newValue)
  Set control RepairInfeasTimeLimit.
 
void  setResourceStrategy (int newValue)
  Set control ResourceStrategy.
 
void  setRLTCuts (int newValue)
  Set control RLTCuts.
 
void  setRootPresolve (int newValue)
  Set control RootPresolve.
 
void  setSBBest (int newValue)
  Set control SBBest.
 
void  setSbEffort (double newValue)
  Set control SbEffort.
 
void  setSBEstimate (int newValue)
  Set control SBEstimate.
 
void  setSBIterLimit (int newValue)
  Set control SBIterLimit.
 
void  setSBSelect (int newValue)
  Set control SBSelect.
 
void  setScaling (int newValue)
  Set control Scaling.
 
void  setSerializePreIntSol (int newValue)
  Set control SerializePreIntSol.
 
void  setSifting (int newValue)
  Set control Sifting.
 
void  setSiftPasses (int newValue)
  Set control SiftPasses.
 
void  setSiftPresolveOps (int newValue)
  Set control SiftPresolveOps.
 
void  setSiftSwitch (int newValue)
  Set control SiftSwitch.
 
void  setSleepOnThreadWait (int newValue)
  Set control SleepOnThreadWait.
 
void  setSlpAlgorithm (int newValue)
  Set control SlpAlgorithm.
 
void  setSlpAnalyze (int newValue)
  Set control SlpAnalyze.
 
void  setSlpATol_A (double newValue)
  Set control SlpATol_A.
 
void  setSlpATol_R (double newValue)
  Set control SlpATol_R.
 
void  setSlpAugmentation (int newValue)
  Set control SlpAugmentation.
 
void  setSlpAutoSave (int newValue)
  Set control SlpAutoSave.
 
void  setSlpBarCrossoverStart (int newValue)
  Set control SlpBarCrossoverStart.
 
void  setSlpBarLimit (int newValue)
  Set control SlpBarLimit.
 
void  setSlpBarStallingLimit (int newValue)
  Set control SlpBarStallingLimit.
 
void  setSlpBarStallingObjLimit (int newValue)
  Set control SlpBarStallingObjLimit.
 
void  setSlpBarStallingTol (double newValue)
  Set control SlpBarStallingTol.
 
void  setSlpBarStartOps (int newValue)
  Set control SlpBarStartOps.
 
void  setSlpBoundThreshold (double newValue)
  Set control SlpBoundThreshold.
 
void  setSlpCascade (int newValue)
  Set control SlpCascade.
 
void  setSlpCascadeNLimit (int newValue)
  Set control SlpCascadeNLimit.
 
void  setSlpCascadeTol_PA (double newValue)
  Set control SlpCascadeTol_PA.
 
void  setSlpCascadeTol_PR (double newValue)
  Set control SlpCascadeTol_PR.
 
void  setSlpCDTol_A (double newValue)
  Set control SlpCDTol_A.
 
void  setSlpCDTol_R (double newValue)
  Set control SlpCDTol_R.
 
void  setSlpClampShrink (double newValue)
  Set control SlpClampShrink.
 
void  setSlpClampValidationTol_A (double newValue)
  Set control SlpClampValidationTol_A.
 
void  setSlpClampValidationTol_R (double newValue)
  Set control SlpClampValidationTol_R.
 
void  setSlpConvergenceOps (int newValue)
  Set control SlpConvergenceOps.
 
void  setSlpCTol (double newValue)
  Set control SlpCTol.
 
void  setSlpCutStrategy (int newValue)
  Set control SlpCutStrategy.
 
void  setSlpDamp (double newValue)
  Set control SlpDamp.
 
void  setSlpDampExpand (double newValue)
  Set control SlpDampExpand.
 
void  setSlpDampMax (double newValue)
  Set control SlpDampMax.
 
void  setSlpDampMin (double newValue)
  Set control SlpDampMin.
 
void  setSlpDampShrink (double newValue)
  Set control SlpDampShrink.
 
void  setSlpDampStart (int newValue)
  Set control SlpDampStart.
 
void  setSlpDefaultStepBound (double newValue)
  Set control SlpDefaultStepBound.
 
void  setSlpDelayUpdateRows (int newValue)
  Set control SlpDelayUpdateRows.
 
void  setSlpDelta_A (double newValue)
  Set control SlpDelta_A.
 
void  setSlpDelta_Infinity (double newValue)
  Set control SlpDelta_Infinity.
 
void  setSlpDelta_R (double newValue)
  Set control SlpDelta_R.
 
void  setSlpDelta_X (double newValue)
  Set control SlpDelta_X.
 
void  setSlpDelta_Z (double newValue)
  Set control SlpDelta_Z.
 
void  setSlpDelta_Zero (double newValue)
  Set control SlpDelta_Zero.
 
void  setSlpDeltaCost (double newValue)
  Set control SlpDeltaCost.
 
void  setSlpDeltaCostFactor (double newValue)
  Set control SlpDeltaCostFactor.
 
void  setSlpDeltaMaxCost (double newValue)
  Set control SlpDeltaMaxCost.
 
void  setSlpDeltaOffset (int newValue)
  Set control SlpDeltaOffset.
 
void  setSlpDeltaZLimit (int newValue)
  Set control SlpDeltaZLimit.
 
void  setSlpDJTol (double newValue)
  Set control SlpDJTol.
 
void  setSlpDRColDjTol (double newValue)
  Set control SlpDRColDjTol.
 
void  setSlpDRColTol (double newValue)
  Set control SlpDRColTol.
 
void  setSlpDRFixRange (double newValue)
  Set control SlpDRFixRange.
 
void  setSlpECFCheck (int newValue)
  Set control SlpECFCheck.
 
void  setSlpEcfTol_A (double newValue)
  Set control SlpEcfTol_A.
 
void  setSlpEcfTol_R (double newValue)
  Set control SlpEcfTol_R.
 
void  setSlpEnforceCostShrink (double newValue)
  Set control SlpEnforceCostShrink.
 
void  setSlpEnforceMaxCost (double newValue)
  Set control SlpEnforceMaxCost.
 
void  setSlpErrorCost (double newValue)
  Set control SlpErrorCost.
 
void  setSlpErrorCostFactor (double newValue)
  Set control SlpErrorCostFactor.
 
void  setSlpErrorMaxCost (double newValue)
  Set control SlpErrorMaxCost.
 
void  setSlpErrorOffset (int newValue)
  Set control SlpErrorOffset.
 
void  setSlpErrorTol_A (double newValue)
  Set control SlpErrorTol_A.
 
void  setSlpErrorTol_P (double newValue)
  Set control SlpErrorTol_P.
 
void  setSlpEscalation (double newValue)
  Set control SlpEscalation.
 
void  setSlpETol_A (double newValue)
  Set control SlpETol_A.
 
void  setSlpETol_R (double newValue)
  Set control SlpETol_R.
 
void  setSlpEVTol_A (double newValue)
  Set control SlpEVTol_A.
 
void  setSlpEVTol_R (double newValue)
  Set control SlpEVTol_R.
 
void  setSlpExpand (double newValue)
  Set control SlpExpand.
 
void  setSlpFeastolTarget (double newValue)
  Set control SlpFeastolTarget.
 
void  setSlpFilter (int newValue)
  Set control SlpFilter.
 
void  setSlpGranularity (double newValue)
  Set control SlpGranularity.
 
void  setSlpGridHeurSelect (int newValue)
  Set control SlpGridHeurSelect.
 
void  setSlpHeurStrategy (int newValue)
  Set control SlpHeurStrategy.
 
void  setSlpInfeasLimit (int newValue)
  Set control SlpInfeasLimit.
 
void  setSlpIterLimit (int newValue)
  Set control SlpIterLimit.
 
void  setSlpItol_A (double newValue)
  Set control SlpItol_A.
 
void  setSlpITol_R (double newValue)
  Set control SlpITol_R.
 
void  setSlpLSIterLimit (int newValue)
  Set control SlpLSIterLimit.
 
void  setSlpLSPatternLimit (int newValue)
  Set control SlpLSPatternLimit.
 
void  setSlpLSStart (int newValue)
  Set control SlpLSStart.
 
void  setSlpLSZeroLimit (int newValue)
  Set control SlpLSZeroLimit.
 
void  setSlpMatrixTol (double newValue)
  Set control SlpMatrixTol.
 
void  setSlpMaxWeight (double newValue)
  Set control SlpMaxWeight.
 
void  setSlpMinSBFactor (double newValue)
  Set control SlpMinSBFactor.
 
void  setSlpMinWeight (double newValue)
  Set control SlpMinWeight.
 
void  setSlpMipAlgorithm (int newValue)
  Set control SlpMipAlgorithm.
 
void  setSlpMipCutoff_A (double newValue)
  Set control SlpMipCutoff_A.
 
void  setSlpMipCutoff_R (double newValue)
  Set control SlpMipCutoff_R.
 
void  setSlpMipCutOffCount (int newValue)
  Set control SlpMipCutOffCount.
 
void  setSlpMipCutoffLimit (int newValue)
  Set control SlpMipCutoffLimit.
 
void  setSlpMipDefaultAlgorithm (int newValue)
  Set control SlpMipDefaultAlgorithm.
 
void  setSlpMipErrorTol_A (double newValue)
  Set control SlpMipErrorTol_A.
 
void  setSlpMipErrorTol_R (double newValue)
  Set control SlpMipErrorTol_R.
 
void  setSlpMipFixStepBounds (int newValue)
  Set control SlpMipFixStepBounds.
 
void  setSlpMipIterLimit (int newValue)
  Set control SlpMipIterLimit.
 
void  setSlpMipLog (int newValue)
  Set control SlpMipLog.
 
void  setSlpMipOCount (int newValue)
  Set control SlpMipOCount.
 
void  setSlpMipOtol_A (double newValue)
  Set control SlpMipOtol_A.
 
void  setSlpMipOtol_R (double newValue)
  Set control SlpMipOtol_R.
 
void  setSlpMipRelaxStepBounds (int newValue)
  Set control SlpMipRelaxStepBounds.
 
void  setSlpMTol_A (double newValue)
  Set control SlpMTol_A.
 
void  setSlpMTol_R (double newValue)
  Set control SlpMTol_R.
 
void  setSlpMVTol (double newValue)
  Set control SlpMVTol.
 
void  setSlpObjThreshold (double newValue)
  Set control SlpObjThreshold.
 
void  setSlpObjToPenaltyCost (double newValue)
  Set control SlpObjToPenaltyCost.
 
void  setSlpOCount (int newValue)
  Set control SlpOCount.
 
void  setSlpOptimalityTolTarget (double newValue)
  Set control SlpOptimalityTolTarget.
 
void  setSlpOTol_A (double newValue)
  Set control SlpOTol_A.
 
void  setSlpOTol_R (double newValue)
  Set control SlpOTol_R.
 
void  setSlpPenaltyInfoStart (int newValue)
  Set control SlpPenaltyInfoStart.
 
void  setSlpSameCount (int newValue)
  Set control SlpSameCount.
 
void  setSlpSameDamp (int newValue)
  Set control SlpSameDamp.
 
void  setSlpSBRowOffset (int newValue)
  Set control SlpSBRowOffset.
 
void  setSlpSBStart (int newValue)
  Set control SlpSBStart.
 
void  setSlpShrink (double newValue)
  Set control SlpShrink.
 
void  setSlpShrinkBias (double newValue)
  Set control SlpShrinkBias.
 
void  setSlpSTol_A (double newValue)
  Set control SlpSTol_A.
 
void  setSlpSTol_R (double newValue)
  Set control SlpSTol_R.
 
void  setSlpTraceMaskOps (int newValue)
  Set control SlpTraceMaskOps.
 
void  setSlpUnFinishedLimit (int newValue)
  Set control SlpUnFinishedLimit.
 
void  setSlpUpdateOffset (int newValue)
  Set control SlpUpdateOffset.
 
void  setSlpVCount (int newValue)
  Set control SlpVCount.
 
void  setSlpVLimit (int newValue)
  Set control SlpVLimit.
 
void  setSlpVTol_A (double newValue)
  Set control SlpVTol_A.
 
void  setSlpVTol_R (double newValue)
  Set control SlpVTol_R.
 
void  setSlpWCount (int newValue)
  Set control SlpWCount.
 
void  setSlpWTol_A (double newValue)
  Set control SlpWTol_A.
 
void  setSlpWTol_R (double newValue)
  Set control SlpWTol_R.
 
void  setSlpXCount (int newValue)
  Set control SlpXCount.
 
void  setSlpXLimit (int newValue)
  Set control SlpXLimit.
 
void  setSlpXTol_A (double newValue)
  Set control SlpXTol_A.
 
void  setSlpXTol_R (double newValue)
  Set control SlpXTol_R.
 
void  setSlpZeroCriterion (int newValue)
  Set control SlpZeroCriterion.
 
void  setSlpZeroCriterionCount (int newValue)
  Set control SlpZeroCriterionCount.
 
void  setSlpZeroCriterionStart (int newValue)
  Set control SlpZeroCriterionStart.
 
void  setSolTimeLimit (double newValue)
  Set control SolTimeLimit.
 
void  setSosRefTol (double newValue)
  Set control SosRefTol.
 
void  setSymmetry (int newValue)
  Set control Symmetry.
 
void  setSymSelect (int newValue)
  Set control SymSelect.
 
void  setThreads (int newValue)
  Set control Threads.
 
void  setTimeLimit (double newValue)
  Set control TimeLimit.
 
void  setTrace (int newValue)
  Set control Trace.
 
void  setTreeCompression (int newValue)
  Set control TreeCompression.
 
void  setTreeCoverCuts (int newValue)
  Set control TreeCoverCuts.
 
void  setTreeCutSelect (int newValue)
  Set control TreeCutSelect.
 
void  setTreeDiagnostics (int newValue)
  Set control TreeDiagnostics.
 
void  setTreeFileLogInterval (int newValue)
  Set control TreeFileLogInterval.
 
void  setTreeGomCuts (int newValue)
  Set control TreeGomCuts.
 
void  setTreeMemoryLimit (int newValue)
  Set control TreeMemoryLimit.
 
void  setTreeMemorySavingTarget (double newValue)
  Set control TreeMemorySavingTarget.
 
void  setTreeQCCuts (int newValue)
  Set control TreeQCCuts.
 
void  setTunerHistory (xpress::TunerHistory newValue)
  Set control TunerHistory.
 
void  setTunerMaxTime (double newValue)
  Set control TunerMaxTime.
 
void  setTunerMethod (xpress::TunerMethod newValue)
  Set control TunerMethod.
 
void  setTunerMethodFile (std::string const &newValue)
  Set control TunerMethodFile.
 
void  setTunerMode (xpress::TunerMode newValue)
  Set control TunerMode.
 
void  setTunerOutput (int newValue)
  Set control TunerOutput.
 
void  setTunerOutputPath (std::string const &newValue)
  Set control TunerOutputPath.
 
void  setTunerPermute (int newValue)
  Set control TunerPermute.
 
void  setTunerSessionName (std::string const &newValue)
  Set control TunerSessionName.
 
void  setTunerTarget (xpress::TunerTarget newValue)
  Set control TunerTarget.
 
void  setTunerThreads (int newValue)
  Set control TunerThreads.
 
void  setTunerVerbose (int newValue)
  Set control TunerVerbose.
 
void  setUserSolHeuristic (int newValue)
  Set control UserSolHeuristic.
 
void  setVarSelection (int newValue)
  Set control VarSelection.
 
void  setVersion (int newValue)
  Set control Version.
 

Detailed Description

Controls API.

Member Function Documentation

getAlgAfterCrossOver()

auto xpress::XPRSProblem::Controls::getAlgAfterCrossOver ( ) const -> int
inline

Get the value for control AlgAfterCrossOver.

The algorithm to be used for the final clean up step after the crossover.

Returns
The current value for AlgAfterCrossOver.

getAlgAfterNetwork()

auto xpress::XPRSProblem::Controls::getAlgAfterNetwork ( ) const -> int
inline

Get the value for control AlgAfterNetwork.

The algorithm to be used for the clean up step after the network simplex solver.

Returns
The current value for AlgAfterNetwork.

getAlternativeRedCosts()

auto xpress::XPRSProblem::Controls::getAlternativeRedCosts ( ) const -> int
inline

Get the value for control AlternativeRedCosts.

Controls aggressiveness of searching for alternative reduced cost

Returns
The current value for AlternativeRedCosts.

getAutoCutting()

auto xpress::XPRSProblem::Controls::getAutoCutting ( ) const -> int
inline

Get the value for control AutoCutting.

Should the Optimizer automatically decide whether to generate cutting planes at local nodes in the tree or not? If the CUTFREQ control is set, no automatic selection will be made and local cutting will be enabled.

Returns
The current value for AutoCutting.

getAutoPerturb()

auto xpress::XPRSProblem::Controls::getAutoPerturb ( ) const -> int
inline

Get the value for control AutoPerturb.

Simplex: This indicates whether automatic perturbation is performed. If this is set to 1, the problem will be perturbed whenever the simplex method encounters an excessive number of degenerate pivot steps, thus preventing the Optimizer being hindered by degeneracies.

Returns
The current value for AutoPerturb.

getAutoScaling()

auto xpress::XPRSProblem::Controls::getAutoScaling ( ) const -> int
inline

Get the value for control AutoScaling.

Whether the Optimizer should automatically select between different scaling algorithms. If the SCALING control is set, no automatic scaling will be applied.

Returns
The current value for AutoScaling.

getBackgroundMaxThreads()

auto xpress::XPRSProblem::Controls::getBackgroundMaxThreads ( ) const -> int
inline

Get the value for control BackgroundMaxThreads.

Limit the number of threads to use in background jobs (for example in parallel to the root cut loop).

Returns
The current value for BackgroundMaxThreads.

getBackgroundSelect()

auto xpress::XPRSProblem::Controls::getBackgroundSelect ( ) const -> XPRSint64
inline

Get the value for control BackgroundSelect.

Select which tasks to run in background jobs (for example in parallel to the root cut loop).

Returns
The current value for BackgroundSelect.

getBackTrack()

auto xpress::XPRSProblem::Controls::getBackTrack ( ) const -> int
inline

Get the value for control BackTrack.

Branch and Bound: Specifies how to select the next node to work on when a full backtrack is performed.

Returns
The current value for BackTrack.

getBacktrackTie()

auto xpress::XPRSProblem::Controls::getBacktrackTie ( ) const -> int
inline

Get the value for control BacktrackTie.

Branch and Bound: Specifies how to break ties when selecting the next node to work on when a full backtrack is performed. The options are the same as for the BACKTRACK control.

Returns
The current value for BacktrackTie.

getBarAlg()

auto xpress::XPRSProblem::Controls::getBarAlg ( ) const -> int
inline

Get the value for control BarAlg.

This control determines which barrier algorithm is used to solve the problem.

Returns
The current value for BarAlg.

getBarCores()

auto xpress::XPRSProblem::Controls::getBarCores ( ) const -> int
inline

Get the value for control BarCores.

If set to a positive integer it determines the number of physical CPU cores assumed to be present in the system by the barrier and hybrid gradient algorithms. If the value is set to the default value (-1), Xpress will automatically detect the number of cores.

Returns
The current value for BarCores.

getBarCrash()

auto xpress::XPRSProblem::Controls::getBarCrash ( ) const -> int
inline

Get the value for control BarCrash.

Newton barrier and hybrid gradient: This determines the type of crash used for the crossover. During the crash procedure, an initial basis is determined which attempts to speed up the crossover. A good choice at this stage will significantly reduce the number of iterations required to crossover to an optimal solution. The possible values increase proportionally to their time-consumption.

Returns
The current value for BarCrash.

getBarDualStop()

auto xpress::XPRSProblem::Controls::getBarDualStop ( ) const -> double
inline

Get the value for control BarDualStop.

Newton barrier and hybrid gradient: This is a convergence parameter, representing the tolerance for dual infeasibilities. If the difference between the constraints and their bounds in the dual problem falls below this tolerance in absolute value, optimization will stop and the current solution will be returned.

Returns
The current value for BarDualStop.

getBarFailIterLimit()

auto xpress::XPRSProblem::Controls::getBarFailIterLimit ( ) const -> int
inline

Get the value for control BarFailIterLimit.

Newton barrier: The maximum number of consecutive iterations that fail to improve the solution in the barrier algorithm.

Returns
The current value for BarFailIterLimit.

getBarFreeScale()

auto xpress::XPRSProblem::Controls::getBarFreeScale ( ) const -> double
inline

Get the value for control BarFreeScale.

Defines how the barrier algorithm scales free variables.

Returns
The current value for BarFreeScale.

getBarGapStop()

auto xpress::XPRSProblem::Controls::getBarGapStop ( ) const -> double
inline

Get the value for control BarGapStop.

Newton barrier and hybrid gradient: This is a convergence parameter, representing the tolerance for the relative duality gap. When the difference between the primal and dual objective function values falls below this tolerance, the Optimizer determines that the optimal solution has been found.

Returns
The current value for BarGapStop.

getBarGapTarget()

auto xpress::XPRSProblem::Controls::getBarGapTarget ( ) const -> double
inline

Get the value for control BarGapTarget.

Newton barrier: The target tolerance for the relative duality gap. The barrier algorithm will keep iterating until either BARGAPTARGET is satisfied or until no further improvements are possible. In the latter case, if BARGAPSTOP is satisfied, it will declare the problem optimal.

Returns
The current value for BarGapTarget.

getBarhgExtrapolate()

auto xpress::XPRSProblem::Controls::getBarhgExtrapolate ( ) const -> double
inline

Get the value for control BarhgExtrapolate.

 Extrapolation parameter for the hybrid gradient algorithm. Although theory suggests that a value of 1 is best, slightly smaller values perform better in general.
Returns
The current value for BarhgExtrapolate.

getBarhgMaxRestarts()

auto xpress::XPRSProblem::Controls::getBarhgMaxRestarts ( ) const -> int
inline

Get the value for control BarhgMaxRestarts.

The maximum number of restarts in the hybrid gradient algorithm. Restarts play the role of iterations in the hybrid gradient algorithm. A log line is printed at every restart, unless BAROUTPUT is set to 0.

Returns
The current value for BarhgMaxRestarts.

getBarhgOps()

auto xpress::XPRSProblem::Controls::getBarhgOps ( ) const -> xpress::BARHGOps
inline

Get the value for control BarhgOps.

 Control options for the hybrid gradient algorithm. Bits 1, 2 and 3 control which norms of the coefficient matrix are used for solution normalization. The normalization factor is the maximum of the selected norms. By default, or if all three bits are set to 0, the infinity norm is used.
 The omega parameter referenced in bits 4, 5 and 6 is a measure of the relative magnitudes of the objective and the right-hand side.
Returns
The current value for BarhgOps.

getBarIndefLimit()

auto xpress::XPRSProblem::Controls::getBarIndefLimit ( ) const -> int
inline

Get the value for control BarIndefLimit.

Newton Barrier. This limits the number of consecutive indefinite barrier iterations that will be performed. The optimizer will try to minimize (resp. maximize) a QP problem even if the Q matrix is not positive (resp. negative) semi-definite. However, the optimizer may detect that the Q matrix is indefinite and this can result in the optimizer not converging. This control specifies how many indefinite iterations may occur before the optimizer stops and reports that the problem is indefinite. It is usual to specify a value greater than one, and only stop after a series of indefinite matrices, as the problem may be found to be indefinite incorrectly on a few iterations for numerical reasons.

Returns
The current value for BarIndefLimit.

getBarIterLimit()

auto xpress::XPRSProblem::Controls::getBarIterLimit ( ) const -> int
inline

Get the value for control BarIterLimit.

Newton barrier: The maximum number of iterations. While the simplex method usually performs a number of iterations which is proportional to the number of constraints (rows) in a problem, the barrier method standardly finds the optimal solution to a given accuracy after a number of iterations which is independent of the problem size. The penalty is rather that the time for each iteration increases with the size of the problem. BARITERLIMIT specifies the maximum number of iterations which will be carried out by the barrier.

Returns
The current value for BarIterLimit.

getBarKernel()

auto xpress::XPRSProblem::Controls::getBarKernel ( ) const -> double
inline

Get the value for control BarKernel.

Newton barrier: Defines how centrality is weighted in the barrier algorithm.

Returns
The current value for BarKernel.

getBarLargeBound()

auto xpress::XPRSProblem::Controls::getBarLargeBound ( ) const -> double
inline

Get the value for control BarLargeBound.

Threshold for the barrier to handle large bounds.

Returns
The current value for BarLargeBound.

getBarNumStability()

auto xpress::XPRSProblem::Controls::getBarNumStability ( ) const -> int
inline

Get the value for control BarNumStability.

Returns
The current value for BarNumStability.

getBarObjPerturb()

auto xpress::XPRSProblem::Controls::getBarObjPerturb ( ) const -> double
inline

Get the value for control BarObjPerturb.

Defines how the barrier perturbs the objective.

Returns
The current value for BarObjPerturb.

getBarObjScale()

auto xpress::XPRSProblem::Controls::getBarObjScale ( ) const -> double
inline

Get the value for control BarObjScale.

Defines how the barrier scales the objective.

Returns
The current value for BarObjScale.

getBarOrder()

auto xpress::XPRSProblem::Controls::getBarOrder ( ) const -> xpress::BarOrder
inline

Get the value for control BarOrder.

Newton barrier: This controls the Cholesky factorization in the Newton-Barrier.

Returns
The current value for BarOrder.

getBarOrderThreads()

auto xpress::XPRSProblem::Controls::getBarOrderThreads ( ) const -> int
inline

Get the value for control BarOrderThreads.

If set to a positive integer it determines the number of concurrent threads for the sparse matrix ordering algorithm in the Newton-barrier method.

Returns
The current value for BarOrderThreads.

getBarOutput()

auto xpress::XPRSProblem::Controls::getBarOutput ( ) const -> int
inline

Get the value for control BarOutput.

Newton barrier and hybrid gradient: This specifies the level of solution output provided. Output is provided either after each iteration of the algorithm, or else can be turned off completely by this parameter.

Returns
The current value for BarOutput.

getBarPerturb()

auto xpress::XPRSProblem::Controls::getBarPerturb ( ) const -> double
inline

Get the value for control BarPerturb.

Newton barrier: In numerically challenging cases it is often advantageous to apply perturbations on the KKT system to improve its numerical properties. BARPERTURB controlls how much perturbation is allowed during the barrier iterations. By default no perturbation is allowed. Set this parameter with care as larger perturbations may lead to less efficient iterates and the best settings are problem-dependent.

Returns
The current value for BarPerturb.

getBarPresolveOps()

auto xpress::XPRSProblem::Controls::getBarPresolveOps ( ) const -> int
inline

Get the value for control BarPresolveOps.

Newton barrier: This controls the Newton-Barrier specific presolve operations.

Returns
The current value for BarPresolveOps.

getBarPrimalStop()

auto xpress::XPRSProblem::Controls::getBarPrimalStop ( ) const -> double
inline

Get the value for control BarPrimalStop.

Newton barrier and hybrid gradient: This is a convergence parameter, indicating the tolerance for primal infeasibilities. If the difference between the constraints and their bounds in the primal problem falls below this tolerance in absolute value, the Optimizer will terminate and return the current solution.

Returns
The current value for BarPrimalStop.

getBarRefIter()

auto xpress::XPRSProblem::Controls::getBarRefIter ( ) const -> int
inline

Get the value for control BarRefIter.

Newton barrier: After terminating the barrier algorithm, further refinement steps can be performed. Such refinement steps are especially helpful if the solution is near to the optimum and can improve primal feasibility and decrease the complementarity gap. It is also often advantageous for the crossover algorithm. BARREFITER specifies the maximum number of such refinement iterations.

Returns
The current value for BarRefIter.

getBarRegularize()

auto xpress::XPRSProblem::Controls::getBarRegularize ( ) const -> int
inline

Get the value for control BarRegularize.

This control determines how the barrier algorithm applies regularization on the KKT system.

Returns
The current value for BarRegularize.

getBarRhsScale()

auto xpress::XPRSProblem::Controls::getBarRhsScale ( ) const -> double
inline

Get the value for control BarRhsScale.

Defines how the barrier scales the right hand side.

Returns
The current value for BarRhsScale.

getBarSolution()

auto xpress::XPRSProblem::Controls::getBarSolution ( ) const -> int
inline

Get the value for control BarSolution.

This determines whether the barrier has to decide which is the best solution found or return the solution computed by the last barrier iteration.

Returns
The current value for BarSolution.

getBarStart()

auto xpress::XPRSProblem::Controls::getBarStart ( ) const -> int
inline

Get the value for control BarStart.

Controls the computation of the starting point and warm-starting for the Newton barrier and the hybrid gradient algorithms.

Returns
The current value for BarStart.

getBarStartWeight()

auto xpress::XPRSProblem::Controls::getBarStartWeight ( ) const -> double
inline

Get the value for control BarStartWeight.

Newton barrier: This sets a weight for the warm-start point when warm-start is set for the barrier algorithm. Using larger weight gives more emphasis for the supplied starting point.

Returns
The current value for BarStartWeight.

getBarStepStop()

auto xpress::XPRSProblem::Controls::getBarStepStop ( ) const -> double
inline

Get the value for control BarStepStop.

Newton barrier: A convergence parameter, representing the minimal step size. On each iteration of the barrier algorithm, a step is taken along a computed search direction. If that step size is smaller than BARSTEPSTOP, the Optimizer will terminate and return the current solution.

Returns
The current value for BarStepStop.

getBarThreads()

auto xpress::XPRSProblem::Controls::getBarThreads ( ) const -> int
inline

Get the value for control BarThreads.

If set to a positive integer it determines the number of threads implemented to run the Newton-barrier and hybrid gradient algorithms. If the value is set to the default value (-1), the THREADS control will determine the number of threads used.

Returns
The current value for BarThreads.

getBigM()

auto xpress::XPRSProblem::Controls::getBigM ( ) const -> double
inline

Get the value for control BigM.

The infeasibility penalty used if the "Big M" method is implemented.

Returns
The current value for BigM.

getBigmMethod()

auto xpress::XPRSProblem::Controls::getBigmMethod ( ) const -> int
inline

Get the value for control BigmMethod.

Simplex: This specifies whether to use the "Big M" method, or the standard phase I (achieving feasibility) and phase II (achieving optimality). In the "Big M" method, the objective coefficients of the variables are considered during the feasibility phase, possibly leading to an initial feasible basis which is closer to optimal. The side-effects involve possible round-off errors due to the presence of the "Big M" factor in the problem.

Returns
The current value for BigmMethod.

getBranchChoice()

auto xpress::XPRSProblem::Controls::getBranchChoice ( ) const -> int
inline

Get the value for control BranchChoice.

Once a MIP entity has been selected for branching, this control determines which of the branches is solved first.

Returns
The current value for BranchChoice.

getBranchDisj()

auto xpress::XPRSProblem::Controls::getBranchDisj ( ) const -> int
inline

Get the value for control BranchDisj.

Branch and Bound: Determines whether the optimizer should attempt to branch on general split disjunctions during the branch and bound search.

Returns
The current value for BranchDisj.

getBranchStructural()

auto xpress::XPRSProblem::Controls::getBranchStructural ( ) const -> int
inline

Get the value for control BranchStructural.

Branch and Bound: Determines whether the optimizer should search for special structure in the problem to branch on during the branch and bound search.

Returns
The current value for BranchStructural.

getBreadthFirst()

auto xpress::XPRSProblem::Controls::getBreadthFirst ( ) const -> int
inline

Get the value for control BreadthFirst.

The number of nodes to include in the best-first search before switching to the local first search (NODESELECTION = 4).

Returns
The current value for BreadthFirst.

getCacheSize()

auto xpress::XPRSProblem::Controls::getCacheSize ( ) const -> int
inline

Get the value for control CacheSize.

Newton Barrier: L2 or L3 (see notes) cache size in kB (kilobytes) of the CPU. On Intel (or compatible) platforms a value of -1 may be used to determine the cache size automatically. If the CPU model is new then the cache size may not be correctly detected by an older release of the software.

Returns
The current value for CacheSize.

getCallbackCheckTimeDelay()

auto xpress::XPRSProblem::Controls::getCallbackCheckTimeDelay ( ) const -> int
inline

Get the value for control CallbackCheckTimeDelay.

Minimum delay in milliseconds between two consecutive executions of the CHECKTIME callback in the same solution process

Returns
The current value for CallbackCheckTimeDelay.

getCallbackFromMasterThread()

auto xpress::XPRSProblem::Controls::getCallbackFromMasterThread ( ) const -> int
inline

Get the value for control CallbackFromMasterThread.

Branch and Bound: specifies whether the MIP callbacks should only be called on the master thread.

Returns
The current value for CallbackFromMasterThread.

getCheckInputData()

auto xpress::XPRSProblem::Controls::getCheckInputData ( ) const -> int
inline

Get the value for control CheckInputData.

Check input arrays for bad data.

Returns
The current value for CheckInputData.

getCholeskyAlg()

auto xpress::XPRSProblem::Controls::getCholeskyAlg ( ) const -> int
inline

Get the value for control CholeskyAlg.

Newton barrier: type of Cholesky factorization used.

Returns
The current value for CholeskyAlg.

getCholeskyTol()

auto xpress::XPRSProblem::Controls::getCholeskyTol ( ) const -> double
inline

Get the value for control CholeskyTol.

Newton barrier: The tolerance for pivot elements in the Cholesky decomposition of the normal equations coefficient matrix, computed at each iteration of the barrier algorithm. If the absolute value of the pivot element is less than or equal to CHOLESKYTOL, it merits special treatment in the Cholesky decomposition process.

Returns
The current value for CholeskyTol.

getClamping()

auto xpress::XPRSProblem::Controls::getClamping ( ) const -> int
inline

Get the value for control Clamping.

This control allows for the adjustment of returned solution values such that they are always within bounds.

Returns
The current value for Clamping.

getCompute()

auto xpress::XPRSProblem::Controls::getCompute ( ) const -> int
inline

Get the value for control Compute.

Controls whether the next solve is performed directly or on an Insight Compute Interface.

Returns
The current value for Compute.

getComputeExecService()

auto xpress::XPRSProblem::Controls::getComputeExecService ( ) const -> std::string
inline

Get the value for control ComputeExecService.

Selects the Insight execution service that will be used for solving remote optimizations.

Returns
The current value for ComputeExecService.

getComputeJobPriority()

auto xpress::XPRSProblem::Controls::getComputeJobPriority ( ) const -> int
inline

Get the value for control ComputeJobPriority.

Selects the priority that will be used for remote optimization jobs.

Returns
The current value for ComputeJobPriority.

getComputeLog()

auto xpress::XPRSProblem::Controls::getComputeLog ( ) const -> xpress::ComputeLog
inline

Get the value for control ComputeLog.

Controls how the run log is fetched when a solve is performed on an Insight Compute Interface.

Returns
The current value for ComputeLog.

getConcurrentThreads()

auto xpress::XPRSProblem::Controls::getConcurrentThreads ( ) const -> int
inline

Get the value for control ConcurrentThreads.

Determines the number of threads used by the concurrent solver.

Returns
The current value for ConcurrentThreads.

getConflictCuts()

auto xpress::XPRSProblem::Controls::getConflictCuts ( ) const -> int
inline

Get the value for control ConflictCuts.

Branch and Bound: Specifies how cautious or aggressive the optimizer should be when searching for and applying conflict cuts. Conflict cuts are in-tree cuts derived from nodes found to be infeasible or cut off, which can be used to cut off other branches of the search tree.

Returns
The current value for ConflictCuts.

getCoresPerCPU()

auto xpress::XPRSProblem::Controls::getCoresPerCPU ( ) const -> int
inline

Get the value for control CoresPerCPU.

Used to override the detected value of the number of cores on a CPU. The cache size (either detected or specified via the CACHESIZE control) used in Barrier methods will be divided by this amount, and this scaled-down value will be the amount of cache allocated to each Barrier thread

Returns
The current value for CoresPerCPU.

getCoverCuts()

auto xpress::XPRSProblem::Controls::getCoverCuts ( ) const -> int
inline

Get the value for control CoverCuts.

Branch and Bound: The number of rounds of lifted cover inequalities at the top node. A lifted cover inequality is an additional constraint that can be particularly effective at reducing the size of the feasible region without removing potential integral solutions. The process of generating these can be carried out a number of times, further reducing the feasible region, albeit incurring a time penalty. There is usually a good payoff from generating these at the top node, since these inequalities then apply to every subsequent node in the tree search.

Returns
The current value for CoverCuts.

getCpiAlpha()

auto xpress::XPRSProblem::Controls::getCpiAlpha ( ) const -> double
inline

Get the value for control CpiAlpha.

decay term for confined primal integral computation.

Returns
The current value for CpiAlpha.

getCPUPlatform()

auto xpress::XPRSProblem::Controls::getCPUPlatform ( ) const -> int
inline

Get the value for control CPUPlatform.

Newton Barrier: Selects the AMD, Intel x86 or ARM vectorization instruction set that Barrier should run optimized code for. On AMD / Intel x86 platforms the SSE2, AVX and AVX2 instruction sets are supported while on ARM platforms the NEON architecture extension can be activated.

Returns
The current value for CPUPlatform.

getCPUTime()

auto xpress::XPRSProblem::Controls::getCPUTime ( ) const -> int
inline

Get the value for control CPUTime.

How time should be measured when timings are reported in the log and when checking against time limits

Returns
The current value for CPUTime.

getCrash()

auto xpress::XPRSProblem::Controls::getCrash ( ) const -> int
inline

Get the value for control Crash.

Simplex: This determines the type of crash used when the algorithm begins. During the crash procedure, an initial basis is determined which is as close to feasibility and triangularity as possible. A good choice at this stage will significantly reduce the number of iterations required to find an optimal solution. The possible values increase proportionally to their time-consumption.

Returns
The current value for Crash.

getCrossOver()

auto xpress::XPRSProblem::Controls::getCrossOver ( ) const -> int
inline

Get the value for control CrossOver.

Newton barrier and hybrid gradient: This control determines whether the barrier method will cross over to the simplex method when at optimal solution has been found, to provide an end basis (see XPRSgetbasis, XPRSwritebasis) and advanced sensitivity analysis information (see XPRSobjsa, XPRSrhssa, XPRSbndsa).

Returns
The current value for CrossOver.

getCrossoverAccuracyTol()

auto xpress::XPRSProblem::Controls::getCrossoverAccuracyTol ( ) const -> double
inline

Get the value for control CrossoverAccuracyTol.

Newton barrier: This control determines how crossover adjusts the default relative pivot tolerance. When re-inversion is necessary, crossover will compare the recalculated working basic solution with the assumed ones just before re-inversion took place. If the error is above this threshold, crossover will adjust the relative pivot tolerance to address the build-up of numerical inaccuracies.

Returns
The current value for CrossoverAccuracyTol.

getCrossOverDRP()

auto xpress::XPRSProblem::Controls::getCrossOverDRP ( ) const -> int
inline

Get the value for control CrossOverDRP.

Returns
The current value for CrossOverDRP.

getCrossOverFeasWeight()

auto xpress::XPRSProblem::Controls::getCrossOverFeasWeight ( ) const -> double
inline

Get the value for control CrossOverFeasWeight.

Returns
The current value for CrossOverFeasWeight.

getCrossoverIterLimit()

auto xpress::XPRSProblem::Controls::getCrossoverIterLimit ( ) const -> int
inline

Get the value for control CrossoverIterLimit.

Newton barrier and hybrid gradient: The maximum number of iterations that will be performed in the crossover procedure before the optimization process terminates.

Returns
The current value for CrossoverIterLimit.

getCrossoverOps()

auto xpress::XPRSProblem::Controls::getCrossoverOps ( ) const -> int
inline

Get the value for control CrossoverOps.

Newton barrier and hybrid gradient: a bit vector for adjusting the behavior of the crossover procedure.

Returns
The current value for CrossoverOps.

getCrossOverRelPivotTol()

auto xpress::XPRSProblem::Controls::getCrossOverRelPivotTol ( ) const -> double
inline

Get the value for control CrossOverRelPivotTol.

Returns
The current value for CrossOverRelPivotTol.

getCrossOverRelPivotTolSafe()

auto xpress::XPRSProblem::Controls::getCrossOverRelPivotTolSafe ( ) const -> double
inline

Get the value for control CrossOverRelPivotTolSafe.

Returns
The current value for CrossOverRelPivotTolSafe.

getCrossoverThreads()

auto xpress::XPRSProblem::Controls::getCrossoverThreads ( ) const -> int
inline

Get the value for control CrossoverThreads.

Determines the maximum number of threads that parallel crossover is allowed to use. If CROSSOVERTHREADS is set to the default value (-1), the BARTHREADS control will determine the number of threads used.

Returns
The current value for CrossoverThreads.

getCutDepth()

auto xpress::XPRSProblem::Controls::getCutDepth ( ) const -> int
inline

Get the value for control CutDepth.

Branch and Bound: Sets the maximum depth in the tree search at which cuts will be generated. Generating cuts can take a lot of time, and is often less important at deeper levels of the tree since tighter bounds on the variables have already reduced the feasible region. A value of 0 signifies that no cuts will be generated.

Returns
The current value for CutDepth.

getCutFactor()

auto xpress::XPRSProblem::Controls::getCutFactor ( ) const -> double
inline

Get the value for control CutFactor.

Limit on the number of cuts and cut coefficients the optimizer is allowed to add to the matrix during tree search. The cuts and cut coefficients are limited by CUTFACTOR times the number of rows and coefficients in the initial matrix.

Returns
The current value for CutFactor.

getCutFreq()

auto xpress::XPRSProblem::Controls::getCutFreq ( ) const -> int
inline

Get the value for control CutFreq.

Branch and Bound: This specifies the frequency at which cuts are generated in the tree search. If the depth of the node modulo CUTFREQ is zero, then cuts will be generated.

Returns
The current value for CutFreq.

getCutSelect()

auto xpress::XPRSProblem::Controls::getCutSelect ( ) const -> int
inline

Get the value for control CutSelect.

A bit vector providing detailed control of the cuts created for the root node of a MIP solve. Use TREECUTSELECT to control cuts during the tree search.

Returns
The current value for CutSelect.

getCutStrategy()

auto xpress::XPRSProblem::Controls::getCutStrategy ( ) const -> int
inline

Get the value for control CutStrategy.

Branch and Bound: This specifies the cut strategy. A more aggressive cut strategy, generating a greater number of cuts, will result in fewer nodes to be explored, but with an associated time cost in generating the cuts. The fewer cuts generated, the less time taken, but the greater subsequent number of nodes to be explored.

Returns
The current value for CutStrategy.

getDefaultAlg()

auto xpress::XPRSProblem::Controls::getDefaultAlg ( ) const -> xpress::DefaultAlg
inline

Get the value for control DefaultAlg.

This selects the algorithm that will be used to solve LPs, standalone or during MIP optimization.

Returns
The current value for DefaultAlg.

getDenseColLimit()

auto xpress::XPRSProblem::Controls::getDenseColLimit ( ) const -> int
inline

Get the value for control DenseColLimit.

Newton barrier: Columns with more than DENSECOLLIMIT elements are considered to be dense. Such columns will be handled specially in the Cholesky factorization of this matrix.

Returns
The current value for DenseColLimit.

getDeterministic()

auto xpress::XPRSProblem::Controls::getDeterministic ( ) const -> int
inline

Get the value for control Deterministic.

Selects whether to use a deterministic or opportunistic mode when solving a problem using multiple threads.

Returns
The current value for Deterministic.

getDetLogFreq()

auto xpress::XPRSProblem::Controls::getDetLogFreq ( ) const -> double
inline

Get the value for control DetLogFreq.

Returns
The current value for DetLogFreq.

getDualGradient()

auto xpress::XPRSProblem::Controls::getDualGradient ( ) const -> int
inline

Get the value for control DualGradient.

Simplex: This specifies the dual simplex pricing method.

Returns
The current value for DualGradient.

getDualize()

auto xpress::XPRSProblem::Controls::getDualize ( ) const -> int
inline

Get the value for control Dualize.

For a linear problem or the initial linear relaxation of a MIP, determines whether to form and solve the dual problem.

Returns
The current value for Dualize.

getDualizeOps()

auto xpress::XPRSProblem::Controls::getDualizeOps ( ) const -> int
inline

Get the value for control DualizeOps.

Bit-vector control for adjusting the behavior when a problem is dualized.

Returns
The current value for DualizeOps.

getDualPerturb()

auto xpress::XPRSProblem::Controls::getDualPerturb ( ) const -> double
inline

Get the value for control DualPerturb.

The factor by which the problem will be perturbed prior to optimization by dual simplex. A value of 0.0 results in no perturbation prior to optimization.

Note the interconnection to the AUTOPERTURB control. If AUTOPERTURB is set to 1, the decision whether to perturb or not is left to the Optimizer. When the problem is automatically perturbed in dual simplex, however, the value of DUALPERTURB will be used for perturbation.

Returns
The current value for DualPerturb.

getDualStrategy()

auto xpress::XPRSProblem::Controls::getDualStrategy ( ) const -> int
inline

Get the value for control DualStrategy.

This bit-vector control specifies the dual simplex strategy.

Returns
The current value for DualStrategy.

getDualThreads()

auto xpress::XPRSProblem::Controls::getDualThreads ( ) const -> int
inline

Get the value for control DualThreads.

Determines the maximum number of threads that dual simplex is allowed to use. If DUALTHREADS is set to the default value (-1), the THREADS control will determine the number of threads used.

Returns
The current value for DualThreads.

getDummyControl()

auto xpress::XPRSProblem::Controls::getDummyControl ( ) const -> double
inline

Get the value for control DummyControl.

Returns
The current value for DummyControl.

getEigenValueTol()

auto xpress::XPRSProblem::Controls::getEigenValueTol ( ) const -> double
inline

Get the value for control EigenValueTol.

A quadratic matrix is considered not to be positive semi-definite, if its smallest eigenvalue is smaller than the negative of this value.

Returns
The current value for EigenValueTol.

getElimFillIn()

auto xpress::XPRSProblem::Controls::getElimFillIn ( ) const -> int
inline

Get the value for control ElimFillIn.

Amount of fill-in allowed when performing an elimination in presolve .

Returns
The current value for ElimFillIn.

getElimTol()

auto xpress::XPRSProblem::Controls::getElimTol ( ) const -> double
inline

Get the value for control ElimTol.

The Markowitz tolerance for the elimination phase of the presolve.

Returns
The current value for ElimTol.

getEscapeNames()

auto xpress::XPRSProblem::Controls::getEscapeNames ( ) const -> int
inline

Get the value for control EscapeNames.

If characters illegal to an mps or lp file should be escaped to guarantee readability, and whether escaped characters should be transformed back when reading such a file.

Returns
The current value for EscapeNames.

getEtaTol()

auto xpress::XPRSProblem::Controls::getEtaTol ( ) const -> double
inline

Get the value for control EtaTol.

Tolerance on eta elements. During each iteration, the basis inverse is premultiplied by an elementary matrix, which is the identity except for one column - the eta vector. Elements of eta vectors whose absolute value is smaller than ETATOL are taken to be zero in this step.

Returns
The current value for EtaTol.

getExtraCols()

auto xpress::XPRSProblem::Controls::getExtraCols ( ) const -> int
inline

Get the value for control ExtraCols.

The initial number of extra columns to allow for in the matrix. If columns are to be added to the matrix, then, for maximum efficiency, space should be reserved for the columns before the matrix is input by setting the EXTRACOLS control. If this is not done, resizing will occur automatically, but more space may be allocated than the user actually requires.

Returns
The current value for ExtraCols.

getExtraElems()

auto xpress::XPRSProblem::Controls::getExtraElems ( ) const -> XPRSint64
inline

Get the value for control ExtraElems.

The initial number of extra matrix elements to allow for in the matrix, including coefficients for cuts. If rows or columns are to be added to the matrix, then, for maximum efficiency, space should be reserved for the extra matrix elements before the matrix is input by setting the EXTRAELEMS control. If this is not done, resizing will occur automatically, but more space may be allocated than the user actually requires.

Returns
The current value for ExtraElems.

getExtraMipEnts()

auto xpress::XPRSProblem::Controls::getExtraMipEnts ( ) const -> int
inline

Get the value for control ExtraMipEnts.

The initial number of extra MIP entities to allow for.

Returns
The current value for ExtraMipEnts.

getExtraRows()

auto xpress::XPRSProblem::Controls::getExtraRows ( ) const -> int
inline

Get the value for control ExtraRows.

The initial number of extra rows to allow for in the matrix, including cuts. If rows are to be added to the matrix, then, for maximum efficiency, space should be reserved for the rows before the matrix is input by setting the EXTRAROWS control. If this is not done, resizing will occur automatically, but more space may be allocated than the user actually requires.

Returns
The current value for ExtraRows.

getExtraSetElems()

auto xpress::XPRSProblem::Controls::getExtraSetElems ( ) const -> XPRSint64
inline

Get the value for control ExtraSetElems.

The initial number of extra elements in sets to allow for in the matrix. If sets are to be added to the matrix, then, for maximum efficiency, space should be reserved for the set elements before the matrix is input by setting the EXTRASETELEMS control. If this is not done, resizing will occur automatically, but more space may be allocated than the user actually requires.

Returns
The current value for ExtraSetElems.

getExtraSets()

auto xpress::XPRSProblem::Controls::getExtraSets ( ) const -> int
inline

Get the value for control ExtraSets.

The initial number of extra sets to allow for in the matrix. If sets are to be added to the matrix, then, for maximum efficiency, space should be reserved for the sets before the matrix is input by setting the EXTRASETS control. If this is not done, resizing will occur automatically, but more space may be allocated than the user actually requires.

Returns
The current value for ExtraSets.

getFeasibilityJump()

auto xpress::XPRSProblem::Controls::getFeasibilityJump ( ) const -> int
inline

Get the value for control FeasibilityJump.

MIP: Decides if the Feasibility Jump heuristic should be run. The value for this control is either -1 (let Xpress decide), 0 (off) or a value that indicates for which type of models the heuristic should be run.

Returns
The current value for FeasibilityJump.

getFeasibilityPump()

auto xpress::XPRSProblem::Controls::getFeasibilityPump ( ) const -> int
inline

Get the value for control FeasibilityPump.

Branch and Bound: Decides if the Feasibility Pump heuristic should be run at the top node.

Returns
The current value for FeasibilityPump.

getFeasTol()

auto xpress::XPRSProblem::Controls::getFeasTol ( ) const -> double
inline

Get the value for control FeasTol.

This tolerance determines when a solution is treated as feasible. If the amount by which a constraint's activity violates its right-hand side or ranged bound is less in absolute magnitude than FEASTOL, then the constraint is treated as satisfied. Similarly, if the amount by which a column violates its bounds is less in absolute magnitude than FEASTOL, those bounds are also treated as satisfied.

Returns
The current value for FeasTol.

getFeasTolPerturb()

auto xpress::XPRSProblem::Controls::getFeasTolPerturb ( ) const -> double
inline

Get the value for control FeasTolPerturb.

This tolerance determines how much a feasible primal basic solution is allowed to be perturbed when performing basis changes. The tolerance FEASTOL is always considered as an upper limit for the perturbations, but in some cases smaller value can be more desirable.

Returns
The current value for FeasTolPerturb.

getFeasTolTarget()

auto xpress::XPRSProblem::Controls::getFeasTolTarget ( ) const -> double
inline

Get the value for control FeasTolTarget.

This specifies the target feasibility tolerance for the solution refiner.

Returns
The current value for FeasTolTarget.

getForceOutput()

auto xpress::XPRSProblem::Controls::getForceOutput ( ) const -> int
inline

Get the value for control ForceOutput.

Certain names in the problem object may be incompatible with different file formats (such as names containing spaces for LP files). If the optimizer might be unable to read back a problem because of non-standard names, it will first attempt to write it out using an extended naming convention. If the names would not be possible to extend so that they would be reproducible and recognizable, it will give an error message and won't create the file. If the optimizer might be unable to read back a problem because of non-standard names, it will give an error message and won't create the file. This option may be used to force output anyway.

Returns
The current value for ForceOutput.

getForceParallelDual()

auto xpress::XPRSProblem::Controls::getForceParallelDual ( ) const -> int
inline

Get the value for control ForceParallelDual.

Dual simplex: specifies whether the dual simplex solver should always use the parallel simplex algorithm. By default, when using a single thread, the dual simplex solver will execute a dedicated sequential simplex algorithm.

Returns
The current value for ForceParallelDual.

getGenconsAbsTransformation()

auto xpress::XPRSProblem::Controls::getGenconsAbsTransformation ( ) const -> int
inline

Get the value for control GenconsAbsTransformation.

This control specifies the reformulation method for absolute value general constraints at the beginning of the search.

Returns
The current value for GenconsAbsTransformation.

getGenconsDualReductions()

auto xpress::XPRSProblem::Controls::getGenconsDualReductions ( ) const -> int
inline

Get the value for control GenconsDualReductions.

This parameter specifies whether dual reductions should be applied to reduce the number of columns and rows added when transforming general constraints to MIP structs.

Returns
The current value for GenconsDualReductions.

getGlobalBoundingBox()

auto xpress::XPRSProblem::Controls::getGlobalBoundingBox ( ) const -> double
inline

Get the value for control GlobalBoundingBox.

If a nonlinear problem cannot be solved due to appearing unbounded, it can automatically be regularized by the application of a bounding box on the variables. If this control is set to a negative value, in a second solving attempt all original variables will be bounded by the absolute value of this control. If set to a positive value, there will be a third solving attempt afterwards, if necessary, in which also all auxiliary variables are bounded by this value.

Returns
The current value for GlobalBoundingBox.

getGlobalLSHeurstrategy()

auto xpress::XPRSProblem::Controls::getGlobalLSHeurstrategy ( ) const -> int
inline

Get the value for control GlobalLSHeurstrategy.

 When integer-feasible (for MINLP, any solution for NLP) but nonlinear-infeasible solutions
 are encountered within a global solve, the integer variables can be fixed and a local solver (as defined
 by the <code>LOCALSOLVER</code> control) can be called on the remaining continuous problem. This
 control defines the frequency and effort of such local solves.
Returns
The current value for GlobalLSHeurstrategy.

getGlobalNlpCuts()

auto xpress::XPRSProblem::Controls::getGlobalNlpCuts ( ) const -> int
inline

Get the value for control GlobalNlpCuts.

Limit on the number of rounds of outer approximation and convexification cuts generated for the root node, when solving an (MI)NLP to global optimality.

Returns
The current value for GlobalNlpCuts.

getGlobalNumInitNlpCuts()

auto xpress::XPRSProblem::Controls::getGlobalNumInitNlpCuts ( ) const -> int
inline

Get the value for control GlobalNumInitNlpCuts.

Specifies the maximum number of tangent cuts when setting up the initial relaxation during a global solve. By default, the algorithm chooses the number of cuts automatically. Adding more cuts tightens the problem, resulting in a smaller branch-and-bound tree, at the cost of slowing down each LP solve.

Returns
The current value for GlobalNumInitNlpCuts.

getGlobalSpatialBranchCuttingEffort()

auto xpress::XPRSProblem::Controls::getGlobalSpatialBranchCuttingEffort ( ) const -> double
inline

Get the value for control GlobalSpatialBranchCuttingEffort.

Limits the effort that is spent on creating cuts during spatial branching.

Returns
The current value for GlobalSpatialBranchCuttingEffort.

getGlobalSpatialBranchIfPreferOrig()

auto xpress::XPRSProblem::Controls::getGlobalSpatialBranchIfPreferOrig ( ) const -> int
inline

Get the value for control GlobalSpatialBranchIfPreferOrig.

Whether spatial branchings on original variables should be preferred over branching on auxiliary variables that were introduced by the reformulation of the global solver.

Returns
The current value for GlobalSpatialBranchIfPreferOrig.

getGlobalSpatialBranchPropagationEffort()

auto xpress::XPRSProblem::Controls::getGlobalSpatialBranchPropagationEffort ( ) const -> double
inline

Get the value for control GlobalSpatialBranchPropagationEffort.

Limits the effort that is spent on propagation during spatial branching.

Returns
The current value for GlobalSpatialBranchPropagationEffort.

getGlobalTreeNlpCuts()

auto xpress::XPRSProblem::Controls::getGlobalTreeNlpCuts ( ) const -> int
inline

Get the value for control GlobalTreeNlpCuts.

Limit on the number of rounds of outer approximation and convexification cuts generated for each node in the tree, when solving an (MI)NLP to global optimality.

Returns
The current value for GlobalTreeNlpCuts.

getGomCuts()

auto xpress::XPRSProblem::Controls::getGomCuts ( ) const -> int
inline

Get the value for control GomCuts.

Branch and Bound: The number of rounds of Gomory or lift-and-project cuts at the top node.

Returns
The current value for GomCuts.

getHeurBeforeLp()

auto xpress::XPRSProblem::Controls::getHeurBeforeLp ( ) const -> int
inline

Get the value for control HeurBeforeLp.

Branch and Bound: Determines whether primal heuristics should be run before the initial LP relaxation has been solved.

Returns
The current value for HeurBeforeLp.

getHeurDepth()

auto xpress::XPRSProblem::Controls::getHeurDepth ( ) const -> int
inline

Get the value for control HeurDepth.

Branch and Bound: Sets the maximum depth in the tree search at which heuristics will be used to find MIP solutions. It may be worth stopping the heuristic search for solutions after a certain depth in the tree search. A value of 0 signifies that heuristics will not be used. This control no longer has any effect and will be removed from future releases.

Returns
The current value for HeurDepth.

getHeurDiveIterLimit()

auto xpress::XPRSProblem::Controls::getHeurDiveIterLimit ( ) const -> double
inline

Get the value for control HeurDiveIterLimit.

Branch and Bound: Simplex iteration limit for reoptimizing during the diving heuristic.

Returns
The current value for HeurDiveIterLimit.

getHeurDiveRandomize()

auto xpress::XPRSProblem::Controls::getHeurDiveRandomize ( ) const -> double
inline

Get the value for control HeurDiveRandomize.

The level of randomization to apply in the diving heuristic. The diving heuristic uses priority weights on rows and columns to determine the order in which to e.g. round fractional columns, or the direction in which to round them. This control determines by how large a random factor these weights should be changed.

Returns
The current value for HeurDiveRandomize.

getHeurDiveSoftRounding()

auto xpress::XPRSProblem::Controls::getHeurDiveSoftRounding ( ) const -> int
inline

Get the value for control HeurDiveSoftRounding.

Branch and Bound: Enables a more cautious strategy for the diving heuristic, where it tries to push binaries and integer variables to their bounds using the objective, instead of directly fixing them. This can be useful when the default diving heuristics fail to find any feasible solutions.

Returns
The current value for HeurDiveSoftRounding.

getHeurDiveSpeedUp()

auto xpress::XPRSProblem::Controls::getHeurDiveSpeedUp ( ) const -> int
inline

Get the value for control HeurDiveSpeedUp.

Branch and Bound: Changes the emphasis of the diving heuristic from solution quality to diving speed.

Returns
The current value for HeurDiveSpeedUp.

getHeurDiveStrategy()

auto xpress::XPRSProblem::Controls::getHeurDiveStrategy ( ) const -> int
inline

Get the value for control HeurDiveStrategy.

Branch and Bound: Chooses the strategy for the diving heuristic.

Returns
The current value for HeurDiveStrategy.

getHeurEmphasis()

auto xpress::XPRSProblem::Controls::getHeurEmphasis ( ) const -> int
inline

Get the value for control HeurEmphasis.

Branch and Bound: This control specifies an emphasis for the search w.r.t. primal heuristics and other procedures that affect the speed of convergence of the primal-dual gap. For problems where the goal is to achieve a small gap but not neccessarily solving them to optimality, it is recommended to set HEUREMPHASIS to 1. This setting triggers many additional heuristic calls, aiming for reducing the gap at the beginning of the search, typically at the expense of an increased time for proving optimality.

Returns
The current value for HeurEmphasis.

getHeurForceSpecialObj()

auto xpress::XPRSProblem::Controls::getHeurForceSpecialObj ( ) const -> int
inline

Get the value for control HeurForceSpecialObj.

Branch and Bound: This specifies whether local search heuristics without objective or with an auxiliary objective should always be used, despite the automatic selection of the Optimiezr. Deactivated by default.

Returns
The current value for HeurForceSpecialObj.

getHeurFreq()

auto xpress::XPRSProblem::Controls::getHeurFreq ( ) const -> int
inline

Get the value for control HeurFreq.

Branch and Bound: This specifies the frequency at which heuristics are used in the tree search. Heuristics will only be used at a node if the depth of the node is a multiple of HEURFREQ.

Returns
The current value for HeurFreq.

getHeurMaxSol()

auto xpress::XPRSProblem::Controls::getHeurMaxSol ( ) const -> int
inline

Get the value for control HeurMaxSol.

Branch and Bound: This specifies the maximum number of heuristic solutions that will be found in the tree search. This control no longer has any effect and will be removed from future releases.

Returns
The current value for HeurMaxSol.

getHeurNodes()

auto xpress::XPRSProblem::Controls::getHeurNodes ( ) const -> int
inline

Get the value for control HeurNodes.

Branch and Bound: This specifies the maximum number of nodes at which heuristics are used in the tree search. This control no longer has any effect and will be removed from future releases.

Returns
The current value for HeurNodes.

getHeursearchBackgroundSelect()

auto xpress::XPRSProblem::Controls::getHeursearchBackgroundSelect ( ) const -> XPRSint64
inline

Get the value for control HeursearchBackgroundSelect.

Select which large neighborhood searches to run in the background (for example in parallel to the root cut loop).

Returns
The current value for HeursearchBackgroundSelect.

getHeurSearchCopyControls()

auto xpress::XPRSProblem::Controls::getHeurSearchCopyControls ( ) const -> int
inline

Get the value for control HeurSearchCopyControls.

Select how user-set controls should affect local search heuristics.

Returns
The current value for HeurSearchCopyControls.

getHeurSearchEffort()

auto xpress::XPRSProblem::Controls::getHeurSearchEffort ( ) const -> double
inline

Get the value for control HeurSearchEffort.

Adjusts the overall level of the local search heuristics.

Returns
The current value for HeurSearchEffort.

getHeurSearchFreq()

auto xpress::XPRSProblem::Controls::getHeurSearchFreq ( ) const -> int
inline

Get the value for control HeurSearchFreq.

Branch and Bound: This specifies how often the local search heuristic should be run in the tree.

Returns
The current value for HeurSearchFreq.

getHeurSearchRootCutFreq()

auto xpress::XPRSProblem::Controls::getHeurSearchRootCutFreq ( ) const -> int
inline

Get the value for control HeurSearchRootCutFreq.

How frequently to run the local search heuristic during root cutting. This is given as how many cut rounds to perform between runs of the heuristic. Set to zero to avoid applying the heuristic during root cutting.

Branch and Bound: This specifies how often the local search heuristic should be run in the tree.

Returns
The current value for HeurSearchRootCutFreq.

getHeurSearchRootSelect()

auto xpress::XPRSProblem::Controls::getHeurSearchRootSelect ( ) const -> int
inline

Get the value for control HeurSearchRootSelect.

A bit vector control for selecting which local search heuristics to apply on the root node of a MIP solve. Use HEURSEARCHTREESELECT to control local search heuristics during the tree search.

Returns
The current value for HeurSearchRootSelect.

getHeurSearchTargetSize()

auto xpress::XPRSProblem::Controls::getHeurSearchTargetSize ( ) const -> double
inline

Get the value for control HeurSearchTargetSize.

Returns
The current value for HeurSearchTargetSize.

getHeurSearchTreeSelect()

auto xpress::XPRSProblem::Controls::getHeurSearchTreeSelect ( ) const -> int
inline

Get the value for control HeurSearchTreeSelect.

A bit vector control for selecting which local search heuristics to apply during the tree search of a MIP solve. Use HEURSEARCHROOTSELECT to control local search heuristics on the root node.

Returns
The current value for HeurSearchTreeSelect.

getHeurSelect()

auto xpress::XPRSProblem::Controls::getHeurSelect ( ) const -> int
inline

Get the value for control HeurSelect.

Returns
The current value for HeurSelect.

getHeurShiftProp()

auto xpress::XPRSProblem::Controls::getHeurShiftProp ( ) const -> int
inline

Get the value for control HeurShiftProp.

Determines whether the Shift-and-propagate primal heuristic should be executed. If enabled, Shift-and-propagate is an LP-free primal heuristic that is executed immediately after presolve.

Returns
The current value for HeurShiftProp.

getHeurThreads()

auto xpress::XPRSProblem::Controls::getHeurThreads ( ) const -> int
inline

Get the value for control HeurThreads.

Branch and Bound: The number of threads to dedicate to running heuristics during the root solve.

Returns
The current value for HeurThreads.

getHistoryCosts()

auto xpress::XPRSProblem::Controls::getHistoryCosts ( ) const -> int
inline

Get the value for control HistoryCosts.

Branch and Bound: How to update the pseudo cost for a MIP entity when a strong branch or a regular branch is applied.

Returns
The current value for HistoryCosts.

getIfCheckConvexity()

auto xpress::XPRSProblem::Controls::getIfCheckConvexity ( ) const -> int
inline

Get the value for control IfCheckConvexity.

Determines if the convexity of the problem is checked before optimization. Applies to quadratic, mixed integer quadratic and quadratically constrained problems. Checking convexity takes some time, thus for problems that are known to be convex it might be reasonable to switch the checking off.

Returns
The current value for IfCheckConvexity.

getIgnoreContainerCpuLimit()

auto xpress::XPRSProblem::Controls::getIgnoreContainerCpuLimit ( ) const -> int
inline

Get the value for control IgnoreContainerCpuLimit.

Returns
The current value for IgnoreContainerCpuLimit.

getIgnoreContainerMemoryLimit()

auto xpress::XPRSProblem::Controls::getIgnoreContainerMemoryLimit ( ) const -> int
inline

Get the value for control IgnoreContainerMemoryLimit.

Returns
The current value for IgnoreContainerMemoryLimit.

getIISLog()

auto xpress::XPRSProblem::Controls::getIISLog ( ) const -> int
inline

Get the value for control IISLog.

 Selects how much information should be printed during the IIS procedure. Please refer to Appendix  for a more detailed description of the IIS logging format.
Returns
The current value for IISLog.

getIISOps()

auto xpress::XPRSProblem::Controls::getIISOps ( ) const -> xpress::IISOps
inline

Get the value for control IISOps.

        Selects which part of the restrictions (bounds, constraints, entities) should always be kept in an IIS. This is useful if certain types of restrictions cannot be violated, thus they are known not to be the cause of infeasibility.
        The IIS obtained this way is irreducible only for the non-protected restrictions.

        This control has an effect only on the deletion filter of the IIS procedure.
Returns
The current value for IISOps.

getIndLinBigM()

auto xpress::XPRSProblem::Controls::getIndLinBigM ( ) const -> double
inline

Get the value for control IndLinBigM.

During presolve, indicator constraints will be linearized using a BigM coefficient whenever that BigM coefficient is small enough. This control defines the largest BigM for which such a linearized version will be added to the problem in addition to the original constraint. If the BigM is even smaller than INDPRELINBIGM, then the original indicator constraint will additionally be dropped from the problem.

Returns
The current value for IndLinBigM.

getIndPreLinBigM()

auto xpress::XPRSProblem::Controls::getIndPreLinBigM ( ) const -> double
inline

Get the value for control IndPreLinBigM.

During presolve, indicator constraints will be linearized using a BigM coefficient whenever that BigM coefficient is small enough. This control defines the largest BigM for which the original constraint will be replaced by the linearized version. If the BigM is larger than INDPRELINBIGM but smaller than INDLINBIGM, the linearized row will be added but the original indicator constraint is kept as a numerically stable way to check feasibility.

Returns
The current value for IndPreLinBigM.

getInputtol()

auto xpress::XPRSProblem::Controls::getInputtol ( ) const -> double
inline

Get the value for control Inputtol.

The tolerance on input values elements. If any value is less than or equal to INPUTTOL in absolute value, it is treated as zero. For the internal zero tolerance see MATRIXTOL.

Returns
The current value for Inputtol.

getInvertFreq()

auto xpress::XPRSProblem::Controls::getInvertFreq ( ) const -> int
inline

Get the value for control InvertFreq.

Simplex: The frequency with which the basis will be inverted. The basis is maintained in a factorized form and on most simplex iterations it is incrementally updated to reflect the step just taken. This is considerably faster than computing the full inverted matrix at each iteration, although after a number of iterations the basis becomes less well-conditioned and it becomes necessary to compute the full inverted matrix. The value of INVERTFREQ specifies the maximum number of iterations between full inversions.

Returns
The current value for InvertFreq.

getInvertMin()

auto xpress::XPRSProblem::Controls::getInvertMin ( ) const -> int
inline

Get the value for control InvertMin.

Simplex: The minimum number of iterations between full inversions of the basis matrix. See the description of INVERTFREQ for details.

Returns
The current value for InvertMin.

getIOTimeout()

auto xpress::XPRSProblem::Controls::getIOTimeout ( ) const -> int
inline

Get the value for control IOTimeout.

The maximum number of seconds to wait for an I/O operation before it is cancelled.

Returns
The current value for IOTimeout.

getKeepBasis()

auto xpress::XPRSProblem::Controls::getKeepBasis ( ) const -> int
inline

Get the value for control KeepBasis.

Simplex: This determines whether the basis should be kept when reoptimizing a problem. The choice is between using a crash basis created at the beginning of simplex or using a basis from a previous solve (if such exists). By default, this control gets (re)set automatically in various situations. By default, it will be automatically set to 1 after a solve that produced a valid basis. This will automatically warmstart a subsequent solve. Explicitly loading a starting basis will also set this control to 1. If the control is explicitly set to 0, any existing basis will be ignored for a new solve, and the Optimizer will start from an ad-hoc crash basis.

Returns
The current value for KeepBasis.

getKeepNRows()

auto xpress::XPRSProblem::Controls::getKeepNRows ( ) const -> int
inline

Get the value for control KeepNRows.

How nonbinding rows should be handled by the MPS reader.

Returns
The current value for KeepNRows.

getKnitroParamAlgorithm()

auto xpress::XPRSProblem::Controls::getKnitroParamAlgorithm ( ) const -> int
inline

Get the value for control KnitroParamAlgorithm.

Indicates which algorithm to use to solve the problem

Returns
The current value for KnitroParamAlgorithm.

getKnitroParamBarDirectInterval()

auto xpress::XPRSProblem::Controls::getKnitroParamBarDirectInterval ( ) const -> int
inline

Get the value for control KnitroParamBarDirectInterval.

Controls the maximum number of consecutive conjugate gradient (CG) steps before Knitro will try to enforce that a step is taken using direct linear algebra.

Returns
The current value for KnitroParamBarDirectInterval.

getKnitroParamBarFeasible()

auto xpress::XPRSProblem::Controls::getKnitroParamBarFeasible ( ) const -> int
inline

Get the value for control KnitroParamBarFeasible.

Specifies whether special emphasis is placed on getting and staying feasible in the interior-point algorithms.

Returns
The current value for KnitroParamBarFeasible.

getKnitroParamBarFeasModeTol()

auto xpress::XPRSProblem::Controls::getKnitroParamBarFeasModeTol ( ) const -> double
inline

Get the value for control KnitroParamBarFeasModeTol.

Specifies the tolerance in equation that determines whether Knitro will force subsequent iterates to remain feasible.

Returns
The current value for KnitroParamBarFeasModeTol.

getKnitroParamBarInitMu()

auto xpress::XPRSProblem::Controls::getKnitroParamBarInitMu ( ) const -> double
inline

Get the value for control KnitroParamBarInitMu.

Specifies the initial value for the barrier parameter : mu used with the barrier algorithms. This option has no effect on the Active Set algorithm.

Returns
The current value for KnitroParamBarInitMu.

getKnitroParamBarInitPt()

auto xpress::XPRSProblem::Controls::getKnitroParamBarInitPt ( ) const -> int
inline

Get the value for control KnitroParamBarInitPt.

Indicates whether an initial point strategy is used with barrier algorithms.

Returns
The current value for KnitroParamBarInitPt.

getKnitroParamBarMaxBacktrack()

auto xpress::XPRSProblem::Controls::getKnitroParamBarMaxBacktrack ( ) const -> int
inline

Get the value for control KnitroParamBarMaxBacktrack.

Indicates the maximum allowable number of backtracks during the linesearch of the Interior/Direct algorithm before reverting to a CG step.

Returns
The current value for KnitroParamBarMaxBacktrack.

getKnitroParamBarMaxRefactor()

auto xpress::XPRSProblem::Controls::getKnitroParamBarMaxRefactor ( ) const -> int
inline

Get the value for control KnitroParamBarMaxRefactor.

Indicates the maximum number of refactorizations of the KKT system per iteration of the Interior/Direct algorithm before reverting to a CG step.

Returns
The current value for KnitroParamBarMaxRefactor.

getKnitroParamBarMuRule()

auto xpress::XPRSProblem::Controls::getKnitroParamBarMuRule ( ) const -> int
inline

Get the value for control KnitroParamBarMuRule.

Indicates which strategy to use for modifying the barrier parameter mu in the barrier algorithms.

Returns
The current value for KnitroParamBarMuRule.

getKnitroParamBarPenCons()

auto xpress::XPRSProblem::Controls::getKnitroParamBarPenCons ( ) const -> int
inline

Get the value for control KnitroParamBarPenCons.

Indicates whether a penalty approach is applied to the constraints.

Returns
The current value for KnitroParamBarPenCons.

getKnitroParamBarPenRule()

auto xpress::XPRSProblem::Controls::getKnitroParamBarPenRule ( ) const -> int
inline

Get the value for control KnitroParamBarPenRule.

Indicates which penalty parameter strategy to use for determining whether or not to accept a trial iterate.

Returns
The current value for KnitroParamBarPenRule.

getKnitroParamBarRelaxCons()

auto xpress::XPRSProblem::Controls::getKnitroParamBarRelaxCons ( ) const -> int
inline

Get the value for control KnitroParamBarRelaxCons.

Returns
The current value for KnitroParamBarRelaxCons.

getKnitroParamBarSwitchRule()

auto xpress::XPRSProblem::Controls::getKnitroParamBarSwitchRule ( ) const -> int
inline

Get the value for control KnitroParamBarSwitchRule.

Indicates whether or not the barrier algorithms will allow switching from an optimality phase to a pure feasibility phase.

Returns
The current value for KnitroParamBarSwitchRule.

getKnitroParamBLASOption()

auto xpress::XPRSProblem::Controls::getKnitroParamBLASOption ( ) const -> int
inline

Get the value for control KnitroParamBLASOption.

Returns
The current value for KnitroParamBLASOption.

getKnitroParamDebug()

auto xpress::XPRSProblem::Controls::getKnitroParamDebug ( ) const -> int
inline

Get the value for control KnitroParamDebug.

Returns
The current value for KnitroParamDebug.

getKnitroParamDelta()

auto xpress::XPRSProblem::Controls::getKnitroParamDelta ( ) const -> double
inline

Get the value for control KnitroParamDelta.

Specifies the initial trust region radius scaling factor used to determine the initial trust region size.

Returns
The current value for KnitroParamDelta.

getKnitroParamFeastol()

auto xpress::XPRSProblem::Controls::getKnitroParamFeastol ( ) const -> double
inline

Get the value for control KnitroParamFeastol.

Specifies the final relative stopping tolerance for the feasibility error.

Returns
The current value for KnitroParamFeastol.

getKnitroParamFeasTolAbs()

auto xpress::XPRSProblem::Controls::getKnitroParamFeasTolAbs ( ) const -> double
inline

Get the value for control KnitroParamFeasTolAbs.

Specifies the final absolute stopping tolerance for the feasibility error.

Returns
The current value for KnitroParamFeasTolAbs.

getKnitroParamGradOpt()

auto xpress::XPRSProblem::Controls::getKnitroParamGradOpt ( ) const -> int
inline

Get the value for control KnitroParamGradOpt.

Specifies how to compute the gradients of the objective and constraint functions.

Returns
The current value for KnitroParamGradOpt.

getKnitroParamHessOpt()

auto xpress::XPRSProblem::Controls::getKnitroParamHessOpt ( ) const -> int
inline

Get the value for control KnitroParamHessOpt.

Specifies how to compute the (approximate) Hessian of the Lagrangian.

Returns
The current value for KnitroParamHessOpt.

getKnitroParamHonorBbnds()

auto xpress::XPRSProblem::Controls::getKnitroParamHonorBbnds ( ) const -> int
inline

Get the value for control KnitroParamHonorBbnds.

Indicates whether or not to enforce satisfaction of simple variable bounds throughout the optimization.

Returns
The current value for KnitroParamHonorBbnds.

getKnitroParamInfeasTol()

auto xpress::XPRSProblem::Controls::getKnitroParamInfeasTol ( ) const -> double
inline

Get the value for control KnitroParamInfeasTol.

Specifies the (relative) tolerance used for declaring infeasibility of a model.

Returns
The current value for KnitroParamInfeasTol.

getKnitroParamLinSolver()

auto xpress::XPRSProblem::Controls::getKnitroParamLinSolver ( ) const -> int
inline

Get the value for control KnitroParamLinSolver.

Returns
The current value for KnitroParamLinSolver.

getKnitroParamLMSize()

auto xpress::XPRSProblem::Controls::getKnitroParamLMSize ( ) const -> int
inline

Get the value for control KnitroParamLMSize.

Specifies the number of limited memory pairs stored when approximating the Hessian using the limited-memory quasi-Newton BFGS option.

Returns
The current value for KnitroParamLMSize.

getKnitroParamMATerminate()

auto xpress::XPRSProblem::Controls::getKnitroParamMATerminate ( ) const -> int
inline

Get the value for control KnitroParamMATerminate.

Returns
The current value for KnitroParamMATerminate.

getKnitroParamMaxCGIt()

auto xpress::XPRSProblem::Controls::getKnitroParamMaxCGIt ( ) const -> int
inline

Get the value for control KnitroParamMaxCGIt.

Specifies the number of limited memory pairs stored when approximating the Hessian using the limited-memory quasi-Newton BFGS option.

Returns
The current value for KnitroParamMaxCGIt.

getKnitroParamMaxCrossIt()

auto xpress::XPRSProblem::Controls::getKnitroParamMaxCrossIt ( ) const -> int
inline

Get the value for control KnitroParamMaxCrossIt.

Specifies the maximum number of crossover iterations before termination.

Returns
The current value for KnitroParamMaxCrossIt.

getKnitroParamMaxIt()

auto xpress::XPRSProblem::Controls::getKnitroParamMaxIt ( ) const -> int
inline

Get the value for control KnitroParamMaxIt.

Specifies the maximum number of iterations before termination.

Returns
The current value for KnitroParamMaxIt.

getKnitroParamMipBranchRule()

auto xpress::XPRSProblem::Controls::getKnitroParamMipBranchRule ( ) const -> int
inline

Get the value for control KnitroParamMipBranchRule.

Specifies which branching rule to use for MIP branch and bound procedure.

Returns
The current value for KnitroParamMipBranchRule.

getKnitroParamMipDebug()

auto xpress::XPRSProblem::Controls::getKnitroParamMipDebug ( ) const -> int
inline

Get the value for control KnitroParamMipDebug.

Returns
The current value for KnitroParamMipDebug.

getKnitroParamMipGUBBranch()

auto xpress::XPRSProblem::Controls::getKnitroParamMipGUBBranch ( ) const -> int
inline

Get the value for control KnitroParamMipGUBBranch.

Specifies whether or not to branch on generalized upper bounds (GUBs).

Returns
The current value for KnitroParamMipGUBBranch.

getKnitroParamMipHeuristic()

auto xpress::XPRSProblem::Controls::getKnitroParamMipHeuristic ( ) const -> int
inline

Get the value for control KnitroParamMipHeuristic.

Specifies which MIP heuristic search approach to apply to try to find an initial integer feasible point.

Returns
The current value for KnitroParamMipHeuristic.

getKnitroParamMipHeurMaxIt()

auto xpress::XPRSProblem::Controls::getKnitroParamMipHeurMaxIt ( ) const -> int
inline

Get the value for control KnitroParamMipHeurMaxIt.

Returns
The current value for KnitroParamMipHeurMaxIt.

getKnitroParamMipImplicatns()

auto xpress::XPRSProblem::Controls::getKnitroParamMipImplicatns ( ) const -> int
inline

Get the value for control KnitroParamMipImplicatns.

Specifies whether or not to add constraints to the MIP derived from logical implications.

Returns
The current value for KnitroParamMipImplicatns.

getKnitroParamMipIntGapAbs()

auto xpress::XPRSProblem::Controls::getKnitroParamMipIntGapAbs ( ) const -> double
inline

Get the value for control KnitroParamMipIntGapAbs.

The absolute integrality gap stop tolerance for MIP.

Returns
The current value for KnitroParamMipIntGapAbs.

getKnitroParamMipIntGapRel()

auto xpress::XPRSProblem::Controls::getKnitroParamMipIntGapRel ( ) const -> double
inline

Get the value for control KnitroParamMipIntGapRel.

The relative integrality gap stop tolerance for MIP.

Returns
The current value for KnitroParamMipIntGapRel.

getKnitroParamMipKnapsack()

auto xpress::XPRSProblem::Controls::getKnitroParamMipKnapsack ( ) const -> int
inline

Get the value for control KnitroParamMipKnapsack.

Specifies rules for adding MIP knapsack cuts.

Returns
The current value for KnitroParamMipKnapsack.

getKnitroParamMipLpAlg()

auto xpress::XPRSProblem::Controls::getKnitroParamMipLpAlg ( ) const -> int
inline

Get the value for control KnitroParamMipLpAlg.

Specifies which algorithm to use for any linear programming (LP) subproblem solves that may occur in the MIP branch and bound procedure.

Returns
The current value for KnitroParamMipLpAlg.

getKnitroParamMipMaxNodes()

auto xpress::XPRSProblem::Controls::getKnitroParamMipMaxNodes ( ) const -> int
inline

Get the value for control KnitroParamMipMaxNodes.

Specifies the maximum number of nodes explored.

Returns
The current value for KnitroParamMipMaxNodes.

getKnitroParamMipMethod()

auto xpress::XPRSProblem::Controls::getKnitroParamMipMethod ( ) const -> int
inline

Get the value for control KnitroParamMipMethod.

Specifies which MIP method to use.

Returns
The current value for KnitroParamMipMethod.

getKnitroParamMipOutInterval()

auto xpress::XPRSProblem::Controls::getKnitroParamMipOutInterval ( ) const -> int
inline

Get the value for control KnitroParamMipOutInterval.

Specifies node printing interval for XKTR_PARAM_MIP_OUTLEVEL when XKTR_PARAM_MIP_OUTLEVEL > 0.

Returns
The current value for KnitroParamMipOutInterval.

getKnitroParamMipOutLevel()

auto xpress::XPRSProblem::Controls::getKnitroParamMipOutLevel ( ) const -> int
inline

Get the value for control KnitroParamMipOutLevel.

Specifies how much MIP information to print.

Returns
The current value for KnitroParamMipOutLevel.

getKnitroParamMipPseudoint()

auto xpress::XPRSProblem::Controls::getKnitroParamMipPseudoint ( ) const -> int
inline

Get the value for control KnitroParamMipPseudoint.

Specifies the method used to initialize pseudo-costs corresponding to variables that have not yet been branched on in the MIP method.

Returns
The current value for KnitroParamMipPseudoint.

getKnitroParamMipRootAlg()

auto xpress::XPRSProblem::Controls::getKnitroParamMipRootAlg ( ) const -> int
inline

Get the value for control KnitroParamMipRootAlg.

Specifies which algorithm to use for the root node solve in MIP (same options as XKTR_PARAM_ALGORITHM user option).

Returns
The current value for KnitroParamMipRootAlg.

getKnitroParamMipRounding()

auto xpress::XPRSProblem::Controls::getKnitroParamMipRounding ( ) const -> int
inline

Get the value for control KnitroParamMipRounding.

Specifies the MIP rounding rule to apply.

Returns
The current value for KnitroParamMipRounding.

getKnitroParamMipSelectRule()

auto xpress::XPRSProblem::Controls::getKnitroParamMipSelectRule ( ) const -> int
inline

Get the value for control KnitroParamMipSelectRule.

Specifies the MIP select rule for choosing the next node in the branch and bound tree.

Returns
The current value for KnitroParamMipSelectRule.

getKnitroParamMipStringMaxIt()

auto xpress::XPRSProblem::Controls::getKnitroParamMipStringMaxIt ( ) const -> int
inline

Get the value for control KnitroParamMipStringMaxIt.

Specifies the maximum number of iterations to allow for MIP strong branching solves.

Returns
The current value for KnitroParamMipStringMaxIt.

getKnitroParamMipStrongCandLim()

auto xpress::XPRSProblem::Controls::getKnitroParamMipStrongCandLim ( ) const -> int
inline

Get the value for control KnitroParamMipStrongCandLim.

Specifies the maximum number of candidates to explore for MIP strong branching.

Returns
The current value for KnitroParamMipStrongCandLim.

getKnitroParamMipStrongLevel()

auto xpress::XPRSProblem::Controls::getKnitroParamMipStrongLevel ( ) const -> int
inline

Get the value for control KnitroParamMipStrongLevel.

Specifies the maximum number of tree levels on which to perform MIP strong branching.

Returns
The current value for KnitroParamMipStrongLevel.

getKnitroParamMsMaxBndRange()

auto xpress::XPRSProblem::Controls::getKnitroParamMsMaxBndRange ( ) const -> double
inline

Get the value for control KnitroParamMsMaxBndRange.

Returns
The current value for KnitroParamMsMaxBndRange.

getKnitroParamMSMaxSolves()

auto xpress::XPRSProblem::Controls::getKnitroParamMSMaxSolves ( ) const -> int
inline

Get the value for control KnitroParamMSMaxSolves.

Returns
The current value for KnitroParamMSMaxSolves.

getKnitroParamMSNumToSave()

auto xpress::XPRSProblem::Controls::getKnitroParamMSNumToSave ( ) const -> int
inline

Get the value for control KnitroParamMSNumToSave.

Returns
The current value for KnitroParamMSNumToSave.

getKnitroParamMSSaveTol()

auto xpress::XPRSProblem::Controls::getKnitroParamMSSaveTol ( ) const -> double
inline

Get the value for control KnitroParamMSSaveTol.

Returns
The current value for KnitroParamMSSaveTol.

getKnitroParamMSSeed()

auto xpress::XPRSProblem::Controls::getKnitroParamMSSeed ( ) const -> int
inline

Get the value for control KnitroParamMSSeed.

Returns
The current value for KnitroParamMSSeed.

getKnitroParamMSStartPtRange()

auto xpress::XPRSProblem::Controls::getKnitroParamMSStartPtRange ( ) const -> double
inline

Get the value for control KnitroParamMSStartPtRange.

Returns
The current value for KnitroParamMSStartPtRange.

getKnitroParamMSTerminate()

auto xpress::XPRSProblem::Controls::getKnitroParamMSTerminate ( ) const -> int
inline

Get the value for control KnitroParamMSTerminate.

Returns
The current value for KnitroParamMSTerminate.

getKnitroParamMultiStart()

auto xpress::XPRSProblem::Controls::getKnitroParamMultiStart ( ) const -> int
inline

Get the value for control KnitroParamMultiStart.

Returns
The current value for KnitroParamMultiStart.

getKnitroParamNewPoint()

auto xpress::XPRSProblem::Controls::getKnitroParamNewPoint ( ) const -> int
inline

Get the value for control KnitroParamNewPoint.

Returns
The current value for KnitroParamNewPoint.

getKnitroParamObjRange()

auto xpress::XPRSProblem::Controls::getKnitroParamObjRange ( ) const -> double
inline

Get the value for control KnitroParamObjRange.

Specifies the extreme limits of the objective function for purposes of determining unboundedness.

Returns
The current value for KnitroParamObjRange.

getKnitroParamOptTol()

auto xpress::XPRSProblem::Controls::getKnitroParamOptTol ( ) const -> double
inline

Get the value for control KnitroParamOptTol.

Specifies the final relative stopping tolerance for the KKT (optimality) error.

Returns
The current value for KnitroParamOptTol.

getKnitroParamOptTolAbs()

auto xpress::XPRSProblem::Controls::getKnitroParamOptTolAbs ( ) const -> double
inline

Get the value for control KnitroParamOptTolAbs.

Specifies the final absolute stopping tolerance for the KKT (optimality) error.

Returns
The current value for KnitroParamOptTolAbs.

getKnitroParamOutLev()

auto xpress::XPRSProblem::Controls::getKnitroParamOutLev ( ) const -> int
inline

Get the value for control KnitroParamOutLev.

Controls the level of output produced by Knitro.

Returns
The current value for KnitroParamOutLev.

getKnitroParamParNumThreads()

auto xpress::XPRSProblem::Controls::getKnitroParamParNumThreads ( ) const -> int
inline

Get the value for control KnitroParamParNumThreads.

Returns
The current value for KnitroParamParNumThreads.

getKnitroParamPivot()

auto xpress::XPRSProblem::Controls::getKnitroParamPivot ( ) const -> double
inline

Get the value for control KnitroParamPivot.

Returns
The current value for KnitroParamPivot.

getKnitroParamPresolve()

auto xpress::XPRSProblem::Controls::getKnitroParamPresolve ( ) const -> int
inline

Get the value for control KnitroParamPresolve.

Determine whether or not to use the Knitro presolver to try to simplify the model by removing variables or constraints. Specifies conditions for terminating the MIP algorithm.

Returns
The current value for KnitroParamPresolve.

getKnitroParamPresolveTol()

auto xpress::XPRSProblem::Controls::getKnitroParamPresolveTol ( ) const -> double
inline

Get the value for control KnitroParamPresolveTol.

Determines the tolerance used by the Knitro presolver to remove variables and constraints from the model.

Returns
The current value for KnitroParamPresolveTol.

getKnitroParamScale()

auto xpress::XPRSProblem::Controls::getKnitroParamScale ( ) const -> int
inline

Get the value for control KnitroParamScale.

Performs a scaling of the objective and constraint functions based on their values at the initial point.

Returns
The current value for KnitroParamScale.

getKnitroParamSOC()

auto xpress::XPRSProblem::Controls::getKnitroParamSOC ( ) const -> int
inline

Get the value for control KnitroParamSOC.

Specifies whether or not to try second order corrections (SOC).

Returns
The current value for KnitroParamSOC.

getKnitroParamXTol()

auto xpress::XPRSProblem::Controls::getKnitroParamXTol ( ) const -> double
inline

Get the value for control KnitroParamXTol.

The optimization process will terminate if the relative change in all components of the solution point estimate is less than xtol.

Returns
The current value for KnitroParamXTol.

getL1Cache()

auto xpress::XPRSProblem::Controls::getL1Cache ( ) const -> int
inline

Get the value for control L1Cache.

Newton barrier: L1 cache size in kB (kilo bytes) of the CPU. On Intel (or compatible) platforms a value of -1 may be used to determine the cache size automatically.

Returns
The current value for L1Cache.

getLNPBest()

auto xpress::XPRSProblem::Controls::getLNPBest ( ) const -> int
inline

Get the value for control LNPBest.

Number of infeasible MIP entities to create lift-and-project cuts for during each round of Gomory cuts at the top node (see GOMCUTS).

Returns
The current value for LNPBest.

getLNPIterLimit()

auto xpress::XPRSProblem::Controls::getLNPIterLimit ( ) const -> int
inline

Get the value for control LNPIterLimit.

Number of iterations to perform in improving each lift-and-project cut.

Returns
The current value for LNPIterLimit.

getLocalBacktrack()

auto xpress::XPRSProblem::Controls::getLocalBacktrack ( ) const -> int
inline

Get the value for control LocalBacktrack.

Returns
The current value for LocalBacktrack.

getLocalChoice()

auto xpress::XPRSProblem::Controls::getLocalChoice ( ) const -> int
inline

Get the value for control LocalChoice.

Controls when to perform a local backtrack between the two child nodes during a dive in the branch and bound tree.

Returns
The current value for LocalChoice.

getLocalSolver()

auto xpress::XPRSProblem::Controls::getLocalSolver ( ) const -> int
inline

Get the value for control LocalSolver.

Returns
The current value for LocalSolver.

getLpFlags()

auto xpress::XPRSProblem::Controls::getLpFlags ( ) const -> xpress::LPFlags
inline

Get the value for control LpFlags.

A bit-vector control which defines the algorithm for solving an LP problem or the initial LP relaxation of a MIP problem.

Returns
The current value for LpFlags.

getLpFolding()

auto xpress::XPRSProblem::Controls::getLpFolding ( ) const -> int
inline

Get the value for control LpFolding.

Simplex and barrier: whether to fold an LP problem before solving it.

Returns
The current value for LpFolding.

getLpIterLimit()

auto xpress::XPRSProblem::Controls::getLpIterLimit ( ) const -> int
inline

Get the value for control LpIterLimit.

The maximum number of iterations that will be performed by primal simplex or dual simplex before the optimization process terminates. For MIP problems, this is the maximum total number of iterations over all nodes explored by the Branch and Bound method.

Returns
The current value for LpIterLimit.

getLpLog()

auto xpress::XPRSProblem::Controls::getLpLog ( ) const -> int
inline

Get the value for control LpLog.

Simplex: The frequency at which the simplex log is printed.

Returns
The current value for LpLog.

getLpLogDelay()

auto xpress::XPRSProblem::Controls::getLpLogDelay ( ) const -> double
inline

Get the value for control LpLogDelay.

Time interval between two LP log lines.

Returns
The current value for LpLogDelay.

getLpLogStyle()

auto xpress::XPRSProblem::Controls::getLpLogStyle ( ) const -> int
inline

Get the value for control LpLogStyle.

Simplex: The style of the simplex log.

Returns
The current value for LpLogStyle.

getLpRefineIterLimit()

auto xpress::XPRSProblem::Controls::getLpRefineIterLimit ( ) const -> int
inline

Get the value for control LpRefineIterLimit.

This specifies the simplex iteration limit the solution refiner can spend in attempting to increase the accuracy of an LP solution.

Returns
The current value for LpRefineIterLimit.

getLUPivotTol()

auto xpress::XPRSProblem::Controls::getLUPivotTol ( ) const -> double
inline

Get the value for control LUPivotTol.

Returns
The current value for LUPivotTol.

getMarkowitzTol()

auto xpress::XPRSProblem::Controls::getMarkowitzTol ( ) const -> double
inline

Get the value for control MarkowitzTol.

The Markowitz tolerance used for the factorization of the basis matrix.

Returns
The current value for MarkowitzTol.

getMatrixTol()

auto xpress::XPRSProblem::Controls::getMatrixTol ( ) const -> double
inline

Get the value for control MatrixTol.

The zero tolerance on matrix elements. If the value of a matrix element is less than or equal to MATRIXTOL in absolute value, it is treated as zero. The control applies when solving a problem, for an input tolerance see INPUTTOL.

Returns
The current value for MatrixTol.

getMaxChecksOnMaxCutTime()

auto xpress::XPRSProblem::Controls::getMaxChecksOnMaxCutTime ( ) const -> int
inline

Get the value for control MaxChecksOnMaxCutTime.

This control is intended for use where optimization runs that are terminated using the MAXCUTTIME control are required to be reproduced exactly. This control is necessary because of the inherent difficulty in terminating algorithmic software in a consistent way using temporal criteria. The control value relates to the number of times the optimizer checks the MAXCUTTIME criterion up to and including the check when the termination of cutting was activated. To use the control the user first must obtain the value of the CHECKSONMAXCUTTIME attribute after the run returns. This attribute value is the number of times the optimizer checked the MAXCUTTIME criterion during the last call to the optimization routine XPRSmipoptimize. Note that this attribute value will be negative if the optimizer terminated cutting on the MAXCUTTIME criterion. To ensure accurate reproduction of a run the user should first ensure that MAXCUTTIME is set to its default value or to a large value so the run does not terminate again on MAXCUTTIME and then simply set the control MAXCHECKSONMAXCUTTIME to the absolute value of the CHECKSONMAXCUTTIME value.

Returns
The current value for MaxChecksOnMaxCutTime.

getMaxChecksOnMaxTime()

auto xpress::XPRSProblem::Controls::getMaxChecksOnMaxTime ( ) const -> int
inline

Get the value for control MaxChecksOnMaxTime.

This control is intended for use where optimization runs that are terminated using the TIMELIMIT (or the deprecated MAXTIME) control are required to be reproduced exactly. This control is necessary because of the inherent difficulty in terminating algorithmic software in a consistent way using temporal criteria. The control value relates to the number of times the optimizer checks the TIMELIMIT criterion up to and including the check when the termination was activated. To use the control the user first must obtain the value of the CHECKSONMAXTIME attribute after the run returns. This attribute value is the number of times the optimizer checked the TIMELIMIT criterion during the last call to the optimization routine XPRSmipoptimize. Note that this attribute value will be negative if the optimizer terminated on the TIMELIMIT criterion. To ensure that a reproduction of a run terminates in the same way the user should first ensure that TIMELIMIT is set to its default value or to a large value so the run does not terminate again on TIMELIMIT and then simply set the control MAXCHECKSONMAXTIME to the absolute value of the CHECKSONMAXTIME value.

Returns
The current value for MaxChecksOnMaxTime.

getMaxCutTime()

auto xpress::XPRSProblem::Controls::getMaxCutTime ( ) const -> double
inline

Get the value for control MaxCutTime.

The maximum amount of time allowed for generation of cutting planes and reoptimization. The limit is checked during generation and no further cuts are added once this limit has been exceeded.

Returns
The current value for MaxCutTime.

getMaxIIS()

auto xpress::XPRSProblem::Controls::getMaxIIS ( ) const -> int
inline

Get the value for control MaxIIS.

This function controls the number of Irreducible Infeasible Sets to be found using the XPRSiisall (IIS -a).

Returns
The current value for MaxIIS.

getMaxImpliedBound()

auto xpress::XPRSProblem::Controls::getMaxImpliedBound ( ) const -> double
inline

Get the value for control MaxImpliedBound.

Presolve: When tighter bounds are calculated during MIP preprocessing, only bounds whose absolute value are smaller than MAXIMPLIEDBOUND will be applied to the problem.

Returns
The current value for MaxImpliedBound.

getMaxLocalBacktrack()

auto xpress::XPRSProblem::Controls::getMaxLocalBacktrack ( ) const -> int
inline

Get the value for control MaxLocalBacktrack.

Branch-and-Bound: How far back up the current dive path the optimizer is allowed to look for a local backtrack candidate node.

Returns
The current value for MaxLocalBacktrack.

getMaxMCoeffBufferElems()

auto xpress::XPRSProblem::Controls::getMaxMCoeffBufferElems ( ) const -> int
inline

Get the value for control MaxMCoeffBufferElems.

The maximum number of matrix coefficients to buffer before flushing into the internal representation of the problem. Buffering coefficients can offer a significant performance gain when you are building a matrix using XPRSchgcoef or XPRSchgmcoef, but can lead to a significant memory overhead for large matrices, which this control allows you to influence.

Returns
The current value for MaxMCoeffBufferElems.

getMaxMemoryHard()

auto xpress::XPRSProblem::Controls::getMaxMemoryHard ( ) const -> int
inline

Get the value for control MaxMemoryHard.

This control sets the maximum amount of memory in megabytes the optimizer should allocate. If this limit is exceeded, the solve will terminate. This control is designed to make the optimizer stop in a controlled manner, so that the problem object is valid once termination occurs. The solve state will be set to incomplete. This is different to an out of memory condition in which case the optimizer returns an error. The optimizer may still allocate memory once the limit is exceeded to be able to finsish the operations and stop in a controlled manner. When RESOURCESTRATEGY is enabled, the control also has the same effect as MAXMEMORYSOFT and will cause the optimizer to try preserving memory when possible.

Returns
The current value for MaxMemoryHard.

getMaxMemorySoft()

auto xpress::XPRSProblem::Controls::getMaxMemorySoft ( ) const -> int
inline

Get the value for control MaxMemorySoft.

When RESOURCESTRATEGY is enabled, this control sets the maximum amount of memory in megabytes the optimizer targets to allocate. This may change the solving path, but will not cause the solve to terminate early. To set a hard version of the same, please set MAXMEMORYHARD.

Returns
The current value for MaxMemorySoft.

getMaxMipSol()

auto xpress::XPRSProblem::Controls::getMaxMipSol ( ) const -> int
inline

Get the value for control MaxMipSol.

Branch and Bound: This specifies a limit on the number of integer solutions to be found by the Optimizer. It is possible that during optimization the Optimizer will find the same objective solution from different nodes. However, MAXMIPSOL refers to the total number of integer solutions found, and not necessarily the number of distinct solutions.

Returns
The current value for MaxMipSol.

getMaxMipTasks()

auto xpress::XPRSProblem::Controls::getMaxMipTasks ( ) const -> int
inline

Get the value for control MaxMipTasks.

Branch-and-Bound: The maximum number of tasks to run in parallel during a MIP solve.

Returns
The current value for MaxMipTasks.

getMaxNode()

auto xpress::XPRSProblem::Controls::getMaxNode ( ) const -> int
inline

Get the value for control MaxNode.

Branch and Bound: The maximum number of nodes that will be explored.

Returns
The current value for MaxNode.

getMaxPageLines()

auto xpress::XPRSProblem::Controls::getMaxPageLines ( ) const -> int
inline

Get the value for control MaxPageLines.

Number of lines between page breaks in printable output.

Returns
The current value for MaxPageLines.

getMaxScaleFactor()

auto xpress::XPRSProblem::Controls::getMaxScaleFactor ( ) const -> int
inline

Get the value for control MaxScaleFactor.

This determines the maximum scaling factor that can be applied during scaling. The maximum is provided as an exponent of a power of 2.

Returns
The current value for MaxScaleFactor.

getMaxStallTime()

auto xpress::XPRSProblem::Controls::getMaxStallTime ( ) const -> double
inline

Get the value for control MaxStallTime.

The maximum time in seconds that the Optimizer will continue to search for improving solution after finding a new incumbent.

Returns
The current value for MaxStallTime.

getMaxTime()

auto xpress::XPRSProblem::Controls::getMaxTime ( ) const -> int
inline

Get the value for control MaxTime.

The maximum time in seconds that the Optimizer will run before it terminates, including the problem setup time and solution time. For MIP problems, this is the total time taken to solve all nodes.

Returns
The current value for MaxTime.

getMaxTreeFileSize()

auto xpress::XPRSProblem::Controls::getMaxTreeFileSize ( ) const -> int
inline

Get the value for control MaxTreeFileSize.

The maximum size, in megabytes, to which the tree file may grow, or 0 for no limit. When the tree file reaches this limit, a second tree file will be created. Useful if you are using a filesystem that puts a maximum limit on the size of a file.

Returns
The current value for MaxTreeFileSize.

getMCFCutStrategy()

auto xpress::XPRSProblem::Controls::getMCFCutStrategy ( ) const -> int
inline

Get the value for control MCFCutStrategy.

Level of Multi-Commodity Flow (MCF) cutting planes separation: This specifies how much aggresively MCF cuts should be separated. If the separation of MCF cuts is enabled, Xpress will try to detect a MCF network structure in the problem and, if such a structure is identified, it will separate specific cutting planes exploiting the identified network.

Returns
The current value for MCFCutStrategy.

getMipAbsCutoff()

auto xpress::XPRSProblem::Controls::getMipAbsCutoff ( ) const -> double
inline

Get the value for control MipAbsCutoff.

Branch and Bound: If the user knows that they are interested only in values of the objective function which are better than some value, this can be assigned to MIPABSCUTOFF. This allows the Optimizer to ignore solving any nodes which may yield worse objective values, saving solution time. When a MIP solution is found a new cut off value is calculated and the value can be obtained from the CURRMIPCUTOFF attribute. The value of CURRMIPCUTOFF is calculated using the MIPRELCUTOFF and MIPADDCUTOFF controls.

Returns
The current value for MipAbsCutoff.

getMipAbsGapNotify()

auto xpress::XPRSProblem::Controls::getMipAbsGapNotify ( ) const -> double
inline

Get the value for control MipAbsGapNotify.

Branch and bound: if the gapnotify callback has been set using XPRSaddcbgapnotify, then this callback will be triggered during the tree search when the absolute gap reaches or passes the value you set of the MIPRELGAPNOTIFY control.

Returns
The current value for MipAbsGapNotify.

getMipAbsGapNotifyBound()

auto xpress::XPRSProblem::Controls::getMipAbsGapNotifyBound ( ) const -> double
inline

Get the value for control MipAbsGapNotifyBound.

Branch and bound: if the gapnotify callback has been set using XPRSaddcbgapnotify, then this callback will be triggered during the tree search when the best bound reaches or passes the value you set of the MIPRELGAPNOTIFYBOUND control.

Returns
The current value for MipAbsGapNotifyBound.

getMipAbsGapNotifyObj()

auto xpress::XPRSProblem::Controls::getMipAbsGapNotifyObj ( ) const -> double
inline

Get the value for control MipAbsGapNotifyObj.

Branch and bound: if the gapnotify callback has been set using XPRSaddcbgapnotify, then this callback will be triggered during the tree search when the best solution value reaches or passes the value you set of the MIPRELGAPNOTIFYOBJ control.

Returns
The current value for MipAbsGapNotifyObj.

getMipAbsStop()

auto xpress::XPRSProblem::Controls::getMipAbsStop ( ) const -> double
inline

Get the value for control MipAbsStop.

Branch and Bound: The absolute tolerance determining whether the tree search will continue or not. It will terminate if
   |MIPOBJVAL - BESTBOUND| <= MIPABSSTOP
where MIPOBJVAL is the value of the best solution's objective function, and BESTBOUND is the current best solution bound. For example, to stop the tree search when a MIP solution has been found and the Optimizer can guarantee it is within 100 of the optimal solution, set MIPABSSTOP to 100.

Returns
The current value for MipAbsStop.

getMipAddCutoff()

auto xpress::XPRSProblem::Controls::getMipAddCutoff ( ) const -> double
inline

Get the value for control MipAddCutoff.

Branch and Bound: The amount to add to the objective function of the best integer solution found to give the new CURRMIPCUTOFF. Once an integer solution has been found whose objective function is equal to or better than CURRMIPCUTOFF, improvements on this value may not be interesting unless they are better by at least a certain amount. If MIPADDCUTOFF is nonzero, it will be added to CURRMIPCUTOFF each time an integer solution is found which is better than this new value. This cuts off sections of the tree whose solutions would not represent substantial improvements in the objective function, saving processor time. The control MIPABSSTOP provides a similar function but works in a different way.

Returns
The current value for MipAddCutoff.

getMipComponents()

auto xpress::XPRSProblem::Controls::getMipComponents ( ) const -> int
inline

Get the value for control MipComponents.

Determines whether disconnected components in a MIP should be solved as separate MIPs. There can be significant performence benefits from solving disconnected components individual instead of being part of the main branch-and-bound search.

Returns
The current value for MipComponents.

getMipConcurrentNodes()

auto xpress::XPRSProblem::Controls::getMipConcurrentNodes ( ) const -> int
inline

Get the value for control MipConcurrentNodes.

Sets the node limit for when a winning solve is selected when concurrent MIP solves are enabled. When multiple MIP solves are started, they each run up to the MIPCONCURRENTNODES node limit and only one winning solve is selected for contuinuing the search with.

Returns
The current value for MipConcurrentNodes.

getMipConcurrentSolves()

auto xpress::XPRSProblem::Controls::getMipConcurrentSolves ( ) const -> int
inline

Get the value for control MipConcurrentSolves.

Selects the number of concurrent solves to start for a MIP. Each solve will use a unique random seed for its random number generator, but will otherwise apply the same user controls. The first concurrent solve to complete will have solved the MIP and all the concurrent solves will be terminated at this point. Using concurrent solves can be advantageous when a MIP displays a high level of performance variability.

Returns
The current value for MipConcurrentSolves.

getMipDualReductions()

auto xpress::XPRSProblem::Controls::getMipDualReductions ( ) const -> int
inline

Get the value for control MipDualReductions.

Branch and Bound: Limits operations that can reduce the MIP solution space.

Returns
The current value for MipDualReductions.

getMipFracReduce()

auto xpress::XPRSProblem::Controls::getMipFracReduce ( ) const -> int
inline

Get the value for control MipFracReduce.

Branch and Bound: Specifies how often the optimizer should run a heuristic to reduce the number of fractional integer variables in the node LP solutions.

Returns
The current value for MipFracReduce.

getMipKappaFreq()

auto xpress::XPRSProblem::Controls::getMipKappaFreq ( ) const -> int
inline

Get the value for control MipKappaFreq.

Branch and Bound: Specifies how frequently the basis condition number (also known as kappa) should be calculated during the branch-and-bound search.

Returns
The current value for MipKappaFreq.

getMipLog()

auto xpress::XPRSProblem::Controls::getMipLog ( ) const -> int
inline

Get the value for control MipLog.

MIP log print control.

Returns
The current value for MipLog.

getMipPresolve()

auto xpress::XPRSProblem::Controls::getMipPresolve ( ) const -> int
inline

Get the value for control MipPresolve.

Branch and Bound: Type of integer processing to be performed. If set to 0, no processing will be performed.

Returns
The current value for MipPresolve.

getMipRampup()

auto xpress::XPRSProblem::Controls::getMipRampup ( ) const -> int
inline

Get the value for control MipRampup.

Controls the strategy used by the parallel MIP solver during the ramp-up phase of a branch-and-bound tree search.

Returns
The current value for MipRampup.

getMipRefineIterLimit()

auto xpress::XPRSProblem::Controls::getMipRefineIterLimit ( ) const -> int
inline

Get the value for control MipRefineIterLimit.

This defines an effort limit expressed as simplex iterations for the MIP solution refiner. The limit is per reoptimizations in the MIP refiner.

Returns
The current value for MipRefineIterLimit.

getMipRelCutoff()

auto xpress::XPRSProblem::Controls::getMipRelCutoff ( ) const -> double
inline

Get the value for control MipRelCutoff.

Branch and Bound: Percentage of the incumbent value to be added to the value of the objective function when an integer solution is found, to give the new value of CURRMIPCUTOFF. The effect is to cut off the search in parts of the tree whose best possible objective function would not be substantially better than the current solution. The control MIPRELSTOP provides a similar functionality but works in a different way.

Returns
The current value for MipRelCutoff.

getMipRelGapNotify()

auto xpress::XPRSProblem::Controls::getMipRelGapNotify ( ) const -> double
inline

Get the value for control MipRelGapNotify.

Branch and bound: if the gapnotify callback has been set using XPRSaddcbgapnotify, then this callback will be triggered during the branch and bound tree search when the relative gap reaches or passes the value you set of the MIPRELGAPNOTIFY control.

Returns
The current value for MipRelGapNotify.

getMipRelStop()

auto xpress::XPRSProblem::Controls::getMipRelStop ( ) const -> double
inline

Get the value for control MipRelStop.

Branch and Bound: This determines when the branch and bound tree search will terminate. Branch and bound tree search will stop if:
   |MIPOBJVAL - BESTBOUND| <= MIPRELSTOP x max(|BESTBOUND|,|MIPOBJVAL|)
where MIPOBJVAL is the value of the best solution's objective function and BESTBOUND is the current best solution bound. For example, to stop the tree search when a MIP solution has been found and the Optimizer can guarantee it is within 5% of the optimal solution, set MIPRELSTOP to 0.05.

Returns
The current value for MipRelStop.

getMipRestart()

auto xpress::XPRSProblem::Controls::getMipRestart ( ) const -> int
inline

Get the value for control MipRestart.

Branch and Bound: controls strategy for in-tree restarts.

Returns
The current value for MipRestart.

getMipRestartFactor()

auto xpress::XPRSProblem::Controls::getMipRestartFactor ( ) const -> double
inline

Get the value for control MipRestartFactor.

Branch and Bound: Fine tune initial conditions to trigger an in-tree restart. Use a value > 1 to increase the aggressiveness with which the Optimizer restarts. Use a value < 1 to relax the aggressiveness with which the Optimizer restarts. Note that this control does not affect the initial condition on the gap, which must be set separately.

Returns
The current value for MipRestartFactor.

getMipRestartGapThreshold()

auto xpress::XPRSProblem::Controls::getMipRestartGapThreshold ( ) const -> double
inline

Get the value for control MipRestartGapThreshold.

Branch and Bound: Initial gap threshold to delay in-tree restart. The restart is delayed initially if the gap, given as a fraction between 0 and 1, is below this threshold. The optimizer adjusts the threshold every time a restart is delayed. Note that there are other criteria that can delay or prevent a restart.

Returns
The current value for MipRestartGapThreshold.

getMipTerminationMethod()

auto xpress::XPRSProblem::Controls::getMipTerminationMethod ( ) const -> int
inline

Get the value for control MipTerminationMethod.

Branch and Bound: How a MIP solve should be stopped on early termination when there are still active tasks in the system. This can happen when, for example, a time or node limit is reached.

Returns
The current value for MipTerminationMethod.

getMipThreads()

auto xpress::XPRSProblem::Controls::getMipThreads ( ) const -> int
inline

Get the value for control MipThreads.

If set to a positive integer it determines the number of threads implemented to run the parallel MIP code. If MIPTHREADS is set to the default value (-1), the THREADS control will determine the number of threads used.

Returns
The current value for MipThreads.

getMipTol()

auto xpress::XPRSProblem::Controls::getMipTol ( ) const -> double
inline

Get the value for control MipTol.

Branch and Bound: This is the tolerance within which a decision variable's value is considered to be integral.

Returns
The current value for MipTol.

getMipTolTarget()

auto xpress::XPRSProblem::Controls::getMipTolTarget ( ) const -> double
inline

Get the value for control MipTolTarget.

Target MIPTOL value used by the automatic MIP solution refiner as defined by REFINEOPS. Negative and zero values are ignored.

Returns
The current value for MipTolTarget.

getMIQCPAlg()

auto xpress::XPRSProblem::Controls::getMIQCPAlg ( ) const -> int
inline

Get the value for control MIQCPAlg.

This control determines which algorithm is to be used to solve mixed integer quadratic constrained and mixed integer second order cone problems.

Returns
The current value for MIQCPAlg.

getMps18Compatible()

auto xpress::XPRSProblem::Controls::getMps18Compatible ( ) const -> int
inline

Get the value for control Mps18Compatible.

Provides compatibility of MPS file output for older MPS readers.

Returns
The current value for Mps18Compatible.

getMpsBoundName()

auto xpress::XPRSProblem::Controls::getMpsBoundName ( ) const -> std::string
inline

Get the value for control MpsBoundName.

When reading an MPS file, this control determines which entries from the BOUNDS section will be read. As with all string controls, this is of length 64 characters plus a null terminator, \0.

Returns
The current value for MpsBoundName.

getMpsEcho()

auto xpress::XPRSProblem::Controls::getMpsEcho ( ) const -> int
inline

Get the value for control MpsEcho.

Determines whether comments in MPS matrix files are to be printed out during matrix input.

Returns
The current value for MpsEcho.

getMpsFormat()

auto xpress::XPRSProblem::Controls::getMpsFormat ( ) const -> int
inline

Get the value for control MpsFormat.

Specifies the format of MPS files.

Returns
The current value for MpsFormat.

getMpsNameLength()

auto xpress::XPRSProblem::Controls::getMpsNameLength ( ) const -> int
inline

Get the value for control MpsNameLength.

Returns
The current value for MpsNameLength.

getMpsObjName()

auto xpress::XPRSProblem::Controls::getMpsObjName ( ) const -> std::string
inline

Get the value for control MpsObjName.

When reading an MPS file, this control determines which neutral row will be read as the objective function. If this control is set when reading a multi-objective MPS file, only the named objective will be read; all other objectives will be ignored. As with all string controls, this is of length 64 characters plus a null terminator, \0.

Returns
The current value for MpsObjName.

getMpsRangeName()

auto xpress::XPRSProblem::Controls::getMpsRangeName ( ) const -> std::string
inline

Get the value for control MpsRangeName.

When reading an MPS file, this control determines which entries from the RANGES section will be read. As with all string controls, this is of length 64 characters plus a null terminator, \0.

Returns
The current value for MpsRangeName.

getMpsRhsName()

auto xpress::XPRSProblem::Controls::getMpsRhsName ( ) const -> std::string
inline

Get the value for control MpsRhsName.

When reading an MPS file, this control determines which entries from the RHS section will be read. As with all string controls, this is of length 64 characters plus a null terminator, \0.

Returns
The current value for MpsRhsName.

getMseCallbackCullSols_Diversity()

auto xpress::XPRSProblem::Controls::getMseCallbackCullSols_Diversity ( ) const -> int
inline

Get the value for control MseCallbackCullSols_Diversity.

Returns
The current value for MseCallbackCullSols_Diversity.

getMseCallbackCullSols_MipObject()

auto xpress::XPRSProblem::Controls::getMseCallbackCullSols_MipObject ( ) const -> int
inline

Get the value for control MseCallbackCullSols_MipObject.

Returns
The current value for MseCallbackCullSols_MipObject.

getMseCallbackCullSols_ModObject()

auto xpress::XPRSProblem::Controls::getMseCallbackCullSols_ModObject ( ) const -> int
inline

Get the value for control MseCallbackCullSols_ModObject.

Returns
The current value for MseCallbackCullSols_ModObject.

getMseOptimizeDiversity()

auto xpress::XPRSProblem::Controls::getMseOptimizeDiversity ( ) const -> int
inline

Get the value for control MseOptimizeDiversity.

Returns
The current value for MseOptimizeDiversity.

getMseOutputLog()

auto xpress::XPRSProblem::Controls::getMseOutputLog ( ) const -> int
inline

Get the value for control MseOutputLog.

Returns
The current value for MseOutputLog.

getMseOutputTol()

auto xpress::XPRSProblem::Controls::getMseOutputTol ( ) const -> double
inline

Get the value for control MseOutputTol.

Returns
The current value for MseOutputTol.

getMsMaxBoundRange()

auto xpress::XPRSProblem::Controls::getMsMaxBoundRange ( ) const -> double
inline

Get the value for control MsMaxBoundRange.

Defines the maximum range inside which initial points are generated by multistart presets

Returns
The current value for MsMaxBoundRange.

getMspDefaultUserSolFeasTol()

auto xpress::XPRSProblem::Controls::getMspDefaultUserSolFeasTol ( ) const -> double
inline

Get the value for control MspDefaultUserSolFeasTol.

Returns
The current value for MspDefaultUserSolFeasTol.

getMspDefaultUserSolMipTol()

auto xpress::XPRSProblem::Controls::getMspDefaultUserSolMipTol ( ) const -> double
inline

Get the value for control MspDefaultUserSolMipTol.

Returns
The current value for MspDefaultUserSolMipTol.

getMspDuplicateSolutionsPolicy()

auto xpress::XPRSProblem::Controls::getMspDuplicateSolutionsPolicy ( ) const -> int
inline

Get the value for control MspDuplicateSolutionsPolicy.

Returns
The current value for MspDuplicateSolutionsPolicy.

getMspEnableSlackStorage()

auto xpress::XPRSProblem::Controls::getMspEnableSlackStorage ( ) const -> int
inline

Get the value for control MspEnableSlackStorage.

Returns
The current value for MspEnableSlackStorage.

getMspIncludeProbNameInLogging()

auto xpress::XPRSProblem::Controls::getMspIncludeProbNameInLogging ( ) const -> int
inline

Get the value for control MspIncludeProbNameInLogging.

Returns
The current value for MspIncludeProbNameInLogging.

getMspOutputLog()

auto xpress::XPRSProblem::Controls::getMspOutputLog ( ) const -> int
inline

Get the value for control MspOutputLog.

Returns
The current value for MspOutputLog.

getMspSol_BitFieldsUsr()

auto xpress::XPRSProblem::Controls::getMspSol_BitFieldsUsr ( ) const -> int
inline

Get the value for control MspSol_BitFieldsUsr.

Returns
The current value for MspSol_BitFieldsUsr.

getMspSol_FeasTol()

auto xpress::XPRSProblem::Controls::getMspSol_FeasTol ( ) const -> double
inline

Get the value for control MspSol_FeasTol.

Returns
The current value for MspSol_FeasTol.

getMspSol_MipTol()

auto xpress::XPRSProblem::Controls::getMspSol_MipTol ( ) const -> double
inline

Get the value for control MspSol_MipTol.

Returns
The current value for MspSol_MipTol.

getMspWriteSlxSolLogging()

auto xpress::XPRSProblem::Controls::getMspWriteSlxSolLogging ( ) const -> int
inline

Get the value for control MspWriteSlxSolLogging.

Returns
The current value for MspWriteSlxSolLogging.

getMultiObjLog()

auto xpress::XPRSProblem::Controls::getMultiObjLog ( ) const -> int
inline

Get the value for control MultiObjLog.

Log level for multi-objective optimization.

Returns
The current value for MultiObjLog.

getMultiObjOps()

auto xpress::XPRSProblem::Controls::getMultiObjOps ( ) const -> int
inline

Get the value for control MultiObjOps.

Modifies the behaviour of the optimizer when solving multi-objective problems.

Returns
The current value for MultiObjOps.

getMultiStart()

auto xpress::XPRSProblem::Controls::getMultiStart ( ) const -> int
inline

Get the value for control MultiStart.

The multistart master control. Defines if the multistart search is to be initiated, or if only the baseline model is to be solved.

Returns
The current value for MultiStart.

getMultiStart_Log()

auto xpress::XPRSProblem::Controls::getMultiStart_Log ( ) const -> int
inline

Get the value for control MultiStart_Log.

The level of logging during the multistart run.

Returns
The current value for MultiStart_Log.

getMultiStart_MaxSolves()

auto xpress::XPRSProblem::Controls::getMultiStart_MaxSolves ( ) const -> int
inline

Get the value for control MultiStart_MaxSolves.

The maximum number of jobs to create during the multistart search.

Returns
The current value for MultiStart_MaxSolves.

getMultiStart_MaxTime()

auto xpress::XPRSProblem::Controls::getMultiStart_MaxTime ( ) const -> int
inline

Get the value for control MultiStart_MaxTime.

The maximum total time to be spent in the mutlistart search.

Returns
The current value for MultiStart_MaxTime.

getMultiStart_PoolSize()

auto xpress::XPRSProblem::Controls::getMultiStart_PoolSize ( ) const -> int
inline

Get the value for control MultiStart_PoolSize.

The maximum number of problem objects allowed to pool up before synchronization in the deterministic multistart.

Returns
The current value for MultiStart_PoolSize.

getMultiStart_Seed()

auto xpress::XPRSProblem::Controls::getMultiStart_Seed ( ) const -> int
inline

Get the value for control MultiStart_Seed.

Random seed used for the automatic generation of initial point when loading multistart presets

Returns
The current value for MultiStart_Seed.

getMultiStart_Threads()

auto xpress::XPRSProblem::Controls::getMultiStart_Threads ( ) const -> int
inline

Get the value for control MultiStart_Threads.

The maximum number of threads to be used in multistart

Returns
The current value for MultiStart_Threads.

getMutexCallBacks()

auto xpress::XPRSProblem::Controls::getMutexCallBacks ( ) const -> int
inline

Get the value for control MutexCallBacks.

Branch and Bound: This determines whether the callback routines are mutexed from within the optimizer.

Returns
The current value for MutexCallBacks.

getNetCuts()

auto xpress::XPRSProblem::Controls::getNetCuts ( ) const -> int
inline

Get the value for control NetCuts.

Returns
The current value for NetCuts.

getNetStallLimit()

auto xpress::XPRSProblem::Controls::getNetStallLimit ( ) const -> int
inline

Get the value for control NetStallLimit.

Limit the number of degenerate pivots of the network simplex algorithm, before switching to either primal or dual simplex, depending on ALGAFTERNETWORK.

Returns
The current value for NetStallLimit.

getNlpCalcThreads()

auto xpress::XPRSProblem::Controls::getNlpCalcThreads ( ) const -> int
inline

Get the value for control NlpCalcThreads.

Number of threads used for formula and derivatives evaluations

Returns
The current value for NlpCalcThreads.

getNlpDefaultIV()

auto xpress::XPRSProblem::Controls::getNlpDefaultIV ( ) const -> double
inline

Get the value for control NlpDefaultIV.

Default initial value for an SLP variable if none is explicitly given

Returns
The current value for NlpDefaultIV.

getNlpDerivatives()

auto xpress::XPRSProblem::Controls::getNlpDerivatives ( ) const -> int
inline

Get the value for control NlpDerivatives.

Bitmap describing the method of calculating derivatives

Returns
The current value for NlpDerivatives.

getNlpDeterministic()

auto xpress::XPRSProblem::Controls::getNlpDeterministic ( ) const -> int
inline

Get the value for control NlpDeterministic.

Determines if the parallel features of SLP should be guaranteed to be deterministic

Returns
The current value for NlpDeterministic.

getNlpEvaluate()

auto xpress::XPRSProblem::Controls::getNlpEvaluate ( ) const -> int
inline

Get the value for control NlpEvaluate.

Evaluation strategy for user functions

Returns
The current value for NlpEvaluate.

getNlpFindIV()

auto xpress::XPRSProblem::Controls::getNlpFindIV ( ) const -> int
inline

Get the value for control NlpFindIV.

Option for running a heuristic to find a feasible initial point

Returns
The current value for NlpFindIV.

getNlpFuncEval()

auto xpress::XPRSProblem::Controls::getNlpFuncEval ( ) const -> int
inline

Get the value for control NlpFuncEval.

Bit map for determining the method of evaluating user functions and their derivatives

Returns
The current value for NlpFuncEval.

getNlpHessian()

auto xpress::XPRSProblem::Controls::getNlpHessian ( ) const -> int
inline

Get the value for control NlpHessian.

Second order differentiation mode when using analytical derivatives

Returns
The current value for NlpHessian.

getNlpInfinity()

auto xpress::XPRSProblem::Controls::getNlpInfinity ( ) const -> double
inline

Get the value for control NlpInfinity.

Value returned by a divide-by-zero in a formula

Returns
The current value for NlpInfinity.

getNlpJacobian()

auto xpress::XPRSProblem::Controls::getNlpJacobian ( ) const -> int
inline

Get the value for control NlpJacobian.

First order differentiation mode when using analytical derivatives

Returns
The current value for NlpJacobian.

getNlpLinQuadBR()

auto xpress::XPRSProblem::Controls::getNlpLinQuadBR ( ) const -> int
inline

Get the value for control NlpLinQuadBR.

Use linear and quadratic constraints and objective function to further reduce bounds on all variables

Returns
The current value for NlpLinQuadBR.

getNlpLog()

auto xpress::XPRSProblem::Controls::getNlpLog ( ) const -> int
inline

Get the value for control NlpLog.

Level of printing during SLP iterations

Returns
The current value for NlpLog.

getNlpMaxTime()

auto xpress::XPRSProblem::Controls::getNlpMaxTime ( ) const -> int
inline

Get the value for control NlpMaxTime.

The maximum time in seconds that the SLP optimization will run before it terminates

Returns
The current value for NlpMaxTime.

getNlpMeritLambda()

auto xpress::XPRSProblem::Controls::getNlpMeritLambda ( ) const -> double
inline

Get the value for control NlpMeritLambda.

Factor by which the net objective is taken into account in the merit function

Returns
The current value for NlpMeritLambda.

getNlpPostsolve()

auto xpress::XPRSProblem::Controls::getNlpPostsolve ( ) const -> int
inline

Get the value for control NlpPostsolve.

This control determines whether postsolving should be performed automatically

Returns
The current value for NlpPostsolve.

getNlpPresolve()

auto xpress::XPRSProblem::Controls::getNlpPresolve ( ) const -> int
inline

Get the value for control NlpPresolve.

This control determines whether presolving should be performed prior to starting the main algorithm

Returns
The current value for NlpPresolve.

getNlpPresolve_ElimTol()

auto xpress::XPRSProblem::Controls::getNlpPresolve_ElimTol ( ) const -> double
inline

Get the value for control NlpPresolve_ElimTol.

Tolerance for nonlinear eliminations during SLP presolve

Returns
The current value for NlpPresolve_ElimTol.

getNlpPresolveLevel()

auto xpress::XPRSProblem::Controls::getNlpPresolveLevel ( ) const -> int
inline

Get the value for control NlpPresolveLevel.

This control determines the level of changes presolve may carry out on the problem and whether column/row indices may change

Returns
The current value for NlpPresolveLevel.

getNlpPresolveOps()

auto xpress::XPRSProblem::Controls::getNlpPresolveOps ( ) const -> int
inline

Get the value for control NlpPresolveOps.

Bitmap indicating the SLP presolve actions to be taken

Returns
The current value for NlpPresolveOps.

getNlpPresolveZero()

auto xpress::XPRSProblem::Controls::getNlpPresolveZero ( ) const -> double
inline

Get the value for control NlpPresolveZero.

Minimum absolute value for a variable which is identified as nonzero during SLP presolve

Returns
The current value for NlpPresolveZero.

getNlpPrimalIntegralAlpha()

auto xpress::XPRSProblem::Controls::getNlpPrimalIntegralAlpha ( ) const -> double
inline

Get the value for control NlpPrimalIntegralAlpha.

Decay term for primal integral computation

Returns
The current value for NlpPrimalIntegralAlpha.

getNlpPrimalIntegralRef()

auto xpress::XPRSProblem::Controls::getNlpPrimalIntegralRef ( ) const -> double
inline

Get the value for control NlpPrimalIntegralRef.

Reference solution value to take into account when calculating the primal integral

Returns
The current value for NlpPrimalIntegralRef.

getNlpProbing()

auto xpress::XPRSProblem::Controls::getNlpProbing ( ) const -> int
inline

Get the value for control NlpProbing.

This control determines whether probing on a subset of variables should be performed prior to starting the main algorithm. Probing runs multiple times bound reduction in order to further tighten the bounding box.

Returns
The current value for NlpProbing.

getNlpReformulate()

auto xpress::XPRSProblem::Controls::getNlpReformulate ( ) const -> int
inline

Get the value for control NlpReformulate.

Controls the problem reformulations carried out before augmentation. This allows SLP to take advantage of dedicated algorithms for special problem classes.

Returns
The current value for NlpReformulate.

getNlpSolver()

auto xpress::XPRSProblem::Controls::getNlpSolver ( ) const -> int
inline

Get the value for control NlpSolver.

Selects the library to use for local solves

Returns
The current value for NlpSolver.

getNlpStopOutOfRange()

auto xpress::XPRSProblem::Controls::getNlpStopOutOfRange ( ) const -> int
inline

Get the value for control NlpStopOutOfRange.

Stop optimization and return error code if internal function argument is out of range

Returns
The current value for NlpStopOutOfRange.

getNlpThreads()

auto xpress::XPRSProblem::Controls::getNlpThreads ( ) const -> int
inline

Get the value for control NlpThreads.

Default number of threads to be used

Returns
The current value for NlpThreads.

getNlpThreadSafeUserFunc()

auto xpress::XPRSProblem::Controls::getNlpThreadSafeUserFunc ( ) const -> int
inline

Get the value for control NlpThreadSafeUserFunc.

Defines if user functions are allowed to be called in parallel

Returns
The current value for NlpThreadSafeUserFunc.

getNlpValidationFactor()

auto xpress::XPRSProblem::Controls::getNlpValidationFactor ( ) const -> double
inline

Get the value for control NlpValidationFactor.

Minimum improvement in validation targets to continue iterating

Returns
The current value for NlpValidationFactor.

getNlpValidationTarget_K()

auto xpress::XPRSProblem::Controls::getNlpValidationTarget_K ( ) const -> double
inline

Get the value for control NlpValidationTarget_K.

Optimality target tolerance

Returns
The current value for NlpValidationTarget_K.

getNlpValidationTarget_R()

auto xpress::XPRSProblem::Controls::getNlpValidationTarget_R ( ) const -> double
inline

Get the value for control NlpValidationTarget_R.

Feasiblity target tolerance

Returns
The current value for NlpValidationTarget_R.

getNlpValidationTol_A()

auto xpress::XPRSProblem::Controls::getNlpValidationTol_A ( ) const -> double
inline

Get the value for control NlpValidationTol_A.

Absolute tolerance for the XSLPvalidate procedure

Returns
The current value for NlpValidationTol_A.

getNlpValidationTol_K()

auto xpress::XPRSProblem::Controls::getNlpValidationTol_K ( ) const -> double
inline

Get the value for control NlpValidationTol_K.

Relative tolerance for the XSLPvalidatekkt procedure

Returns
The current value for NlpValidationTol_K.

getNlpValidationTol_R()

auto xpress::XPRSProblem::Controls::getNlpValidationTol_R ( ) const -> double
inline

Get the value for control NlpValidationTol_R.

Relative tolerance for the XSLPvalidate procedure

Returns
The current value for NlpValidationTol_R.

getNlpZero()

auto xpress::XPRSProblem::Controls::getNlpZero ( ) const -> double
inline

Get the value for control NlpZero.

Absolute tolerance

Returns
The current value for NlpZero.

getNodeProbingEffort()

auto xpress::XPRSProblem::Controls::getNodeProbingEffort ( ) const -> double
inline

Get the value for control NodeProbingEffort.

Adjusts the overall level of node probing.

Returns
The current value for NodeProbingEffort.

getNodeSelection()

auto xpress::XPRSProblem::Controls::getNodeSelection ( ) const -> int
inline

Get the value for control NodeSelection.

Branch and Bound: This determines which nodes will be considered for solution once the current node has been solved.

Returns
The current value for NodeSelection.

getNumericalEmphasis()

auto xpress::XPRSProblem::Controls::getNumericalEmphasis ( ) const -> int
inline

Get the value for control NumericalEmphasis.

How much emphasis to place on numerical stability instead of solve speed.

Returns
The current value for NumericalEmphasis.

getObjScaleFactor()

auto xpress::XPRSProblem::Controls::getObjScaleFactor ( ) const -> int
inline

Get the value for control ObjScaleFactor.

Custom objective scaling factor, expressed as a power of 2. When set, it overwrites the automatic objective scaling factor. A value of 0 means no objective scaling. This control is applied for the full solve, and is independent of any extra scaling that may occur specifically for the barrier or simplex solvers. As it is a power of 2, to scale by 16, set the value of the control to 4.

Returns
The current value for ObjScaleFactor.

getOptimalityTol()

auto xpress::XPRSProblem::Controls::getOptimalityTol ( ) const -> double
inline

Get the value for control OptimalityTol.

Simplex: This is the zero tolerance for reduced costs. On each iteration, the simplex method searches for a variable to enter the basis which has a negative reduced cost. The candidates are only those variables which have reduced costs less than the negative value of OPTIMALITYTOL.

Returns
The current value for OptimalityTol.

getOptimalityTolTarget()

auto xpress::XPRSProblem::Controls::getOptimalityTolTarget ( ) const -> double
inline

Get the value for control OptimalityTolTarget.

This specifies the target optimality tolerance for the solution refiner.

Returns
The current value for OptimalityTolTarget.

getOutputControls()

auto xpress::XPRSProblem::Controls::getOutputControls ( ) const -> int
inline

Get the value for control OutputControls.

This control toggles the printing of all control settings at the beginning of the search. This includes the printing of controls that have been explicitly assigned to their default value. All unset controls are omitted as they keep their default value.

Returns
The current value for OutputControls.

getOutputLog()

auto xpress::XPRSProblem::Controls::getOutputLog ( ) const -> int
inline

Get the value for control OutputLog.

This controls the level of output produced by the Optimizer during optimization. In the Console Optimizer, OUTPUTLOG controls which messages are sent to the screen (stdout). When using the Optimizer library, no output is sent to the screen. If the user wishes output to be displayed, they must define a callback function and print messages to the screen themselves. In this case, OUTPUTLOG controls which messages are sent to the user output callback.

Returns
The current value for OutputLog.

getOutputMask()

auto xpress::XPRSProblem::Controls::getOutputMask ( ) const -> std::string
inline

Get the value for control OutputMask.

Mask to restrict the row and column names written to file. As with all string controls, this is of length 64 characters plus a null terminator, \0.

Returns
The current value for OutputMask.

getOutputTol()

auto xpress::XPRSProblem::Controls::getOutputTol ( ) const -> double
inline

Get the value for control OutputTol.

Zero tolerance on print values.

Returns
The current value for OutputTol.

getPenalty()

auto xpress::XPRSProblem::Controls::getPenalty ( ) const -> double
inline

Get the value for control Penalty.

Minimum absolute penalty variable coefficient. BIGM and PENALTY are set by the input routine (XPRSreadprob (READPROB)) but may be reset by the user prior to XPRSlpoptimize (LPOPTIMIZE).

Returns
The current value for Penalty.

getPivotTol()

auto xpress::XPRSProblem::Controls::getPivotTol ( ) const -> double
inline

Get the value for control PivotTol.

Simplex: The zero tolerance for matrix elements. On each iteration, the simplex method seeks a nonzero matrix element to pivot on. Any element with absolute value less than PIVOTTOL is treated as zero for this purpose.

Returns
The current value for PivotTol.

getPPFactor()

auto xpress::XPRSProblem::Controls::getPPFactor ( ) const -> double
inline

Get the value for control PPFactor.

The partial pricing candidate list sizing parameter.

Returns
The current value for PPFactor.

getPreAnalyticcenter()

auto xpress::XPRSProblem::Controls::getPreAnalyticcenter ( ) const -> int
inline

Get the value for control PreAnalyticcenter.

Determines if analytic centers should be computed and used for variable fixing and the generation of alternative reduced costs (-1: Auto 0: Off, 1: Fixing, 2: Redcost, 3: Both)

Returns
The current value for PreAnalyticcenter.

getPreBasisRed()

auto xpress::XPRSProblem::Controls::getPreBasisRed ( ) const -> int
inline

Get the value for control PreBasisRed.

Determines if a lattice basis reduction algorithm should be attempted as part of presolve

Returns
The current value for PreBasisRed.

getPreBndRedCone()

auto xpress::XPRSProblem::Controls::getPreBndRedCone ( ) const -> int
inline

Get the value for control PreBndRedCone.

Determines if second order cone constraints should be used for inferring bound reductions on variables when solving a MIP.

Returns
The current value for PreBndRedCone.

getPreBndRedQuad()

auto xpress::XPRSProblem::Controls::getPreBndRedQuad ( ) const -> int
inline

Get the value for control PreBndRedQuad.

Determines if convex quadratic constraints should be used for inferring bound reductions on variables when solving a MIP.

Returns
The current value for PreBndRedQuad.

getPreCliqueStrategy()

auto xpress::XPRSProblem::Controls::getPreCliqueStrategy ( ) const -> int
inline

Get the value for control PreCliqueStrategy.

Determines how much effort to spend on clique covers in presolve.

Returns
The current value for PreCliqueStrategy.

getPreCoefElim()

auto xpress::XPRSProblem::Controls::getPreCoefElim ( ) const -> int
inline

Get the value for control PreCoefElim.

Presolve: Specifies whether the optimizer should attempt to recombine constraints in order to reduce the number of non zero coefficients when presolving a mixed integer problem.

Returns
The current value for PreCoefElim.

getPreComponents()

auto xpress::XPRSProblem::Controls::getPreComponents ( ) const -> int
inline

Get the value for control PreComponents.

Presolve: determines whether small independent components should be detected and solved as individual subproblems during root node processing.

Returns
The current value for PreComponents.

getPreComponentsEffort()

auto xpress::XPRSProblem::Controls::getPreComponentsEffort ( ) const -> double
inline

Get the value for control PreComponentsEffort.

Presolve: adjusts the overall effort for the independent component presolver. This control affects working limits for the subproblem solving as well as thresholds when it is called. Increase to put more emphasis on component presolving.

Returns
The current value for PreComponentsEffort.

getPreConeDecomp()

auto xpress::XPRSProblem::Controls::getPreConeDecomp ( ) const -> int
inline

Get the value for control PreConeDecomp.

Presolve: decompose regular and rotated cones with more than two elements and apply Outer Approximation on the resulting components.

Returns
The current value for PreConeDecomp.

getPreConfiguration()

auto xpress::XPRSProblem::Controls::getPreConfiguration ( ) const -> int
inline

Get the value for control PreConfiguration.

MIP Presolve: determines whether binary rows with only few repeating coefficients should be reformulated. The reformulation enumerates the extremal feasible configurations of a row and introduces new columns and rows to model the choice between these extremal configurations. This presolve operation can be disabled as part of the (advanced) IP reductions PRESOLVEOPS.

Returns
The current value for PreConfiguration.

getPreConvertObjToCons()

auto xpress::XPRSProblem::Controls::getPreConvertObjToCons ( ) const -> int
inline

Get the value for control PreConvertObjToCons.

Presolve: convert a linear or quadratic objective function into an objective transfer constraint

Returns
The current value for PreConvertObjToCons.

getPreConvertSeparable()

auto xpress::XPRSProblem::Controls::getPreConvertSeparable ( ) const -> int
inline

Get the value for control PreConvertSeparable.

Presolve: reformulate problems with a non-diagonal quadratic objective and/or constraints as diagonal quadratic or second-order conic constraints.

Returns
The current value for PreConvertSeparable.

getPreDomCol()

auto xpress::XPRSProblem::Controls::getPreDomCol ( ) const -> int
inline

Get the value for control PreDomCol.

Presolve: Determines the level of dominated column removal reductions to perform when presolving a mixed integer problem. Only binary columns will be checked.

Returns
The current value for PreDomCol.

getPreDomRow()

auto xpress::XPRSProblem::Controls::getPreDomRow ( ) const -> int
inline

Get the value for control PreDomRow.

Presolve: Determines the level of dominated row removal reductions to perform when presolving a problem.

Returns
The current value for PreDomRow.

getPreDupRow()

auto xpress::XPRSProblem::Controls::getPreDupRow ( ) const -> int
inline

Get the value for control PreDupRow.

Presolve: Determines the type of duplicate rows to look for and eliminate when presolving a problem.

Returns
The current value for PreDupRow.

getPreElimQuad()

auto xpress::XPRSProblem::Controls::getPreElimQuad ( ) const -> int
inline

Get the value for control PreElimQuad.

Presolve: Allows for elimination of quadratic variables via doubleton rows.

Returns
The current value for PreElimQuad.

getPreFolding()

auto xpress::XPRSProblem::Controls::getPreFolding ( ) const -> int
inline

Get the value for control PreFolding.

Presolve: Determines if a folding procedure should be used to aggregate continuous columns in an equitable partition.

Returns
The current value for PreFolding.

getPreImplications()

auto xpress::XPRSProblem::Controls::getPreImplications ( ) const -> int
inline

Get the value for control PreImplications.

Presolve: Determines whether to use implication structures to remove redundant rows. If implication sequences are detected, they might also be used in probing.

Returns
The current value for PreImplications.

getPreLinDep()

auto xpress::XPRSProblem::Controls::getPreLinDep ( ) const -> int
inline

Get the value for control PreLinDep.

Presolve: Determines whether to check for and remove linearly dependent equality constraints when presolving a problem.

Returns
The current value for PreLinDep.

getPreObjCutDetect()

auto xpress::XPRSProblem::Controls::getPreObjCutDetect ( ) const -> int
inline

Get the value for control PreObjCutDetect.

Presolve: Determines whether to check for constraints that are parallel or near parallel to a linear objective function, and which can safely be removed. This reduction applies to MIPs only.

Returns
The current value for PreObjCutDetect.

getPrePermute()

auto xpress::XPRSProblem::Controls::getPrePermute ( ) const -> int
inline

Get the value for control PrePermute.

This bit vector control specifies whether to randomly permute rows, columns and MIP entities when starting the presolve. With the default value 0, no permutation will take place.

Returns
The current value for PrePermute.

getPrePermuteSeed()

auto xpress::XPRSProblem::Controls::getPrePermuteSeed ( ) const -> int
inline

Get the value for control PrePermuteSeed.

This control sets the seed for the pseudo-random number generator for permuting the problem when starting the presolve. This control only has effects when PREPERMUTE is enabled.

Returns
The current value for PrePermuteSeed.

getPreProbing()

auto xpress::XPRSProblem::Controls::getPreProbing ( ) const -> int
inline

Get the value for control PreProbing.

Presolve: Amount of probing to perform on binary variables during presolve. This is done by fixing a binary to each of its values in turn and analyzing the implications.

Returns
The current value for PreProbing.

getPreProtectDual()

auto xpress::XPRSProblem::Controls::getPreProtectDual ( ) const -> int
inline

Get the value for control PreProtectDual.

Presolve: specifies whether the presolver should protect a given dual solution by maintaining the same level of dual feasibility. Enabling this control often results in a worse presolved model. This control only expected to be optionally enabled before calling XPRScrossoverlpsol.

Returns
The current value for PreProtectDual.

getPresolve()

auto xpress::XPRSProblem::Controls::getPresolve ( ) const -> int
inline

Get the value for control Presolve.

This control determines whether presolving should be performed prior to starting the main algorithm. Presolve attempts to simplify the problem by detecting and removing redundant constraints, tightening variable bounds, etc. In some cases, infeasibility may even be determined at this stage, or the optimal solution found.

Returns
The current value for Presolve.

getPresolveMaxGrow()

auto xpress::XPRSProblem::Controls::getPresolveMaxGrow ( ) const -> double
inline

Get the value for control PresolveMaxGrow.

Limit on how much the number of non-zero coefficients is allowed to grow during presolve, specified as a ratio of the number of non-zero coefficients in the original problem.

Returns
The current value for PresolveMaxGrow.

getPresolveOps()

auto xpress::XPRSProblem::Controls::getPresolveOps ( ) const -> int
inline

Get the value for control PresolveOps.

This bit vector control specifies the operations which are performed during the presolve.

Returns
The current value for PresolveOps.

getPresolvePasses()

auto xpress::XPRSProblem::Controls::getPresolvePasses ( ) const -> int
inline

Get the value for control PresolvePasses.

Number of reduction rounds to be performed in presolve

Returns
The current value for PresolvePasses.

getPreSort()

auto xpress::XPRSProblem::Controls::getPreSort ( ) const -> int
inline

Get the value for control PreSort.

This bit vector control specifies whether to sort rows, columns and MIP entities by their names when starting the presolve. With the default value 0, no sorting will take place.

Returns
The current value for PreSort.

getPricingAlg()

auto xpress::XPRSProblem::Controls::getPricingAlg ( ) const -> int
inline

Get the value for control PricingAlg.

Simplex: This determines the primal simplex pricing method. It is used to select which variable enters the basis on each iteration. In general Devex pricing requires more time on each iteration, but may reduce the total number of iterations, whereas partial pricing saves time on each iteration, but may result in more iterations.

Returns
The current value for PricingAlg.

getPrimalOps()

auto xpress::XPRSProblem::Controls::getPrimalOps ( ) const -> int
inline

Get the value for control PrimalOps.

Primal simplex: allows fine tuning the variable selection in the primal simplex solver.

Returns
The current value for PrimalOps.

getPrimalPerturb()

auto xpress::XPRSProblem::Controls::getPrimalPerturb ( ) const -> double
inline

Get the value for control PrimalPerturb.

The factor by which the problem will be perturbed prior to optimization by primal simplex. A value of 0.0 results in no perturbation prior to optimization.

Note the interconnection to the AUTOPERTURB control. If AUTOPERTURB is set to 1, the decision whether to perturb or not is left to the Optimizer. When the problem is automatically perturbed in primal simplex, however, the value of PRIMALPERTURB will be used for perturbation.

Returns
The current value for PrimalPerturb.

getPrimalUnshift()

auto xpress::XPRSProblem::Controls::getPrimalUnshift ( ) const -> int
inline

Get the value for control PrimalUnshift.

Determines whether primal is allowed to call dual to unshift.

Returns
The current value for PrimalUnshift.

getPseudoCost()

auto xpress::XPRSProblem::Controls::getPseudoCost ( ) const -> double
inline

Get the value for control PseudoCost.

Branch and Bound: The default pseudo cost used in estimation of the degradation associated with an unexplored node in the tree search. A pseudo cost is associated with each integer decision variable and is an estimate of the amount by which the objective function will be worse if that variable is forced to an integral value.

Returns
The current value for PseudoCost.

getPwlDualReductions()

auto xpress::XPRSProblem::Controls::getPwlDualReductions ( ) const -> int
inline

Get the value for control PwlDualReductions.

This parameter specifies whether dual reductions should be applied to reduce the number of columns, rows and SOS-constraints added when transforming piecewise linear objectives and constraints to MIP structs.

Returns
The current value for PwlDualReductions.

getPwlNonConvexTransformation()

auto xpress::XPRSProblem::Controls::getPwlNonConvexTransformation ( ) const -> int
inline

Get the value for control PwlNonConvexTransformation.

This control specifies the reformulation method for piecewise linear constraints at the beginning of the search.

Note that the chosen formulation will only be used if MIP entities are necessary but not if presolve detected that a convex reformulation is possible. Furthermore, the binary formulation will only be applied to piecewise linear constraints with bounded input variable, otherwise the SOS2-formulation will be used.

Returns
The current value for PwlNonConvexTransformation.

getQCCuts()

auto xpress::XPRSProblem::Controls::getQCCuts ( ) const -> int
inline

Get the value for control QCCuts.

Branch and Bound: Limit on the number of rounds of outer approximation cuts generated for the root node, when solving a mixed integer quadratic constrained or mixed integer second order conic problem with outer approximation.

Returns
The current value for QCCuts.

getQCRootAlg()

auto xpress::XPRSProblem::Controls::getQCRootAlg ( ) const -> int
inline

Get the value for control QCRootAlg.

This control determines which algorithm is to be used to solve the root of a mixed integer quadratic constrained or mixed integer second order cone problem, when outer approximation is used.

Returns
The current value for QCRootAlg.

getQSimplexOps()

auto xpress::XPRSProblem::Controls::getQSimplexOps ( ) const -> int
inline

Get the value for control QSimplexOps.

Controls the behavior of the quadratic simplex solvers.

Returns
The current value for QSimplexOps.

getQuadraticUnshift()

auto xpress::XPRSProblem::Controls::getQuadraticUnshift ( ) const -> int
inline

Get the value for control QuadraticUnshift.

Determines whether an extra solution purification step is called after a solution found by the quadratic simplex (either primal or dual).

Returns
The current value for QuadraticUnshift.

getRandomSeed()

auto xpress::XPRSProblem::Controls::getRandomSeed ( ) const -> int
inline

Get the value for control RandomSeed.

Sets the initial seed to use for the pseudo-random number generator in the Optimizer. The sequence of random numbers is always reset using the seed when starting a new optimization run.

Returns
The current value for RandomSeed.

getRefactor()

auto xpress::XPRSProblem::Controls::getRefactor ( ) const -> int
inline

Get the value for control Refactor.

Indicates whether the optimization should restart using the current representation of the factorization in memory.

Returns
The current value for Refactor.

getRefineOps()

auto xpress::XPRSProblem::Controls::getRefineOps ( ) const -> int
inline

Get the value for control RefineOps.

This specifies when the solution refiner should be executed to reduce solution infeasibilities. The refiner will attempt to satisfy the target tolerances for all original linear constraints before presolve or scaling has been applied.

Returns
The current value for RefineOps.

getRelaxTreeMemoryLimit()

auto xpress::XPRSProblem::Controls::getRelaxTreeMemoryLimit ( ) const -> double
inline

Get the value for control RelaxTreeMemoryLimit.

When the memory used by the branch and bound search tree exceeds the target specified by the TREEMEMORYLIMIT control, the optimizer will try to reduce this by writing nodes to the tree file. In rare cases, usually where the solve has many millions of very small nodes, the tree structural data (which cannot be written to the tree file) will grow large enough to approach or exceed the tree's memory target. When this happens, optimizer performance can degrade greatly as the solver makes heavy use of the tree file in preference to memory. To prevent this, the solver will automatically relax the tree memory limit when it detects this case; the RELAXTREEMEMORYLIMIT control specifies the proportion of the previous memory limit by which to relax it. Set RELAXTREEMEMORYLIMIT to 0.0 to force the Xpress Optimizer to never relax the tree memory limit in this way.

Returns
The current value for RelaxTreeMemoryLimit.

getRelPivotTol()

auto xpress::XPRSProblem::Controls::getRelPivotTol ( ) const -> double
inline

Get the value for control RelPivotTol.

Simplex: At each iteration a pivot element is chosen within a given column of the matrix. The relative pivot tolerance, RELPIVOTTOL, is the size of the element chosen relative to the largest possible pivot element in the same column.

Returns
The current value for RelPivotTol.

getRepairIndefiniteQ()

auto xpress::XPRSProblem::Controls::getRepairIndefiniteQ ( ) const -> xpress::RepairIndefiniteQuadratic
inline

Get the value for control RepairIndefiniteQ.

Controls if the optimizer should make indefinite quadratic matrices positive definite when it is possible.

Returns
The current value for RepairIndefiniteQ.

getRepairIndefiniteQMax()

auto xpress::XPRSProblem::Controls::getRepairIndefiniteQMax ( ) const -> double
inline

Get the value for control RepairIndefiniteQMax.

Returns
The current value for RepairIndefiniteQMax.

getRepairInfeasMaxTime()

auto xpress::XPRSProblem::Controls::getRepairInfeasMaxTime ( ) const -> int
inline

Get the value for control RepairInfeasMaxTime.

Overall time limit for the repairinfeas tool

Returns
The current value for RepairInfeasMaxTime.

getRepairInfeasTimeLimit()

auto xpress::XPRSProblem::Controls::getRepairInfeasTimeLimit ( ) const -> double
inline

Get the value for control RepairInfeasTimeLimit.

Overall time limit for the repairinfeas tool

Returns
The current value for RepairInfeasTimeLimit.

getResourceStrategy()

auto xpress::XPRSProblem::Controls::getResourceStrategy ( ) const -> int
inline

Get the value for control ResourceStrategy.

Controls whether the optimizer is allowed to make nondeterministic decisions if memory is running low in an effort to preserve memory and finish the solve. Available memory (or container limits) are automatically detected but can also be changed by MAXMEMORYSOFT and MAXMEMORYHARD

Returns
The current value for ResourceStrategy.

getRLTCuts()

auto xpress::XPRSProblem::Controls::getRLTCuts ( ) const -> int
inline

Get the value for control RLTCuts.

Determines whether RLT cuts should be separated in the Xpress Global Solver.

Returns
The current value for RLTCuts.

getRootPresolve()

auto xpress::XPRSProblem::Controls::getRootPresolve ( ) const -> int
inline

Get the value for control RootPresolve.

Determines if presolving should be performed on the problem after the tree search has finished with root cutting and heuristics.

Returns
The current value for RootPresolve.

getSBBest()

auto xpress::XPRSProblem::Controls::getSBBest ( ) const -> int
inline

Get the value for control SBBest.

Number of infeasible MIP entities to initialize pseudo costs for on each node.

Returns
The current value for SBBest.

getSbEffort()

auto xpress::XPRSProblem::Controls::getSbEffort ( ) const -> double
inline

Get the value for control SbEffort.

Adjusts the overall amount of effort when using strong branching to select an infeasible MIP entity to branch on.

Returns
The current value for SbEffort.

getSBEstimate()

auto xpress::XPRSProblem::Controls::getSBEstimate ( ) const -> int
inline

Get the value for control SBEstimate.

Branch and Bound: How to calculate pseudo costs from the local node when selecting an infeasible MIP entity to branch on. These pseudo costs are used in combination with local strong branching and history costs to select the branch candidate.

Returns
The current value for SBEstimate.

getSBIterLimit()

auto xpress::XPRSProblem::Controls::getSBIterLimit ( ) const -> int
inline

Get the value for control SBIterLimit.

Number of dual iterations to perform the strong branching for each entity.

Returns
The current value for SBIterLimit.

getSBSelect()

auto xpress::XPRSProblem::Controls::getSBSelect ( ) const -> int
inline

Get the value for control SBSelect.

The size of the candidate list of MIP entities for strong branching.

Returns
The current value for SBSelect.

getScaling()

auto xpress::XPRSProblem::Controls::getScaling ( ) const -> int
inline

Get the value for control Scaling.

This bit vector control determines how the Optimizer will rescale a model internally before optimization. If set to 0, no scaling will take place.

Returns
The current value for Scaling.

getSerializePreIntSol()

auto xpress::XPRSProblem::Controls::getSerializePreIntSol ( ) const -> int
inline

Get the value for control SerializePreIntSol.

Setting SERIALIZEPREINTSOL to 1 will ensure that the preintsol callback is always fired in a deterministic order during a parallel MIP solve. This applies only when the control DETERMINISTIC is set to 1.

Returns
The current value for SerializePreIntSol.

getSifting()

auto xpress::XPRSProblem::Controls::getSifting ( ) const -> int
inline

Get the value for control Sifting.

Determines whether to enable sifting algorithm with the dual simplex method.

Returns
The current value for Sifting.

getSiftPasses()

auto xpress::XPRSProblem::Controls::getSiftPasses ( ) const -> int
inline

Get the value for control SiftPasses.

Determines how quickly we allow to grow the worker problems during the sifting algorithm. Using larger values can increase the number of columns added to the worker problem which often results in increased solve times for the worker problems but the number of necessary sifting iterations may be reduced.

Returns
The current value for SiftPasses.

getSiftPresolveOps()

auto xpress::XPRSProblem::Controls::getSiftPresolveOps ( ) const -> int
inline

Get the value for control SiftPresolveOps.

Determines the presolve operations for solving the subproblems during the sifting algorithm.

Returns
The current value for SiftPresolveOps.

getSiftSwitch()

auto xpress::XPRSProblem::Controls::getSiftSwitch ( ) const -> int
inline

Get the value for control SiftSwitch.

Determines which algorithm to use for solving the subproblems during sifting.

Returns
The current value for SiftSwitch.

getSleepOnThreadWait()

auto xpress::XPRSProblem::Controls::getSleepOnThreadWait ( ) const -> int
inline

Get the value for control SleepOnThreadWait.

In previous versions this was used to determine if the threads should be put into a wait state when waiting for work.

Returns
The current value for SleepOnThreadWait.

getSlpAlgorithm()

auto xpress::XPRSProblem::Controls::getSlpAlgorithm ( ) const -> int
inline

Get the value for control SlpAlgorithm.

Bit map describing the SLP algorithm(s) to be used

Returns
The current value for SlpAlgorithm.

getSlpAnalyze()

auto xpress::XPRSProblem::Controls::getSlpAnalyze ( ) const -> int
inline

Get the value for control SlpAnalyze.

Bit map activating additional options supporting model / solution path analyzis

Returns
The current value for SlpAnalyze.

getSlpATol_A()

auto xpress::XPRSProblem::Controls::getSlpATol_A ( ) const -> double
inline

Get the value for control SlpATol_A.

Absolute delta convergence tolerance

Returns
The current value for SlpATol_A.

getSlpATol_R()

auto xpress::XPRSProblem::Controls::getSlpATol_R ( ) const -> double
inline

Get the value for control SlpATol_R.

Relative delta convergence tolerance

Returns
The current value for SlpATol_R.

getSlpAugmentation()

auto xpress::XPRSProblem::Controls::getSlpAugmentation ( ) const -> int
inline

Get the value for control SlpAugmentation.

Bit map describing the SLP augmentation method(s) to be used

Returns
The current value for SlpAugmentation.

getSlpAutoSave()

auto xpress::XPRSProblem::Controls::getSlpAutoSave ( ) const -> int
inline

Get the value for control SlpAutoSave.

Frequency with which to save the model

Returns
The current value for SlpAutoSave.

getSlpBarCrossoverStart()

auto xpress::XPRSProblem::Controls::getSlpBarCrossoverStart ( ) const -> int
inline

Get the value for control SlpBarCrossoverStart.

Default crossover activation behaviour for barrier start

Returns
The current value for SlpBarCrossoverStart.

getSlpBarLimit()

auto xpress::XPRSProblem::Controls::getSlpBarLimit ( ) const -> int
inline

Get the value for control SlpBarLimit.

Number of initial SLP iterations using the barrier method

Returns
The current value for SlpBarLimit.

getSlpBarStallingLimit()

auto xpress::XPRSProblem::Controls::getSlpBarStallingLimit ( ) const -> int
inline

Get the value for control SlpBarStallingLimit.

Number of iterations to allow numerical failures in barrier before switching to dual

Returns
The current value for SlpBarStallingLimit.

getSlpBarStallingObjLimit()

auto xpress::XPRSProblem::Controls::getSlpBarStallingObjLimit ( ) const -> int
inline

Get the value for control SlpBarStallingObjLimit.

Number of iterations over which to measure the objective change for barrier iterations with no crossover

Returns
The current value for SlpBarStallingObjLimit.

getSlpBarStallingTol()

auto xpress::XPRSProblem::Controls::getSlpBarStallingTol ( ) const -> double
inline

Get the value for control SlpBarStallingTol.

Required change in the objective when progress is measured in barrier iterations without crossover

Returns
The current value for SlpBarStallingTol.

getSlpBarStartOps()

auto xpress::XPRSProblem::Controls::getSlpBarStartOps ( ) const -> int
inline

Get the value for control SlpBarStartOps.

Controls behaviour when the barrier is used to solve the linearizations

Returns
The current value for SlpBarStartOps.

getSlpBoundThreshold()

auto xpress::XPRSProblem::Controls::getSlpBoundThreshold ( ) const -> double
inline

Get the value for control SlpBoundThreshold.

The maximum size of a bound that can be introduced by nonlinear presolve.

Returns
The current value for SlpBoundThreshold.

getSlpCascade()

auto xpress::XPRSProblem::Controls::getSlpCascade ( ) const -> int
inline

Get the value for control SlpCascade.

Bit map describing the cascading to be used

Returns
The current value for SlpCascade.

getSlpCascadeNLimit()

auto xpress::XPRSProblem::Controls::getSlpCascadeNLimit ( ) const -> int
inline

Get the value for control SlpCascadeNLimit.

Maximum number of iterations for cascading with non-linear determining rows

Returns
The current value for SlpCascadeNLimit.

getSlpCascadeTol_PA()

auto xpress::XPRSProblem::Controls::getSlpCascadeTol_PA ( ) const -> double
inline

Get the value for control SlpCascadeTol_PA.

Absolute cascading print tolerance

Returns
The current value for SlpCascadeTol_PA.

getSlpCascadeTol_PR()

auto xpress::XPRSProblem::Controls::getSlpCascadeTol_PR ( ) const -> double
inline

Get the value for control SlpCascadeTol_PR.

Relative cascading print tolerance

Returns
The current value for SlpCascadeTol_PR.

getSlpCDTol_A()

auto xpress::XPRSProblem::Controls::getSlpCDTol_A ( ) const -> double
inline

Get the value for control SlpCDTol_A.

Absolute tolerance for deducing constant derivatives

Returns
The current value for SlpCDTol_A.

getSlpCDTol_R()

auto xpress::XPRSProblem::Controls::getSlpCDTol_R ( ) const -> double
inline

Get the value for control SlpCDTol_R.

Relative tolerance for deducing constant derivatives

Returns
The current value for SlpCDTol_R.

getSlpClampShrink()

auto xpress::XPRSProblem::Controls::getSlpClampShrink ( ) const -> double
inline

Get the value for control SlpClampShrink.

Shrink ratio used to impose strict convergence on variables converged in extended criteria only

Returns
The current value for SlpClampShrink.

getSlpClampValidationTol_A()

auto xpress::XPRSProblem::Controls::getSlpClampValidationTol_A ( ) const -> double
inline

Get the value for control SlpClampValidationTol_A.

Absolute validation tolerance for applying XSLP_CLAMPSHRINK

Returns
The current value for SlpClampValidationTol_A.

getSlpClampValidationTol_R()

auto xpress::XPRSProblem::Controls::getSlpClampValidationTol_R ( ) const -> double
inline

Get the value for control SlpClampValidationTol_R.

Relative validation tolerance for applying XSLP_CLAMPSHRINK

Returns
The current value for SlpClampValidationTol_R.

getSlpConvergenceOps()

auto xpress::XPRSProblem::Controls::getSlpConvergenceOps ( ) const -> int
inline

Get the value for control SlpConvergenceOps.

Bit map describing which convergence tests should be carried out

Returns
The current value for SlpConvergenceOps.

getSlpCTol()

auto xpress::XPRSProblem::Controls::getSlpCTol ( ) const -> double
inline

Get the value for control SlpCTol.

Closure convergence tolerance

Returns
The current value for SlpCTol.

getSlpCutStrategy()

auto xpress::XPRSProblem::Controls::getSlpCutStrategy ( ) const -> int
inline

Get the value for control SlpCutStrategy.

Determines whihc cuts to apply in the MISLP search when the default SLP-in-MIP strategy is used.

Returns
The current value for SlpCutStrategy.

getSlpDamp()

auto xpress::XPRSProblem::Controls::getSlpDamp ( ) const -> double
inline

Get the value for control SlpDamp.

Damping factor for updating values of variables

Returns
The current value for SlpDamp.

getSlpDampExpand()

auto xpress::XPRSProblem::Controls::getSlpDampExpand ( ) const -> double
inline

Get the value for control SlpDampExpand.

Multiplier to increase damping factor during dynamic damping

Returns
The current value for SlpDampExpand.

getSlpDampMax()

auto xpress::XPRSProblem::Controls::getSlpDampMax ( ) const -> double
inline

Get the value for control SlpDampMax.

Maximum value for the damping factor of a variable during dynamic damping

Returns
The current value for SlpDampMax.

getSlpDampMin()

auto xpress::XPRSProblem::Controls::getSlpDampMin ( ) const -> double
inline

Get the value for control SlpDampMin.

Minimum value for the damping factor of a variable during dynamic damping

Returns
The current value for SlpDampMin.

getSlpDampShrink()

auto xpress::XPRSProblem::Controls::getSlpDampShrink ( ) const -> double
inline

Get the value for control SlpDampShrink.

Multiplier to decrease damping factor during dynamic damping

Returns
The current value for SlpDampShrink.

getSlpDampStart()

auto xpress::XPRSProblem::Controls::getSlpDampStart ( ) const -> int
inline

Get the value for control SlpDampStart.

SLP iteration at which damping is activated

Returns
The current value for SlpDampStart.

getSlpDefaultStepBound()

auto xpress::XPRSProblem::Controls::getSlpDefaultStepBound ( ) const -> double
inline

Get the value for control SlpDefaultStepBound.

Minimum initial value for the step bound of an SLP variable if none is explicitly given

Returns
The current value for SlpDefaultStepBound.

getSlpDelayUpdateRows()

auto xpress::XPRSProblem::Controls::getSlpDelayUpdateRows ( ) const -> int
inline

Get the value for control SlpDelayUpdateRows.

Number of SLP iterations before update rows are fully activated

Returns
The current value for SlpDelayUpdateRows.

getSlpDelta_A()

auto xpress::XPRSProblem::Controls::getSlpDelta_A ( ) const -> double
inline

Get the value for control SlpDelta_A.

Absolute perturbation of values for calculating numerical derivatives

Returns
The current value for SlpDelta_A.

getSlpDelta_Infinity()

auto xpress::XPRSProblem::Controls::getSlpDelta_Infinity ( ) const -> double
inline

Get the value for control SlpDelta_Infinity.

Maximum value for partial derivatives

Returns
The current value for SlpDelta_Infinity.

getSlpDelta_R()

auto xpress::XPRSProblem::Controls::getSlpDelta_R ( ) const -> double
inline

Get the value for control SlpDelta_R.

Relative perturbation of values for calculating numerical derivatives

Returns
The current value for SlpDelta_R.

getSlpDelta_X()

auto xpress::XPRSProblem::Controls::getSlpDelta_X ( ) const -> double
inline

Get the value for control SlpDelta_X.

Minimum absolute value of delta coefficients to be retained

Returns
The current value for SlpDelta_X.

getSlpDelta_Z()

auto xpress::XPRSProblem::Controls::getSlpDelta_Z ( ) const -> double
inline

Get the value for control SlpDelta_Z.

Tolerance used when calculating derivatives

Returns
The current value for SlpDelta_Z.

getSlpDelta_Zero()

auto xpress::XPRSProblem::Controls::getSlpDelta_Zero ( ) const -> double
inline

Get the value for control SlpDelta_Zero.

Absolute zero acceptance tolerance used when calculating derivatives

Returns
The current value for SlpDelta_Zero.

getSlpDeltaCost()

auto xpress::XPRSProblem::Controls::getSlpDeltaCost ( ) const -> double
inline

Get the value for control SlpDeltaCost.

Initial penalty cost multiplier for penalty delta vectors

Returns
The current value for SlpDeltaCost.

getSlpDeltaCostFactor()

auto xpress::XPRSProblem::Controls::getSlpDeltaCostFactor ( ) const -> double
inline

Get the value for control SlpDeltaCostFactor.

Factor for increasing cost multiplier on total penalty delta vectors

Returns
The current value for SlpDeltaCostFactor.

getSlpDeltaMaxCost()

auto xpress::XPRSProblem::Controls::getSlpDeltaMaxCost ( ) const -> double
inline

Get the value for control SlpDeltaMaxCost.

Maximum penalty cost multiplier for penalty delta vectors

Returns
The current value for SlpDeltaMaxCost.

getSlpDeltaOffset()

auto xpress::XPRSProblem::Controls::getSlpDeltaOffset ( ) const -> int
inline

Get the value for control SlpDeltaOffset.

Position of first character of SLP variable name used to create name of delta vector

Returns
The current value for SlpDeltaOffset.

getSlpDeltaZLimit()

auto xpress::XPRSProblem::Controls::getSlpDeltaZLimit ( ) const -> int
inline

Get the value for control SlpDeltaZLimit.

Number of SLP iterations during which to apply XSLP_DELTA_Z

Returns
The current value for SlpDeltaZLimit.

getSlpDJTol()

auto xpress::XPRSProblem::Controls::getSlpDJTol ( ) const -> double
inline

Get the value for control SlpDJTol.

Tolerance on DJ value for determining if a variable is at its step bound

Returns
The current value for SlpDJTol.

getSlpDRColDjTol()

auto xpress::XPRSProblem::Controls::getSlpDRColDjTol ( ) const -> double
inline

Get the value for control SlpDRColDjTol.

Reduced cost tolerance on the delta variable when fixing due to the determining column being below XSLP_DRCOLTOL.

Returns
The current value for SlpDRColDjTol.

getSlpDRColTol()

auto xpress::XPRSProblem::Controls::getSlpDRColTol ( ) const -> double
inline

Get the value for control SlpDRColTol.

The minimum absolute magnitude of a determining column, for which the determined variable is still regarded as well defined

Returns
The current value for SlpDRColTol.

getSlpDRFixRange()

auto xpress::XPRSProblem::Controls::getSlpDRFixRange ( ) const -> double
inline

Get the value for control SlpDRFixRange.

The range around the previous value where variables are fixed in cascading if the determining column is below XSLP_DRCOLTOL.

Returns
The current value for SlpDRFixRange.

getSlpECFCheck()

auto xpress::XPRSProblem::Controls::getSlpECFCheck ( ) const -> int
inline

Get the value for control SlpECFCheck.

Check feasibility at the point of linearization for extended convergence criteria

Returns
The current value for SlpECFCheck.

getSlpEcfTol_A()

auto xpress::XPRSProblem::Controls::getSlpEcfTol_A ( ) const -> double
inline

Get the value for control SlpEcfTol_A.

Absolute tolerance on testing feasibility at the point of linearization

Returns
The current value for SlpEcfTol_A.

getSlpEcfTol_R()

auto xpress::XPRSProblem::Controls::getSlpEcfTol_R ( ) const -> double
inline

Get the value for control SlpEcfTol_R.

Relative tolerance on testing feasibility at the point of linearization

Returns
The current value for SlpEcfTol_R.

getSlpEnforceCostShrink()

auto xpress::XPRSProblem::Controls::getSlpEnforceCostShrink ( ) const -> double
inline

Get the value for control SlpEnforceCostShrink.

Factor by which to decrease the current penalty multiplier when enforcing rows.

Returns
The current value for SlpEnforceCostShrink.

getSlpEnforceMaxCost()

auto xpress::XPRSProblem::Controls::getSlpEnforceMaxCost ( ) const -> double
inline

Get the value for control SlpEnforceMaxCost.

Maximum penalty cost in the objective before enforcing most violating rows

Returns
The current value for SlpEnforceMaxCost.

getSlpErrorCost()

auto xpress::XPRSProblem::Controls::getSlpErrorCost ( ) const -> double
inline

Get the value for control SlpErrorCost.

Initial penalty cost multiplier for penalty error vectors

Returns
The current value for SlpErrorCost.

getSlpErrorCostFactor()

auto xpress::XPRSProblem::Controls::getSlpErrorCostFactor ( ) const -> double
inline

Get the value for control SlpErrorCostFactor.

Factor for increasing cost multiplier on total penalty error vectors

Returns
The current value for SlpErrorCostFactor.

getSlpErrorMaxCost()

auto xpress::XPRSProblem::Controls::getSlpErrorMaxCost ( ) const -> double
inline

Get the value for control SlpErrorMaxCost.

Maximum penalty cost multiplier for penalty error vectors

Returns
The current value for SlpErrorMaxCost.

getSlpErrorOffset()

auto xpress::XPRSProblem::Controls::getSlpErrorOffset ( ) const -> int
inline

Get the value for control SlpErrorOffset.

Position of first character of constraint name used to create name of penalty error vectors

Returns
The current value for SlpErrorOffset.

getSlpErrorTol_A()

auto xpress::XPRSProblem::Controls::getSlpErrorTol_A ( ) const -> double
inline

Get the value for control SlpErrorTol_A.

Absolute tolerance for error vectors

Returns
The current value for SlpErrorTol_A.

getSlpErrorTol_P()

auto xpress::XPRSProblem::Controls::getSlpErrorTol_P ( ) const -> double
inline

Get the value for control SlpErrorTol_P.

Absolute tolerance for printing error vectors

Returns
The current value for SlpErrorTol_P.

getSlpEscalation()

auto xpress::XPRSProblem::Controls::getSlpEscalation ( ) const -> double
inline

Get the value for control SlpEscalation.

Factor for increasing cost multiplier on individual penalty error vectors

Returns
The current value for SlpEscalation.

getSlpETol_A()

auto xpress::XPRSProblem::Controls::getSlpETol_A ( ) const -> double
inline

Get the value for control SlpETol_A.

Absolute tolerance on penalty vectors

Returns
The current value for SlpETol_A.

getSlpETol_R()

auto xpress::XPRSProblem::Controls::getSlpETol_R ( ) const -> double
inline

Get the value for control SlpETol_R.

Relative tolerance on penalty vectors

Returns
The current value for SlpETol_R.

getSlpEVTol_A()

auto xpress::XPRSProblem::Controls::getSlpEVTol_A ( ) const -> double
inline

Get the value for control SlpEVTol_A.

Absolute tolerance on total penalty costs

Returns
The current value for SlpEVTol_A.

getSlpEVTol_R()

auto xpress::XPRSProblem::Controls::getSlpEVTol_R ( ) const -> double
inline

Get the value for control SlpEVTol_R.

Relative tolerance on total penalty costs

Returns
The current value for SlpEVTol_R.

getSlpExpand()

auto xpress::XPRSProblem::Controls::getSlpExpand ( ) const -> double
inline

Get the value for control SlpExpand.

Multiplier to increase a step bound

Returns
The current value for SlpExpand.

getSlpFeastolTarget()

auto xpress::XPRSProblem::Controls::getSlpFeastolTarget ( ) const -> double
inline

Get the value for control SlpFeastolTarget.

When set, this defines a target feasibility tolerance to which the linearizations are solved to

Returns
The current value for SlpFeastolTarget.

getSlpFilter()

auto xpress::XPRSProblem::Controls::getSlpFilter ( ) const -> int
inline

Get the value for control SlpFilter.

Bit map for controlling solution updates

Returns
The current value for SlpFilter.

getSlpGranularity()

auto xpress::XPRSProblem::Controls::getSlpGranularity ( ) const -> double
inline

Get the value for control SlpGranularity.

Base for calculating penalty costs

Returns
The current value for SlpGranularity.

getSlpGridHeurSelect()

auto xpress::XPRSProblem::Controls::getSlpGridHeurSelect ( ) const -> int
inline

Get the value for control SlpGridHeurSelect.

Bit map selectin which heuristics to run if the problem has variable with an integer delta

Returns
The current value for SlpGridHeurSelect.

getSlpHeurStrategy()

auto xpress::XPRSProblem::Controls::getSlpHeurStrategy ( ) const -> int
inline

Get the value for control SlpHeurStrategy.

Branch and Bound: This specifies the MINLP heuristic strategy. On some problems it is worth trying more comprehensive heuristic strategies by setting HEURSTRATEGY to 2 or 3.

Returns
The current value for SlpHeurStrategy.

getSlpInfeasLimit()

auto xpress::XPRSProblem::Controls::getSlpInfeasLimit ( ) const -> int
inline

Get the value for control SlpInfeasLimit.

The maximum number of consecutive infeasible SLP iterations which can occur before Xpress-SLP terminates

Returns
The current value for SlpInfeasLimit.

getSlpIterLimit()

auto xpress::XPRSProblem::Controls::getSlpIterLimit ( ) const -> int
inline

Get the value for control SlpIterLimit.

The maximum number of SLP iterations

Returns
The current value for SlpIterLimit.

getSlpItol_A()

auto xpress::XPRSProblem::Controls::getSlpItol_A ( ) const -> double
inline

Get the value for control SlpItol_A.

Absolute impact convergence tolerance

Returns
The current value for SlpItol_A.

getSlpITol_R()

auto xpress::XPRSProblem::Controls::getSlpITol_R ( ) const -> double
inline

Get the value for control SlpITol_R.

Relative impact convergence tolerance

Returns
The current value for SlpITol_R.

getSlpLSIterLimit()

auto xpress::XPRSProblem::Controls::getSlpLSIterLimit ( ) const -> int
inline

Get the value for control SlpLSIterLimit.

Number of iterations in the line search

Returns
The current value for SlpLSIterLimit.

getSlpLSPatternLimit()

auto xpress::XPRSProblem::Controls::getSlpLSPatternLimit ( ) const -> int
inline

Get the value for control SlpLSPatternLimit.

Number of iterations in the pattern search preceding the line search

Returns
The current value for SlpLSPatternLimit.

getSlpLSStart()

auto xpress::XPRSProblem::Controls::getSlpLSStart ( ) const -> int
inline

Get the value for control SlpLSStart.

Iteration in which to active the line search

Returns
The current value for SlpLSStart.

getSlpLSZeroLimit()

auto xpress::XPRSProblem::Controls::getSlpLSZeroLimit ( ) const -> int
inline

Get the value for control SlpLSZeroLimit.

Maximum number of zero length line search steps before line search is deactivated

Returns
The current value for SlpLSZeroLimit.

getSlpMatrixTol()

auto xpress::XPRSProblem::Controls::getSlpMatrixTol ( ) const -> double
inline

Get the value for control SlpMatrixTol.

Nonzero tolerance for dropping coefficients from the linearization.

Returns
The current value for SlpMatrixTol.

getSlpMaxWeight()

auto xpress::XPRSProblem::Controls::getSlpMaxWeight ( ) const -> double
inline

Get the value for control SlpMaxWeight.

Maximum penalty weight for delta or error vectors

Returns
The current value for SlpMaxWeight.

getSlpMinSBFactor()

auto xpress::XPRSProblem::Controls::getSlpMinSBFactor ( ) const -> double
inline

Get the value for control SlpMinSBFactor.

Factor by which step bounds can be decreased beneath XSLP_ATOL_A

Returns
The current value for SlpMinSBFactor.

getSlpMinWeight()

auto xpress::XPRSProblem::Controls::getSlpMinWeight ( ) const -> double
inline

Get the value for control SlpMinWeight.

Minimum penalty weight for delta or error vectors

Returns
The current value for SlpMinWeight.

getSlpMipAlgorithm()

auto xpress::XPRSProblem::Controls::getSlpMipAlgorithm ( ) const -> int
inline

Get the value for control SlpMipAlgorithm.

Bitmap describing the MISLP algorithms to be used

Returns
The current value for SlpMipAlgorithm.

getSlpMipCutoff_A()

auto xpress::XPRSProblem::Controls::getSlpMipCutoff_A ( ) const -> double
inline

Get the value for control SlpMipCutoff_A.

Absolute objective function cutoff for MIP termination

Returns
The current value for SlpMipCutoff_A.

getSlpMipCutoff_R()

auto xpress::XPRSProblem::Controls::getSlpMipCutoff_R ( ) const -> double
inline

Get the value for control SlpMipCutoff_R.

Absolute objective function cutoff for MIP termination

Returns
The current value for SlpMipCutoff_R.

getSlpMipCutOffCount()

auto xpress::XPRSProblem::Controls::getSlpMipCutOffCount ( ) const -> int
inline

Get the value for control SlpMipCutOffCount.

Number of SLP iterations to check when considering a node for cutting off

Returns
The current value for SlpMipCutOffCount.

getSlpMipCutoffLimit()

auto xpress::XPRSProblem::Controls::getSlpMipCutoffLimit ( ) const -> int
inline

Get the value for control SlpMipCutoffLimit.

Number of SLP iterations to check when considering a node for cutting off

Returns
The current value for SlpMipCutoffLimit.

getSlpMipDefaultAlgorithm()

auto xpress::XPRSProblem::Controls::getSlpMipDefaultAlgorithm ( ) const -> int
inline

Get the value for control SlpMipDefaultAlgorithm.

Default algorithm to be used during the tree search in MISLP

Returns
The current value for SlpMipDefaultAlgorithm.

getSlpMipErrorTol_A()

auto xpress::XPRSProblem::Controls::getSlpMipErrorTol_A ( ) const -> double
inline

Get the value for control SlpMipErrorTol_A.

Absolute penalty error cost tolerance for MIP cut-off

Returns
The current value for SlpMipErrorTol_A.

getSlpMipErrorTol_R()

auto xpress::XPRSProblem::Controls::getSlpMipErrorTol_R ( ) const -> double
inline

Get the value for control SlpMipErrorTol_R.

Relative penalty error cost tolerance for MIP cut-off

Returns
The current value for SlpMipErrorTol_R.

getSlpMipFixStepBounds()

auto xpress::XPRSProblem::Controls::getSlpMipFixStepBounds ( ) const -> int
inline

Get the value for control SlpMipFixStepBounds.

Bitmap describing the step-bound fixing strategy during MISLP

Returns
The current value for SlpMipFixStepBounds.

getSlpMipIterLimit()

auto xpress::XPRSProblem::Controls::getSlpMipIterLimit ( ) const -> int
inline

Get the value for control SlpMipIterLimit.

Maximum number of SLP iterations at each node

Returns
The current value for SlpMipIterLimit.

getSlpMipLog()

auto xpress::XPRSProblem::Controls::getSlpMipLog ( ) const -> int
inline

Get the value for control SlpMipLog.

Frequency with which MIP status is printed

Returns
The current value for SlpMipLog.

getSlpMipOCount()

auto xpress::XPRSProblem::Controls::getSlpMipOCount ( ) const -> int
inline

Get the value for control SlpMipOCount.

Number of SLP iterations at each node over which to measure objective function variation

Returns
The current value for SlpMipOCount.

getSlpMipOtol_A()

auto xpress::XPRSProblem::Controls::getSlpMipOtol_A ( ) const -> double
inline

Get the value for control SlpMipOtol_A.

Absolute objective function tolerance for MIP termination

Returns
The current value for SlpMipOtol_A.

getSlpMipOtol_R()

auto xpress::XPRSProblem::Controls::getSlpMipOtol_R ( ) const -> double
inline

Get the value for control SlpMipOtol_R.

Relative objective function tolerance for MIP termination

Returns
The current value for SlpMipOtol_R.

getSlpMipRelaxStepBounds()

auto xpress::XPRSProblem::Controls::getSlpMipRelaxStepBounds ( ) const -> int
inline

Get the value for control SlpMipRelaxStepBounds.

Bitmap describing the step-bound relaxation strategy during MISLP

Returns
The current value for SlpMipRelaxStepBounds.

getSlpMTol_A()

auto xpress::XPRSProblem::Controls::getSlpMTol_A ( ) const -> double
inline

Get the value for control SlpMTol_A.

Absolute effective matrix element convergence tolerance

Returns
The current value for SlpMTol_A.

getSlpMTol_R()

auto xpress::XPRSProblem::Controls::getSlpMTol_R ( ) const -> double
inline

Get the value for control SlpMTol_R.

Relative effective matrix element convergence tolerance

Returns
The current value for SlpMTol_R.

getSlpMVTol()

auto xpress::XPRSProblem::Controls::getSlpMVTol ( ) const -> double
inline

Get the value for control SlpMVTol.

Marginal value tolerance for determining if a constraint is slack

Returns
The current value for SlpMVTol.

getSlpObjThreshold()

auto xpress::XPRSProblem::Controls::getSlpObjThreshold ( ) const -> double
inline

Get the value for control SlpObjThreshold.

Assumed maximum value of the objective function in absolute value.

Returns
The current value for SlpObjThreshold.

getSlpObjToPenaltyCost()

auto xpress::XPRSProblem::Controls::getSlpObjToPenaltyCost ( ) const -> double
inline

Get the value for control SlpObjToPenaltyCost.

Factor to estimate initial penalty costs from objective function

Returns
The current value for SlpObjToPenaltyCost.

getSlpOCount()

auto xpress::XPRSProblem::Controls::getSlpOCount ( ) const -> int
inline

Get the value for control SlpOCount.

Number of SLP iterations over which to measure objective function variation for static objective (2) convergence criterion

Returns
The current value for SlpOCount.

getSlpOptimalityTolTarget()

auto xpress::XPRSProblem::Controls::getSlpOptimalityTolTarget ( ) const -> double
inline

Get the value for control SlpOptimalityTolTarget.

When set, this defines a target optimality tolerance to which the linearizations are solved to

Returns
The current value for SlpOptimalityTolTarget.

getSlpOTol_A()

auto xpress::XPRSProblem::Controls::getSlpOTol_A ( ) const -> double
inline

Get the value for control SlpOTol_A.

Absolute static objective (2) convergence tolerance

Returns
The current value for SlpOTol_A.

getSlpOTol_R()

auto xpress::XPRSProblem::Controls::getSlpOTol_R ( ) const -> double
inline

Get the value for control SlpOTol_R.

Relative static objective (2) convergence tolerance

Returns
The current value for SlpOTol_R.

getSlpPenaltyInfoStart()

auto xpress::XPRSProblem::Controls::getSlpPenaltyInfoStart ( ) const -> int
inline

Get the value for control SlpPenaltyInfoStart.

Iteration from which to record row penalty information

Returns
The current value for SlpPenaltyInfoStart.

getSlpSameCount()

auto xpress::XPRSProblem::Controls::getSlpSameCount ( ) const -> int
inline

Get the value for control SlpSameCount.

Number of steps reaching the step bound in the same direction before step bounds are increased

Returns
The current value for SlpSameCount.

getSlpSameDamp()

auto xpress::XPRSProblem::Controls::getSlpSameDamp ( ) const -> int
inline

Get the value for control SlpSameDamp.

Number of steps in same direction before damping factor is increased

Returns
The current value for SlpSameDamp.

getSlpSBRowOffset()

auto xpress::XPRSProblem::Controls::getSlpSBRowOffset ( ) const -> int
inline

Get the value for control SlpSBRowOffset.

Position of first character of SLP variable name used to create name of SLP lower and upper step bound rows

Returns
The current value for SlpSBRowOffset.

getSlpSBStart()

auto xpress::XPRSProblem::Controls::getSlpSBStart ( ) const -> int
inline

Get the value for control SlpSBStart.

SLP iteration after which step bounds are first applied

Returns
The current value for SlpSBStart.

getSlpShrink()

auto xpress::XPRSProblem::Controls::getSlpShrink ( ) const -> double
inline

Get the value for control SlpShrink.

Multiplier to reduce a step bound

Returns
The current value for SlpShrink.

getSlpShrinkBias()

auto xpress::XPRSProblem::Controls::getSlpShrinkBias ( ) const -> double
inline

Get the value for control SlpShrinkBias.

Defines an overwrite / adjustment of step bounds for improving iterations

Returns
The current value for SlpShrinkBias.

getSlpSTol_A()

auto xpress::XPRSProblem::Controls::getSlpSTol_A ( ) const -> double
inline

Get the value for control SlpSTol_A.

Absolute slack convergence tolerance

Returns
The current value for SlpSTol_A.

getSlpSTol_R()

auto xpress::XPRSProblem::Controls::getSlpSTol_R ( ) const -> double
inline

Get the value for control SlpSTol_R.

Relative slack convergence tolerance

Returns
The current value for SlpSTol_R.

getSlpTraceMaskOps()

auto xpress::XPRSProblem::Controls::getSlpTraceMaskOps ( ) const -> int
inline

Get the value for control SlpTraceMaskOps.

Controls the information printed for XSLP_TRACEMASK. The order in which the information is printed is determined by the order of bits in XSLP_TRACEMASKOPS.

Returns
The current value for SlpTraceMaskOps.

getSlpUnFinishedLimit()

auto xpress::XPRSProblem::Controls::getSlpUnFinishedLimit ( ) const -> int
inline

Get the value for control SlpUnFinishedLimit.

The number of consecutive SLP iterations that may have an unfinished status before the solve is terminated.

Returns
The current value for SlpUnFinishedLimit.

getSlpUpdateOffset()

auto xpress::XPRSProblem::Controls::getSlpUpdateOffset ( ) const -> int
inline

Get the value for control SlpUpdateOffset.

Position of first character of SLP variable name used to create name of SLP update row

Returns
The current value for SlpUpdateOffset.

getSlpVCount()

auto xpress::XPRSProblem::Controls::getSlpVCount ( ) const -> int
inline

Get the value for control SlpVCount.

Number of SLP iterations over which to measure static objective (3) convergence

Returns
The current value for SlpVCount.

getSlpVLimit()

auto xpress::XPRSProblem::Controls::getSlpVLimit ( ) const -> int
inline

Get the value for control SlpVLimit.

Number of SLP iterations after which static objective (3) convergence testing starts

Returns
The current value for SlpVLimit.

getSlpVTol_A()

auto xpress::XPRSProblem::Controls::getSlpVTol_A ( ) const -> double
inline

Get the value for control SlpVTol_A.

Absolute static objective (3) convergence tolerance

Returns
The current value for SlpVTol_A.

getSlpVTol_R()

auto xpress::XPRSProblem::Controls::getSlpVTol_R ( ) const -> double
inline

Get the value for control SlpVTol_R.

Relative static objective (3) convergence tolerance

Returns
The current value for SlpVTol_R.

getSlpWCount()

auto xpress::XPRSProblem::Controls::getSlpWCount ( ) const -> int
inline

Get the value for control SlpWCount.

Number of SLP iterations over which to measure the objective for the extended convergence continuation criterion

Returns
The current value for SlpWCount.

getSlpWTol_A()

auto xpress::XPRSProblem::Controls::getSlpWTol_A ( ) const -> double
inline

Get the value for control SlpWTol_A.

Absolute extended convergence continuation tolerance

Returns
The current value for SlpWTol_A.

getSlpWTol_R()

auto xpress::XPRSProblem::Controls::getSlpWTol_R ( ) const -> double
inline

Get the value for control SlpWTol_R.

Relative extended convergence continuation tolerance

Returns
The current value for SlpWTol_R.

getSlpXCount()

auto xpress::XPRSProblem::Controls::getSlpXCount ( ) const -> int
inline

Get the value for control SlpXCount.

Number of SLP iterations over which to measure static objective (1) convergence

Returns
The current value for SlpXCount.

getSlpXLimit()

auto xpress::XPRSProblem::Controls::getSlpXLimit ( ) const -> int
inline

Get the value for control SlpXLimit.

Number of SLP iterations up to which static objective (1) convergence testing starts

Returns
The current value for SlpXLimit.

getSlpXTol_A()

auto xpress::XPRSProblem::Controls::getSlpXTol_A ( ) const -> double
inline

Get the value for control SlpXTol_A.

Absolute static objective function (1) tolerance

Returns
The current value for SlpXTol_A.

getSlpXTol_R()

auto xpress::XPRSProblem::Controls::getSlpXTol_R ( ) const -> double
inline

Get the value for control SlpXTol_R.

Relative static objective function (1) tolerance

Returns
The current value for SlpXTol_R.

getSlpZeroCriterion()

auto xpress::XPRSProblem::Controls::getSlpZeroCriterion ( ) const -> int
inline

Get the value for control SlpZeroCriterion.

Bitmap determining the behavior of the placeholder deletion procedure

Returns
The current value for SlpZeroCriterion.

getSlpZeroCriterionCount()

auto xpress::XPRSProblem::Controls::getSlpZeroCriterionCount ( ) const -> int
inline

Get the value for control SlpZeroCriterionCount.

Number of consecutive times a placeholder entry is zero before being considered for deletion

Returns
The current value for SlpZeroCriterionCount.

getSlpZeroCriterionStart()

auto xpress::XPRSProblem::Controls::getSlpZeroCriterionStart ( ) const -> int
inline

Get the value for control SlpZeroCriterionStart.

SLP iteration at which criteria for deletion of placeholder entries are first activated.

Returns
The current value for SlpZeroCriterionStart.

getSolTimeLimit()

auto xpress::XPRSProblem::Controls::getSolTimeLimit ( ) const -> double
inline

Get the value for control SolTimeLimit.

The maximum time in seconds that the Optimizer will run a MIP solve before it terminates, given that a solution has been found. As long as no solution has been found, this control will have no effect.

Returns
The current value for SolTimeLimit.

getSosRefTol()

auto xpress::XPRSProblem::Controls::getSosRefTol ( ) const -> double
inline

Get the value for control SosRefTol.

The minimum relative gap between the ordering values of elements in a special ordered set. The gap divided by the absolute value of the larger of the two adjacent values must be at least SOSREFTOL.

Returns
The current value for SosRefTol.

getSymmetry()

auto xpress::XPRSProblem::Controls::getSymmetry ( ) const -> int
inline

Get the value for control Symmetry.

Adjusts the overall amount of effort for symmetry detection.

Returns
The current value for Symmetry.

getSymSelect()

auto xpress::XPRSProblem::Controls::getSymSelect ( ) const -> int
inline

Get the value for control SymSelect.

Adjusts the overall amount of effort for symmetry detection.

Returns
The current value for SymSelect.

getThreads()

auto xpress::XPRSProblem::Controls::getThreads ( ) const -> int
inline

Get the value for control Threads.

The default number of threads used during optimization.

Returns
The current value for Threads.

getTimeLimit()

auto xpress::XPRSProblem::Controls::getTimeLimit ( ) const -> double
inline

Get the value for control TimeLimit.

The maximum time in seconds that the Optimizer will run before it terminates, including the problem setup time and solution time. For MIP problems, this is the total time taken to solve all nodes.

Returns
The current value for TimeLimit.

getTrace()

auto xpress::XPRSProblem::Controls::getTrace ( ) const -> int
inline

Get the value for control Trace.

Display the infeasibility diagnosis during presolve. If non-zero, an explanation of the logical deductions made by presolve to deduce infeasibility or unboundedness will be displayed on screen or sent to the message callback function.

Returns
The current value for Trace.

getTreeCompression()

auto xpress::XPRSProblem::Controls::getTreeCompression ( ) const -> int
inline

Get the value for control TreeCompression.

When writing nodes to the gloal file, the optimizer can try to use data-compression techniques to reduce the size of the tree file on disk. The TREECOMPRESSION control determines the strength of the data-compression algorithm used; higher values give superior data-compression at the affect of decreasing performance, while lower values compress quicker but not as effectively. Where TREECOMPRESSION is set to 0, no data compression will be used on the tree file.

Returns
The current value for TreeCompression.

getTreeCoverCuts()

auto xpress::XPRSProblem::Controls::getTreeCoverCuts ( ) const -> int
inline

Get the value for control TreeCoverCuts.

Branch and Bound: The number of rounds of lifted cover inequalities generated at nodes other than the top node in the tree. Compare with the description for COVERCUTS. A value of -1 indicates the number of rounds is determined automatically.

Returns
The current value for TreeCoverCuts.

getTreeCutSelect()

auto xpress::XPRSProblem::Controls::getTreeCutSelect ( ) const -> int
inline

Get the value for control TreeCutSelect.

A bit vector providing detailed control of the cuts created during the tree search of a MIP solve. Use CUTSELECT to control cuts on the root node.

Returns
The current value for TreeCutSelect.

getTreeDiagnostics()

auto xpress::XPRSProblem::Controls::getTreeDiagnostics ( ) const -> int
inline

Get the value for control TreeDiagnostics.

A bit vector providing control over how various tree-management-related messages get printed in the tree log file during the branch-and-bound search.

Returns
The current value for TreeDiagnostics.

getTreeFileLogInterval()

auto xpress::XPRSProblem::Controls::getTreeFileLogInterval ( ) const -> int
inline

Get the value for control TreeFileLogInterval.

This control sets the interval between progress messages output while writing tree data to the tree file, in seconds. The solve is slowed greatly while data is being written to the tree file and this output allows the user to see how much progress is being made.

Returns
The current value for TreeFileLogInterval.

getTreeGomCuts()

auto xpress::XPRSProblem::Controls::getTreeGomCuts ( ) const -> int
inline

Get the value for control TreeGomCuts.

Branch and Bound: The number of rounds of Gomory cuts generated at nodes other than the first node in the tree. Compare with the description for GOMCUTS. A value of -1 indicates the number of rounds is determined automatically.

Returns
The current value for TreeGomCuts.

getTreeMemoryLimit()

auto xpress::XPRSProblem::Controls::getTreeMemoryLimit ( ) const -> int
inline

Get the value for control TreeMemoryLimit.

A soft limit, in megabytes, for the amount of memory to use in storing the branch and bound search tree. This doesn't include memory used for presolve, heuristics, solving the LP relaxation, etc. When set to 0 (the default), the optimizer will calculate a limit automatically based on the amount of free physical memory detected in the machine. When the memory used by the branch and bound tree exceeds this limit, the optimizer will try to reduce the memory usage by writing lower-rated sections of the tree to a file called the "tree file". Though the solve can continue if it cannot bring the tree memory usage below the specified limit, performance will be inhibited and a message will be printed to the log.

Returns
The current value for TreeMemoryLimit.

getTreeMemorySavingTarget()

auto xpress::XPRSProblem::Controls::getTreeMemorySavingTarget ( ) const -> double
inline

Get the value for control TreeMemorySavingTarget.

When the memory used by the branch-and-bound search tree exceeds the limit specified by the TREEMEMORYLIMIT control, the optimizer will try to save memory by writing lower-rated sections of the tree to the tree file. The target amount of memory to save will be enough to bring memory usage back below the limit, plus enough extra to give the tree room to grow. The TREEMEMORYSAVINGTARGET control specifies the extra proportion of the tree's size to try to save; for example, if the tree memory limit is 1000Mb and TREEMEMORYSAVINGTARGET is 0.1, when the tree size exceeds 1000Mb the optimizer will try to reduce the tree size to 900Mb. Reducing the value of TREEMEMORYSAVINGTARGET will cause less extra nodes of the tree to be written to the tree file, but will result in the memory saving routine being triggered more often (as the tree will have less room in which to grow), which can reduce performance. Increasing the value of TREEMEMORYSAVINGTARGET will cause additional, more highly-rated nodes, of the tree to be written to the tree file, which can cause performance issues if these nodes are required later in the solve.

Returns
The current value for TreeMemorySavingTarget.

getTreeQCCuts()

auto xpress::XPRSProblem::Controls::getTreeQCCuts ( ) const -> int
inline

Get the value for control TreeQCCuts.

Branch and Bound: Limit on the number of rounds of outer approximation cuts generated for nodes other than the root node, when solving a mixed integer quadratic constrained or mixed integer second order conic problem with outer approximation.

Returns
The current value for TreeQCCuts.

getTunerHistory()

auto xpress::XPRSProblem::Controls::getTunerHistory ( ) const -> xpress::TunerHistory
inline

Get the value for control TunerHistory.

Tuner: Whether to reuse and append to previous tuner results of the same problem.

Returns
The current value for TunerHistory.

getTunerMaxTime()

auto xpress::XPRSProblem::Controls::getTunerMaxTime ( ) const -> double
inline

Get the value for control TunerMaxTime.

Tuner: The maximum time in seconds that the tuner will run before it terminates.

Returns
The current value for TunerMaxTime.

getTunerMethod()

auto xpress::XPRSProblem::Controls::getTunerMethod ( ) const -> xpress::TunerMethod
inline

Get the value for control TunerMethod.

Tuner: Selects a factory tuner method. A tuner method consists of a list of controls with different settings that the tuner will evaluate and try to combine.

Returns
The current value for TunerMethod.

getTunerMethodFile()

auto xpress::XPRSProblem::Controls::getTunerMethodFile ( ) const -> std::string
inline

Get the value for control TunerMethodFile.

Tuner: Defines a file from which the tuner can read user-defined tuner method.

Returns
The current value for TunerMethodFile.

getTunerMode()

auto xpress::XPRSProblem::Controls::getTunerMode ( ) const -> xpress::TunerMode
inline

Get the value for control TunerMode.

Tuner: Whether to always enable the tuner or disable it.

Returns
The current value for TunerMode.

getTunerOutput()

auto xpress::XPRSProblem::Controls::getTunerOutput ( ) const -> int
inline

Get the value for control TunerOutput.

Tuner: Whether to output tuner results and logs to the file system.

Returns
The current value for TunerOutput.

getTunerOutputPath()

auto xpress::XPRSProblem::Controls::getTunerOutputPath ( ) const -> std::string
inline

Get the value for control TunerOutputPath.

Tuner: Defines a root path to which the tuner writes the result file and logs.

Returns
The current value for TunerOutputPath.

getTunerPermute()

auto xpress::XPRSProblem::Controls::getTunerPermute ( ) const -> int
inline

Get the value for control TunerPermute.

Tuner: Defines the number of permutations to solve for each control setting.

Returns
The current value for TunerPermute.

getTunerSessionName()

auto xpress::XPRSProblem::Controls::getTunerSessionName ( ) const -> std::string
inline

Get the value for control TunerSessionName.

Tuner: Defines a session name for the tuner.

Returns
The current value for TunerSessionName.

getTunerTarget()

auto xpress::XPRSProblem::Controls::getTunerTarget ( ) const -> xpress::TunerTarget
inline

Get the value for control TunerTarget.

Tuner: Defines the tuner target – what should be evaluated when comparing two runs with different control settings.

Returns
The current value for TunerTarget.

getTunerThreads()

auto xpress::XPRSProblem::Controls::getTunerThreads ( ) const -> int
inline

Get the value for control TunerThreads.

Tuner: the number of threads used by the tuner.

Returns
The current value for TunerThreads.

getTunerVerbose()

auto xpress::XPRSProblem::Controls::getTunerVerbose ( ) const -> int
inline

Get the value for control TunerVerbose.

Tuner: whether the tuner should prints detailed information for each run.

Returns
The current value for TunerVerbose.

getUserSolHeuristic()

auto xpress::XPRSProblem::Controls::getUserSolHeuristic ( ) const -> int
inline

Get the value for control UserSolHeuristic.

Determines how much effort to put into running a local search heuristic to find a feasible integer solution from a partial or infeasible user solution.

Returns
The current value for UserSolHeuristic.

getVarSelection()

auto xpress::XPRSProblem::Controls::getVarSelection ( ) const -> int
inline

Get the value for control VarSelection.

Branch and Bound: This determines the formula used to calculate the estimate of each integer variable, and thus which integer variable is selected to be branched on at a given node. The variable selected to be branched on is the one with the maximum estimate.

Returns
The current value for VarSelection.

getVersion()

auto xpress::XPRSProblem::Controls::getVersion ( ) const -> int
inline

Get the value for control Version.

The Optimizer version number, e.g. 1301 meaning release 13.01.

Returns
The current value for Version.

setAlgAfterCrossOver()

void xpress::XPRSProblem::Controls::setAlgAfterCrossOver ( int newValue )
inline

Set control AlgAfterCrossOver.

The algorithm to be used for the final clean up step after the crossover.

Parameters
newValue The new value for AlgAfterCrossOver.

setAlgAfterNetwork()

void xpress::XPRSProblem::Controls::setAlgAfterNetwork ( int newValue )
inline

Set control AlgAfterNetwork.

The algorithm to be used for the clean up step after the network simplex solver.

Parameters
newValue The new value for AlgAfterNetwork.

setAlternativeRedCosts()

void xpress::XPRSProblem::Controls::setAlternativeRedCosts ( int newValue )
inline

Set control AlternativeRedCosts.

Controls aggressiveness of searching for alternative reduced cost

Parameters
newValue The new value for AlternativeRedCosts.

setAutoCutting()

void xpress::XPRSProblem::Controls::setAutoCutting ( int newValue )
inline

Set control AutoCutting.

Should the Optimizer automatically decide whether to generate cutting planes at local nodes in the tree or not? If the CUTFREQ control is set, no automatic selection will be made and local cutting will be enabled.

Parameters
newValue The new value for AutoCutting.

setAutoPerturb()

void xpress::XPRSProblem::Controls::setAutoPerturb ( int newValue )
inline

Set control AutoPerturb.

Simplex: This indicates whether automatic perturbation is performed. If this is set to 1, the problem will be perturbed whenever the simplex method encounters an excessive number of degenerate pivot steps, thus preventing the Optimizer being hindered by degeneracies.

Parameters
newValue The new value for AutoPerturb.

setAutoScaling()

void xpress::XPRSProblem::Controls::setAutoScaling ( int newValue )
inline

Set control AutoScaling.

Whether the Optimizer should automatically select between different scaling algorithms. If the SCALING control is set, no automatic scaling will be applied.

Parameters
newValue The new value for AutoScaling.

setBackgroundMaxThreads()

void xpress::XPRSProblem::Controls::setBackgroundMaxThreads ( int newValue )
inline

Set control BackgroundMaxThreads.

Limit the number of threads to use in background jobs (for example in parallel to the root cut loop).

Parameters
newValue The new value for BackgroundMaxThreads.

setBackgroundSelect()

void xpress::XPRSProblem::Controls::setBackgroundSelect ( XPRSint64 newValue )
inline

Set control BackgroundSelect.

Select which tasks to run in background jobs (for example in parallel to the root cut loop).

Parameters
newValue The new value for BackgroundSelect.

setBackTrack()

void xpress::XPRSProblem::Controls::setBackTrack ( int newValue )
inline

Set control BackTrack.

Branch and Bound: Specifies how to select the next node to work on when a full backtrack is performed.

Parameters
newValue The new value for BackTrack.

setBacktrackTie()

void xpress::XPRSProblem::Controls::setBacktrackTie ( int newValue )
inline

Set control BacktrackTie.

Branch and Bound: Specifies how to break ties when selecting the next node to work on when a full backtrack is performed. The options are the same as for the BACKTRACK control.

Parameters
newValue The new value for BacktrackTie.

setBarAlg()

void xpress::XPRSProblem::Controls::setBarAlg ( int newValue )
inline

Set control BarAlg.

This control determines which barrier algorithm is used to solve the problem.

Parameters
newValue The new value for BarAlg.

setBarCores()

void xpress::XPRSProblem::Controls::setBarCores ( int newValue )
inline

Set control BarCores.

If set to a positive integer it determines the number of physical CPU cores assumed to be present in the system by the barrier and hybrid gradient algorithms. If the value is set to the default value (-1), Xpress will automatically detect the number of cores.

Parameters
newValue The new value for BarCores.

setBarCrash()

void xpress::XPRSProblem::Controls::setBarCrash ( int newValue )
inline

Set control BarCrash.

Newton barrier and hybrid gradient: This determines the type of crash used for the crossover. During the crash procedure, an initial basis is determined which attempts to speed up the crossover. A good choice at this stage will significantly reduce the number of iterations required to crossover to an optimal solution. The possible values increase proportionally to their time-consumption.

Parameters
newValue The new value for BarCrash.

setBarDualStop()

void xpress::XPRSProblem::Controls::setBarDualStop ( double newValue )
inline

Set control BarDualStop.

Newton barrier and hybrid gradient: This is a convergence parameter, representing the tolerance for dual infeasibilities. If the difference between the constraints and their bounds in the dual problem falls below this tolerance in absolute value, optimization will stop and the current solution will be returned.

Parameters
newValue The new value for BarDualStop.

setBarFailIterLimit()

void xpress::XPRSProblem::Controls::setBarFailIterLimit ( int newValue )
inline

Set control BarFailIterLimit.

Newton barrier: The maximum number of consecutive iterations that fail to improve the solution in the barrier algorithm.

Parameters
newValue The new value for BarFailIterLimit.

setBarFreeScale()

void xpress::XPRSProblem::Controls::setBarFreeScale ( double newValue )
inline

Set control BarFreeScale.

Defines how the barrier algorithm scales free variables.

Parameters
newValue The new value for BarFreeScale.

setBarGapStop()

void xpress::XPRSProblem::Controls::setBarGapStop ( double newValue )
inline

Set control BarGapStop.

Newton barrier and hybrid gradient: This is a convergence parameter, representing the tolerance for the relative duality gap. When the difference between the primal and dual objective function values falls below this tolerance, the Optimizer determines that the optimal solution has been found.

Parameters
newValue The new value for BarGapStop.

setBarGapTarget()

void xpress::XPRSProblem::Controls::setBarGapTarget ( double newValue )
inline

Set control BarGapTarget.

Newton barrier: The target tolerance for the relative duality gap. The barrier algorithm will keep iterating until either BARGAPTARGET is satisfied or until no further improvements are possible. In the latter case, if BARGAPSTOP is satisfied, it will declare the problem optimal.

Parameters
newValue The new value for BarGapTarget.

setBarhgExtrapolate()

void xpress::XPRSProblem::Controls::setBarhgExtrapolate ( double newValue )
inline

Set control BarhgExtrapolate.

   Extrapolation parameter for the hybrid gradient algorithm. Although theory suggests that a value of 1 is best, slightly smaller values perform better in general.
Parameters
newValue The new value for BarhgExtrapolate.

setBarhgMaxRestarts()

void xpress::XPRSProblem::Controls::setBarhgMaxRestarts ( int newValue )
inline

Set control BarhgMaxRestarts.

The maximum number of restarts in the hybrid gradient algorithm. Restarts play the role of iterations in the hybrid gradient algorithm. A log line is printed at every restart, unless BAROUTPUT is set to 0.

Parameters
newValue The new value for BarhgMaxRestarts.

setBarhgOps()

void xpress::XPRSProblem::Controls::setBarhgOps ( xpress::BARHGOps newValue )
inline

Set control BarhgOps.

   Control options for the hybrid gradient algorithm. Bits 1, 2 and 3 control which norms of the coefficient matrix are used for solution normalization. The normalization factor is the maximum of the selected norms. By default, or if all three bits are set to 0, the infinity norm is used.
   The omega parameter referenced in bits 4, 5 and 6 is a measure of the relative magnitudes of the objective and the right-hand side.
Parameters
newValue The new value for BarhgOps.

setBarIndefLimit()

void xpress::XPRSProblem::Controls::setBarIndefLimit ( int newValue )
inline

Set control BarIndefLimit.

Newton Barrier. This limits the number of consecutive indefinite barrier iterations that will be performed. The optimizer will try to minimize (resp. maximize) a QP problem even if the Q matrix is not positive (resp. negative) semi-definite. However, the optimizer may detect that the Q matrix is indefinite and this can result in the optimizer not converging. This control specifies how many indefinite iterations may occur before the optimizer stops and reports that the problem is indefinite. It is usual to specify a value greater than one, and only stop after a series of indefinite matrices, as the problem may be found to be indefinite incorrectly on a few iterations for numerical reasons.

Parameters
newValue The new value for BarIndefLimit.

setBarIterLimit()

void xpress::XPRSProblem::Controls::setBarIterLimit ( int newValue )
inline

Set control BarIterLimit.

Newton barrier: The maximum number of iterations. While the simplex method usually performs a number of iterations which is proportional to the number of constraints (rows) in a problem, the barrier method standardly finds the optimal solution to a given accuracy after a number of iterations which is independent of the problem size. The penalty is rather that the time for each iteration increases with the size of the problem. BARITERLIMIT specifies the maximum number of iterations which will be carried out by the barrier.

Parameters
newValue The new value for BarIterLimit.

setBarKernel()

void xpress::XPRSProblem::Controls::setBarKernel ( double newValue )
inline

Set control BarKernel.

Newton barrier: Defines how centrality is weighted in the barrier algorithm.

Parameters
newValue The new value for BarKernel.

setBarLargeBound()

void xpress::XPRSProblem::Controls::setBarLargeBound ( double newValue )
inline

Set control BarLargeBound.

Threshold for the barrier to handle large bounds.

Parameters
newValue The new value for BarLargeBound.

setBarNumStability()

void xpress::XPRSProblem::Controls::setBarNumStability ( int newValue )
inline

Set control BarNumStability.

Parameters
newValue The new value for BarNumStability.

setBarObjPerturb()

void xpress::XPRSProblem::Controls::setBarObjPerturb ( double newValue )
inline

Set control BarObjPerturb.

Defines how the barrier perturbs the objective.

Parameters
newValue The new value for BarObjPerturb.

setBarObjScale()

void xpress::XPRSProblem::Controls::setBarObjScale ( double newValue )
inline

Set control BarObjScale.

Defines how the barrier scales the objective.

Parameters
newValue The new value for BarObjScale.

setBarOrder()

void xpress::XPRSProblem::Controls::setBarOrder ( xpress::BarOrder newValue )
inline

Set control BarOrder.

Newton barrier: This controls the Cholesky factorization in the Newton-Barrier.

Parameters
newValue The new value for BarOrder.

setBarOrderThreads()

void xpress::XPRSProblem::Controls::setBarOrderThreads ( int newValue )
inline

Set control BarOrderThreads.

If set to a positive integer it determines the number of concurrent threads for the sparse matrix ordering algorithm in the Newton-barrier method.

Parameters
newValue The new value for BarOrderThreads.

setBarOutput()

void xpress::XPRSProblem::Controls::setBarOutput ( int newValue )
inline

Set control BarOutput.

Newton barrier and hybrid gradient: This specifies the level of solution output provided. Output is provided either after each iteration of the algorithm, or else can be turned off completely by this parameter.

Parameters
newValue The new value for BarOutput.

setBarPerturb()

void xpress::XPRSProblem::Controls::setBarPerturb ( double newValue )
inline

Set control BarPerturb.

Newton barrier: In numerically challenging cases it is often advantageous to apply perturbations on the KKT system to improve its numerical properties. BARPERTURB controlls how much perturbation is allowed during the barrier iterations. By default no perturbation is allowed. Set this parameter with care as larger perturbations may lead to less efficient iterates and the best settings are problem-dependent.

Parameters
newValue The new value for BarPerturb.

setBarPresolveOps()

void xpress::XPRSProblem::Controls::setBarPresolveOps ( int newValue )
inline

Set control BarPresolveOps.

Newton barrier: This controls the Newton-Barrier specific presolve operations.

Parameters
newValue The new value for BarPresolveOps.

setBarPrimalStop()

void xpress::XPRSProblem::Controls::setBarPrimalStop ( double newValue )
inline

Set control BarPrimalStop.

Newton barrier and hybrid gradient: This is a convergence parameter, indicating the tolerance for primal infeasibilities. If the difference between the constraints and their bounds in the primal problem falls below this tolerance in absolute value, the Optimizer will terminate and return the current solution.

Parameters
newValue The new value for BarPrimalStop.

setBarRefIter()

void xpress::XPRSProblem::Controls::setBarRefIter ( int newValue )
inline

Set control BarRefIter.

Newton barrier: After terminating the barrier algorithm, further refinement steps can be performed. Such refinement steps are especially helpful if the solution is near to the optimum and can improve primal feasibility and decrease the complementarity gap. It is also often advantageous for the crossover algorithm. BARREFITER specifies the maximum number of such refinement iterations.

Parameters
newValue The new value for BarRefIter.

setBarRegularize()

void xpress::XPRSProblem::Controls::setBarRegularize ( int newValue )
inline

Set control BarRegularize.

This control determines how the barrier algorithm applies regularization on the KKT system.

Parameters
newValue The new value for BarRegularize.

setBarRhsScale()

void xpress::XPRSProblem::Controls::setBarRhsScale ( double newValue )
inline

Set control BarRhsScale.

Defines how the barrier scales the right hand side.

Parameters
newValue The new value for BarRhsScale.

setBarSolution()

void xpress::XPRSProblem::Controls::setBarSolution ( int newValue )
inline

Set control BarSolution.

This determines whether the barrier has to decide which is the best solution found or return the solution computed by the last barrier iteration.

Parameters
newValue The new value for BarSolution.

setBarStart()

void xpress::XPRSProblem::Controls::setBarStart ( int newValue )
inline

Set control BarStart.

Controls the computation of the starting point and warm-starting for the Newton barrier and the hybrid gradient algorithms.

Parameters
newValue The new value for BarStart.

setBarStartWeight()

void xpress::XPRSProblem::Controls::setBarStartWeight ( double newValue )
inline

Set control BarStartWeight.

Newton barrier: This sets a weight for the warm-start point when warm-start is set for the barrier algorithm. Using larger weight gives more emphasis for the supplied starting point.

Parameters
newValue The new value for BarStartWeight.

setBarStepStop()

void xpress::XPRSProblem::Controls::setBarStepStop ( double newValue )
inline

Set control BarStepStop.

Newton barrier: A convergence parameter, representing the minimal step size. On each iteration of the barrier algorithm, a step is taken along a computed search direction. If that step size is smaller than BARSTEPSTOP, the Optimizer will terminate and return the current solution.

Parameters
newValue The new value for BarStepStop.

setBarThreads()

void xpress::XPRSProblem::Controls::setBarThreads ( int newValue )
inline

Set control BarThreads.

If set to a positive integer it determines the number of threads implemented to run the Newton-barrier and hybrid gradient algorithms. If the value is set to the default value (-1), the THREADS control will determine the number of threads used.

Parameters
newValue The new value for BarThreads.

setBigM()

void xpress::XPRSProblem::Controls::setBigM ( double newValue )
inline

Set control BigM.

The infeasibility penalty used if the "Big M" method is implemented.

Parameters
newValue The new value for BigM.

setBigmMethod()

void xpress::XPRSProblem::Controls::setBigmMethod ( int newValue )
inline

Set control BigmMethod.

Simplex: This specifies whether to use the "Big M" method, or the standard phase I (achieving feasibility) and phase II (achieving optimality). In the "Big M" method, the objective coefficients of the variables are considered during the feasibility phase, possibly leading to an initial feasible basis which is closer to optimal. The side-effects involve possible round-off errors due to the presence of the "Big M" factor in the problem.

Parameters
newValue The new value for BigmMethod.

setBranchChoice()

void xpress::XPRSProblem::Controls::setBranchChoice ( int newValue )
inline

Set control BranchChoice.

Once a MIP entity has been selected for branching, this control determines which of the branches is solved first.

Parameters
newValue The new value for BranchChoice.

setBranchDisj()

void xpress::XPRSProblem::Controls::setBranchDisj ( int newValue )
inline

Set control BranchDisj.

Branch and Bound: Determines whether the optimizer should attempt to branch on general split disjunctions during the branch and bound search.

Parameters
newValue The new value for BranchDisj.

setBranchStructural()

void xpress::XPRSProblem::Controls::setBranchStructural ( int newValue )
inline

Set control BranchStructural.

Branch and Bound: Determines whether the optimizer should search for special structure in the problem to branch on during the branch and bound search.

Parameters
newValue The new value for BranchStructural.

setBreadthFirst()

void xpress::XPRSProblem::Controls::setBreadthFirst ( int newValue )
inline

Set control BreadthFirst.

The number of nodes to include in the best-first search before switching to the local first search (NODESELECTION = 4).

Parameters
newValue The new value for BreadthFirst.

setCacheSize()

void xpress::XPRSProblem::Controls::setCacheSize ( int newValue )
inline

Set control CacheSize.

Newton Barrier: L2 or L3 (see notes) cache size in kB (kilobytes) of the CPU. On Intel (or compatible) platforms a value of -1 may be used to determine the cache size automatically. If the CPU model is new then the cache size may not be correctly detected by an older release of the software.

Parameters
newValue The new value for CacheSize.

setCallbackCheckTimeDelay()

void xpress::XPRSProblem::Controls::setCallbackCheckTimeDelay ( int newValue )
inline

Set control CallbackCheckTimeDelay.

Minimum delay in milliseconds between two consecutive executions of the CHECKTIME callback in the same solution process

Parameters
newValue The new value for CallbackCheckTimeDelay.

setCallbackFromMasterThread()

void xpress::XPRSProblem::Controls::setCallbackFromMasterThread ( int newValue )
inline

Set control CallbackFromMasterThread.

Branch and Bound: specifies whether the MIP callbacks should only be called on the master thread.

Parameters
newValue The new value for CallbackFromMasterThread.

setCheckInputData()

void xpress::XPRSProblem::Controls::setCheckInputData ( int newValue )
inline

Set control CheckInputData.

Check input arrays for bad data.

Parameters
newValue The new value for CheckInputData.

setCholeskyAlg()

void xpress::XPRSProblem::Controls::setCholeskyAlg ( int newValue )
inline

Set control CholeskyAlg.

Newton barrier: type of Cholesky factorization used.

Parameters
newValue The new value for CholeskyAlg.

setCholeskyTol()

void xpress::XPRSProblem::Controls::setCholeskyTol ( double newValue )
inline

Set control CholeskyTol.

Newton barrier: The tolerance for pivot elements in the Cholesky decomposition of the normal equations coefficient matrix, computed at each iteration of the barrier algorithm. If the absolute value of the pivot element is less than or equal to CHOLESKYTOL, it merits special treatment in the Cholesky decomposition process.

Parameters
newValue The new value for CholeskyTol.

setClamping()

void xpress::XPRSProblem::Controls::setClamping ( int newValue )
inline

Set control Clamping.

This control allows for the adjustment of returned solution values such that they are always within bounds.

Parameters
newValue The new value for Clamping.

setCompute()

void xpress::XPRSProblem::Controls::setCompute ( int newValue )
inline

Set control Compute.

Controls whether the next solve is performed directly or on an Insight Compute Interface.

Parameters
newValue The new value for Compute.

setComputeExecService()

void xpress::XPRSProblem::Controls::setComputeExecService ( std::string const & newValue )
inline

Set control ComputeExecService.

Selects the Insight execution service that will be used for solving remote optimizations.

Parameters
newValue The new value for ComputeExecService.

setComputeJobPriority()

void xpress::XPRSProblem::Controls::setComputeJobPriority ( int newValue )
inline

Set control ComputeJobPriority.

Selects the priority that will be used for remote optimization jobs.

Parameters
newValue The new value for ComputeJobPriority.

setComputeLog()

void xpress::XPRSProblem::Controls::setComputeLog ( xpress::ComputeLog newValue )
inline

Set control ComputeLog.

Controls how the run log is fetched when a solve is performed on an Insight Compute Interface.

Parameters
newValue The new value for ComputeLog.

setConcurrentThreads()

void xpress::XPRSProblem::Controls::setConcurrentThreads ( int newValue )
inline

Set control ConcurrentThreads.

Determines the number of threads used by the concurrent solver.

Parameters
newValue The new value for ConcurrentThreads.

setConflictCuts()

void xpress::XPRSProblem::Controls::setConflictCuts ( int newValue )
inline

Set control ConflictCuts.

Branch and Bound: Specifies how cautious or aggressive the optimizer should be when searching for and applying conflict cuts. Conflict cuts are in-tree cuts derived from nodes found to be infeasible or cut off, which can be used to cut off other branches of the search tree.

Parameters
newValue The new value for ConflictCuts.

setCoresPerCPU()

void xpress::XPRSProblem::Controls::setCoresPerCPU ( int newValue )
inline

Set control CoresPerCPU.

Used to override the detected value of the number of cores on a CPU. The cache size (either detected or specified via the CACHESIZE control) used in Barrier methods will be divided by this amount, and this scaled-down value will be the amount of cache allocated to each Barrier thread

Parameters
newValue The new value for CoresPerCPU.

setCoverCuts()

void xpress::XPRSProblem::Controls::setCoverCuts ( int newValue )
inline

Set control CoverCuts.

Branch and Bound: The number of rounds of lifted cover inequalities at the top node. A lifted cover inequality is an additional constraint that can be particularly effective at reducing the size of the feasible region without removing potential integral solutions. The process of generating these can be carried out a number of times, further reducing the feasible region, albeit incurring a time penalty. There is usually a good payoff from generating these at the top node, since these inequalities then apply to every subsequent node in the tree search.

Parameters
newValue The new value for CoverCuts.

setCpiAlpha()

void xpress::XPRSProblem::Controls::setCpiAlpha ( double newValue )
inline

Set control CpiAlpha.

decay term for confined primal integral computation.

Parameters
newValue The new value for CpiAlpha.

setCPUPlatform()

void xpress::XPRSProblem::Controls::setCPUPlatform ( int newValue )
inline

Set control CPUPlatform.

Newton Barrier: Selects the AMD, Intel x86 or ARM vectorization instruction set that Barrier should run optimized code for. On AMD / Intel x86 platforms the SSE2, AVX and AVX2 instruction sets are supported while on ARM platforms the NEON architecture extension can be activated.

Parameters
newValue The new value for CPUPlatform.

setCPUTime()

void xpress::XPRSProblem::Controls::setCPUTime ( int newValue )
inline

Set control CPUTime.

How time should be measured when timings are reported in the log and when checking against time limits

Parameters
newValue The new value for CPUTime.

setCrash()

void xpress::XPRSProblem::Controls::setCrash ( int newValue )
inline

Set control Crash.

Simplex: This determines the type of crash used when the algorithm begins. During the crash procedure, an initial basis is determined which is as close to feasibility and triangularity as possible. A good choice at this stage will significantly reduce the number of iterations required to find an optimal solution. The possible values increase proportionally to their time-consumption.

Parameters
newValue The new value for Crash.

setCrossOver()

void xpress::XPRSProblem::Controls::setCrossOver ( int newValue )
inline

Set control CrossOver.

Newton barrier and hybrid gradient: This control determines whether the barrier method will cross over to the simplex method when at optimal solution has been found, to provide an end basis (see XPRSgetbasis, XPRSwritebasis) and advanced sensitivity analysis information (see XPRSobjsa, XPRSrhssa, XPRSbndsa).

Parameters
newValue The new value for CrossOver.

setCrossoverAccuracyTol()

void xpress::XPRSProblem::Controls::setCrossoverAccuracyTol ( double newValue )
inline

Set control CrossoverAccuracyTol.

Newton barrier: This control determines how crossover adjusts the default relative pivot tolerance. When re-inversion is necessary, crossover will compare the recalculated working basic solution with the assumed ones just before re-inversion took place. If the error is above this threshold, crossover will adjust the relative pivot tolerance to address the build-up of numerical inaccuracies.

Parameters
newValue The new value for CrossoverAccuracyTol.

setCrossOverDRP()

void xpress::XPRSProblem::Controls::setCrossOverDRP ( int newValue )
inline

Set control CrossOverDRP.

Parameters
newValue The new value for CrossOverDRP.

setCrossOverFeasWeight()

void xpress::XPRSProblem::Controls::setCrossOverFeasWeight ( double newValue )
inline

Set control CrossOverFeasWeight.

Parameters
newValue The new value for CrossOverFeasWeight.

setCrossoverIterLimit()

void xpress::XPRSProblem::Controls::setCrossoverIterLimit ( int newValue )
inline

Set control CrossoverIterLimit.

Newton barrier and hybrid gradient: The maximum number of iterations that will be performed in the crossover procedure before the optimization process terminates.

Parameters
newValue The new value for CrossoverIterLimit.

setCrossoverOps()

void xpress::XPRSProblem::Controls::setCrossoverOps ( int newValue )
inline

Set control CrossoverOps.

Newton barrier and hybrid gradient: a bit vector for adjusting the behavior of the crossover procedure.

Parameters
newValue The new value for CrossoverOps.

setCrossOverRelPivotTol()

void xpress::XPRSProblem::Controls::setCrossOverRelPivotTol ( double newValue )
inline

Set control CrossOverRelPivotTol.

Parameters
newValue The new value for CrossOverRelPivotTol.

setCrossOverRelPivotTolSafe()

void xpress::XPRSProblem::Controls::setCrossOverRelPivotTolSafe ( double newValue )
inline

Set control CrossOverRelPivotTolSafe.

Parameters
newValue The new value for CrossOverRelPivotTolSafe.

setCrossoverThreads()

void xpress::XPRSProblem::Controls::setCrossoverThreads ( int newValue )
inline

Set control CrossoverThreads.

Determines the maximum number of threads that parallel crossover is allowed to use. If CROSSOVERTHREADS is set to the default value (-1), the BARTHREADS control will determine the number of threads used.

Parameters
newValue The new value for CrossoverThreads.

setCutDepth()

void xpress::XPRSProblem::Controls::setCutDepth ( int newValue )
inline

Set control CutDepth.

Branch and Bound: Sets the maximum depth in the tree search at which cuts will be generated. Generating cuts can take a lot of time, and is often less important at deeper levels of the tree since tighter bounds on the variables have already reduced the feasible region. A value of 0 signifies that no cuts will be generated.

Parameters
newValue The new value for CutDepth.

setCutFactor()

void xpress::XPRSProblem::Controls::setCutFactor ( double newValue )
inline

Set control CutFactor.

Limit on the number of cuts and cut coefficients the optimizer is allowed to add to the matrix during tree search. The cuts and cut coefficients are limited by CUTFACTOR times the number of rows and coefficients in the initial matrix.

Parameters
newValue The new value for CutFactor.

setCutFreq()

void xpress::XPRSProblem::Controls::setCutFreq ( int newValue )
inline

Set control CutFreq.

Branch and Bound: This specifies the frequency at which cuts are generated in the tree search. If the depth of the node modulo CUTFREQ is zero, then cuts will be generated.

Parameters
newValue The new value for CutFreq.

setCutSelect()

void xpress::XPRSProblem::Controls::setCutSelect ( int newValue )
inline

Set control CutSelect.

A bit vector providing detailed control of the cuts created for the root node of a MIP solve. Use TREECUTSELECT to control cuts during the tree search.

Parameters
newValue The new value for CutSelect.

setCutStrategy()

void xpress::XPRSProblem::Controls::setCutStrategy ( int newValue )
inline

Set control CutStrategy.

Branch and Bound: This specifies the cut strategy. A more aggressive cut strategy, generating a greater number of cuts, will result in fewer nodes to be explored, but with an associated time cost in generating the cuts. The fewer cuts generated, the less time taken, but the greater subsequent number of nodes to be explored.

Parameters
newValue The new value for CutStrategy.

setDefaultAlg()

void xpress::XPRSProblem::Controls::setDefaultAlg ( xpress::DefaultAlg newValue )
inline

Set control DefaultAlg.

This selects the algorithm that will be used to solve LPs, standalone or during MIP optimization.

Parameters
newValue The new value for DefaultAlg.

setDenseColLimit()

void xpress::XPRSProblem::Controls::setDenseColLimit ( int newValue )
inline

Set control DenseColLimit.

Newton barrier: Columns with more than DENSECOLLIMIT elements are considered to be dense. Such columns will be handled specially in the Cholesky factorization of this matrix.

Parameters
newValue The new value for DenseColLimit.

setDeterministic()

void xpress::XPRSProblem::Controls::setDeterministic ( int newValue )
inline

Set control Deterministic.

Selects whether to use a deterministic or opportunistic mode when solving a problem using multiple threads.

Parameters
newValue The new value for Deterministic.

setDetLogFreq()

void xpress::XPRSProblem::Controls::setDetLogFreq ( double newValue )
inline

Set control DetLogFreq.

Parameters
newValue The new value for DetLogFreq.

setDualGradient()

void xpress::XPRSProblem::Controls::setDualGradient ( int newValue )
inline

Set control DualGradient.

Simplex: This specifies the dual simplex pricing method.

Parameters
newValue The new value for DualGradient.

setDualize()

void xpress::XPRSProblem::Controls::setDualize ( int newValue )
inline

Set control Dualize.

For a linear problem or the initial linear relaxation of a MIP, determines whether to form and solve the dual problem.

Parameters
newValue The new value for Dualize.

setDualizeOps()

void xpress::XPRSProblem::Controls::setDualizeOps ( int newValue )
inline

Set control DualizeOps.

Bit-vector control for adjusting the behavior when a problem is dualized.

Parameters
newValue The new value for DualizeOps.

setDualPerturb()

void xpress::XPRSProblem::Controls::setDualPerturb ( double newValue )
inline

Set control DualPerturb.

The factor by which the problem will be perturbed prior to optimization by dual simplex. A value of 0.0 results in no perturbation prior to optimization.

Note the interconnection to the AUTOPERTURB control. If AUTOPERTURB is set to 1, the decision whether to perturb or not is left to the Optimizer. When the problem is automatically perturbed in dual simplex, however, the value of DUALPERTURB will be used for perturbation.

Parameters
newValue The new value for DualPerturb.

setDualStrategy()

void xpress::XPRSProblem::Controls::setDualStrategy ( int newValue )
inline

Set control DualStrategy.

This bit-vector control specifies the dual simplex strategy.

Parameters
newValue The new value for DualStrategy.

setDualThreads()

void xpress::XPRSProblem::Controls::setDualThreads ( int newValue )
inline

Set control DualThreads.

Determines the maximum number of threads that dual simplex is allowed to use. If DUALTHREADS is set to the default value (-1), the THREADS control will determine the number of threads used.

Parameters
newValue The new value for DualThreads.

setDummyControl()

void xpress::XPRSProblem::Controls::setDummyControl ( double newValue )
inline

Set control DummyControl.

Parameters
newValue The new value for DummyControl.

setEigenValueTol()

void xpress::XPRSProblem::Controls::setEigenValueTol ( double newValue )
inline

Set control EigenValueTol.

A quadratic matrix is considered not to be positive semi-definite, if its smallest eigenvalue is smaller than the negative of this value.

Parameters
newValue The new value for EigenValueTol.

setElimFillIn()

void xpress::XPRSProblem::Controls::setElimFillIn ( int newValue )
inline

Set control ElimFillIn.

Amount of fill-in allowed when performing an elimination in presolve .

Parameters
newValue The new value for ElimFillIn.

setElimTol()

void xpress::XPRSProblem::Controls::setElimTol ( double newValue )
inline

Set control ElimTol.

The Markowitz tolerance for the elimination phase of the presolve.

Parameters
newValue The new value for ElimTol.

setEscapeNames()

void xpress::XPRSProblem::Controls::setEscapeNames ( int newValue )
inline

Set control EscapeNames.

If characters illegal to an mps or lp file should be escaped to guarantee readability, and whether escaped characters should be transformed back when reading such a file.

Parameters
newValue The new value for EscapeNames.

setEtaTol()

void xpress::XPRSProblem::Controls::setEtaTol ( double newValue )
inline

Set control EtaTol.

Tolerance on eta elements. During each iteration, the basis inverse is premultiplied by an elementary matrix, which is the identity except for one column - the eta vector. Elements of eta vectors whose absolute value is smaller than ETATOL are taken to be zero in this step.

Parameters
newValue The new value for EtaTol.

setExtraCols()

void xpress::XPRSProblem::Controls::setExtraCols ( int newValue )
inline

Set control ExtraCols.

The initial number of extra columns to allow for in the matrix. If columns are to be added to the matrix, then, for maximum efficiency, space should be reserved for the columns before the matrix is input by setting the EXTRACOLS control. If this is not done, resizing will occur automatically, but more space may be allocated than the user actually requires.

Parameters
newValue The new value for ExtraCols.

setExtraElems()

void xpress::XPRSProblem::Controls::setExtraElems ( XPRSint64 newValue )
inline

Set control ExtraElems.

The initial number of extra matrix elements to allow for in the matrix, including coefficients for cuts. If rows or columns are to be added to the matrix, then, for maximum efficiency, space should be reserved for the extra matrix elements before the matrix is input by setting the EXTRAELEMS control. If this is not done, resizing will occur automatically, but more space may be allocated than the user actually requires.

Parameters
newValue The new value for ExtraElems.

setExtraMipEnts()

void xpress::XPRSProblem::Controls::setExtraMipEnts ( int newValue )
inline

Set control ExtraMipEnts.

The initial number of extra MIP entities to allow for.

Parameters
newValue The new value for ExtraMipEnts.

setExtraRows()

void xpress::XPRSProblem::Controls::setExtraRows ( int newValue )
inline

Set control ExtraRows.

The initial number of extra rows to allow for in the matrix, including cuts. If rows are to be added to the matrix, then, for maximum efficiency, space should be reserved for the rows before the matrix is input by setting the EXTRAROWS control. If this is not done, resizing will occur automatically, but more space may be allocated than the user actually requires.

Parameters
newValue The new value for ExtraRows.

setExtraSetElems()

void xpress::XPRSProblem::Controls::setExtraSetElems ( XPRSint64 newValue )
inline

Set control ExtraSetElems.

The initial number of extra elements in sets to allow for in the matrix. If sets are to be added to the matrix, then, for maximum efficiency, space should be reserved for the set elements before the matrix is input by setting the EXTRASETELEMS control. If this is not done, resizing will occur automatically, but more space may be allocated than the user actually requires.

Parameters
newValue The new value for ExtraSetElems.

setExtraSets()

void xpress::XPRSProblem::Controls::setExtraSets ( int newValue )
inline

Set control ExtraSets.

The initial number of extra sets to allow for in the matrix. If sets are to be added to the matrix, then, for maximum efficiency, space should be reserved for the sets before the matrix is input by setting the EXTRASETS control. If this is not done, resizing will occur automatically, but more space may be allocated than the user actually requires.

Parameters
newValue The new value for ExtraSets.

setFeasibilityJump()

void xpress::XPRSProblem::Controls::setFeasibilityJump ( int newValue )
inline

Set control FeasibilityJump.

MIP: Decides if the Feasibility Jump heuristic should be run. The value for this control is either -1 (let Xpress decide), 0 (off) or a value that indicates for which type of models the heuristic should be run.

Parameters
newValue The new value for FeasibilityJump.

setFeasibilityPump()

void xpress::XPRSProblem::Controls::setFeasibilityPump ( int newValue )
inline

Set control FeasibilityPump.

Branch and Bound: Decides if the Feasibility Pump heuristic should be run at the top node.

Parameters
newValue The new value for FeasibilityPump.

setFeasTol()

void xpress::XPRSProblem::Controls::setFeasTol ( double newValue )
inline

Set control FeasTol.

This tolerance determines when a solution is treated as feasible. If the amount by which a constraint's activity violates its right-hand side or ranged bound is less in absolute magnitude than FEASTOL, then the constraint is treated as satisfied. Similarly, if the amount by which a column violates its bounds is less in absolute magnitude than FEASTOL, those bounds are also treated as satisfied.

Parameters
newValue The new value for FeasTol.

setFeasTolPerturb()

void xpress::XPRSProblem::Controls::setFeasTolPerturb ( double newValue )
inline

Set control FeasTolPerturb.

This tolerance determines how much a feasible primal basic solution is allowed to be perturbed when performing basis changes. The tolerance FEASTOL is always considered as an upper limit for the perturbations, but in some cases smaller value can be more desirable.

Parameters
newValue The new value for FeasTolPerturb.

setFeasTolTarget()

void xpress::XPRSProblem::Controls::setFeasTolTarget ( double newValue )
inline

Set control FeasTolTarget.

This specifies the target feasibility tolerance for the solution refiner.

Parameters
newValue The new value for FeasTolTarget.

setForceOutput()

void xpress::XPRSProblem::Controls::setForceOutput ( int newValue )
inline

Set control ForceOutput.

Certain names in the problem object may be incompatible with different file formats (such as names containing spaces for LP files). If the optimizer might be unable to read back a problem because of non-standard names, it will first attempt to write it out using an extended naming convention. If the names would not be possible to extend so that they would be reproducible and recognizable, it will give an error message and won't create the file. If the optimizer might be unable to read back a problem because of non-standard names, it will give an error message and won't create the file. This option may be used to force output anyway.

Parameters
newValue The new value for ForceOutput.

setForceParallelDual()

void xpress::XPRSProblem::Controls::setForceParallelDual ( int newValue )
inline

Set control ForceParallelDual.

Dual simplex: specifies whether the dual simplex solver should always use the parallel simplex algorithm. By default, when using a single thread, the dual simplex solver will execute a dedicated sequential simplex algorithm.

Parameters
newValue The new value for ForceParallelDual.

setGenconsAbsTransformation()

void xpress::XPRSProblem::Controls::setGenconsAbsTransformation ( int newValue )
inline

Set control GenconsAbsTransformation.

This control specifies the reformulation method for absolute value general constraints at the beginning of the search.

Parameters
newValue The new value for GenconsAbsTransformation.

setGenconsDualReductions()

void xpress::XPRSProblem::Controls::setGenconsDualReductions ( int newValue )
inline

Set control GenconsDualReductions.

This parameter specifies whether dual reductions should be applied to reduce the number of columns and rows added when transforming general constraints to MIP structs.

Parameters
newValue The new value for GenconsDualReductions.

setGlobalBoundingBox()

void xpress::XPRSProblem::Controls::setGlobalBoundingBox ( double newValue )
inline

Set control GlobalBoundingBox.

If a nonlinear problem cannot be solved due to appearing unbounded, it can automatically be regularized by the application of a bounding box on the variables. If this control is set to a negative value, in a second solving attempt all original variables will be bounded by the absolute value of this control. If set to a positive value, there will be a third solving attempt afterwards, if necessary, in which also all auxiliary variables are bounded by this value.

Parameters
newValue The new value for GlobalBoundingBox.

setGlobalLSHeurstrategy()

void xpress::XPRSProblem::Controls::setGlobalLSHeurstrategy ( int newValue )
inline

Set control GlobalLSHeurstrategy.

   When integer-feasible (for MINLP, any solution for NLP) but nonlinear-infeasible solutions
   are encountered within a global solve, the integer variables can be fixed and a local solver (as defined
   by the <code>LOCALSOLVER</code> control) can be called on the remaining continuous problem. This
   control defines the frequency and effort of such local solves.
Parameters
newValue The new value for GlobalLSHeurstrategy.

setGlobalNlpCuts()

void xpress::XPRSProblem::Controls::setGlobalNlpCuts ( int newValue )
inline

Set control GlobalNlpCuts.

Limit on the number of rounds of outer approximation and convexification cuts generated for the root node, when solving an (MI)NLP to global optimality.

Parameters
newValue The new value for GlobalNlpCuts.

setGlobalNumInitNlpCuts()

void xpress::XPRSProblem::Controls::setGlobalNumInitNlpCuts ( int newValue )
inline

Set control GlobalNumInitNlpCuts.

Specifies the maximum number of tangent cuts when setting up the initial relaxation during a global solve. By default, the algorithm chooses the number of cuts automatically. Adding more cuts tightens the problem, resulting in a smaller branch-and-bound tree, at the cost of slowing down each LP solve.

Parameters
newValue The new value for GlobalNumInitNlpCuts.

setGlobalSpatialBranchCuttingEffort()

void xpress::XPRSProblem::Controls::setGlobalSpatialBranchCuttingEffort ( double newValue )
inline

Set control GlobalSpatialBranchCuttingEffort.

Limits the effort that is spent on creating cuts during spatial branching.

Parameters
newValue The new value for GlobalSpatialBranchCuttingEffort.

setGlobalSpatialBranchIfPreferOrig()

void xpress::XPRSProblem::Controls::setGlobalSpatialBranchIfPreferOrig ( int newValue )
inline

Set control GlobalSpatialBranchIfPreferOrig.

Whether spatial branchings on original variables should be preferred over branching on auxiliary variables that were introduced by the reformulation of the global solver.

Parameters
newValue The new value for GlobalSpatialBranchIfPreferOrig.

setGlobalSpatialBranchPropagationEffort()

void xpress::XPRSProblem::Controls::setGlobalSpatialBranchPropagationEffort ( double newValue )
inline

Set control GlobalSpatialBranchPropagationEffort.

Limits the effort that is spent on propagation during spatial branching.

Parameters
newValue The new value for GlobalSpatialBranchPropagationEffort.

setGlobalTreeNlpCuts()

void xpress::XPRSProblem::Controls::setGlobalTreeNlpCuts ( int newValue )
inline

Set control GlobalTreeNlpCuts.

Limit on the number of rounds of outer approximation and convexification cuts generated for each node in the tree, when solving an (MI)NLP to global optimality.

Parameters
newValue The new value for GlobalTreeNlpCuts.

setGomCuts()

void xpress::XPRSProblem::Controls::setGomCuts ( int newValue )
inline

Set control GomCuts.

Branch and Bound: The number of rounds of Gomory or lift-and-project cuts at the top node.

Parameters
newValue The new value for GomCuts.

setHeurBeforeLp()

void xpress::XPRSProblem::Controls::setHeurBeforeLp ( int newValue )
inline

Set control HeurBeforeLp.

Branch and Bound: Determines whether primal heuristics should be run before the initial LP relaxation has been solved.

Parameters
newValue The new value for HeurBeforeLp.

setHeurDepth()

void xpress::XPRSProblem::Controls::setHeurDepth ( int newValue )
inline

Set control HeurDepth.

Branch and Bound: Sets the maximum depth in the tree search at which heuristics will be used to find MIP solutions. It may be worth stopping the heuristic search for solutions after a certain depth in the tree search. A value of 0 signifies that heuristics will not be used. This control no longer has any effect and will be removed from future releases.

Parameters
newValue The new value for HeurDepth.

setHeurDiveIterLimit()

void xpress::XPRSProblem::Controls::setHeurDiveIterLimit ( double newValue )
inline

Set control HeurDiveIterLimit.

Branch and Bound: Simplex iteration limit for reoptimizing during the diving heuristic.

Parameters
newValue The new value for HeurDiveIterLimit.

setHeurDiveRandomize()

void xpress::XPRSProblem::Controls::setHeurDiveRandomize ( double newValue )
inline

Set control HeurDiveRandomize.

The level of randomization to apply in the diving heuristic. The diving heuristic uses priority weights on rows and columns to determine the order in which to e.g. round fractional columns, or the direction in which to round them. This control determines by how large a random factor these weights should be changed.

Parameters
newValue The new value for HeurDiveRandomize.

setHeurDiveSoftRounding()

void xpress::XPRSProblem::Controls::setHeurDiveSoftRounding ( int newValue )
inline

Set control HeurDiveSoftRounding.

Branch and Bound: Enables a more cautious strategy for the diving heuristic, where it tries to push binaries and integer variables to their bounds using the objective, instead of directly fixing them. This can be useful when the default diving heuristics fail to find any feasible solutions.

Parameters
newValue The new value for HeurDiveSoftRounding.

setHeurDiveSpeedUp()

void xpress::XPRSProblem::Controls::setHeurDiveSpeedUp ( int newValue )
inline

Set control HeurDiveSpeedUp.

Branch and Bound: Changes the emphasis of the diving heuristic from solution quality to diving speed.

Parameters
newValue The new value for HeurDiveSpeedUp.

setHeurDiveStrategy()

void xpress::XPRSProblem::Controls::setHeurDiveStrategy ( int newValue )
inline

Set control HeurDiveStrategy.

Branch and Bound: Chooses the strategy for the diving heuristic.

Parameters
newValue The new value for HeurDiveStrategy.

setHeurEmphasis()

void xpress::XPRSProblem::Controls::setHeurEmphasis ( int newValue )
inline

Set control HeurEmphasis.

Branch and Bound: This control specifies an emphasis for the search w.r.t. primal heuristics and other procedures that affect the speed of convergence of the primal-dual gap. For problems where the goal is to achieve a small gap but not neccessarily solving them to optimality, it is recommended to set HEUREMPHASIS to 1. This setting triggers many additional heuristic calls, aiming for reducing the gap at the beginning of the search, typically at the expense of an increased time for proving optimality.

Parameters
newValue The new value for HeurEmphasis.

setHeurForceSpecialObj()

void xpress::XPRSProblem::Controls::setHeurForceSpecialObj ( int newValue )
inline

Set control HeurForceSpecialObj.

Branch and Bound: This specifies whether local search heuristics without objective or with an auxiliary objective should always be used, despite the automatic selection of the Optimiezr. Deactivated by default.

Parameters
newValue The new value for HeurForceSpecialObj.

setHeurFreq()

void xpress::XPRSProblem::Controls::setHeurFreq ( int newValue )
inline

Set control HeurFreq.

Branch and Bound: This specifies the frequency at which heuristics are used in the tree search. Heuristics will only be used at a node if the depth of the node is a multiple of HEURFREQ.

Parameters
newValue The new value for HeurFreq.

setHeurMaxSol()

void xpress::XPRSProblem::Controls::setHeurMaxSol ( int newValue )
inline

Set control HeurMaxSol.

Branch and Bound: This specifies the maximum number of heuristic solutions that will be found in the tree search. This control no longer has any effect and will be removed from future releases.

Parameters
newValue The new value for HeurMaxSol.

setHeurNodes()

void xpress::XPRSProblem::Controls::setHeurNodes ( int newValue )
inline

Set control HeurNodes.

Branch and Bound: This specifies the maximum number of nodes at which heuristics are used in the tree search. This control no longer has any effect and will be removed from future releases.

Parameters
newValue The new value for HeurNodes.

setHeursearchBackgroundSelect()

void xpress::XPRSProblem::Controls::setHeursearchBackgroundSelect ( XPRSint64 newValue )
inline

Set control HeursearchBackgroundSelect.

Select which large neighborhood searches to run in the background (for example in parallel to the root cut loop).

Parameters
newValue The new value for HeursearchBackgroundSelect.

setHeurSearchCopyControls()

void xpress::XPRSProblem::Controls::setHeurSearchCopyControls ( int newValue )
inline

Set control HeurSearchCopyControls.

Select how user-set controls should affect local search heuristics.

Parameters
newValue The new value for HeurSearchCopyControls.

setHeurSearchEffort()

void xpress::XPRSProblem::Controls::setHeurSearchEffort ( double newValue )
inline

Set control HeurSearchEffort.

Adjusts the overall level of the local search heuristics.

Parameters
newValue The new value for HeurSearchEffort.

setHeurSearchFreq()

void xpress::XPRSProblem::Controls::setHeurSearchFreq ( int newValue )
inline

Set control HeurSearchFreq.

Branch and Bound: This specifies how often the local search heuristic should be run in the tree.

Parameters
newValue The new value for HeurSearchFreq.

setHeurSearchRootCutFreq()

void xpress::XPRSProblem::Controls::setHeurSearchRootCutFreq ( int newValue )
inline

Set control HeurSearchRootCutFreq.

How frequently to run the local search heuristic during root cutting. This is given as how many cut rounds to perform between runs of the heuristic. Set to zero to avoid applying the heuristic during root cutting.

Branch and Bound: This specifies how often the local search heuristic should be run in the tree.

Parameters
newValue The new value for HeurSearchRootCutFreq.

setHeurSearchRootSelect()

void xpress::XPRSProblem::Controls::setHeurSearchRootSelect ( int newValue )
inline

Set control HeurSearchRootSelect.

A bit vector control for selecting which local search heuristics to apply on the root node of a MIP solve. Use HEURSEARCHTREESELECT to control local search heuristics during the tree search.

Parameters
newValue The new value for HeurSearchRootSelect.

setHeurSearchTargetSize()

void xpress::XPRSProblem::Controls::setHeurSearchTargetSize ( double newValue )
inline

Set control HeurSearchTargetSize.

Parameters
newValue The new value for HeurSearchTargetSize.

setHeurSearchTreeSelect()

void xpress::XPRSProblem::Controls::setHeurSearchTreeSelect ( int newValue )
inline

Set control HeurSearchTreeSelect.

A bit vector control for selecting which local search heuristics to apply during the tree search of a MIP solve. Use HEURSEARCHROOTSELECT to control local search heuristics on the root node.

Parameters
newValue The new value for HeurSearchTreeSelect.

setHeurSelect()

void xpress::XPRSProblem::Controls::setHeurSelect ( int newValue )
inline

Set control HeurSelect.

Parameters
newValue The new value for HeurSelect.

setHeurShiftProp()

void xpress::XPRSProblem::Controls::setHeurShiftProp ( int newValue )
inline

Set control HeurShiftProp.

Determines whether the Shift-and-propagate primal heuristic should be executed. If enabled, Shift-and-propagate is an LP-free primal heuristic that is executed immediately after presolve.

Parameters
newValue The new value for HeurShiftProp.

setHeurThreads()

void xpress::XPRSProblem::Controls::setHeurThreads ( int newValue )
inline

Set control HeurThreads.

Branch and Bound: The number of threads to dedicate to running heuristics during the root solve.

Parameters
newValue The new value for HeurThreads.

setHistoryCosts()

void xpress::XPRSProblem::Controls::setHistoryCosts ( int newValue )
inline

Set control HistoryCosts.

Branch and Bound: How to update the pseudo cost for a MIP entity when a strong branch or a regular branch is applied.

Parameters
newValue The new value for HistoryCosts.

setIfCheckConvexity()

void xpress::XPRSProblem::Controls::setIfCheckConvexity ( int newValue )
inline

Set control IfCheckConvexity.

Determines if the convexity of the problem is checked before optimization. Applies to quadratic, mixed integer quadratic and quadratically constrained problems. Checking convexity takes some time, thus for problems that are known to be convex it might be reasonable to switch the checking off.

Parameters
newValue The new value for IfCheckConvexity.

setIgnoreContainerCpuLimit()

void xpress::XPRSProblem::Controls::setIgnoreContainerCpuLimit ( int newValue )
inline

Set control IgnoreContainerCpuLimit.

Parameters
newValue The new value for IgnoreContainerCpuLimit.

setIgnoreContainerMemoryLimit()

void xpress::XPRSProblem::Controls::setIgnoreContainerMemoryLimit ( int newValue )
inline

Set control IgnoreContainerMemoryLimit.

Parameters
newValue The new value for IgnoreContainerMemoryLimit.

setIISLog()

void xpress::XPRSProblem::Controls::setIISLog ( int newValue )
inline

Set control IISLog.

   Selects how much information should be printed during the IIS procedure. Please refer to Appendix  for a more detailed description of the IIS logging format.
Parameters
newValue The new value for IISLog.

setIISOps()

void xpress::XPRSProblem::Controls::setIISOps ( xpress::IISOps newValue )
inline

Set control IISOps.

        Selects which part of the restrictions (bounds, constraints, entities) should always be kept in an IIS. This is useful if certain types of restrictions cannot be violated, thus they are known not to be the cause of infeasibility.
        The IIS obtained this way is irreducible only for the non-protected restrictions.

        This control has an effect only on the deletion filter of the IIS procedure.
Parameters
newValue The new value for IISOps.

setIndLinBigM()

void xpress::XPRSProblem::Controls::setIndLinBigM ( double newValue )
inline

Set control IndLinBigM.

During presolve, indicator constraints will be linearized using a BigM coefficient whenever that BigM coefficient is small enough. This control defines the largest BigM for which such a linearized version will be added to the problem in addition to the original constraint. If the BigM is even smaller than INDPRELINBIGM, then the original indicator constraint will additionally be dropped from the problem.

Parameters
newValue The new value for IndLinBigM.

setIndPreLinBigM()

void xpress::XPRSProblem::Controls::setIndPreLinBigM ( double newValue )
inline

Set control IndPreLinBigM.

During presolve, indicator constraints will be linearized using a BigM coefficient whenever that BigM coefficient is small enough. This control defines the largest BigM for which the original constraint will be replaced by the linearized version. If the BigM is larger than INDPRELINBIGM but smaller than INDLINBIGM, the linearized row will be added but the original indicator constraint is kept as a numerically stable way to check feasibility.

Parameters
newValue The new value for IndPreLinBigM.

setInputtol()

void xpress::XPRSProblem::Controls::setInputtol ( double newValue )
inline

Set control Inputtol.

The tolerance on input values elements. If any value is less than or equal to INPUTTOL in absolute value, it is treated as zero. For the internal zero tolerance see MATRIXTOL.

Parameters
newValue The new value for Inputtol.

setInvertFreq()

void xpress::XPRSProblem::Controls::setInvertFreq ( int newValue )
inline

Set control InvertFreq.

Simplex: The frequency with which the basis will be inverted. The basis is maintained in a factorized form and on most simplex iterations it is incrementally updated to reflect the step just taken. This is considerably faster than computing the full inverted matrix at each iteration, although after a number of iterations the basis becomes less well-conditioned and it becomes necessary to compute the full inverted matrix. The value of INVERTFREQ specifies the maximum number of iterations between full inversions.

Parameters
newValue The new value for InvertFreq.

setInvertMin()

void xpress::XPRSProblem::Controls::setInvertMin ( int newValue )
inline

Set control InvertMin.

Simplex: The minimum number of iterations between full inversions of the basis matrix. See the description of INVERTFREQ for details.

Parameters
newValue The new value for InvertMin.

setIOTimeout()

void xpress::XPRSProblem::Controls::setIOTimeout ( int newValue )
inline

Set control IOTimeout.

The maximum number of seconds to wait for an I/O operation before it is cancelled.

Parameters
newValue The new value for IOTimeout.

setKeepBasis()

void xpress::XPRSProblem::Controls::setKeepBasis ( int newValue )
inline

Set control KeepBasis.

Simplex: This determines whether the basis should be kept when reoptimizing a problem. The choice is between using a crash basis created at the beginning of simplex or using a basis from a previous solve (if such exists). By default, this control gets (re)set automatically in various situations. By default, it will be automatically set to 1 after a solve that produced a valid basis. This will automatically warmstart a subsequent solve. Explicitly loading a starting basis will also set this control to 1. If the control is explicitly set to 0, any existing basis will be ignored for a new solve, and the Optimizer will start from an ad-hoc crash basis.

Parameters
newValue The new value for KeepBasis.

setKeepNRows()

void xpress::XPRSProblem::Controls::setKeepNRows ( int newValue )
inline

Set control KeepNRows.

How nonbinding rows should be handled by the MPS reader.

Parameters
newValue The new value for KeepNRows.

setKnitroParamAlgorithm()

void xpress::XPRSProblem::Controls::setKnitroParamAlgorithm ( int newValue )
inline

Set control KnitroParamAlgorithm.

Indicates which algorithm to use to solve the problem

Parameters
newValue The new value for KnitroParamAlgorithm.

setKnitroParamBarDirectInterval()

void xpress::XPRSProblem::Controls::setKnitroParamBarDirectInterval ( int newValue )
inline

Set control KnitroParamBarDirectInterval.

Controls the maximum number of consecutive conjugate gradient (CG) steps before Knitro will try to enforce that a step is taken using direct linear algebra.

Parameters
newValue The new value for KnitroParamBarDirectInterval.

setKnitroParamBarFeasible()

void xpress::XPRSProblem::Controls::setKnitroParamBarFeasible ( int newValue )
inline

Set control KnitroParamBarFeasible.

Specifies whether special emphasis is placed on getting and staying feasible in the interior-point algorithms.

Parameters
newValue The new value for KnitroParamBarFeasible.

setKnitroParamBarFeasModeTol()

void xpress::XPRSProblem::Controls::setKnitroParamBarFeasModeTol ( double newValue )
inline

Set control KnitroParamBarFeasModeTol.

Specifies the tolerance in equation that determines whether Knitro will force subsequent iterates to remain feasible.

Parameters
newValue The new value for KnitroParamBarFeasModeTol.

setKnitroParamBarInitMu()

void xpress::XPRSProblem::Controls::setKnitroParamBarInitMu ( double newValue )
inline

Set control KnitroParamBarInitMu.

Specifies the initial value for the barrier parameter : mu used with the barrier algorithms. This option has no effect on the Active Set algorithm.

Parameters
newValue The new value for KnitroParamBarInitMu.

setKnitroParamBarInitPt()

void xpress::XPRSProblem::Controls::setKnitroParamBarInitPt ( int newValue )
inline

Set control KnitroParamBarInitPt.

Indicates whether an initial point strategy is used with barrier algorithms.

Parameters
newValue The new value for KnitroParamBarInitPt.

setKnitroParamBarMaxBacktrack()

void xpress::XPRSProblem::Controls::setKnitroParamBarMaxBacktrack ( int newValue )
inline

Set control KnitroParamBarMaxBacktrack.

Indicates the maximum allowable number of backtracks during the linesearch of the Interior/Direct algorithm before reverting to a CG step.

Parameters
newValue The new value for KnitroParamBarMaxBacktrack.

setKnitroParamBarMaxRefactor()

void xpress::XPRSProblem::Controls::setKnitroParamBarMaxRefactor ( int newValue )
inline

Set control KnitroParamBarMaxRefactor.

Indicates the maximum number of refactorizations of the KKT system per iteration of the Interior/Direct algorithm before reverting to a CG step.

Parameters
newValue The new value for KnitroParamBarMaxRefactor.

setKnitroParamBarMuRule()

void xpress::XPRSProblem::Controls::setKnitroParamBarMuRule ( int newValue )
inline

Set control KnitroParamBarMuRule.

Indicates which strategy to use for modifying the barrier parameter mu in the barrier algorithms.

Parameters
newValue The new value for KnitroParamBarMuRule.

setKnitroParamBarPenCons()

void xpress::XPRSProblem::Controls::setKnitroParamBarPenCons ( int newValue )
inline

Set control KnitroParamBarPenCons.

Indicates whether a penalty approach is applied to the constraints.

Parameters
newValue The new value for KnitroParamBarPenCons.

setKnitroParamBarPenRule()

void xpress::XPRSProblem::Controls::setKnitroParamBarPenRule ( int newValue )
inline

Set control KnitroParamBarPenRule.

Indicates which penalty parameter strategy to use for determining whether or not to accept a trial iterate.

Parameters
newValue The new value for KnitroParamBarPenRule.

setKnitroParamBarRelaxCons()

void xpress::XPRSProblem::Controls::setKnitroParamBarRelaxCons ( int newValue )
inline

Set control KnitroParamBarRelaxCons.

Parameters
newValue The new value for KnitroParamBarRelaxCons.

setKnitroParamBarSwitchRule()

void xpress::XPRSProblem::Controls::setKnitroParamBarSwitchRule ( int newValue )
inline

Set control KnitroParamBarSwitchRule.

Indicates whether or not the barrier algorithms will allow switching from an optimality phase to a pure feasibility phase.

Parameters
newValue The new value for KnitroParamBarSwitchRule.

setKnitroParamBLASOption()

void xpress::XPRSProblem::Controls::setKnitroParamBLASOption ( int newValue )
inline

Set control KnitroParamBLASOption.

Parameters
newValue The new value for KnitroParamBLASOption.

setKnitroParamDebug()

void xpress::XPRSProblem::Controls::setKnitroParamDebug ( int newValue )
inline

Set control KnitroParamDebug.

Parameters
newValue The new value for KnitroParamDebug.

setKnitroParamDelta()

void xpress::XPRSProblem::Controls::setKnitroParamDelta ( double newValue )
inline

Set control KnitroParamDelta.

Specifies the initial trust region radius scaling factor used to determine the initial trust region size.

Parameters
newValue The new value for KnitroParamDelta.

setKnitroParamFeastol()

void xpress::XPRSProblem::Controls::setKnitroParamFeastol ( double newValue )
inline

Set control KnitroParamFeastol.

Specifies the final relative stopping tolerance for the feasibility error.

Parameters
newValue The new value for KnitroParamFeastol.

setKnitroParamFeasTolAbs()

void xpress::XPRSProblem::Controls::setKnitroParamFeasTolAbs ( double newValue )
inline

Set control KnitroParamFeasTolAbs.

Specifies the final absolute stopping tolerance for the feasibility error.

Parameters
newValue The new value for KnitroParamFeasTolAbs.

setKnitroParamGradOpt()

void xpress::XPRSProblem::Controls::setKnitroParamGradOpt ( int newValue )
inline

Set control KnitroParamGradOpt.

Specifies how to compute the gradients of the objective and constraint functions.

Parameters
newValue The new value for KnitroParamGradOpt.

setKnitroParamHessOpt()

void xpress::XPRSProblem::Controls::setKnitroParamHessOpt ( int newValue )
inline

Set control KnitroParamHessOpt.

Specifies how to compute the (approximate) Hessian of the Lagrangian.

Parameters
newValue The new value for KnitroParamHessOpt.

setKnitroParamHonorBbnds()

void xpress::XPRSProblem::Controls::setKnitroParamHonorBbnds ( int newValue )
inline

Set control KnitroParamHonorBbnds.

Indicates whether or not to enforce satisfaction of simple variable bounds throughout the optimization.

Parameters
newValue The new value for KnitroParamHonorBbnds.

setKnitroParamInfeasTol()

void xpress::XPRSProblem::Controls::setKnitroParamInfeasTol ( double newValue )
inline

Set control KnitroParamInfeasTol.

Specifies the (relative) tolerance used for declaring infeasibility of a model.

Parameters
newValue The new value for KnitroParamInfeasTol.

setKnitroParamLinSolver()

void xpress::XPRSProblem::Controls::setKnitroParamLinSolver ( int newValue )
inline

Set control KnitroParamLinSolver.

Parameters
newValue The new value for KnitroParamLinSolver.

setKnitroParamLMSize()

void xpress::XPRSProblem::Controls::setKnitroParamLMSize ( int newValue )
inline

Set control KnitroParamLMSize.

Specifies the number of limited memory pairs stored when approximating the Hessian using the limited-memory quasi-Newton BFGS option.

Parameters
newValue The new value for KnitroParamLMSize.

setKnitroParamMATerminate()

void xpress::XPRSProblem::Controls::setKnitroParamMATerminate ( int newValue )
inline

Set control KnitroParamMATerminate.

Parameters
newValue The new value for KnitroParamMATerminate.

setKnitroParamMaxCGIt()

void xpress::XPRSProblem::Controls::setKnitroParamMaxCGIt ( int newValue )
inline

Set control KnitroParamMaxCGIt.

Specifies the number of limited memory pairs stored when approximating the Hessian using the limited-memory quasi-Newton BFGS option.

Parameters
newValue The new value for KnitroParamMaxCGIt.

setKnitroParamMaxCrossIt()

void xpress::XPRSProblem::Controls::setKnitroParamMaxCrossIt ( int newValue )
inline

Set control KnitroParamMaxCrossIt.

Specifies the maximum number of crossover iterations before termination.

Parameters
newValue The new value for KnitroParamMaxCrossIt.

setKnitroParamMaxIt()

void xpress::XPRSProblem::Controls::setKnitroParamMaxIt ( int newValue )
inline

Set control KnitroParamMaxIt.

Specifies the maximum number of iterations before termination.

Parameters
newValue The new value for KnitroParamMaxIt.

setKnitroParamMipBranchRule()

void xpress::XPRSProblem::Controls::setKnitroParamMipBranchRule ( int newValue )
inline

Set control KnitroParamMipBranchRule.

Specifies which branching rule to use for MIP branch and bound procedure.

Parameters
newValue The new value for KnitroParamMipBranchRule.

setKnitroParamMipDebug()

void xpress::XPRSProblem::Controls::setKnitroParamMipDebug ( int newValue )
inline

Set control KnitroParamMipDebug.

Parameters
newValue The new value for KnitroParamMipDebug.

setKnitroParamMipGUBBranch()

void xpress::XPRSProblem::Controls::setKnitroParamMipGUBBranch ( int newValue )
inline

Set control KnitroParamMipGUBBranch.

Specifies whether or not to branch on generalized upper bounds (GUBs).

Parameters
newValue The new value for KnitroParamMipGUBBranch.

setKnitroParamMipHeuristic()

void xpress::XPRSProblem::Controls::setKnitroParamMipHeuristic ( int newValue )
inline

Set control KnitroParamMipHeuristic.

Specifies which MIP heuristic search approach to apply to try to find an initial integer feasible point.

Parameters
newValue The new value for KnitroParamMipHeuristic.

setKnitroParamMipHeurMaxIt()

void xpress::XPRSProblem::Controls::setKnitroParamMipHeurMaxIt ( int newValue )
inline

Set control KnitroParamMipHeurMaxIt.

Parameters
newValue The new value for KnitroParamMipHeurMaxIt.

setKnitroParamMipImplicatns()

void xpress::XPRSProblem::Controls::setKnitroParamMipImplicatns ( int newValue )
inline

Set control KnitroParamMipImplicatns.

Specifies whether or not to add constraints to the MIP derived from logical implications.

Parameters
newValue The new value for KnitroParamMipImplicatns.

setKnitroParamMipIntGapAbs()

void xpress::XPRSProblem::Controls::setKnitroParamMipIntGapAbs ( double newValue )
inline

Set control KnitroParamMipIntGapAbs.

The absolute integrality gap stop tolerance for MIP.

Parameters
newValue The new value for KnitroParamMipIntGapAbs.

setKnitroParamMipIntGapRel()

void xpress::XPRSProblem::Controls::setKnitroParamMipIntGapRel ( double newValue )
inline

Set control KnitroParamMipIntGapRel.

The relative integrality gap stop tolerance for MIP.

Parameters
newValue The new value for KnitroParamMipIntGapRel.

setKnitroParamMipKnapsack()

void xpress::XPRSProblem::Controls::setKnitroParamMipKnapsack ( int newValue )
inline

Set control KnitroParamMipKnapsack.

Specifies rules for adding MIP knapsack cuts.

Parameters
newValue The new value for KnitroParamMipKnapsack.

setKnitroParamMipLpAlg()

void xpress::XPRSProblem::Controls::setKnitroParamMipLpAlg ( int newValue )
inline

Set control KnitroParamMipLpAlg.

Specifies which algorithm to use for any linear programming (LP) subproblem solves that may occur in the MIP branch and bound procedure.

Parameters
newValue The new value for KnitroParamMipLpAlg.

setKnitroParamMipMaxNodes()

void xpress::XPRSProblem::Controls::setKnitroParamMipMaxNodes ( int newValue )
inline

Set control KnitroParamMipMaxNodes.

Specifies the maximum number of nodes explored.

Parameters
newValue The new value for KnitroParamMipMaxNodes.

setKnitroParamMipMethod()

void xpress::XPRSProblem::Controls::setKnitroParamMipMethod ( int newValue )
inline

Set control KnitroParamMipMethod.

Specifies which MIP method to use.

Parameters
newValue The new value for KnitroParamMipMethod.

setKnitroParamMipOutInterval()

void xpress::XPRSProblem::Controls::setKnitroParamMipOutInterval ( int newValue )
inline

Set control KnitroParamMipOutInterval.

Specifies node printing interval for XKTR_PARAM_MIP_OUTLEVEL when XKTR_PARAM_MIP_OUTLEVEL > 0.

Parameters
newValue The new value for KnitroParamMipOutInterval.

setKnitroParamMipOutLevel()

void xpress::XPRSProblem::Controls::setKnitroParamMipOutLevel ( int newValue )
inline

Set control KnitroParamMipOutLevel.

Specifies how much MIP information to print.

Parameters
newValue The new value for KnitroParamMipOutLevel.

setKnitroParamMipPseudoint()

void xpress::XPRSProblem::Controls::setKnitroParamMipPseudoint ( int newValue )
inline

Set control KnitroParamMipPseudoint.

Specifies the method used to initialize pseudo-costs corresponding to variables that have not yet been branched on in the MIP method.

Parameters
newValue The new value for KnitroParamMipPseudoint.

setKnitroParamMipRootAlg()

void xpress::XPRSProblem::Controls::setKnitroParamMipRootAlg ( int newValue )
inline

Set control KnitroParamMipRootAlg.

Specifies which algorithm to use for the root node solve in MIP (same options as XKTR_PARAM_ALGORITHM user option).

Parameters
newValue The new value for KnitroParamMipRootAlg.

setKnitroParamMipRounding()

void xpress::XPRSProblem::Controls::setKnitroParamMipRounding ( int newValue )
inline

Set control KnitroParamMipRounding.

Specifies the MIP rounding rule to apply.

Parameters
newValue The new value for KnitroParamMipRounding.

setKnitroParamMipSelectRule()

void xpress::XPRSProblem::Controls::setKnitroParamMipSelectRule ( int newValue )
inline

Set control KnitroParamMipSelectRule.

Specifies the MIP select rule for choosing the next node in the branch and bound tree.

Parameters
newValue The new value for KnitroParamMipSelectRule.

setKnitroParamMipStringMaxIt()

void xpress::XPRSProblem::Controls::setKnitroParamMipStringMaxIt ( int newValue )
inline

Set control KnitroParamMipStringMaxIt.

Specifies the maximum number of iterations to allow for MIP strong branching solves.

Parameters
newValue The new value for KnitroParamMipStringMaxIt.

setKnitroParamMipStrongCandLim()

void xpress::XPRSProblem::Controls::setKnitroParamMipStrongCandLim ( int newValue )
inline

Set control KnitroParamMipStrongCandLim.

Specifies the maximum number of candidates to explore for MIP strong branching.

Parameters
newValue The new value for KnitroParamMipStrongCandLim.

setKnitroParamMipStrongLevel()

void xpress::XPRSProblem::Controls::setKnitroParamMipStrongLevel ( int newValue )
inline

Set control KnitroParamMipStrongLevel.

Specifies the maximum number of tree levels on which to perform MIP strong branching.

Parameters
newValue The new value for KnitroParamMipStrongLevel.

setKnitroParamMsMaxBndRange()

void xpress::XPRSProblem::Controls::setKnitroParamMsMaxBndRange ( double newValue )
inline

Set control KnitroParamMsMaxBndRange.

Parameters
newValue The new value for KnitroParamMsMaxBndRange.

setKnitroParamMSMaxSolves()

void xpress::XPRSProblem::Controls::setKnitroParamMSMaxSolves ( int newValue )
inline

Set control KnitroParamMSMaxSolves.

Parameters
newValue The new value for KnitroParamMSMaxSolves.

setKnitroParamMSNumToSave()

void xpress::XPRSProblem::Controls::setKnitroParamMSNumToSave ( int newValue )
inline

Set control KnitroParamMSNumToSave.

Parameters
newValue The new value for KnitroParamMSNumToSave.

setKnitroParamMSSaveTol()

void xpress::XPRSProblem::Controls::setKnitroParamMSSaveTol ( double newValue )
inline

Set control KnitroParamMSSaveTol.

Parameters
newValue The new value for KnitroParamMSSaveTol.

setKnitroParamMSSeed()

void xpress::XPRSProblem::Controls::setKnitroParamMSSeed ( int newValue )
inline

Set control KnitroParamMSSeed.

Parameters
newValue The new value for KnitroParamMSSeed.

setKnitroParamMSStartPtRange()

void xpress::XPRSProblem::Controls::setKnitroParamMSStartPtRange ( double newValue )
inline

Set control KnitroParamMSStartPtRange.

Parameters
newValue The new value for KnitroParamMSStartPtRange.

setKnitroParamMSTerminate()

void xpress::XPRSProblem::Controls::setKnitroParamMSTerminate ( int newValue )
inline

Set control KnitroParamMSTerminate.

Parameters
newValue The new value for KnitroParamMSTerminate.

setKnitroParamMultiStart()

void xpress::XPRSProblem::Controls::setKnitroParamMultiStart ( int newValue )
inline

Set control KnitroParamMultiStart.

Parameters
newValue The new value for KnitroParamMultiStart.

setKnitroParamNewPoint()

void xpress::XPRSProblem::Controls::setKnitroParamNewPoint ( int newValue )
inline

Set control KnitroParamNewPoint.

Parameters
newValue The new value for KnitroParamNewPoint.

setKnitroParamObjRange()

void xpress::XPRSProblem::Controls::setKnitroParamObjRange ( double newValue )
inline

Set control KnitroParamObjRange.

Specifies the extreme limits of the objective function for purposes of determining unboundedness.

Parameters
newValue The new value for KnitroParamObjRange.

setKnitroParamOptTol()

void xpress::XPRSProblem::Controls::setKnitroParamOptTol ( double newValue )
inline

Set control KnitroParamOptTol.

Specifies the final relative stopping tolerance for the KKT (optimality) error.

Parameters
newValue The new value for KnitroParamOptTol.

setKnitroParamOptTolAbs()

void xpress::XPRSProblem::Controls::setKnitroParamOptTolAbs ( double newValue )
inline

Set control KnitroParamOptTolAbs.

Specifies the final absolute stopping tolerance for the KKT (optimality) error.

Parameters
newValue The new value for KnitroParamOptTolAbs.

setKnitroParamOutLev()

void xpress::XPRSProblem::Controls::setKnitroParamOutLev ( int newValue )
inline

Set control KnitroParamOutLev.

Controls the level of output produced by Knitro.

Parameters
newValue The new value for KnitroParamOutLev.

setKnitroParamParNumThreads()

void xpress::XPRSProblem::Controls::setKnitroParamParNumThreads ( int newValue )
inline

Set control KnitroParamParNumThreads.

Parameters
newValue The new value for KnitroParamParNumThreads.

setKnitroParamPivot()

void xpress::XPRSProblem::Controls::setKnitroParamPivot ( double newValue )
inline

Set control KnitroParamPivot.

Parameters
newValue The new value for KnitroParamPivot.

setKnitroParamPresolve()

void xpress::XPRSProblem::Controls::setKnitroParamPresolve ( int newValue )
inline

Set control KnitroParamPresolve.

Determine whether or not to use the Knitro presolver to try to simplify the model by removing variables or constraints. Specifies conditions for terminating the MIP algorithm.

Parameters
newValue The new value for KnitroParamPresolve.

setKnitroParamPresolveTol()

void xpress::XPRSProblem::Controls::setKnitroParamPresolveTol ( double newValue )
inline

Set control KnitroParamPresolveTol.

Determines the tolerance used by the Knitro presolver to remove variables and constraints from the model.

Parameters
newValue The new value for KnitroParamPresolveTol.

setKnitroParamScale()

void xpress::XPRSProblem::Controls::setKnitroParamScale ( int newValue )
inline

Set control KnitroParamScale.

Performs a scaling of the objective and constraint functions based on their values at the initial point.

Parameters
newValue The new value for KnitroParamScale.

setKnitroParamSOC()

void xpress::XPRSProblem::Controls::setKnitroParamSOC ( int newValue )
inline

Set control KnitroParamSOC.

Specifies whether or not to try second order corrections (SOC).

Parameters
newValue The new value for KnitroParamSOC.

setKnitroParamXTol()

void xpress::XPRSProblem::Controls::setKnitroParamXTol ( double newValue )
inline

Set control KnitroParamXTol.

The optimization process will terminate if the relative change in all components of the solution point estimate is less than xtol.

Parameters
newValue The new value for KnitroParamXTol.

setL1Cache()

void xpress::XPRSProblem::Controls::setL1Cache ( int newValue )
inline

Set control L1Cache.

Newton barrier: L1 cache size in kB (kilo bytes) of the CPU. On Intel (or compatible) platforms a value of -1 may be used to determine the cache size automatically.

Parameters
newValue The new value for L1Cache.

setLNPBest()

void xpress::XPRSProblem::Controls::setLNPBest ( int newValue )
inline

Set control LNPBest.

Number of infeasible MIP entities to create lift-and-project cuts for during each round of Gomory cuts at the top node (see GOMCUTS).

Parameters
newValue The new value for LNPBest.

setLNPIterLimit()

void xpress::XPRSProblem::Controls::setLNPIterLimit ( int newValue )
inline

Set control LNPIterLimit.

Number of iterations to perform in improving each lift-and-project cut.

Parameters
newValue The new value for LNPIterLimit.

setLocalBacktrack()

void xpress::XPRSProblem::Controls::setLocalBacktrack ( int newValue )
inline

Set control LocalBacktrack.

Parameters
newValue The new value for LocalBacktrack.

setLocalChoice()

void xpress::XPRSProblem::Controls::setLocalChoice ( int newValue )
inline

Set control LocalChoice.

Controls when to perform a local backtrack between the two child nodes during a dive in the branch and bound tree.

Parameters
newValue The new value for LocalChoice.

setLocalSolver()

void xpress::XPRSProblem::Controls::setLocalSolver ( int newValue )
inline

Set control LocalSolver.

Parameters
newValue The new value for LocalSolver.

setLpFlags()

void xpress::XPRSProblem::Controls::setLpFlags ( xpress::LPFlags newValue )
inline

Set control LpFlags.

A bit-vector control which defines the algorithm for solving an LP problem or the initial LP relaxation of a MIP problem.

Parameters
newValue The new value for LpFlags.

setLpFolding()

void xpress::XPRSProblem::Controls::setLpFolding ( int newValue )
inline

Set control LpFolding.

Simplex and barrier: whether to fold an LP problem before solving it.

Parameters
newValue The new value for LpFolding.

setLpIterLimit()

void xpress::XPRSProblem::Controls::setLpIterLimit ( int newValue )
inline

Set control LpIterLimit.

The maximum number of iterations that will be performed by primal simplex or dual simplex before the optimization process terminates. For MIP problems, this is the maximum total number of iterations over all nodes explored by the Branch and Bound method.

Parameters
newValue The new value for LpIterLimit.

setLpLog()

void xpress::XPRSProblem::Controls::setLpLog ( int newValue )
inline

Set control LpLog.

Simplex: The frequency at which the simplex log is printed.

Parameters
newValue The new value for LpLog.

setLpLogDelay()

void xpress::XPRSProblem::Controls::setLpLogDelay ( double newValue )
inline

Set control LpLogDelay.

Time interval between two LP log lines.

Parameters
newValue The new value for LpLogDelay.

setLpLogStyle()

void xpress::XPRSProblem::Controls::setLpLogStyle ( int newValue )
inline

Set control LpLogStyle.

Simplex: The style of the simplex log.

Parameters
newValue The new value for LpLogStyle.

setLpRefineIterLimit()

void xpress::XPRSProblem::Controls::setLpRefineIterLimit ( int newValue )
inline

Set control LpRefineIterLimit.

This specifies the simplex iteration limit the solution refiner can spend in attempting to increase the accuracy of an LP solution.

Parameters
newValue The new value for LpRefineIterLimit.

setLUPivotTol()

void xpress::XPRSProblem::Controls::setLUPivotTol ( double newValue )
inline

Set control LUPivotTol.

Parameters
newValue The new value for LUPivotTol.

setMarkowitzTol()

void xpress::XPRSProblem::Controls::setMarkowitzTol ( double newValue )
inline

Set control MarkowitzTol.

The Markowitz tolerance used for the factorization of the basis matrix.

Parameters
newValue The new value for MarkowitzTol.

setMatrixTol()

void xpress::XPRSProblem::Controls::setMatrixTol ( double newValue )
inline

Set control MatrixTol.

The zero tolerance on matrix elements. If the value of a matrix element is less than or equal to MATRIXTOL in absolute value, it is treated as zero. The control applies when solving a problem, for an input tolerance see INPUTTOL.

Parameters
newValue The new value for MatrixTol.

setMaxChecksOnMaxCutTime()

void xpress::XPRSProblem::Controls::setMaxChecksOnMaxCutTime ( int newValue )
inline

Set control MaxChecksOnMaxCutTime.

This control is intended for use where optimization runs that are terminated using the MAXCUTTIME control are required to be reproduced exactly. This control is necessary because of the inherent difficulty in terminating algorithmic software in a consistent way using temporal criteria. The control value relates to the number of times the optimizer checks the MAXCUTTIME criterion up to and including the check when the termination of cutting was activated. To use the control the user first must obtain the value of the CHECKSONMAXCUTTIME attribute after the run returns. This attribute value is the number of times the optimizer checked the MAXCUTTIME criterion during the last call to the optimization routine XPRSmipoptimize. Note that this attribute value will be negative if the optimizer terminated cutting on the MAXCUTTIME criterion. To ensure accurate reproduction of a run the user should first ensure that MAXCUTTIME is set to its default value or to a large value so the run does not terminate again on MAXCUTTIME and then simply set the control MAXCHECKSONMAXCUTTIME to the absolute value of the CHECKSONMAXCUTTIME value.

Parameters
newValue The new value for MaxChecksOnMaxCutTime.

setMaxChecksOnMaxTime()

void xpress::XPRSProblem::Controls::setMaxChecksOnMaxTime ( int newValue )
inline

Set control MaxChecksOnMaxTime.

This control is intended for use where optimization runs that are terminated using the TIMELIMIT (or the deprecated MAXTIME) control are required to be reproduced exactly. This control is necessary because of the inherent difficulty in terminating algorithmic software in a consistent way using temporal criteria. The control value relates to the number of times the optimizer checks the TIMELIMIT criterion up to and including the check when the termination was activated. To use the control the user first must obtain the value of the CHECKSONMAXTIME attribute after the run returns. This attribute value is the number of times the optimizer checked the TIMELIMIT criterion during the last call to the optimization routine XPRSmipoptimize. Note that this attribute value will be negative if the optimizer terminated on the TIMELIMIT criterion. To ensure that a reproduction of a run terminates in the same way the user should first ensure that TIMELIMIT is set to its default value or to a large value so the run does not terminate again on TIMELIMIT and then simply set the control MAXCHECKSONMAXTIME to the absolute value of the CHECKSONMAXTIME value.

Parameters
newValue The new value for MaxChecksOnMaxTime.

setMaxCutTime()

void xpress::XPRSProblem::Controls::setMaxCutTime ( double newValue )
inline

Set control MaxCutTime.

The maximum amount of time allowed for generation of cutting planes and reoptimization. The limit is checked during generation and no further cuts are added once this limit has been exceeded.

Parameters
newValue The new value for MaxCutTime.

setMaxIIS()

void xpress::XPRSProblem::Controls::setMaxIIS ( int newValue )
inline

Set control MaxIIS.

This function controls the number of Irreducible Infeasible Sets to be found using the XPRSiisall (IIS -a).

Parameters
newValue The new value for MaxIIS.

setMaxImpliedBound()

void xpress::XPRSProblem::Controls::setMaxImpliedBound ( double newValue )
inline

Set control MaxImpliedBound.

Presolve: When tighter bounds are calculated during MIP preprocessing, only bounds whose absolute value are smaller than MAXIMPLIEDBOUND will be applied to the problem.

Parameters
newValue The new value for MaxImpliedBound.

setMaxLocalBacktrack()

void xpress::XPRSProblem::Controls::setMaxLocalBacktrack ( int newValue )
inline

Set control MaxLocalBacktrack.

Branch-and-Bound: How far back up the current dive path the optimizer is allowed to look for a local backtrack candidate node.

Parameters
newValue The new value for MaxLocalBacktrack.

setMaxMCoeffBufferElems()

void xpress::XPRSProblem::Controls::setMaxMCoeffBufferElems ( int newValue )
inline

Set control MaxMCoeffBufferElems.

The maximum number of matrix coefficients to buffer before flushing into the internal representation of the problem. Buffering coefficients can offer a significant performance gain when you are building a matrix using XPRSchgcoef or XPRSchgmcoef, but can lead to a significant memory overhead for large matrices, which this control allows you to influence.

Parameters
newValue The new value for MaxMCoeffBufferElems.

setMaxMemoryHard()

void xpress::XPRSProblem::Controls::setMaxMemoryHard ( int newValue )
inline

Set control MaxMemoryHard.

This control sets the maximum amount of memory in megabytes the optimizer should allocate. If this limit is exceeded, the solve will terminate. This control is designed to make the optimizer stop in a controlled manner, so that the problem object is valid once termination occurs. The solve state will be set to incomplete. This is different to an out of memory condition in which case the optimizer returns an error. The optimizer may still allocate memory once the limit is exceeded to be able to finsish the operations and stop in a controlled manner. When RESOURCESTRATEGY is enabled, the control also has the same effect as MAXMEMORYSOFT and will cause the optimizer to try preserving memory when possible.

Parameters
newValue The new value for MaxMemoryHard.

setMaxMemorySoft()

void xpress::XPRSProblem::Controls::setMaxMemorySoft ( int newValue )
inline

Set control MaxMemorySoft.

When RESOURCESTRATEGY is enabled, this control sets the maximum amount of memory in megabytes the optimizer targets to allocate. This may change the solving path, but will not cause the solve to terminate early. To set a hard version of the same, please set MAXMEMORYHARD.

Parameters
newValue The new value for MaxMemorySoft.

setMaxMipSol()

void xpress::XPRSProblem::Controls::setMaxMipSol ( int newValue )
inline

Set control MaxMipSol.

Branch and Bound: This specifies a limit on the number of integer solutions to be found by the Optimizer. It is possible that during optimization the Optimizer will find the same objective solution from different nodes. However, MAXMIPSOL refers to the total number of integer solutions found, and not necessarily the number of distinct solutions.

Parameters
newValue The new value for MaxMipSol.

setMaxMipTasks()

void xpress::XPRSProblem::Controls::setMaxMipTasks ( int newValue )
inline

Set control MaxMipTasks.

Branch-and-Bound: The maximum number of tasks to run in parallel during a MIP solve.

Parameters
newValue The new value for MaxMipTasks.

setMaxNode()

void xpress::XPRSProblem::Controls::setMaxNode ( int newValue )
inline

Set control MaxNode.

Branch and Bound: The maximum number of nodes that will be explored.

Parameters
newValue The new value for MaxNode.

setMaxPageLines()

void xpress::XPRSProblem::Controls::setMaxPageLines ( int newValue )
inline

Set control MaxPageLines.

Number of lines between page breaks in printable output.

Parameters
newValue The new value for MaxPageLines.

setMaxScaleFactor()

void xpress::XPRSProblem::Controls::setMaxScaleFactor ( int newValue )
inline

Set control MaxScaleFactor.

This determines the maximum scaling factor that can be applied during scaling. The maximum is provided as an exponent of a power of 2.

Parameters
newValue The new value for MaxScaleFactor.

setMaxStallTime()

void xpress::XPRSProblem::Controls::setMaxStallTime ( double newValue )
inline

Set control MaxStallTime.

The maximum time in seconds that the Optimizer will continue to search for improving solution after finding a new incumbent.

Parameters
newValue The new value for MaxStallTime.

setMaxTime()

void xpress::XPRSProblem::Controls::setMaxTime ( int newValue )
inline

Set control MaxTime.

The maximum time in seconds that the Optimizer will run before it terminates, including the problem setup time and solution time. For MIP problems, this is the total time taken to solve all nodes.

Parameters
newValue The new value for MaxTime.

setMaxTreeFileSize()

void xpress::XPRSProblem::Controls::setMaxTreeFileSize ( int newValue )
inline

Set control MaxTreeFileSize.

The maximum size, in megabytes, to which the tree file may grow, or 0 for no limit. When the tree file reaches this limit, a second tree file will be created. Useful if you are using a filesystem that puts a maximum limit on the size of a file.

Parameters
newValue The new value for MaxTreeFileSize.

setMCFCutStrategy()

void xpress::XPRSProblem::Controls::setMCFCutStrategy ( int newValue )
inline

Set control MCFCutStrategy.

Level of Multi-Commodity Flow (MCF) cutting planes separation: This specifies how much aggresively MCF cuts should be separated. If the separation of MCF cuts is enabled, Xpress will try to detect a MCF network structure in the problem and, if such a structure is identified, it will separate specific cutting planes exploiting the identified network.

Parameters
newValue The new value for MCFCutStrategy.

setMipAbsCutoff()

void xpress::XPRSProblem::Controls::setMipAbsCutoff ( double newValue )
inline

Set control MipAbsCutoff.

Branch and Bound: If the user knows that they are interested only in values of the objective function which are better than some value, this can be assigned to MIPABSCUTOFF. This allows the Optimizer to ignore solving any nodes which may yield worse objective values, saving solution time. When a MIP solution is found a new cut off value is calculated and the value can be obtained from the CURRMIPCUTOFF attribute. The value of CURRMIPCUTOFF is calculated using the MIPRELCUTOFF and MIPADDCUTOFF controls.

Parameters
newValue The new value for MipAbsCutoff.

setMipAbsGapNotify()

void xpress::XPRSProblem::Controls::setMipAbsGapNotify ( double newValue )
inline

Set control MipAbsGapNotify.

Branch and bound: if the gapnotify callback has been set using XPRSaddcbgapnotify, then this callback will be triggered during the tree search when the absolute gap reaches or passes the value you set of the MIPRELGAPNOTIFY control.

Parameters
newValue The new value for MipAbsGapNotify.

setMipAbsGapNotifyBound()

void xpress::XPRSProblem::Controls::setMipAbsGapNotifyBound ( double newValue )
inline

Set control MipAbsGapNotifyBound.

Branch and bound: if the gapnotify callback has been set using XPRSaddcbgapnotify, then this callback will be triggered during the tree search when the best bound reaches or passes the value you set of the MIPRELGAPNOTIFYBOUND control.

Parameters
newValue The new value for MipAbsGapNotifyBound.

setMipAbsGapNotifyObj()

void xpress::XPRSProblem::Controls::setMipAbsGapNotifyObj ( double newValue )
inline

Set control MipAbsGapNotifyObj.

Branch and bound: if the gapnotify callback has been set using XPRSaddcbgapnotify, then this callback will be triggered during the tree search when the best solution value reaches or passes the value you set of the MIPRELGAPNOTIFYOBJ control.

Parameters
newValue The new value for MipAbsGapNotifyObj.

setMipAbsStop()

void xpress::XPRSProblem::Controls::setMipAbsStop ( double newValue )
inline

Set control MipAbsStop.

Branch and Bound: The absolute tolerance determining whether the tree search will continue or not. It will terminate if
   |MIPOBJVAL - BESTBOUND| <= MIPABSSTOP
where MIPOBJVAL is the value of the best solution's objective function, and BESTBOUND is the current best solution bound. For example, to stop the tree search when a MIP solution has been found and the Optimizer can guarantee it is within 100 of the optimal solution, set MIPABSSTOP to 100.

Parameters
newValue The new value for MipAbsStop.

setMipAddCutoff()

void xpress::XPRSProblem::Controls::setMipAddCutoff ( double newValue )
inline

Set control MipAddCutoff.

Branch and Bound: The amount to add to the objective function of the best integer solution found to give the new CURRMIPCUTOFF. Once an integer solution has been found whose objective function is equal to or better than CURRMIPCUTOFF, improvements on this value may not be interesting unless they are better by at least a certain amount. If MIPADDCUTOFF is nonzero, it will be added to CURRMIPCUTOFF each time an integer solution is found which is better than this new value. This cuts off sections of the tree whose solutions would not represent substantial improvements in the objective function, saving processor time. The control MIPABSSTOP provides a similar function but works in a different way.

Parameters
newValue The new value for MipAddCutoff.

setMipComponents()

void xpress::XPRSProblem::Controls::setMipComponents ( int newValue )
inline

Set control MipComponents.

Determines whether disconnected components in a MIP should be solved as separate MIPs. There can be significant performence benefits from solving disconnected components individual instead of being part of the main branch-and-bound search.

Parameters
newValue The new value for MipComponents.

setMipConcurrentNodes()

void xpress::XPRSProblem::Controls::setMipConcurrentNodes ( int newValue )
inline

Set control MipConcurrentNodes.

Sets the node limit for when a winning solve is selected when concurrent MIP solves are enabled. When multiple MIP solves are started, they each run up to the MIPCONCURRENTNODES node limit and only one winning solve is selected for contuinuing the search with.

Parameters
newValue The new value for MipConcurrentNodes.

setMipConcurrentSolves()

void xpress::XPRSProblem::Controls::setMipConcurrentSolves ( int newValue )
inline

Set control MipConcurrentSolves.

Selects the number of concurrent solves to start for a MIP. Each solve will use a unique random seed for its random number generator, but will otherwise apply the same user controls. The first concurrent solve to complete will have solved the MIP and all the concurrent solves will be terminated at this point. Using concurrent solves can be advantageous when a MIP displays a high level of performance variability.

Parameters
newValue The new value for MipConcurrentSolves.

setMipDualReductions()

void xpress::XPRSProblem::Controls::setMipDualReductions ( int newValue )
inline

Set control MipDualReductions.

Branch and Bound: Limits operations that can reduce the MIP solution space.

Parameters
newValue The new value for MipDualReductions.

setMipFracReduce()

void xpress::XPRSProblem::Controls::setMipFracReduce ( int newValue )
inline

Set control MipFracReduce.

Branch and Bound: Specifies how often the optimizer should run a heuristic to reduce the number of fractional integer variables in the node LP solutions.

Parameters
newValue The new value for MipFracReduce.

setMipKappaFreq()

void xpress::XPRSProblem::Controls::setMipKappaFreq ( int newValue )
inline

Set control MipKappaFreq.

Branch and Bound: Specifies how frequently the basis condition number (also known as kappa) should be calculated during the branch-and-bound search.

Parameters
newValue The new value for MipKappaFreq.

setMipLog()

void xpress::XPRSProblem::Controls::setMipLog ( int newValue )
inline

Set control MipLog.

MIP log print control.

Parameters
newValue The new value for MipLog.

setMipPresolve()

void xpress::XPRSProblem::Controls::setMipPresolve ( int newValue )
inline

Set control MipPresolve.

Branch and Bound: Type of integer processing to be performed. If set to 0, no processing will be performed.

Parameters
newValue The new value for MipPresolve.

setMipRampup()

void xpress::XPRSProblem::Controls::setMipRampup ( int newValue )
inline

Set control MipRampup.

Controls the strategy used by the parallel MIP solver during the ramp-up phase of a branch-and-bound tree search.

Parameters
newValue The new value for MipRampup.

setMipRefineIterLimit()

void xpress::XPRSProblem::Controls::setMipRefineIterLimit ( int newValue )
inline

Set control MipRefineIterLimit.

This defines an effort limit expressed as simplex iterations for the MIP solution refiner. The limit is per reoptimizations in the MIP refiner.

Parameters
newValue The new value for MipRefineIterLimit.

setMipRelCutoff()

void xpress::XPRSProblem::Controls::setMipRelCutoff ( double newValue )
inline

Set control MipRelCutoff.

Branch and Bound: Percentage of the incumbent value to be added to the value of the objective function when an integer solution is found, to give the new value of CURRMIPCUTOFF. The effect is to cut off the search in parts of the tree whose best possible objective function would not be substantially better than the current solution. The control MIPRELSTOP provides a similar functionality but works in a different way.

Parameters
newValue The new value for MipRelCutoff.

setMipRelGapNotify()

void xpress::XPRSProblem::Controls::setMipRelGapNotify ( double newValue )
inline

Set control MipRelGapNotify.

Branch and bound: if the gapnotify callback has been set using XPRSaddcbgapnotify, then this callback will be triggered during the branch and bound tree search when the relative gap reaches or passes the value you set of the MIPRELGAPNOTIFY control.

Parameters
newValue The new value for MipRelGapNotify.

setMipRelStop()

void xpress::XPRSProblem::Controls::setMipRelStop ( double newValue )
inline

Set control MipRelStop.

Branch and Bound: This determines when the branch and bound tree search will terminate. Branch and bound tree search will stop if:
   |MIPOBJVAL - BESTBOUND| <= MIPRELSTOP x max(|BESTBOUND|,|MIPOBJVAL|)
where MIPOBJVAL is the value of the best solution's objective function and BESTBOUND is the current best solution bound. For example, to stop the tree search when a MIP solution has been found and the Optimizer can guarantee it is within 5% of the optimal solution, set MIPRELSTOP to 0.05.

Parameters
newValue The new value for MipRelStop.

setMipRestart()

void xpress::XPRSProblem::Controls::setMipRestart ( int newValue )
inline

Set control MipRestart.

Branch and Bound: controls strategy for in-tree restarts.

Parameters
newValue The new value for MipRestart.

setMipRestartFactor()

void xpress::XPRSProblem::Controls::setMipRestartFactor ( double newValue )
inline

Set control MipRestartFactor.

Branch and Bound: Fine tune initial conditions to trigger an in-tree restart. Use a value > 1 to increase the aggressiveness with which the Optimizer restarts. Use a value < 1 to relax the aggressiveness with which the Optimizer restarts. Note that this control does not affect the initial condition on the gap, which must be set separately.

Parameters
newValue The new value for MipRestartFactor.

setMipRestartGapThreshold()

void xpress::XPRSProblem::Controls::setMipRestartGapThreshold ( double newValue )
inline

Set control MipRestartGapThreshold.

Branch and Bound: Initial gap threshold to delay in-tree restart. The restart is delayed initially if the gap, given as a fraction between 0 and 1, is below this threshold. The optimizer adjusts the threshold every time a restart is delayed. Note that there are other criteria that can delay or prevent a restart.

Parameters
newValue The new value for MipRestartGapThreshold.

setMipTerminationMethod()

void xpress::XPRSProblem::Controls::setMipTerminationMethod ( int newValue )
inline

Set control MipTerminationMethod.

Branch and Bound: How a MIP solve should be stopped on early termination when there are still active tasks in the system. This can happen when, for example, a time or node limit is reached.

Parameters
newValue The new value for MipTerminationMethod.

setMipThreads()

void xpress::XPRSProblem::Controls::setMipThreads ( int newValue )
inline

Set control MipThreads.

If set to a positive integer it determines the number of threads implemented to run the parallel MIP code. If MIPTHREADS is set to the default value (-1), the THREADS control will determine the number of threads used.

Parameters
newValue The new value for MipThreads.

setMipTol()

void xpress::XPRSProblem::Controls::setMipTol ( double newValue )
inline

Set control MipTol.

Branch and Bound: This is the tolerance within which a decision variable's value is considered to be integral.

Parameters
newValue The new value for MipTol.

setMipTolTarget()

void xpress::XPRSProblem::Controls::setMipTolTarget ( double newValue )
inline

Set control MipTolTarget.

Target MIPTOL value used by the automatic MIP solution refiner as defined by REFINEOPS. Negative and zero values are ignored.

Parameters
newValue The new value for MipTolTarget.

setMIQCPAlg()

void xpress::XPRSProblem::Controls::setMIQCPAlg ( int newValue )
inline

Set control MIQCPAlg.

This control determines which algorithm is to be used to solve mixed integer quadratic constrained and mixed integer second order cone problems.

Parameters
newValue The new value for MIQCPAlg.

setMps18Compatible()

void xpress::XPRSProblem::Controls::setMps18Compatible ( int newValue )
inline

Set control Mps18Compatible.

Provides compatibility of MPS file output for older MPS readers.

Parameters
newValue The new value for Mps18Compatible.

setMpsBoundName()

void xpress::XPRSProblem::Controls::setMpsBoundName ( std::string const & newValue )
inline

Set control MpsBoundName.

When reading an MPS file, this control determines which entries from the BOUNDS section will be read. As with all string controls, this is of length 64 characters plus a null terminator, \0.

Parameters
newValue The new value for MpsBoundName.

setMpsEcho()

void xpress::XPRSProblem::Controls::setMpsEcho ( int newValue )
inline

Set control MpsEcho.

Determines whether comments in MPS matrix files are to be printed out during matrix input.

Parameters
newValue The new value for MpsEcho.

setMpsFormat()

void xpress::XPRSProblem::Controls::setMpsFormat ( int newValue )
inline

Set control MpsFormat.

Specifies the format of MPS files.

Parameters
newValue The new value for MpsFormat.

setMpsNameLength()

void xpress::XPRSProblem::Controls::setMpsNameLength ( int newValue )
inline

Set control MpsNameLength.

Parameters
newValue The new value for MpsNameLength.

setMpsObjName()

void xpress::XPRSProblem::Controls::setMpsObjName ( std::string const & newValue )
inline

Set control MpsObjName.

When reading an MPS file, this control determines which neutral row will be read as the objective function. If this control is set when reading a multi-objective MPS file, only the named objective will be read; all other objectives will be ignored. As with all string controls, this is of length 64 characters plus a null terminator, \0.

Parameters
newValue The new value for MpsObjName.

setMpsRangeName()

void xpress::XPRSProblem::Controls::setMpsRangeName ( std::string const & newValue )
inline

Set control MpsRangeName.

When reading an MPS file, this control determines which entries from the RANGES section will be read. As with all string controls, this is of length 64 characters plus a null terminator, \0.

Parameters
newValue The new value for MpsRangeName.

setMpsRhsName()

void xpress::XPRSProblem::Controls::setMpsRhsName ( std::string const & newValue )
inline

Set control MpsRhsName.

When reading an MPS file, this control determines which entries from the RHS section will be read. As with all string controls, this is of length 64 characters plus a null terminator, \0.

Parameters
newValue The new value for MpsRhsName.

setMseCallbackCullSols_Diversity()

void xpress::XPRSProblem::Controls::setMseCallbackCullSols_Diversity ( int newValue )
inline

Set control MseCallbackCullSols_Diversity.

Parameters
newValue The new value for MseCallbackCullSols_Diversity.

setMseCallbackCullSols_MipObject()

void xpress::XPRSProblem::Controls::setMseCallbackCullSols_MipObject ( int newValue )
inline

Set control MseCallbackCullSols_MipObject.

Parameters
newValue The new value for MseCallbackCullSols_MipObject.

setMseCallbackCullSols_ModObject()

void xpress::XPRSProblem::Controls::setMseCallbackCullSols_ModObject ( int newValue )
inline

Set control MseCallbackCullSols_ModObject.

Parameters
newValue The new value for MseCallbackCullSols_ModObject.

setMseOptimizeDiversity()

void xpress::XPRSProblem::Controls::setMseOptimizeDiversity ( int newValue )
inline

Set control MseOptimizeDiversity.

Parameters
newValue The new value for MseOptimizeDiversity.

setMseOutputLog()

void xpress::XPRSProblem::Controls::setMseOutputLog ( int newValue )
inline

Set control MseOutputLog.

Parameters
newValue The new value for MseOutputLog.

setMseOutputTol()

void xpress::XPRSProblem::Controls::setMseOutputTol ( double newValue )
inline

Set control MseOutputTol.

Parameters
newValue The new value for MseOutputTol.

setMsMaxBoundRange()

void xpress::XPRSProblem::Controls::setMsMaxBoundRange ( double newValue )
inline

Set control MsMaxBoundRange.

Defines the maximum range inside which initial points are generated by multistart presets

Parameters
newValue The new value for MsMaxBoundRange.

setMspDefaultUserSolFeasTol()

void xpress::XPRSProblem::Controls::setMspDefaultUserSolFeasTol ( double newValue )
inline

Set control MspDefaultUserSolFeasTol.

Parameters
newValue The new value for MspDefaultUserSolFeasTol.

setMspDefaultUserSolMipTol()

void xpress::XPRSProblem::Controls::setMspDefaultUserSolMipTol ( double newValue )
inline

Set control MspDefaultUserSolMipTol.

Parameters
newValue The new value for MspDefaultUserSolMipTol.

setMspDuplicateSolutionsPolicy()

void xpress::XPRSProblem::Controls::setMspDuplicateSolutionsPolicy ( int newValue )
inline

Set control MspDuplicateSolutionsPolicy.

Parameters
newValue The new value for MspDuplicateSolutionsPolicy.

setMspEnableSlackStorage()

void xpress::XPRSProblem::Controls::setMspEnableSlackStorage ( int newValue )
inline

Set control MspEnableSlackStorage.

Parameters
newValue The new value for MspEnableSlackStorage.

setMspIncludeProbNameInLogging()

void xpress::XPRSProblem::Controls::setMspIncludeProbNameInLogging ( int newValue )
inline

Set control MspIncludeProbNameInLogging.

Parameters
newValue The new value for MspIncludeProbNameInLogging.

setMspOutputLog()

void xpress::XPRSProblem::Controls::setMspOutputLog ( int newValue )
inline

Set control MspOutputLog.

Parameters
newValue The new value for MspOutputLog.

setMspSol_BitFieldsUsr()

void xpress::XPRSProblem::Controls::setMspSol_BitFieldsUsr ( int newValue )
inline

Set control MspSol_BitFieldsUsr.

Parameters
newValue The new value for MspSol_BitFieldsUsr.

setMspSol_FeasTol()

void xpress::XPRSProblem::Controls::setMspSol_FeasTol ( double newValue )
inline

Set control MspSol_FeasTol.

Parameters
newValue The new value for MspSol_FeasTol.

setMspSol_MipTol()

void xpress::XPRSProblem::Controls::setMspSol_MipTol ( double newValue )
inline

Set control MspSol_MipTol.

Parameters
newValue The new value for MspSol_MipTol.

setMspWriteSlxSolLogging()

void xpress::XPRSProblem::Controls::setMspWriteSlxSolLogging ( int newValue )
inline

Set control MspWriteSlxSolLogging.

Parameters
newValue The new value for MspWriteSlxSolLogging.

setMultiObjLog()

void xpress::XPRSProblem::Controls::setMultiObjLog ( int newValue )
inline

Set control MultiObjLog.

Log level for multi-objective optimization.

Parameters
newValue The new value for MultiObjLog.

setMultiObjOps()

void xpress::XPRSProblem::Controls::setMultiObjOps ( int newValue )
inline

Set control MultiObjOps.

Modifies the behaviour of the optimizer when solving multi-objective problems.

Parameters
newValue The new value for MultiObjOps.

setMultiStart()

void xpress::XPRSProblem::Controls::setMultiStart ( int newValue )
inline

Set control MultiStart.

The multistart master control. Defines if the multistart search is to be initiated, or if only the baseline model is to be solved.

Parameters
newValue The new value for MultiStart.

setMultiStart_Log()

void xpress::XPRSProblem::Controls::setMultiStart_Log ( int newValue )
inline

Set control MultiStart_Log.

The level of logging during the multistart run.

Parameters
newValue The new value for MultiStart_Log.

setMultiStart_MaxSolves()

void xpress::XPRSProblem::Controls::setMultiStart_MaxSolves ( int newValue )
inline

Set control MultiStart_MaxSolves.

The maximum number of jobs to create during the multistart search.

Parameters
newValue The new value for MultiStart_MaxSolves.

setMultiStart_MaxTime()

void xpress::XPRSProblem::Controls::setMultiStart_MaxTime ( int newValue )
inline

Set control MultiStart_MaxTime.

The maximum total time to be spent in the mutlistart search.

Parameters
newValue The new value for MultiStart_MaxTime.

setMultiStart_PoolSize()

void xpress::XPRSProblem::Controls::setMultiStart_PoolSize ( int newValue )
inline

Set control MultiStart_PoolSize.

The maximum number of problem objects allowed to pool up before synchronization in the deterministic multistart.

Parameters
newValue The new value for MultiStart_PoolSize.

setMultiStart_Seed()

void xpress::XPRSProblem::Controls::setMultiStart_Seed ( int newValue )
inline

Set control MultiStart_Seed.

Random seed used for the automatic generation of initial point when loading multistart presets

Parameters
newValue The new value for MultiStart_Seed.

setMultiStart_Threads()

void xpress::XPRSProblem::Controls::setMultiStart_Threads ( int newValue )
inline

Set control MultiStart_Threads.

The maximum number of threads to be used in multistart

Parameters
newValue The new value for MultiStart_Threads.

setMutexCallBacks()

void xpress::XPRSProblem::Controls::setMutexCallBacks ( int newValue )
inline

Set control MutexCallBacks.

Branch and Bound: This determines whether the callback routines are mutexed from within the optimizer.

Parameters
newValue The new value for MutexCallBacks.

setNetCuts()

void xpress::XPRSProblem::Controls::setNetCuts ( int newValue )
inline

Set control NetCuts.

Parameters
newValue The new value for NetCuts.

setNetStallLimit()

void xpress::XPRSProblem::Controls::setNetStallLimit ( int newValue )
inline

Set control NetStallLimit.

Limit the number of degenerate pivots of the network simplex algorithm, before switching to either primal or dual simplex, depending on ALGAFTERNETWORK.

Parameters
newValue The new value for NetStallLimit.

setNlpCalcThreads()

void xpress::XPRSProblem::Controls::setNlpCalcThreads ( int newValue )
inline

Set control NlpCalcThreads.

Number of threads used for formula and derivatives evaluations

Parameters
newValue The new value for NlpCalcThreads.

setNlpDefaultIV()

void xpress::XPRSProblem::Controls::setNlpDefaultIV ( double newValue )
inline

Set control NlpDefaultIV.

Default initial value for an SLP variable if none is explicitly given

Parameters
newValue The new value for NlpDefaultIV.

setNlpDerivatives()

void xpress::XPRSProblem::Controls::setNlpDerivatives ( int newValue )
inline

Set control NlpDerivatives.

Bitmap describing the method of calculating derivatives

Parameters
newValue The new value for NlpDerivatives.

setNlpDeterministic()

void xpress::XPRSProblem::Controls::setNlpDeterministic ( int newValue )
inline

Set control NlpDeterministic.

Determines if the parallel features of SLP should be guaranteed to be deterministic

Parameters
newValue The new value for NlpDeterministic.

setNlpEvaluate()

void xpress::XPRSProblem::Controls::setNlpEvaluate ( int newValue )
inline

Set control NlpEvaluate.

Evaluation strategy for user functions

Parameters
newValue The new value for NlpEvaluate.

setNlpFindIV()

void xpress::XPRSProblem::Controls::setNlpFindIV ( int newValue )
inline

Set control NlpFindIV.

Option for running a heuristic to find a feasible initial point

Parameters
newValue The new value for NlpFindIV.

setNlpFuncEval()

void xpress::XPRSProblem::Controls::setNlpFuncEval ( int newValue )
inline

Set control NlpFuncEval.

Bit map for determining the method of evaluating user functions and their derivatives

Parameters
newValue The new value for NlpFuncEval.

setNlpHessian()

void xpress::XPRSProblem::Controls::setNlpHessian ( int newValue )
inline

Set control NlpHessian.

Second order differentiation mode when using analytical derivatives

Parameters
newValue The new value for NlpHessian.

setNlpInfinity()

void xpress::XPRSProblem::Controls::setNlpInfinity ( double newValue )
inline

Set control NlpInfinity.

Value returned by a divide-by-zero in a formula

Parameters
newValue The new value for NlpInfinity.

setNlpJacobian()

void xpress::XPRSProblem::Controls::setNlpJacobian ( int newValue )
inline

Set control NlpJacobian.

First order differentiation mode when using analytical derivatives

Parameters
newValue The new value for NlpJacobian.

setNlpLinQuadBR()

void xpress::XPRSProblem::Controls::setNlpLinQuadBR ( int newValue )
inline

Set control NlpLinQuadBR.

Use linear and quadratic constraints and objective function to further reduce bounds on all variables

Parameters
newValue The new value for NlpLinQuadBR.

setNlpLog()

void xpress::XPRSProblem::Controls::setNlpLog ( int newValue )
inline

Set control NlpLog.

Level of printing during SLP iterations

Parameters
newValue The new value for NlpLog.

setNlpMaxTime()

void xpress::XPRSProblem::Controls::setNlpMaxTime ( int newValue )
inline

Set control NlpMaxTime.

The maximum time in seconds that the SLP optimization will run before it terminates

Parameters
newValue The new value for NlpMaxTime.

setNlpMeritLambda()

void xpress::XPRSProblem::Controls::setNlpMeritLambda ( double newValue )
inline

Set control NlpMeritLambda.

Factor by which the net objective is taken into account in the merit function

Parameters
newValue The new value for NlpMeritLambda.

setNlpPostsolve()

void xpress::XPRSProblem::Controls::setNlpPostsolve ( int newValue )
inline

Set control NlpPostsolve.

This control determines whether postsolving should be performed automatically

Parameters
newValue The new value for NlpPostsolve.

setNlpPresolve()

void xpress::XPRSProblem::Controls::setNlpPresolve ( int newValue )
inline

Set control NlpPresolve.

This control determines whether presolving should be performed prior to starting the main algorithm

Parameters
newValue The new value for NlpPresolve.

setNlpPresolve_ElimTol()

void xpress::XPRSProblem::Controls::setNlpPresolve_ElimTol ( double newValue )
inline

Set control NlpPresolve_ElimTol.

Tolerance for nonlinear eliminations during SLP presolve

Parameters
newValue The new value for NlpPresolve_ElimTol.

setNlpPresolveLevel()

void xpress::XPRSProblem::Controls::setNlpPresolveLevel ( int newValue )
inline

Set control NlpPresolveLevel.

This control determines the level of changes presolve may carry out on the problem and whether column/row indices may change

Parameters
newValue The new value for NlpPresolveLevel.

setNlpPresolveOps()

void xpress::XPRSProblem::Controls::setNlpPresolveOps ( int newValue )
inline

Set control NlpPresolveOps.

Bitmap indicating the SLP presolve actions to be taken

Parameters
newValue The new value for NlpPresolveOps.

setNlpPresolveZero()

void xpress::XPRSProblem::Controls::setNlpPresolveZero ( double newValue )
inline

Set control NlpPresolveZero.

Minimum absolute value for a variable which is identified as nonzero during SLP presolve

Parameters
newValue The new value for NlpPresolveZero.

setNlpPrimalIntegralAlpha()

void xpress::XPRSProblem::Controls::setNlpPrimalIntegralAlpha ( double newValue )
inline

Set control NlpPrimalIntegralAlpha.

Decay term for primal integral computation

Parameters
newValue The new value for NlpPrimalIntegralAlpha.

setNlpPrimalIntegralRef()

void xpress::XPRSProblem::Controls::setNlpPrimalIntegralRef ( double newValue )
inline

Set control NlpPrimalIntegralRef.

Reference solution value to take into account when calculating the primal integral

Parameters
newValue The new value for NlpPrimalIntegralRef.

setNlpProbing()

void xpress::XPRSProblem::Controls::setNlpProbing ( int newValue )
inline

Set control NlpProbing.

This control determines whether probing on a subset of variables should be performed prior to starting the main algorithm. Probing runs multiple times bound reduction in order to further tighten the bounding box.

Parameters
newValue The new value for NlpProbing.

setNlpReformulate()

void xpress::XPRSProblem::Controls::setNlpReformulate ( int newValue )
inline

Set control NlpReformulate.

Controls the problem reformulations carried out before augmentation. This allows SLP to take advantage of dedicated algorithms for special problem classes.

Parameters
newValue The new value for NlpReformulate.

setNlpSolver()

void xpress::XPRSProblem::Controls::setNlpSolver ( int newValue )
inline

Set control NlpSolver.

Selects the library to use for local solves

Parameters
newValue The new value for NlpSolver.

setNlpStopOutOfRange()

void xpress::XPRSProblem::Controls::setNlpStopOutOfRange ( int newValue )
inline

Set control NlpStopOutOfRange.

Stop optimization and return error code if internal function argument is out of range

Parameters
newValue The new value for NlpStopOutOfRange.

setNlpThreads()

void xpress::XPRSProblem::Controls::setNlpThreads ( int newValue )
inline

Set control NlpThreads.

Default number of threads to be used

Parameters
newValue The new value for NlpThreads.

setNlpThreadSafeUserFunc()

void xpress::XPRSProblem::Controls::setNlpThreadSafeUserFunc ( int newValue )
inline

Set control NlpThreadSafeUserFunc.

Defines if user functions are allowed to be called in parallel

Parameters
newValue The new value for NlpThreadSafeUserFunc.

setNlpValidationFactor()

void xpress::XPRSProblem::Controls::setNlpValidationFactor ( double newValue )
inline

Set control NlpValidationFactor.

Minimum improvement in validation targets to continue iterating

Parameters
newValue The new value for NlpValidationFactor.

setNlpValidationTarget_K()

void xpress::XPRSProblem::Controls::setNlpValidationTarget_K ( double newValue )
inline

Set control NlpValidationTarget_K.

Optimality target tolerance

Parameters
newValue The new value for NlpValidationTarget_K.

setNlpValidationTarget_R()

void xpress::XPRSProblem::Controls::setNlpValidationTarget_R ( double newValue )
inline

Set control NlpValidationTarget_R.

Feasiblity target tolerance

Parameters
newValue The new value for NlpValidationTarget_R.

setNlpValidationTol_A()

void xpress::XPRSProblem::Controls::setNlpValidationTol_A ( double newValue )
inline

Set control NlpValidationTol_A.

Absolute tolerance for the XSLPvalidate procedure

Parameters
newValue The new value for NlpValidationTol_A.

setNlpValidationTol_K()

void xpress::XPRSProblem::Controls::setNlpValidationTol_K ( double newValue )
inline

Set control NlpValidationTol_K.

Relative tolerance for the XSLPvalidatekkt procedure

Parameters
newValue The new value for NlpValidationTol_K.

setNlpValidationTol_R()

void xpress::XPRSProblem::Controls::setNlpValidationTol_R ( double newValue )
inline

Set control NlpValidationTol_R.

Relative tolerance for the XSLPvalidate procedure

Parameters
newValue The new value for NlpValidationTol_R.

setNlpZero()

void xpress::XPRSProblem::Controls::setNlpZero ( double newValue )
inline

Set control NlpZero.

Absolute tolerance

Parameters
newValue The new value for NlpZero.

setNodeProbingEffort()

void xpress::XPRSProblem::Controls::setNodeProbingEffort ( double newValue )
inline

Set control NodeProbingEffort.

Adjusts the overall level of node probing.

Parameters
newValue The new value for NodeProbingEffort.

setNodeSelection()

void xpress::XPRSProblem::Controls::setNodeSelection ( int newValue )
inline

Set control NodeSelection.

Branch and Bound: This determines which nodes will be considered for solution once the current node has been solved.

Parameters
newValue The new value for NodeSelection.

setNumericalEmphasis()

void xpress::XPRSProblem::Controls::setNumericalEmphasis ( int newValue )
inline

Set control NumericalEmphasis.

How much emphasis to place on numerical stability instead of solve speed.

Parameters
newValue The new value for NumericalEmphasis.

setObjScaleFactor()

void xpress::XPRSProblem::Controls::setObjScaleFactor ( int newValue )
inline

Set control ObjScaleFactor.

Custom objective scaling factor, expressed as a power of 2. When set, it overwrites the automatic objective scaling factor. A value of 0 means no objective scaling. This control is applied for the full solve, and is independent of any extra scaling that may occur specifically for the barrier or simplex solvers. As it is a power of 2, to scale by 16, set the value of the control to 4.

Parameters
newValue The new value for ObjScaleFactor.

setOptimalityTol()

void xpress::XPRSProblem::Controls::setOptimalityTol ( double newValue )
inline

Set control OptimalityTol.

Simplex: This is the zero tolerance for reduced costs. On each iteration, the simplex method searches for a variable to enter the basis which has a negative reduced cost. The candidates are only those variables which have reduced costs less than the negative value of OPTIMALITYTOL.

Parameters
newValue The new value for OptimalityTol.

setOptimalityTolTarget()

void xpress::XPRSProblem::Controls::setOptimalityTolTarget ( double newValue )
inline

Set control OptimalityTolTarget.

This specifies the target optimality tolerance for the solution refiner.

Parameters
newValue The new value for OptimalityTolTarget.

setOutputControls()

void xpress::XPRSProblem::Controls::setOutputControls ( int newValue )
inline

Set control OutputControls.

This control toggles the printing of all control settings at the beginning of the search. This includes the printing of controls that have been explicitly assigned to their default value. All unset controls are omitted as they keep their default value.

Parameters
newValue The new value for OutputControls.

setOutputLog()

void xpress::XPRSProblem::Controls::setOutputLog ( int newValue )
inline

Set control OutputLog.

This controls the level of output produced by the Optimizer during optimization. In the Console Optimizer, OUTPUTLOG controls which messages are sent to the screen (stdout). When using the Optimizer library, no output is sent to the screen. If the user wishes output to be displayed, they must define a callback function and print messages to the screen themselves. In this case, OUTPUTLOG controls which messages are sent to the user output callback.

Parameters
newValue The new value for OutputLog.

setOutputMask()

void xpress::XPRSProblem::Controls::setOutputMask ( std::string const & newValue )
inline

Set control OutputMask.

Mask to restrict the row and column names written to file. As with all string controls, this is of length 64 characters plus a null terminator, \0.

Parameters
newValue The new value for OutputMask.

setOutputTol()

void xpress::XPRSProblem::Controls::setOutputTol ( double newValue )
inline

Set control OutputTol.

Zero tolerance on print values.

Parameters
newValue The new value for OutputTol.

setPenalty()

void xpress::XPRSProblem::Controls::setPenalty ( double newValue )
inline

Set control Penalty.

Minimum absolute penalty variable coefficient. BIGM and PENALTY are set by the input routine (XPRSreadprob (READPROB)) but may be reset by the user prior to XPRSlpoptimize (LPOPTIMIZE).

Parameters
newValue The new value for Penalty.

setPivotTol()

void xpress::XPRSProblem::Controls::setPivotTol ( double newValue )
inline

Set control PivotTol.

Simplex: The zero tolerance for matrix elements. On each iteration, the simplex method seeks a nonzero matrix element to pivot on. Any element with absolute value less than PIVOTTOL is treated as zero for this purpose.

Parameters
newValue The new value for PivotTol.

setPPFactor()

void xpress::XPRSProblem::Controls::setPPFactor ( double newValue )
inline

Set control PPFactor.

The partial pricing candidate list sizing parameter.

Parameters
newValue The new value for PPFactor.

setPreAnalyticcenter()

void xpress::XPRSProblem::Controls::setPreAnalyticcenter ( int newValue )
inline

Set control PreAnalyticcenter.

Determines if analytic centers should be computed and used for variable fixing and the generation of alternative reduced costs (-1: Auto 0: Off, 1: Fixing, 2: Redcost, 3: Both)

Parameters
newValue The new value for PreAnalyticcenter.

setPreBasisRed()

void xpress::XPRSProblem::Controls::setPreBasisRed ( int newValue )
inline

Set control PreBasisRed.

Determines if a lattice basis reduction algorithm should be attempted as part of presolve

Parameters
newValue The new value for PreBasisRed.

setPreBndRedCone()

void xpress::XPRSProblem::Controls::setPreBndRedCone ( int newValue )
inline

Set control PreBndRedCone.

Determines if second order cone constraints should be used for inferring bound reductions on variables when solving a MIP.

Parameters
newValue The new value for PreBndRedCone.

setPreBndRedQuad()

void xpress::XPRSProblem::Controls::setPreBndRedQuad ( int newValue )
inline

Set control PreBndRedQuad.

Determines if convex quadratic constraints should be used for inferring bound reductions on variables when solving a MIP.

Parameters
newValue The new value for PreBndRedQuad.

setPreCliqueStrategy()

void xpress::XPRSProblem::Controls::setPreCliqueStrategy ( int newValue )
inline

Set control PreCliqueStrategy.

Determines how much effort to spend on clique covers in presolve.

Parameters
newValue The new value for PreCliqueStrategy.

setPreCoefElim()

void xpress::XPRSProblem::Controls::setPreCoefElim ( int newValue )
inline

Set control PreCoefElim.

Presolve: Specifies whether the optimizer should attempt to recombine constraints in order to reduce the number of non zero coefficients when presolving a mixed integer problem.

Parameters
newValue The new value for PreCoefElim.

setPreComponents()

void xpress::XPRSProblem::Controls::setPreComponents ( int newValue )
inline

Set control PreComponents.

Presolve: determines whether small independent components should be detected and solved as individual subproblems during root node processing.

Parameters
newValue The new value for PreComponents.

setPreComponentsEffort()

void xpress::XPRSProblem::Controls::setPreComponentsEffort ( double newValue )
inline

Set control PreComponentsEffort.

Presolve: adjusts the overall effort for the independent component presolver. This control affects working limits for the subproblem solving as well as thresholds when it is called. Increase to put more emphasis on component presolving.

Parameters
newValue The new value for PreComponentsEffort.

setPreConeDecomp()

void xpress::XPRSProblem::Controls::setPreConeDecomp ( int newValue )
inline

Set control PreConeDecomp.

Presolve: decompose regular and rotated cones with more than two elements and apply Outer Approximation on the resulting components.

Parameters
newValue The new value for PreConeDecomp.

setPreConfiguration()

void xpress::XPRSProblem::Controls::setPreConfiguration ( int newValue )
inline

Set control PreConfiguration.

MIP Presolve: determines whether binary rows with only few repeating coefficients should be reformulated. The reformulation enumerates the extremal feasible configurations of a row and introduces new columns and rows to model the choice between these extremal configurations. This presolve operation can be disabled as part of the (advanced) IP reductions PRESOLVEOPS.

Parameters
newValue The new value for PreConfiguration.

setPreConvertObjToCons()

void xpress::XPRSProblem::Controls::setPreConvertObjToCons ( int newValue )
inline

Set control PreConvertObjToCons.

Presolve: convert a linear or quadratic objective function into an objective transfer constraint

Parameters
newValue The new value for PreConvertObjToCons.

setPreConvertSeparable()

void xpress::XPRSProblem::Controls::setPreConvertSeparable ( int newValue )
inline

Set control PreConvertSeparable.

Presolve: reformulate problems with a non-diagonal quadratic objective and/or constraints as diagonal quadratic or second-order conic constraints.

Parameters
newValue The new value for PreConvertSeparable.

setPreDomCol()

void xpress::XPRSProblem::Controls::setPreDomCol ( int newValue )
inline

Set control PreDomCol.

Presolve: Determines the level of dominated column removal reductions to perform when presolving a mixed integer problem. Only binary columns will be checked.

Parameters
newValue The new value for PreDomCol.

setPreDomRow()

void xpress::XPRSProblem::Controls::setPreDomRow ( int newValue )
inline

Set control PreDomRow.

Presolve: Determines the level of dominated row removal reductions to perform when presolving a problem.

Parameters
newValue The new value for PreDomRow.

setPreDupRow()

void xpress::XPRSProblem::Controls::setPreDupRow ( int newValue )
inline

Set control PreDupRow.

Presolve: Determines the type of duplicate rows to look for and eliminate when presolving a problem.

Parameters
newValue The new value for PreDupRow.

setPreElimQuad()

void xpress::XPRSProblem::Controls::setPreElimQuad ( int newValue )
inline

Set control PreElimQuad.

Presolve: Allows for elimination of quadratic variables via doubleton rows.

Parameters
newValue The new value for PreElimQuad.

setPreFolding()

void xpress::XPRSProblem::Controls::setPreFolding ( int newValue )
inline

Set control PreFolding.

Presolve: Determines if a folding procedure should be used to aggregate continuous columns in an equitable partition.

Parameters
newValue The new value for PreFolding.

setPreImplications()

void xpress::XPRSProblem::Controls::setPreImplications ( int newValue )
inline

Set control PreImplications.

Presolve: Determines whether to use implication structures to remove redundant rows. If implication sequences are detected, they might also be used in probing.

Parameters
newValue The new value for PreImplications.

setPreLinDep()

void xpress::XPRSProblem::Controls::setPreLinDep ( int newValue )
inline

Set control PreLinDep.

Presolve: Determines whether to check for and remove linearly dependent equality constraints when presolving a problem.

Parameters
newValue The new value for PreLinDep.

setPreObjCutDetect()

void xpress::XPRSProblem::Controls::setPreObjCutDetect ( int newValue )
inline

Set control PreObjCutDetect.

Presolve: Determines whether to check for constraints that are parallel or near parallel to a linear objective function, and which can safely be removed. This reduction applies to MIPs only.

Parameters
newValue The new value for PreObjCutDetect.

setPrePermute()

void xpress::XPRSProblem::Controls::setPrePermute ( int newValue )
inline

Set control PrePermute.

This bit vector control specifies whether to randomly permute rows, columns and MIP entities when starting the presolve. With the default value 0, no permutation will take place.

Parameters
newValue The new value for PrePermute.

setPrePermuteSeed()

void xpress::XPRSProblem::Controls::setPrePermuteSeed ( int newValue )
inline

Set control PrePermuteSeed.

This control sets the seed for the pseudo-random number generator for permuting the problem when starting the presolve. This control only has effects when PREPERMUTE is enabled.

Parameters
newValue The new value for PrePermuteSeed.

setPreProbing()

void xpress::XPRSProblem::Controls::setPreProbing ( int newValue )
inline

Set control PreProbing.

Presolve: Amount of probing to perform on binary variables during presolve. This is done by fixing a binary to each of its values in turn and analyzing the implications.

Parameters
newValue The new value for PreProbing.

setPreProtectDual()

void xpress::XPRSProblem::Controls::setPreProtectDual ( int newValue )
inline

Set control PreProtectDual.

Presolve: specifies whether the presolver should protect a given dual solution by maintaining the same level of dual feasibility. Enabling this control often results in a worse presolved model. This control only expected to be optionally enabled before calling XPRScrossoverlpsol.

Parameters
newValue The new value for PreProtectDual.

setPresolve()

void xpress::XPRSProblem::Controls::setPresolve ( int newValue )
inline

Set control Presolve.

This control determines whether presolving should be performed prior to starting the main algorithm. Presolve attempts to simplify the problem by detecting and removing redundant constraints, tightening variable bounds, etc. In some cases, infeasibility may even be determined at this stage, or the optimal solution found.

Parameters
newValue The new value for Presolve.

setPresolveMaxGrow()

void xpress::XPRSProblem::Controls::setPresolveMaxGrow ( double newValue )
inline

Set control PresolveMaxGrow.

Limit on how much the number of non-zero coefficients is allowed to grow during presolve, specified as a ratio of the number of non-zero coefficients in the original problem.

Parameters
newValue The new value for PresolveMaxGrow.

setPresolveOps()

void xpress::XPRSProblem::Controls::setPresolveOps ( int newValue )
inline

Set control PresolveOps.

This bit vector control specifies the operations which are performed during the presolve.

Parameters
newValue The new value for PresolveOps.

setPresolvePasses()

void xpress::XPRSProblem::Controls::setPresolvePasses ( int newValue )
inline

Set control PresolvePasses.

Number of reduction rounds to be performed in presolve

Parameters
newValue The new value for PresolvePasses.

setPreSort()

void xpress::XPRSProblem::Controls::setPreSort ( int newValue )
inline

Set control PreSort.

This bit vector control specifies whether to sort rows, columns and MIP entities by their names when starting the presolve. With the default value 0, no sorting will take place.

Parameters
newValue The new value for PreSort.

setPricingAlg()

void xpress::XPRSProblem::Controls::setPricingAlg ( int newValue )
inline

Set control PricingAlg.

Simplex: This determines the primal simplex pricing method. It is used to select which variable enters the basis on each iteration. In general Devex pricing requires more time on each iteration, but may reduce the total number of iterations, whereas partial pricing saves time on each iteration, but may result in more iterations.

Parameters
newValue The new value for PricingAlg.

setPrimalOps()

void xpress::XPRSProblem::Controls::setPrimalOps ( int newValue )
inline

Set control PrimalOps.

Primal simplex: allows fine tuning the variable selection in the primal simplex solver.

Parameters
newValue The new value for PrimalOps.

setPrimalPerturb()

void xpress::XPRSProblem::Controls::setPrimalPerturb ( double newValue )
inline

Set control PrimalPerturb.

The factor by which the problem will be perturbed prior to optimization by primal simplex. A value of 0.0 results in no perturbation prior to optimization.

Note the interconnection to the AUTOPERTURB control. If AUTOPERTURB is set to 1, the decision whether to perturb or not is left to the Optimizer. When the problem is automatically perturbed in primal simplex, however, the value of PRIMALPERTURB will be used for perturbation.

Parameters
newValue The new value for PrimalPerturb.

setPrimalUnshift()

void xpress::XPRSProblem::Controls::setPrimalUnshift ( int newValue )
inline

Set control PrimalUnshift.

Determines whether primal is allowed to call dual to unshift.

Parameters
newValue The new value for PrimalUnshift.

setPseudoCost()

void xpress::XPRSProblem::Controls::setPseudoCost ( double newValue )
inline

Set control PseudoCost.

Branch and Bound: The default pseudo cost used in estimation of the degradation associated with an unexplored node in the tree search. A pseudo cost is associated with each integer decision variable and is an estimate of the amount by which the objective function will be worse if that variable is forced to an integral value.

Parameters
newValue The new value for PseudoCost.

setPwlDualReductions()

void xpress::XPRSProblem::Controls::setPwlDualReductions ( int newValue )
inline

Set control PwlDualReductions.

This parameter specifies whether dual reductions should be applied to reduce the number of columns, rows and SOS-constraints added when transforming piecewise linear objectives and constraints to MIP structs.

Parameters
newValue The new value for PwlDualReductions.

setPwlNonConvexTransformation()

void xpress::XPRSProblem::Controls::setPwlNonConvexTransformation ( int newValue )
inline

Set control PwlNonConvexTransformation.

This control specifies the reformulation method for piecewise linear constraints at the beginning of the search.

Note that the chosen formulation will only be used if MIP entities are necessary but not if presolve detected that a convex reformulation is possible. Furthermore, the binary formulation will only be applied to piecewise linear constraints with bounded input variable, otherwise the SOS2-formulation will be used.

Parameters
newValue The new value for PwlNonConvexTransformation.

setQCCuts()

void xpress::XPRSProblem::Controls::setQCCuts ( int newValue )
inline

Set control QCCuts.

Branch and Bound: Limit on the number of rounds of outer approximation cuts generated for the root node, when solving a mixed integer quadratic constrained or mixed integer second order conic problem with outer approximation.

Parameters
newValue The new value for QCCuts.

setQCRootAlg()

void xpress::XPRSProblem::Controls::setQCRootAlg ( int newValue )
inline

Set control QCRootAlg.

This control determines which algorithm is to be used to solve the root of a mixed integer quadratic constrained or mixed integer second order cone problem, when outer approximation is used.

Parameters
newValue The new value for QCRootAlg.

setQSimplexOps()

void xpress::XPRSProblem::Controls::setQSimplexOps ( int newValue )
inline

Set control QSimplexOps.

Controls the behavior of the quadratic simplex solvers.

Parameters
newValue The new value for QSimplexOps.

setQuadraticUnshift()

void xpress::XPRSProblem::Controls::setQuadraticUnshift ( int newValue )
inline

Set control QuadraticUnshift.

Determines whether an extra solution purification step is called after a solution found by the quadratic simplex (either primal or dual).

Parameters
newValue The new value for QuadraticUnshift.

setRandomSeed()

void xpress::XPRSProblem::Controls::setRandomSeed ( int newValue )
inline

Set control RandomSeed.

Sets the initial seed to use for the pseudo-random number generator in the Optimizer. The sequence of random numbers is always reset using the seed when starting a new optimization run.

Parameters
newValue The new value for RandomSeed.

setRefactor()

void xpress::XPRSProblem::Controls::setRefactor ( int newValue )
inline

Set control Refactor.

Indicates whether the optimization should restart using the current representation of the factorization in memory.

Parameters
newValue The new value for Refactor.

setRefineOps()

void xpress::XPRSProblem::Controls::setRefineOps ( int newValue )
inline

Set control RefineOps.

This specifies when the solution refiner should be executed to reduce solution infeasibilities. The refiner will attempt to satisfy the target tolerances for all original linear constraints before presolve or scaling has been applied.

Parameters
newValue The new value for RefineOps.

setRelaxTreeMemoryLimit()

void xpress::XPRSProblem::Controls::setRelaxTreeMemoryLimit ( double newValue )
inline

Set control RelaxTreeMemoryLimit.

When the memory used by the branch and bound search tree exceeds the target specified by the TREEMEMORYLIMIT control, the optimizer will try to reduce this by writing nodes to the tree file. In rare cases, usually where the solve has many millions of very small nodes, the tree structural data (which cannot be written to the tree file) will grow large enough to approach or exceed the tree's memory target. When this happens, optimizer performance can degrade greatly as the solver makes heavy use of the tree file in preference to memory. To prevent this, the solver will automatically relax the tree memory limit when it detects this case; the RELAXTREEMEMORYLIMIT control specifies the proportion of the previous memory limit by which to relax it. Set RELAXTREEMEMORYLIMIT to 0.0 to force the Xpress Optimizer to never relax the tree memory limit in this way.

Parameters
newValue The new value for RelaxTreeMemoryLimit.

setRelPivotTol()

void xpress::XPRSProblem::Controls::setRelPivotTol ( double newValue )
inline

Set control RelPivotTol.

Simplex: At each iteration a pivot element is chosen within a given column of the matrix. The relative pivot tolerance, RELPIVOTTOL, is the size of the element chosen relative to the largest possible pivot element in the same column.

Parameters
newValue The new value for RelPivotTol.

setRepairIndefiniteQ()

void xpress::XPRSProblem::Controls::setRepairIndefiniteQ ( xpress::RepairIndefiniteQuadratic newValue )
inline

Set control RepairIndefiniteQ.

Controls if the optimizer should make indefinite quadratic matrices positive definite when it is possible.

Parameters
newValue The new value for RepairIndefiniteQ.

setRepairIndefiniteQMax()

void xpress::XPRSProblem::Controls::setRepairIndefiniteQMax ( double newValue )
inline

Set control RepairIndefiniteQMax.

Parameters
newValue The new value for RepairIndefiniteQMax.

setRepairInfeasMaxTime()

void xpress::XPRSProblem::Controls::setRepairInfeasMaxTime ( int newValue )
inline

Set control RepairInfeasMaxTime.

Overall time limit for the repairinfeas tool

Parameters
newValue The new value for RepairInfeasMaxTime.

setRepairInfeasTimeLimit()

void xpress::XPRSProblem::Controls::setRepairInfeasTimeLimit ( double newValue )
inline

Set control RepairInfeasTimeLimit.

Overall time limit for the repairinfeas tool

Parameters
newValue The new value for RepairInfeasTimeLimit.

setResourceStrategy()

void xpress::XPRSProblem::Controls::setResourceStrategy ( int newValue )
inline

Set control ResourceStrategy.

Controls whether the optimizer is allowed to make nondeterministic decisions if memory is running low in an effort to preserve memory and finish the solve. Available memory (or container limits) are automatically detected but can also be changed by MAXMEMORYSOFT and MAXMEMORYHARD

Parameters
newValue The new value for ResourceStrategy.

setRLTCuts()

void xpress::XPRSProblem::Controls::setRLTCuts ( int newValue )
inline

Set control RLTCuts.

Determines whether RLT cuts should be separated in the Xpress Global Solver.

Parameters
newValue The new value for RLTCuts.

setRootPresolve()

void xpress::XPRSProblem::Controls::setRootPresolve ( int newValue )
inline

Set control RootPresolve.

Determines if presolving should be performed on the problem after the tree search has finished with root cutting and heuristics.

Parameters
newValue The new value for RootPresolve.

setSBBest()

void xpress::XPRSProblem::Controls::setSBBest ( int newValue )
inline

Set control SBBest.

Number of infeasible MIP entities to initialize pseudo costs for on each node.

Parameters
newValue The new value for SBBest.

setSbEffort()

void xpress::XPRSProblem::Controls::setSbEffort ( double newValue )
inline

Set control SbEffort.

Adjusts the overall amount of effort when using strong branching to select an infeasible MIP entity to branch on.

Parameters
newValue The new value for SbEffort.

setSBEstimate()

void xpress::XPRSProblem::Controls::setSBEstimate ( int newValue )
inline

Set control SBEstimate.

Branch and Bound: How to calculate pseudo costs from the local node when selecting an infeasible MIP entity to branch on. These pseudo costs are used in combination with local strong branching and history costs to select the branch candidate.

Parameters
newValue The new value for SBEstimate.

setSBIterLimit()

void xpress::XPRSProblem::Controls::setSBIterLimit ( int newValue )
inline

Set control SBIterLimit.

Number of dual iterations to perform the strong branching for each entity.

Parameters
newValue The new value for SBIterLimit.

setSBSelect()

void xpress::XPRSProblem::Controls::setSBSelect ( int newValue )
inline

Set control SBSelect.

The size of the candidate list of MIP entities for strong branching.

Parameters
newValue The new value for SBSelect.

setScaling()

void xpress::XPRSProblem::Controls::setScaling ( int newValue )
inline

Set control Scaling.

This bit vector control determines how the Optimizer will rescale a model internally before optimization. If set to 0, no scaling will take place.

Parameters
newValue The new value for Scaling.

setSerializePreIntSol()

void xpress::XPRSProblem::Controls::setSerializePreIntSol ( int newValue )
inline

Set control SerializePreIntSol.

Setting SERIALIZEPREINTSOL to 1 will ensure that the preintsol callback is always fired in a deterministic order during a parallel MIP solve. This applies only when the control DETERMINISTIC is set to 1.

Parameters
newValue The new value for SerializePreIntSol.

setSifting()

void xpress::XPRSProblem::Controls::setSifting ( int newValue )
inline

Set control Sifting.

Determines whether to enable sifting algorithm with the dual simplex method.

Parameters
newValue The new value for Sifting.

setSiftPasses()

void xpress::XPRSProblem::Controls::setSiftPasses ( int newValue )
inline

Set control SiftPasses.

Determines how quickly we allow to grow the worker problems during the sifting algorithm. Using larger values can increase the number of columns added to the worker problem which often results in increased solve times for the worker problems but the number of necessary sifting iterations may be reduced.

Parameters
newValue The new value for SiftPasses.

setSiftPresolveOps()

void xpress::XPRSProblem::Controls::setSiftPresolveOps ( int newValue )
inline

Set control SiftPresolveOps.

Determines the presolve operations for solving the subproblems during the sifting algorithm.

Parameters
newValue The new value for SiftPresolveOps.

setSiftSwitch()

void xpress::XPRSProblem::Controls::setSiftSwitch ( int newValue )
inline

Set control SiftSwitch.

Determines which algorithm to use for solving the subproblems during sifting.

Parameters
newValue The new value for SiftSwitch.

setSleepOnThreadWait()

void xpress::XPRSProblem::Controls::setSleepOnThreadWait ( int newValue )
inline

Set control SleepOnThreadWait.

In previous versions this was used to determine if the threads should be put into a wait state when waiting for work.

Parameters
newValue The new value for SleepOnThreadWait.

setSlpAlgorithm()

void xpress::XPRSProblem::Controls::setSlpAlgorithm ( int newValue )
inline

Set control SlpAlgorithm.

Bit map describing the SLP algorithm(s) to be used

Parameters
newValue The new value for SlpAlgorithm.

setSlpAnalyze()

void xpress::XPRSProblem::Controls::setSlpAnalyze ( int newValue )
inline

Set control SlpAnalyze.

Bit map activating additional options supporting model / solution path analyzis

Parameters
newValue The new value for SlpAnalyze.

setSlpATol_A()

void xpress::XPRSProblem::Controls::setSlpATol_A ( double newValue )
inline

Set control SlpATol_A.

Absolute delta convergence tolerance

Parameters
newValue The new value for SlpATol_A.

setSlpATol_R()

void xpress::XPRSProblem::Controls::setSlpATol_R ( double newValue )
inline

Set control SlpATol_R.

Relative delta convergence tolerance

Parameters
newValue The new value for SlpATol_R.

setSlpAugmentation()

void xpress::XPRSProblem::Controls::setSlpAugmentation ( int newValue )
inline

Set control SlpAugmentation.

Bit map describing the SLP augmentation method(s) to be used

Parameters
newValue The new value for SlpAugmentation.

setSlpAutoSave()

void xpress::XPRSProblem::Controls::setSlpAutoSave ( int newValue )
inline

Set control SlpAutoSave.

Frequency with which to save the model

Parameters
newValue The new value for SlpAutoSave.

setSlpBarCrossoverStart()

void xpress::XPRSProblem::Controls::setSlpBarCrossoverStart ( int newValue )
inline

Set control SlpBarCrossoverStart.

Default crossover activation behaviour for barrier start

Parameters
newValue The new value for SlpBarCrossoverStart.

setSlpBarLimit()

void xpress::XPRSProblem::Controls::setSlpBarLimit ( int newValue )
inline

Set control SlpBarLimit.

Number of initial SLP iterations using the barrier method

Parameters
newValue The new value for SlpBarLimit.

setSlpBarStallingLimit()

void xpress::XPRSProblem::Controls::setSlpBarStallingLimit ( int newValue )
inline

Set control SlpBarStallingLimit.

Number of iterations to allow numerical failures in barrier before switching to dual

Parameters
newValue The new value for SlpBarStallingLimit.

setSlpBarStallingObjLimit()

void xpress::XPRSProblem::Controls::setSlpBarStallingObjLimit ( int newValue )
inline

Set control SlpBarStallingObjLimit.

Number of iterations over which to measure the objective change for barrier iterations with no crossover

Parameters
newValue The new value for SlpBarStallingObjLimit.

setSlpBarStallingTol()

void xpress::XPRSProblem::Controls::setSlpBarStallingTol ( double newValue )
inline

Set control SlpBarStallingTol.

Required change in the objective when progress is measured in barrier iterations without crossover

Parameters
newValue The new value for SlpBarStallingTol.

setSlpBarStartOps()

void xpress::XPRSProblem::Controls::setSlpBarStartOps ( int newValue )
inline

Set control SlpBarStartOps.

Controls behaviour when the barrier is used to solve the linearizations

Parameters
newValue The new value for SlpBarStartOps.

setSlpBoundThreshold()

void xpress::XPRSProblem::Controls::setSlpBoundThreshold ( double newValue )
inline

Set control SlpBoundThreshold.

The maximum size of a bound that can be introduced by nonlinear presolve.

Parameters
newValue The new value for SlpBoundThreshold.

setSlpCascade()

void xpress::XPRSProblem::Controls::setSlpCascade ( int newValue )
inline

Set control SlpCascade.

Bit map describing the cascading to be used

Parameters
newValue The new value for SlpCascade.

setSlpCascadeNLimit()

void xpress::XPRSProblem::Controls::setSlpCascadeNLimit ( int newValue )
inline

Set control SlpCascadeNLimit.

Maximum number of iterations for cascading with non-linear determining rows

Parameters
newValue The new value for SlpCascadeNLimit.

setSlpCascadeTol_PA()

void xpress::XPRSProblem::Controls::setSlpCascadeTol_PA ( double newValue )
inline

Set control SlpCascadeTol_PA.

Absolute cascading print tolerance

Parameters
newValue The new value for SlpCascadeTol_PA.

setSlpCascadeTol_PR()

void xpress::XPRSProblem::Controls::setSlpCascadeTol_PR ( double newValue )
inline

Set control SlpCascadeTol_PR.

Relative cascading print tolerance

Parameters
newValue The new value for SlpCascadeTol_PR.

setSlpCDTol_A()

void xpress::XPRSProblem::Controls::setSlpCDTol_A ( double newValue )
inline

Set control SlpCDTol_A.

Absolute tolerance for deducing constant derivatives

Parameters
newValue The new value for SlpCDTol_A.

setSlpCDTol_R()

void xpress::XPRSProblem::Controls::setSlpCDTol_R ( double newValue )
inline

Set control SlpCDTol_R.

Relative tolerance for deducing constant derivatives

Parameters
newValue The new value for SlpCDTol_R.

setSlpClampShrink()

void xpress::XPRSProblem::Controls::setSlpClampShrink ( double newValue )
inline

Set control SlpClampShrink.

Shrink ratio used to impose strict convergence on variables converged in extended criteria only

Parameters
newValue The new value for SlpClampShrink.

setSlpClampValidationTol_A()

void xpress::XPRSProblem::Controls::setSlpClampValidationTol_A ( double newValue )
inline

Set control SlpClampValidationTol_A.

Absolute validation tolerance for applying XSLP_CLAMPSHRINK

Parameters
newValue The new value for SlpClampValidationTol_A.

setSlpClampValidationTol_R()

void xpress::XPRSProblem::Controls::setSlpClampValidationTol_R ( double newValue )
inline

Set control SlpClampValidationTol_R.

Relative validation tolerance for applying XSLP_CLAMPSHRINK

Parameters
newValue The new value for SlpClampValidationTol_R.

setSlpConvergenceOps()

void xpress::XPRSProblem::Controls::setSlpConvergenceOps ( int newValue )
inline

Set control SlpConvergenceOps.

Bit map describing which convergence tests should be carried out

Parameters
newValue The new value for SlpConvergenceOps.

setSlpCTol()

void xpress::XPRSProblem::Controls::setSlpCTol ( double newValue )
inline

Set control SlpCTol.

Closure convergence tolerance

Parameters
newValue The new value for SlpCTol.

setSlpCutStrategy()

void xpress::XPRSProblem::Controls::setSlpCutStrategy ( int newValue )
inline

Set control SlpCutStrategy.

Determines whihc cuts to apply in the MISLP search when the default SLP-in-MIP strategy is used.

Parameters
newValue The new value for SlpCutStrategy.

setSlpDamp()

void xpress::XPRSProblem::Controls::setSlpDamp ( double newValue )
inline

Set control SlpDamp.

Damping factor for updating values of variables

Parameters
newValue The new value for SlpDamp.

setSlpDampExpand()

void xpress::XPRSProblem::Controls::setSlpDampExpand ( double newValue )
inline

Set control SlpDampExpand.

Multiplier to increase damping factor during dynamic damping

Parameters
newValue The new value for SlpDampExpand.

setSlpDampMax()

void xpress::XPRSProblem::Controls::setSlpDampMax ( double newValue )
inline

Set control SlpDampMax.

Maximum value for the damping factor of a variable during dynamic damping

Parameters
newValue The new value for SlpDampMax.

setSlpDampMin()

void xpress::XPRSProblem::Controls::setSlpDampMin ( double newValue )
inline

Set control SlpDampMin.

Minimum value for the damping factor of a variable during dynamic damping

Parameters
newValue The new value for SlpDampMin.

setSlpDampShrink()

void xpress::XPRSProblem::Controls::setSlpDampShrink ( double newValue )
inline

Set control SlpDampShrink.

Multiplier to decrease damping factor during dynamic damping

Parameters
newValue The new value for SlpDampShrink.

setSlpDampStart()

void xpress::XPRSProblem::Controls::setSlpDampStart ( int newValue )
inline

Set control SlpDampStart.

SLP iteration at which damping is activated

Parameters
newValue The new value for SlpDampStart.

setSlpDefaultStepBound()

void xpress::XPRSProblem::Controls::setSlpDefaultStepBound ( double newValue )
inline

Set control SlpDefaultStepBound.

Minimum initial value for the step bound of an SLP variable if none is explicitly given

Parameters
newValue The new value for SlpDefaultStepBound.

setSlpDelayUpdateRows()

void xpress::XPRSProblem::Controls::setSlpDelayUpdateRows ( int newValue )
inline

Set control SlpDelayUpdateRows.

Number of SLP iterations before update rows are fully activated

Parameters
newValue The new value for SlpDelayUpdateRows.

setSlpDelta_A()

void xpress::XPRSProblem::Controls::setSlpDelta_A ( double newValue )
inline

Set control SlpDelta_A.

Absolute perturbation of values for calculating numerical derivatives

Parameters
newValue The new value for SlpDelta_A.

setSlpDelta_Infinity()

void xpress::XPRSProblem::Controls::setSlpDelta_Infinity ( double newValue )
inline

Set control SlpDelta_Infinity.

Maximum value for partial derivatives

Parameters
newValue The new value for SlpDelta_Infinity.

setSlpDelta_R()

void xpress::XPRSProblem::Controls::setSlpDelta_R ( double newValue )
inline

Set control SlpDelta_R.

Relative perturbation of values for calculating numerical derivatives

Parameters
newValue The new value for SlpDelta_R.

setSlpDelta_X()

void xpress::XPRSProblem::Controls::setSlpDelta_X ( double newValue )
inline

Set control SlpDelta_X.

Minimum absolute value of delta coefficients to be retained

Parameters
newValue The new value for SlpDelta_X.

setSlpDelta_Z()

void xpress::XPRSProblem::Controls::setSlpDelta_Z ( double newValue )
inline

Set control SlpDelta_Z.

Tolerance used when calculating derivatives

Parameters
newValue The new value for SlpDelta_Z.

setSlpDelta_Zero()

void xpress::XPRSProblem::Controls::setSlpDelta_Zero ( double newValue )
inline

Set control SlpDelta_Zero.

Absolute zero acceptance tolerance used when calculating derivatives

Parameters
newValue The new value for SlpDelta_Zero.

setSlpDeltaCost()

void xpress::XPRSProblem::Controls::setSlpDeltaCost ( double newValue )
inline

Set control SlpDeltaCost.

Initial penalty cost multiplier for penalty delta vectors

Parameters
newValue The new value for SlpDeltaCost.

setSlpDeltaCostFactor()

void xpress::XPRSProblem::Controls::setSlpDeltaCostFactor ( double newValue )
inline

Set control SlpDeltaCostFactor.

Factor for increasing cost multiplier on total penalty delta vectors

Parameters
newValue The new value for SlpDeltaCostFactor.

setSlpDeltaMaxCost()

void xpress::XPRSProblem::Controls::setSlpDeltaMaxCost ( double newValue )
inline

Set control SlpDeltaMaxCost.

Maximum penalty cost multiplier for penalty delta vectors

Parameters
newValue The new value for SlpDeltaMaxCost.

setSlpDeltaOffset()

void xpress::XPRSProblem::Controls::setSlpDeltaOffset ( int newValue )
inline

Set control SlpDeltaOffset.

Position of first character of SLP variable name used to create name of delta vector

Parameters
newValue The new value for SlpDeltaOffset.

setSlpDeltaZLimit()

void xpress::XPRSProblem::Controls::setSlpDeltaZLimit ( int newValue )
inline

Set control SlpDeltaZLimit.

Number of SLP iterations during which to apply XSLP_DELTA_Z

Parameters
newValue The new value for SlpDeltaZLimit.

setSlpDJTol()

void xpress::XPRSProblem::Controls::setSlpDJTol ( double newValue )
inline

Set control SlpDJTol.

Tolerance on DJ value for determining if a variable is at its step bound

Parameters
newValue The new value for SlpDJTol.

setSlpDRColDjTol()

void xpress::XPRSProblem::Controls::setSlpDRColDjTol ( double newValue )
inline

Set control SlpDRColDjTol.

Reduced cost tolerance on the delta variable when fixing due to the determining column being below XSLP_DRCOLTOL.

Parameters
newValue The new value for SlpDRColDjTol.

setSlpDRColTol()

void xpress::XPRSProblem::Controls::setSlpDRColTol ( double newValue )
inline

Set control SlpDRColTol.

The minimum absolute magnitude of a determining column, for which the determined variable is still regarded as well defined

Parameters
newValue The new value for SlpDRColTol.

setSlpDRFixRange()

void xpress::XPRSProblem::Controls::setSlpDRFixRange ( double newValue )
inline

Set control SlpDRFixRange.

The range around the previous value where variables are fixed in cascading if the determining column is below XSLP_DRCOLTOL.

Parameters
newValue The new value for SlpDRFixRange.

setSlpECFCheck()

void xpress::XPRSProblem::Controls::setSlpECFCheck ( int newValue )
inline

Set control SlpECFCheck.

Check feasibility at the point of linearization for extended convergence criteria

Parameters
newValue The new value for SlpECFCheck.

setSlpEcfTol_A()

void xpress::XPRSProblem::Controls::setSlpEcfTol_A ( double newValue )
inline

Set control SlpEcfTol_A.

Absolute tolerance on testing feasibility at the point of linearization

Parameters
newValue The new value for SlpEcfTol_A.

setSlpEcfTol_R()

void xpress::XPRSProblem::Controls::setSlpEcfTol_R ( double newValue )
inline

Set control SlpEcfTol_R.

Relative tolerance on testing feasibility at the point of linearization

Parameters
newValue The new value for SlpEcfTol_R.

setSlpEnforceCostShrink()

void xpress::XPRSProblem::Controls::setSlpEnforceCostShrink ( double newValue )
inline

Set control SlpEnforceCostShrink.

Factor by which to decrease the current penalty multiplier when enforcing rows.

Parameters
newValue The new value for SlpEnforceCostShrink.

setSlpEnforceMaxCost()

void xpress::XPRSProblem::Controls::setSlpEnforceMaxCost ( double newValue )
inline

Set control SlpEnforceMaxCost.

Maximum penalty cost in the objective before enforcing most violating rows

Parameters
newValue The new value for SlpEnforceMaxCost.

setSlpErrorCost()

void xpress::XPRSProblem::Controls::setSlpErrorCost ( double newValue )
inline

Set control SlpErrorCost.

Initial penalty cost multiplier for penalty error vectors

Parameters
newValue The new value for SlpErrorCost.

setSlpErrorCostFactor()

void xpress::XPRSProblem::Controls::setSlpErrorCostFactor ( double newValue )
inline

Set control SlpErrorCostFactor.

Factor for increasing cost multiplier on total penalty error vectors

Parameters
newValue The new value for SlpErrorCostFactor.

setSlpErrorMaxCost()

void xpress::XPRSProblem::Controls::setSlpErrorMaxCost ( double newValue )
inline

Set control SlpErrorMaxCost.

Maximum penalty cost multiplier for penalty error vectors

Parameters
newValue The new value for SlpErrorMaxCost.

setSlpErrorOffset()

void xpress::XPRSProblem::Controls::setSlpErrorOffset ( int newValue )
inline

Set control SlpErrorOffset.

Position of first character of constraint name used to create name of penalty error vectors

Parameters
newValue The new value for SlpErrorOffset.

setSlpErrorTol_A()

void xpress::XPRSProblem::Controls::setSlpErrorTol_A ( double newValue )
inline

Set control SlpErrorTol_A.

Absolute tolerance for error vectors

Parameters
newValue The new value for SlpErrorTol_A.

setSlpErrorTol_P()

void xpress::XPRSProblem::Controls::setSlpErrorTol_P ( double newValue )
inline

Set control SlpErrorTol_P.

Absolute tolerance for printing error vectors

Parameters
newValue The new value for SlpErrorTol_P.

setSlpEscalation()

void xpress::XPRSProblem::Controls::setSlpEscalation ( double newValue )
inline

Set control SlpEscalation.

Factor for increasing cost multiplier on individual penalty error vectors

Parameters
newValue The new value for SlpEscalation.

setSlpETol_A()

void xpress::XPRSProblem::Controls::setSlpETol_A ( double newValue )
inline

Set control SlpETol_A.

Absolute tolerance on penalty vectors

Parameters
newValue The new value for SlpETol_A.

setSlpETol_R()

void xpress::XPRSProblem::Controls::setSlpETol_R ( double newValue )
inline

Set control SlpETol_R.

Relative tolerance on penalty vectors

Parameters
newValue The new value for SlpETol_R.

setSlpEVTol_A()

void xpress::XPRSProblem::Controls::setSlpEVTol_A ( double newValue )
inline

Set control SlpEVTol_A.

Absolute tolerance on total penalty costs

Parameters
newValue The new value for SlpEVTol_A.

setSlpEVTol_R()

void xpress::XPRSProblem::Controls::setSlpEVTol_R ( double newValue )
inline

Set control SlpEVTol_R.

Relative tolerance on total penalty costs

Parameters
newValue The new value for SlpEVTol_R.

setSlpExpand()

void xpress::XPRSProblem::Controls::setSlpExpand ( double newValue )
inline

Set control SlpExpand.

Multiplier to increase a step bound

Parameters
newValue The new value for SlpExpand.

setSlpFeastolTarget()

void xpress::XPRSProblem::Controls::setSlpFeastolTarget ( double newValue )
inline

Set control SlpFeastolTarget.

When set, this defines a target feasibility tolerance to which the linearizations are solved to

Parameters
newValue The new value for SlpFeastolTarget.

setSlpFilter()

void xpress::XPRSProblem::Controls::setSlpFilter ( int newValue )
inline

Set control SlpFilter.

Bit map for controlling solution updates

Parameters
newValue The new value for SlpFilter.

setSlpGranularity()

void xpress::XPRSProblem::Controls::setSlpGranularity ( double newValue )
inline

Set control SlpGranularity.

Base for calculating penalty costs

Parameters
newValue The new value for SlpGranularity.

setSlpGridHeurSelect()

void xpress::XPRSProblem::Controls::setSlpGridHeurSelect ( int newValue )
inline

Set control SlpGridHeurSelect.

Bit map selectin which heuristics to run if the problem has variable with an integer delta

Parameters
newValue The new value for SlpGridHeurSelect.

setSlpHeurStrategy()

void xpress::XPRSProblem::Controls::setSlpHeurStrategy ( int newValue )
inline

Set control SlpHeurStrategy.

Branch and Bound: This specifies the MINLP heuristic strategy. On some problems it is worth trying more comprehensive heuristic strategies by setting HEURSTRATEGY to 2 or 3.

Parameters
newValue The new value for SlpHeurStrategy.

setSlpInfeasLimit()

void xpress::XPRSProblem::Controls::setSlpInfeasLimit ( int newValue )
inline

Set control SlpInfeasLimit.

The maximum number of consecutive infeasible SLP iterations which can occur before Xpress-SLP terminates

Parameters
newValue The new value for SlpInfeasLimit.

setSlpIterLimit()

void xpress::XPRSProblem::Controls::setSlpIterLimit ( int newValue )
inline

Set control SlpIterLimit.

The maximum number of SLP iterations

Parameters
newValue The new value for SlpIterLimit.

setSlpItol_A()

void xpress::XPRSProblem::Controls::setSlpItol_A ( double newValue )
inline

Set control SlpItol_A.

Absolute impact convergence tolerance

Parameters
newValue The new value for SlpItol_A.

setSlpITol_R()

void xpress::XPRSProblem::Controls::setSlpITol_R ( double newValue )
inline

Set control SlpITol_R.

Relative impact convergence tolerance

Parameters
newValue The new value for SlpITol_R.

setSlpLSIterLimit()

void xpress::XPRSProblem::Controls::setSlpLSIterLimit ( int newValue )
inline

Set control SlpLSIterLimit.

Number of iterations in the line search

Parameters
newValue The new value for SlpLSIterLimit.

setSlpLSPatternLimit()

void xpress::XPRSProblem::Controls::setSlpLSPatternLimit ( int newValue )
inline

Set control SlpLSPatternLimit.

Number of iterations in the pattern search preceding the line search

Parameters
newValue The new value for SlpLSPatternLimit.

setSlpLSStart()

void xpress::XPRSProblem::Controls::setSlpLSStart ( int newValue )
inline

Set control SlpLSStart.

Iteration in which to active the line search

Parameters
newValue The new value for SlpLSStart.

setSlpLSZeroLimit()

void xpress::XPRSProblem::Controls::setSlpLSZeroLimit ( int newValue )
inline

Set control SlpLSZeroLimit.

Maximum number of zero length line search steps before line search is deactivated

Parameters
newValue The new value for SlpLSZeroLimit.

setSlpMatrixTol()

void xpress::XPRSProblem::Controls::setSlpMatrixTol ( double newValue )
inline

Set control SlpMatrixTol.

Nonzero tolerance for dropping coefficients from the linearization.

Parameters
newValue The new value for SlpMatrixTol.

setSlpMaxWeight()

void xpress::XPRSProblem::Controls::setSlpMaxWeight ( double newValue )
inline

Set control SlpMaxWeight.

Maximum penalty weight for delta or error vectors

Parameters
newValue The new value for SlpMaxWeight.

setSlpMinSBFactor()

void xpress::XPRSProblem::Controls::setSlpMinSBFactor ( double newValue )
inline

Set control SlpMinSBFactor.

Factor by which step bounds can be decreased beneath XSLP_ATOL_A

Parameters
newValue The new value for SlpMinSBFactor.

setSlpMinWeight()

void xpress::XPRSProblem::Controls::setSlpMinWeight ( double newValue )
inline

Set control SlpMinWeight.

Minimum penalty weight for delta or error vectors

Parameters
newValue The new value for SlpMinWeight.

setSlpMipAlgorithm()

void xpress::XPRSProblem::Controls::setSlpMipAlgorithm ( int newValue )
inline

Set control SlpMipAlgorithm.

Bitmap describing the MISLP algorithms to be used

Parameters
newValue The new value for SlpMipAlgorithm.

setSlpMipCutoff_A()

void xpress::XPRSProblem::Controls::setSlpMipCutoff_A ( double newValue )
inline

Set control SlpMipCutoff_A.

Absolute objective function cutoff for MIP termination

Parameters
newValue The new value for SlpMipCutoff_A.

setSlpMipCutoff_R()

void xpress::XPRSProblem::Controls::setSlpMipCutoff_R ( double newValue )
inline

Set control SlpMipCutoff_R.

Absolute objective function cutoff for MIP termination

Parameters
newValue The new value for SlpMipCutoff_R.

setSlpMipCutOffCount()

void xpress::XPRSProblem::Controls::setSlpMipCutOffCount ( int newValue )
inline

Set control SlpMipCutOffCount.

Number of SLP iterations to check when considering a node for cutting off

Parameters
newValue The new value for SlpMipCutOffCount.

setSlpMipCutoffLimit()

void xpress::XPRSProblem::Controls::setSlpMipCutoffLimit ( int newValue )
inline

Set control SlpMipCutoffLimit.

Number of SLP iterations to check when considering a node for cutting off

Parameters
newValue The new value for SlpMipCutoffLimit.

setSlpMipDefaultAlgorithm()

void xpress::XPRSProblem::Controls::setSlpMipDefaultAlgorithm ( int newValue )
inline

Set control SlpMipDefaultAlgorithm.

Default algorithm to be used during the tree search in MISLP

Parameters
newValue The new value for SlpMipDefaultAlgorithm.

setSlpMipErrorTol_A()

void xpress::XPRSProblem::Controls::setSlpMipErrorTol_A ( double newValue )
inline

Set control SlpMipErrorTol_A.

Absolute penalty error cost tolerance for MIP cut-off

Parameters
newValue The new value for SlpMipErrorTol_A.

setSlpMipErrorTol_R()

void xpress::XPRSProblem::Controls::setSlpMipErrorTol_R ( double newValue )
inline

Set control SlpMipErrorTol_R.

Relative penalty error cost tolerance for MIP cut-off

Parameters
newValue The new value for SlpMipErrorTol_R.

setSlpMipFixStepBounds()

void xpress::XPRSProblem::Controls::setSlpMipFixStepBounds ( int newValue )
inline

Set control SlpMipFixStepBounds.

Bitmap describing the step-bound fixing strategy during MISLP

Parameters
newValue The new value for SlpMipFixStepBounds.

setSlpMipIterLimit()

void xpress::XPRSProblem::Controls::setSlpMipIterLimit ( int newValue )
inline

Set control SlpMipIterLimit.

Maximum number of SLP iterations at each node

Parameters
newValue The new value for SlpMipIterLimit.

setSlpMipLog()

void xpress::XPRSProblem::Controls::setSlpMipLog ( int newValue )
inline

Set control SlpMipLog.

Frequency with which MIP status is printed

Parameters
newValue The new value for SlpMipLog.

setSlpMipOCount()

void xpress::XPRSProblem::Controls::setSlpMipOCount ( int newValue )
inline

Set control SlpMipOCount.

Number of SLP iterations at each node over which to measure objective function variation

Parameters
newValue The new value for SlpMipOCount.

setSlpMipOtol_A()

void xpress::XPRSProblem::Controls::setSlpMipOtol_A ( double newValue )
inline

Set control SlpMipOtol_A.

Absolute objective function tolerance for MIP termination

Parameters
newValue The new value for SlpMipOtol_A.

setSlpMipOtol_R()

void xpress::XPRSProblem::Controls::setSlpMipOtol_R ( double newValue )
inline

Set control SlpMipOtol_R.

Relative objective function tolerance for MIP termination

Parameters
newValue The new value for SlpMipOtol_R.

setSlpMipRelaxStepBounds()

void xpress::XPRSProblem::Controls::setSlpMipRelaxStepBounds ( int newValue )
inline

Set control SlpMipRelaxStepBounds.

Bitmap describing the step-bound relaxation strategy during MISLP

Parameters
newValue The new value for SlpMipRelaxStepBounds.

setSlpMTol_A()

void xpress::XPRSProblem::Controls::setSlpMTol_A ( double newValue )
inline

Set control SlpMTol_A.

Absolute effective matrix element convergence tolerance

Parameters
newValue The new value for SlpMTol_A.

setSlpMTol_R()

void xpress::XPRSProblem::Controls::setSlpMTol_R ( double newValue )
inline

Set control SlpMTol_R.

Relative effective matrix element convergence tolerance

Parameters
newValue The new value for SlpMTol_R.

setSlpMVTol()

void xpress::XPRSProblem::Controls::setSlpMVTol ( double newValue )
inline

Set control SlpMVTol.

Marginal value tolerance for determining if a constraint is slack

Parameters
newValue The new value for SlpMVTol.

setSlpObjThreshold()

void xpress::XPRSProblem::Controls::setSlpObjThreshold ( double newValue )
inline

Set control SlpObjThreshold.

Assumed maximum value of the objective function in absolute value.

Parameters
newValue The new value for SlpObjThreshold.

setSlpObjToPenaltyCost()

void xpress::XPRSProblem::Controls::setSlpObjToPenaltyCost ( double newValue )
inline

Set control SlpObjToPenaltyCost.

Factor to estimate initial penalty costs from objective function

Parameters
newValue The new value for SlpObjToPenaltyCost.

setSlpOCount()

void xpress::XPRSProblem::Controls::setSlpOCount ( int newValue )
inline

Set control SlpOCount.

Number of SLP iterations over which to measure objective function variation for static objective (2) convergence criterion

Parameters
newValue The new value for SlpOCount.

setSlpOptimalityTolTarget()

void xpress::XPRSProblem::Controls::setSlpOptimalityTolTarget ( double newValue )
inline

Set control SlpOptimalityTolTarget.

When set, this defines a target optimality tolerance to which the linearizations are solved to

Parameters
newValue The new value for SlpOptimalityTolTarget.

setSlpOTol_A()

void xpress::XPRSProblem::Controls::setSlpOTol_A ( double newValue )
inline

Set control SlpOTol_A.

Absolute static objective (2) convergence tolerance

Parameters
newValue The new value for SlpOTol_A.

setSlpOTol_R()

void xpress::XPRSProblem::Controls::setSlpOTol_R ( double newValue )
inline

Set control SlpOTol_R.

Relative static objective (2) convergence tolerance

Parameters
newValue The new value for SlpOTol_R.

setSlpPenaltyInfoStart()

void xpress::XPRSProblem::Controls::setSlpPenaltyInfoStart ( int newValue )
inline

Set control SlpPenaltyInfoStart.

Iteration from which to record row penalty information

Parameters
newValue The new value for SlpPenaltyInfoStart.

setSlpSameCount()

void xpress::XPRSProblem::Controls::setSlpSameCount ( int newValue )
inline

Set control SlpSameCount.

Number of steps reaching the step bound in the same direction before step bounds are increased

Parameters
newValue The new value for SlpSameCount.

setSlpSameDamp()

void xpress::XPRSProblem::Controls::setSlpSameDamp ( int newValue )
inline

Set control SlpSameDamp.

Number of steps in same direction before damping factor is increased

Parameters
newValue The new value for SlpSameDamp.

setSlpSBRowOffset()

void xpress::XPRSProblem::Controls::setSlpSBRowOffset ( int newValue )
inline

Set control SlpSBRowOffset.

Position of first character of SLP variable name used to create name of SLP lower and upper step bound rows

Parameters
newValue The new value for SlpSBRowOffset.

setSlpSBStart()

void xpress::XPRSProblem::Controls::setSlpSBStart ( int newValue )
inline

Set control SlpSBStart.

SLP iteration after which step bounds are first applied

Parameters
newValue The new value for SlpSBStart.

setSlpShrink()

void xpress::XPRSProblem::Controls::setSlpShrink ( double newValue )
inline

Set control SlpShrink.

Multiplier to reduce a step bound

Parameters
newValue The new value for SlpShrink.

setSlpShrinkBias()

void xpress::XPRSProblem::Controls::setSlpShrinkBias ( double newValue )
inline

Set control SlpShrinkBias.

Defines an overwrite / adjustment of step bounds for improving iterations

Parameters
newValue The new value for SlpShrinkBias.

setSlpSTol_A()

void xpress::XPRSProblem::Controls::setSlpSTol_A ( double newValue )
inline

Set control SlpSTol_A.

Absolute slack convergence tolerance

Parameters
newValue The new value for SlpSTol_A.

setSlpSTol_R()

void xpress::XPRSProblem::Controls::setSlpSTol_R ( double newValue )
inline

Set control SlpSTol_R.

Relative slack convergence tolerance

Parameters
newValue The new value for SlpSTol_R.

setSlpTraceMaskOps()

void xpress::XPRSProblem::Controls::setSlpTraceMaskOps ( int newValue )
inline

Set control SlpTraceMaskOps.

Controls the information printed for XSLP_TRACEMASK. The order in which the information is printed is determined by the order of bits in XSLP_TRACEMASKOPS.

Parameters
newValue The new value for SlpTraceMaskOps.

setSlpUnFinishedLimit()

void xpress::XPRSProblem::Controls::setSlpUnFinishedLimit ( int newValue )
inline

Set control SlpUnFinishedLimit.

The number of consecutive SLP iterations that may have an unfinished status before the solve is terminated.

Parameters
newValue The new value for SlpUnFinishedLimit.

setSlpUpdateOffset()

void xpress::XPRSProblem::Controls::setSlpUpdateOffset ( int newValue )
inline

Set control SlpUpdateOffset.

Position of first character of SLP variable name used to create name of SLP update row

Parameters
newValue The new value for SlpUpdateOffset.

setSlpVCount()

void xpress::XPRSProblem::Controls::setSlpVCount ( int newValue )
inline

Set control SlpVCount.

Number of SLP iterations over which to measure static objective (3) convergence

Parameters
newValue The new value for SlpVCount.

setSlpVLimit()

void xpress::XPRSProblem::Controls::setSlpVLimit ( int newValue )
inline

Set control SlpVLimit.

Number of SLP iterations after which static objective (3) convergence testing starts

Parameters
newValue The new value for SlpVLimit.

setSlpVTol_A()

void xpress::XPRSProblem::Controls::setSlpVTol_A ( double newValue )
inline

Set control SlpVTol_A.

Absolute static objective (3) convergence tolerance

Parameters
newValue The new value for SlpVTol_A.

setSlpVTol_R()

void xpress::XPRSProblem::Controls::setSlpVTol_R ( double newValue )
inline

Set control SlpVTol_R.

Relative static objective (3) convergence tolerance

Parameters
newValue The new value for SlpVTol_R.

setSlpWCount()

void xpress::XPRSProblem::Controls::setSlpWCount ( int newValue )
inline

Set control SlpWCount.

Number of SLP iterations over which to measure the objective for the extended convergence continuation criterion

Parameters
newValue The new value for SlpWCount.

setSlpWTol_A()

void xpress::XPRSProblem::Controls::setSlpWTol_A ( double newValue )
inline

Set control SlpWTol_A.

Absolute extended convergence continuation tolerance

Parameters
newValue The new value for SlpWTol_A.

setSlpWTol_R()

void xpress::XPRSProblem::Controls::setSlpWTol_R ( double newValue )
inline

Set control SlpWTol_R.

Relative extended convergence continuation tolerance

Parameters
newValue The new value for SlpWTol_R.

setSlpXCount()

void xpress::XPRSProblem::Controls::setSlpXCount ( int newValue )
inline

Set control SlpXCount.

Number of SLP iterations over which to measure static objective (1) convergence

Parameters
newValue The new value for SlpXCount.

setSlpXLimit()

void xpress::XPRSProblem::Controls::setSlpXLimit ( int newValue )
inline

Set control SlpXLimit.

Number of SLP iterations up to which static objective (1) convergence testing starts

Parameters
newValue The new value for SlpXLimit.

setSlpXTol_A()

void xpress::XPRSProblem::Controls::setSlpXTol_A ( double newValue )
inline

Set control SlpXTol_A.

Absolute static objective function (1) tolerance

Parameters
newValue The new value for SlpXTol_A.

setSlpXTol_R()

void xpress::XPRSProblem::Controls::setSlpXTol_R ( double newValue )
inline

Set control SlpXTol_R.

Relative static objective function (1) tolerance

Parameters
newValue The new value for SlpXTol_R.

setSlpZeroCriterion()

void xpress::XPRSProblem::Controls::setSlpZeroCriterion ( int newValue )
inline

Set control SlpZeroCriterion.

Bitmap determining the behavior of the placeholder deletion procedure

Parameters
newValue The new value for SlpZeroCriterion.

setSlpZeroCriterionCount()

void xpress::XPRSProblem::Controls::setSlpZeroCriterionCount ( int newValue )
inline

Set control SlpZeroCriterionCount.

Number of consecutive times a placeholder entry is zero before being considered for deletion

Parameters
newValue The new value for SlpZeroCriterionCount.

setSlpZeroCriterionStart()

void xpress::XPRSProblem::Controls::setSlpZeroCriterionStart ( int newValue )
inline

Set control SlpZeroCriterionStart.

SLP iteration at which criteria for deletion of placeholder entries are first activated.

Parameters
newValue The new value for SlpZeroCriterionStart.

setSolTimeLimit()

void xpress::XPRSProblem::Controls::setSolTimeLimit ( double newValue )
inline

Set control SolTimeLimit.

The maximum time in seconds that the Optimizer will run a MIP solve before it terminates, given that a solution has been found. As long as no solution has been found, this control will have no effect.

Parameters
newValue The new value for SolTimeLimit.

setSosRefTol()

void xpress::XPRSProblem::Controls::setSosRefTol ( double newValue )
inline

Set control SosRefTol.

The minimum relative gap between the ordering values of elements in a special ordered set. The gap divided by the absolute value of the larger of the two adjacent values must be at least SOSREFTOL.

Parameters
newValue The new value for SosRefTol.

setSymmetry()

void xpress::XPRSProblem::Controls::setSymmetry ( int newValue )
inline

Set control Symmetry.

Adjusts the overall amount of effort for symmetry detection.

Parameters
newValue The new value for Symmetry.

setSymSelect()

void xpress::XPRSProblem::Controls::setSymSelect ( int newValue )
inline

Set control SymSelect.

Adjusts the overall amount of effort for symmetry detection.

Parameters
newValue The new value for SymSelect.

setThreads()

void xpress::XPRSProblem::Controls::setThreads ( int newValue )
inline

Set control Threads.

The default number of threads used during optimization.

Parameters
newValue The new value for Threads.

setTimeLimit()

void xpress::XPRSProblem::Controls::setTimeLimit ( double newValue )
inline

Set control TimeLimit.

The maximum time in seconds that the Optimizer will run before it terminates, including the problem setup time and solution time. For MIP problems, this is the total time taken to solve all nodes.

Parameters
newValue The new value for TimeLimit.

setTrace()

void xpress::XPRSProblem::Controls::setTrace ( int newValue )
inline

Set control Trace.

Display the infeasibility diagnosis during presolve. If non-zero, an explanation of the logical deductions made by presolve to deduce infeasibility or unboundedness will be displayed on screen or sent to the message callback function.

Parameters
newValue The new value for Trace.

setTreeCompression()

void xpress::XPRSProblem::Controls::setTreeCompression ( int newValue )
inline

Set control TreeCompression.

When writing nodes to the gloal file, the optimizer can try to use data-compression techniques to reduce the size of the tree file on disk. The TREECOMPRESSION control determines the strength of the data-compression algorithm used; higher values give superior data-compression at the affect of decreasing performance, while lower values compress quicker but not as effectively. Where TREECOMPRESSION is set to 0, no data compression will be used on the tree file.

Parameters
newValue The new value for TreeCompression.

setTreeCoverCuts()

void xpress::XPRSProblem::Controls::setTreeCoverCuts ( int newValue )
inline

Set control TreeCoverCuts.

Branch and Bound: The number of rounds of lifted cover inequalities generated at nodes other than the top node in the tree. Compare with the description for COVERCUTS. A value of -1 indicates the number of rounds is determined automatically.

Parameters
newValue The new value for TreeCoverCuts.

setTreeCutSelect()

void xpress::XPRSProblem::Controls::setTreeCutSelect ( int newValue )
inline

Set control TreeCutSelect.

A bit vector providing detailed control of the cuts created during the tree search of a MIP solve. Use CUTSELECT to control cuts on the root node.

Parameters
newValue The new value for TreeCutSelect.

setTreeDiagnostics()

void xpress::XPRSProblem::Controls::setTreeDiagnostics ( int newValue )
inline

Set control TreeDiagnostics.

A bit vector providing control over how various tree-management-related messages get printed in the tree log file during the branch-and-bound search.

Parameters
newValue The new value for TreeDiagnostics.

setTreeFileLogInterval()

void xpress::XPRSProblem::Controls::setTreeFileLogInterval ( int newValue )
inline

Set control TreeFileLogInterval.

This control sets the interval between progress messages output while writing tree data to the tree file, in seconds. The solve is slowed greatly while data is being written to the tree file and this output allows the user to see how much progress is being made.

Parameters
newValue The new value for TreeFileLogInterval.

setTreeGomCuts()

void xpress::XPRSProblem::Controls::setTreeGomCuts ( int newValue )
inline

Set control TreeGomCuts.

Branch and Bound: The number of rounds of Gomory cuts generated at nodes other than the first node in the tree. Compare with the description for GOMCUTS. A value of -1 indicates the number of rounds is determined automatically.

Parameters
newValue The new value for TreeGomCuts.

setTreeMemoryLimit()

void xpress::XPRSProblem::Controls::setTreeMemoryLimit ( int newValue )
inline

Set control TreeMemoryLimit.

A soft limit, in megabytes, for the amount of memory to use in storing the branch and bound search tree. This doesn't include memory used for presolve, heuristics, solving the LP relaxation, etc. When set to 0 (the default), the optimizer will calculate a limit automatically based on the amount of free physical memory detected in the machine. When the memory used by the branch and bound tree exceeds this limit, the optimizer will try to reduce the memory usage by writing lower-rated sections of the tree to a file called the "tree file". Though the solve can continue if it cannot bring the tree memory usage below the specified limit, performance will be inhibited and a message will be printed to the log.

Parameters
newValue The new value for TreeMemoryLimit.

setTreeMemorySavingTarget()

void xpress::XPRSProblem::Controls::setTreeMemorySavingTarget ( double newValue )
inline

Set control TreeMemorySavingTarget.

When the memory used by the branch-and-bound search tree exceeds the limit specified by the TREEMEMORYLIMIT control, the optimizer will try to save memory by writing lower-rated sections of the tree to the tree file. The target amount of memory to save will be enough to bring memory usage back below the limit, plus enough extra to give the tree room to grow. The TREEMEMORYSAVINGTARGET control specifies the extra proportion of the tree's size to try to save; for example, if the tree memory limit is 1000Mb and TREEMEMORYSAVINGTARGET is 0.1, when the tree size exceeds 1000Mb the optimizer will try to reduce the tree size to 900Mb. Reducing the value of TREEMEMORYSAVINGTARGET will cause less extra nodes of the tree to be written to the tree file, but will result in the memory saving routine being triggered more often (as the tree will have less room in which to grow), which can reduce performance. Increasing the value of TREEMEMORYSAVINGTARGET will cause additional, more highly-rated nodes, of the tree to be written to the tree file, which can cause performance issues if these nodes are required later in the solve.

Parameters
newValue The new value for TreeMemorySavingTarget.

setTreeQCCuts()

void xpress::XPRSProblem::Controls::setTreeQCCuts ( int newValue )
inline

Set control TreeQCCuts.

Branch and Bound: Limit on the number of rounds of outer approximation cuts generated for nodes other than the root node, when solving a mixed integer quadratic constrained or mixed integer second order conic problem with outer approximation.

Parameters
newValue The new value for TreeQCCuts.

setTunerHistory()

void xpress::XPRSProblem::Controls::setTunerHistory ( xpress::TunerHistory newValue )
inline

Set control TunerHistory.

Tuner: Whether to reuse and append to previous tuner results of the same problem.

Parameters
newValue The new value for TunerHistory.

setTunerMaxTime()

void xpress::XPRSProblem::Controls::setTunerMaxTime ( double newValue )
inline

Set control TunerMaxTime.

Tuner: The maximum time in seconds that the tuner will run before it terminates.

Parameters
newValue The new value for TunerMaxTime.

setTunerMethod()

void xpress::XPRSProblem::Controls::setTunerMethod ( xpress::TunerMethod newValue )
inline

Set control TunerMethod.

Tuner: Selects a factory tuner method. A tuner method consists of a list of controls with different settings that the tuner will evaluate and try to combine.

Parameters
newValue The new value for TunerMethod.

setTunerMethodFile()

void xpress::XPRSProblem::Controls::setTunerMethodFile ( std::string const & newValue )
inline

Set control TunerMethodFile.

Tuner: Defines a file from which the tuner can read user-defined tuner method.

Parameters
newValue The new value for TunerMethodFile.

setTunerMode()

void xpress::XPRSProblem::Controls::setTunerMode ( xpress::TunerMode newValue )
inline

Set control TunerMode.

Tuner: Whether to always enable the tuner or disable it.

Parameters
newValue The new value for TunerMode.

setTunerOutput()

void xpress::XPRSProblem::Controls::setTunerOutput ( int newValue )
inline

Set control TunerOutput.

Tuner: Whether to output tuner results and logs to the file system.

Parameters
newValue The new value for TunerOutput.

setTunerOutputPath()

void xpress::XPRSProblem::Controls::setTunerOutputPath ( std::string const & newValue )
inline

Set control TunerOutputPath.

Tuner: Defines a root path to which the tuner writes the result file and logs.

Parameters
newValue The new value for TunerOutputPath.

setTunerPermute()

void xpress::XPRSProblem::Controls::setTunerPermute ( int newValue )
inline

Set control TunerPermute.

Tuner: Defines the number of permutations to solve for each control setting.

Parameters
newValue The new value for TunerPermute.

setTunerSessionName()

void xpress::XPRSProblem::Controls::setTunerSessionName ( std::string const & newValue )
inline

Set control TunerSessionName.

Tuner: Defines a session name for the tuner.

Parameters
newValue The new value for TunerSessionName.

setTunerTarget()

void xpress::XPRSProblem::Controls::setTunerTarget ( xpress::TunerTarget newValue )
inline

Set control TunerTarget.

Tuner: Defines the tuner target – what should be evaluated when comparing two runs with different control settings.

Parameters
newValue The new value for TunerTarget.

setTunerThreads()

void xpress::XPRSProblem::Controls::setTunerThreads ( int newValue )
inline

Set control TunerThreads.

Tuner: the number of threads used by the tuner.

Parameters
newValue The new value for TunerThreads.

setTunerVerbose()

void xpress::XPRSProblem::Controls::setTunerVerbose ( int newValue )
inline

Set control TunerVerbose.

Tuner: whether the tuner should prints detailed information for each run.

Parameters
newValue The new value for TunerVerbose.

setUserSolHeuristic()

void xpress::XPRSProblem::Controls::setUserSolHeuristic ( int newValue )
inline

Set control UserSolHeuristic.

Determines how much effort to put into running a local search heuristic to find a feasible integer solution from a partial or infeasible user solution.

Parameters
newValue The new value for UserSolHeuristic.

setVarSelection()

void xpress::XPRSProblem::Controls::setVarSelection ( int newValue )
inline

Set control VarSelection.

Branch and Bound: This determines the formula used to calculate the estimate of each integer variable, and thus which integer variable is selected to be branched on at a given node. The variable selected to be branched on is the one with the maximum estimate.

Parameters
newValue The new value for VarSelection.

setVersion()

void xpress::XPRSProblem::Controls::setVersion ( int newValue )
inline

Set control Version.

The Optimizer version number, e.g. 1301 meaning release 13.01.

Parameters
newValue The new value for Version.

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.