com.google.ortools.sat.SatParameters.Builder Class Reference

Inheritance diagram for com.google.ortools.sat.SatParameters.Builder:

Public Member Functions
Builder	clear ()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType ()
com.google.ortools.sat.SatParameters	getDefaultInstanceForType ()
com.google.ortools.sat.SatParameters	build ()
com.google.ortools.sat.SatParameters	buildPartial ()
Builder	mergeFrom (com.google.protobuf.Message other)
Builder	mergeFrom (com.google.ortools.sat.SatParameters other)
final boolean	isInitialized ()
Builder	mergeFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
boolean	hasName ()
java.lang.String	getName ()
com.google.protobuf.ByteString	getNameBytes ()
Builder	setName (java.lang.String value)
Builder	clearName ()
Builder	setNameBytes (com.google.protobuf.ByteString value)
boolean	hasPreferredVariableOrder ()
com.google.ortools.sat.SatParameters.VariableOrder	getPreferredVariableOrder ()
Builder	setPreferredVariableOrder (com.google.ortools.sat.SatParameters.VariableOrder value)
Builder	clearPreferredVariableOrder ()
boolean	hasInitialPolarity ()
com.google.ortools.sat.SatParameters.Polarity	getInitialPolarity ()
Builder	setInitialPolarity (com.google.ortools.sat.SatParameters.Polarity value)
Builder	clearInitialPolarity ()
boolean	hasUsePhaseSaving ()
boolean	getUsePhaseSaving ()
Builder	setUsePhaseSaving (boolean value)
Builder	clearUsePhaseSaving ()
boolean	hasPolarityRephaseIncrement ()
int	getPolarityRephaseIncrement ()
Builder	setPolarityRephaseIncrement (int value)
Builder	clearPolarityRephaseIncrement ()
boolean	hasRandomPolarityRatio ()
double	getRandomPolarityRatio ()
Builder	setRandomPolarityRatio (double value)
Builder	clearRandomPolarityRatio ()
boolean	hasRandomBranchesRatio ()
double	getRandomBranchesRatio ()
Builder	setRandomBranchesRatio (double value)
Builder	clearRandomBranchesRatio ()
boolean	hasUseErwaHeuristic ()
boolean	getUseErwaHeuristic ()
Builder	setUseErwaHeuristic (boolean value)
Builder	clearUseErwaHeuristic ()
boolean	hasInitialVariablesActivity ()
double	getInitialVariablesActivity ()
Builder	setInitialVariablesActivity (double value)
Builder	clearInitialVariablesActivity ()
boolean	hasAlsoBumpVariablesInConflictReasons ()
boolean	getAlsoBumpVariablesInConflictReasons ()
Builder	setAlsoBumpVariablesInConflictReasons (boolean value)
Builder	clearAlsoBumpVariablesInConflictReasons ()
boolean	hasMinimizationAlgorithm ()
com.google.ortools.sat.SatParameters.ConflictMinimizationAlgorithm	getMinimizationAlgorithm ()
Builder	setMinimizationAlgorithm (com.google.ortools.sat.SatParameters.ConflictMinimizationAlgorithm value)
Builder	clearMinimizationAlgorithm ()
boolean	hasBinaryMinimizationAlgorithm ()
com.google.ortools.sat.SatParameters.BinaryMinizationAlgorithm	getBinaryMinimizationAlgorithm ()
Builder	setBinaryMinimizationAlgorithm (com.google.ortools.sat.SatParameters.BinaryMinizationAlgorithm value)
Builder	clearBinaryMinimizationAlgorithm ()
boolean	hasSubsumptionDuringConflictAnalysis ()
boolean	getSubsumptionDuringConflictAnalysis ()
Builder	setSubsumptionDuringConflictAnalysis (boolean value)
Builder	clearSubsumptionDuringConflictAnalysis ()
boolean	hasClauseCleanupPeriod ()
int	getClauseCleanupPeriod ()
Builder	setClauseCleanupPeriod (int value)
Builder	clearClauseCleanupPeriod ()
boolean	hasClauseCleanupTarget ()
int	getClauseCleanupTarget ()
Builder	setClauseCleanupTarget (int value)
Builder	clearClauseCleanupTarget ()
boolean	hasClauseCleanupRatio ()
double	getClauseCleanupRatio ()
Builder	setClauseCleanupRatio (double value)
Builder	clearClauseCleanupRatio ()
boolean	hasClauseCleanupProtection ()
com.google.ortools.sat.SatParameters.ClauseProtection	getClauseCleanupProtection ()
Builder	setClauseCleanupProtection (com.google.ortools.sat.SatParameters.ClauseProtection value)
Builder	clearClauseCleanupProtection ()
boolean	hasClauseCleanupLbdBound ()
int	getClauseCleanupLbdBound ()
Builder	setClauseCleanupLbdBound (int value)
Builder	clearClauseCleanupLbdBound ()
boolean	hasClauseCleanupOrdering ()
com.google.ortools.sat.SatParameters.ClauseOrdering	getClauseCleanupOrdering ()
Builder	setClauseCleanupOrdering (com.google.ortools.sat.SatParameters.ClauseOrdering value)
Builder	clearClauseCleanupOrdering ()
boolean	hasPbCleanupIncrement ()
int	getPbCleanupIncrement ()
Builder	setPbCleanupIncrement (int value)
Builder	clearPbCleanupIncrement ()
boolean	hasPbCleanupRatio ()
double	getPbCleanupRatio ()
Builder	setPbCleanupRatio (double value)
Builder	clearPbCleanupRatio ()
boolean	hasVariableActivityDecay ()
double	getVariableActivityDecay ()
Builder	setVariableActivityDecay (double value)
Builder	clearVariableActivityDecay ()
boolean	hasMaxVariableActivityValue ()
double	getMaxVariableActivityValue ()
Builder	setMaxVariableActivityValue (double value)
Builder	clearMaxVariableActivityValue ()
boolean	hasGlucoseMaxDecay ()
double	getGlucoseMaxDecay ()
Builder	setGlucoseMaxDecay (double value)
Builder	clearGlucoseMaxDecay ()
boolean	hasGlucoseDecayIncrement ()
double	getGlucoseDecayIncrement ()
Builder	setGlucoseDecayIncrement (double value)
Builder	clearGlucoseDecayIncrement ()
boolean	hasGlucoseDecayIncrementPeriod ()
int	getGlucoseDecayIncrementPeriod ()
Builder	setGlucoseDecayIncrementPeriod (int value)
Builder	clearGlucoseDecayIncrementPeriod ()
boolean	hasClauseActivityDecay ()
double	getClauseActivityDecay ()
Builder	setClauseActivityDecay (double value)
Builder	clearClauseActivityDecay ()
boolean	hasMaxClauseActivityValue ()
double	getMaxClauseActivityValue ()
Builder	setMaxClauseActivityValue (double value)
Builder	clearMaxClauseActivityValue ()
java.util.List< com.google.ortools.sat.SatParameters.RestartAlgorithm >	getRestartAlgorithmsList ()
int	getRestartAlgorithmsCount ()
com.google.ortools.sat.SatParameters.RestartAlgorithm	getRestartAlgorithms (int index)
Builder	setRestartAlgorithms (int index, com.google.ortools.sat.SatParameters.RestartAlgorithm value)
Builder	addRestartAlgorithms (com.google.ortools.sat.SatParameters.RestartAlgorithm value)
Builder	addAllRestartAlgorithms (java.lang.Iterable<? extends com.google.ortools.sat.SatParameters.RestartAlgorithm > values)
Builder	clearRestartAlgorithms ()
boolean	hasDefaultRestartAlgorithms ()
java.lang.String	getDefaultRestartAlgorithms ()
com.google.protobuf.ByteString	getDefaultRestartAlgorithmsBytes ()
Builder	setDefaultRestartAlgorithms (java.lang.String value)
Builder	clearDefaultRestartAlgorithms ()
Builder	setDefaultRestartAlgorithmsBytes (com.google.protobuf.ByteString value)
boolean	hasRestartPeriod ()
int	getRestartPeriod ()
Builder	setRestartPeriod (int value)
Builder	clearRestartPeriod ()
boolean	hasRestartRunningWindowSize ()
int	getRestartRunningWindowSize ()
Builder	setRestartRunningWindowSize (int value)
Builder	clearRestartRunningWindowSize ()
boolean	hasRestartDlAverageRatio ()
double	getRestartDlAverageRatio ()
Builder	setRestartDlAverageRatio (double value)
Builder	clearRestartDlAverageRatio ()
boolean	hasRestartLbdAverageRatio ()
double	getRestartLbdAverageRatio ()
Builder	setRestartLbdAverageRatio (double value)
Builder	clearRestartLbdAverageRatio ()
boolean	hasUseBlockingRestart ()
boolean	getUseBlockingRestart ()
Builder	setUseBlockingRestart (boolean value)
Builder	clearUseBlockingRestart ()
boolean	hasBlockingRestartWindowSize ()
int	getBlockingRestartWindowSize ()
Builder	setBlockingRestartWindowSize (int value)
Builder	clearBlockingRestartWindowSize ()
boolean	hasBlockingRestartMultiplier ()
double	getBlockingRestartMultiplier ()
Builder	setBlockingRestartMultiplier (double value)
Builder	clearBlockingRestartMultiplier ()
boolean	hasNumConflictsBeforeStrategyChanges ()
int	getNumConflictsBeforeStrategyChanges ()
Builder	setNumConflictsBeforeStrategyChanges (int value)
Builder	clearNumConflictsBeforeStrategyChanges ()
boolean	hasStrategyChangeIncreaseRatio ()
double	getStrategyChangeIncreaseRatio ()
Builder	setStrategyChangeIncreaseRatio (double value)
Builder	clearStrategyChangeIncreaseRatio ()
boolean	hasMaxTimeInSeconds ()
double	getMaxTimeInSeconds ()
Builder	setMaxTimeInSeconds (double value)
Builder	clearMaxTimeInSeconds ()
boolean	hasMaxDeterministicTime ()
double	getMaxDeterministicTime ()
Builder	setMaxDeterministicTime (double value)
Builder	clearMaxDeterministicTime ()
boolean	hasMaxNumDeterministicBatches ()
int	getMaxNumDeterministicBatches ()
Builder	setMaxNumDeterministicBatches (int value)
Builder	clearMaxNumDeterministicBatches ()
boolean	hasMaxNumberOfConflicts ()
long	getMaxNumberOfConflicts ()
Builder	setMaxNumberOfConflicts (long value)
Builder	clearMaxNumberOfConflicts ()
boolean	hasMaxMemoryInMb ()
long	getMaxMemoryInMb ()
Builder	setMaxMemoryInMb (long value)
Builder	clearMaxMemoryInMb ()
boolean	hasAbsoluteGapLimit ()
double	getAbsoluteGapLimit ()
Builder	setAbsoluteGapLimit (double value)
Builder	clearAbsoluteGapLimit ()
boolean	hasRelativeGapLimit ()
double	getRelativeGapLimit ()
Builder	setRelativeGapLimit (double value)
Builder	clearRelativeGapLimit ()
boolean	hasRandomSeed ()
int	getRandomSeed ()
Builder	setRandomSeed (int value)
Builder	clearRandomSeed ()
boolean	hasPermuteVariableRandomly ()
boolean	getPermuteVariableRandomly ()
Builder	setPermuteVariableRandomly (boolean value)
Builder	clearPermuteVariableRandomly ()
boolean	hasPermutePresolveConstraintOrder ()
boolean	getPermutePresolveConstraintOrder ()
Builder	setPermutePresolveConstraintOrder (boolean value)
Builder	clearPermutePresolveConstraintOrder ()
boolean	hasUseAbslRandom ()
boolean	getUseAbslRandom ()
Builder	setUseAbslRandom (boolean value)
Builder	clearUseAbslRandom ()
boolean	hasLogSearchProgress ()
boolean	getLogSearchProgress ()
Builder	setLogSearchProgress (boolean value)
Builder	clearLogSearchProgress ()
boolean	hasLogSubsolverStatistics ()
boolean	getLogSubsolverStatistics ()
Builder	setLogSubsolverStatistics (boolean value)
Builder	clearLogSubsolverStatistics ()
boolean	hasLogPrefix ()
java.lang.String	getLogPrefix ()
com.google.protobuf.ByteString	getLogPrefixBytes ()
Builder	setLogPrefix (java.lang.String value)
Builder	clearLogPrefix ()
Builder	setLogPrefixBytes (com.google.protobuf.ByteString value)
boolean	hasLogToStdout ()
boolean	getLogToStdout ()
Builder	setLogToStdout (boolean value)
Builder	clearLogToStdout ()
boolean	hasLogToResponse ()
boolean	getLogToResponse ()
Builder	setLogToResponse (boolean value)
Builder	clearLogToResponse ()
boolean	hasUsePbResolution ()
boolean	getUsePbResolution ()
Builder	setUsePbResolution (boolean value)
Builder	clearUsePbResolution ()
boolean	hasMinimizeReductionDuringPbResolution ()
boolean	getMinimizeReductionDuringPbResolution ()
Builder	setMinimizeReductionDuringPbResolution (boolean value)
Builder	clearMinimizeReductionDuringPbResolution ()
boolean	hasCountAssumptionLevelsInLbd ()
boolean	getCountAssumptionLevelsInLbd ()
Builder	setCountAssumptionLevelsInLbd (boolean value)
Builder	clearCountAssumptionLevelsInLbd ()
boolean	hasPresolveBveThreshold ()
int	getPresolveBveThreshold ()
Builder	setPresolveBveThreshold (int value)
Builder	clearPresolveBveThreshold ()
boolean	hasPresolveBveClauseWeight ()
int	getPresolveBveClauseWeight ()
Builder	setPresolveBveClauseWeight (int value)
Builder	clearPresolveBveClauseWeight ()
boolean	hasProbingDeterministicTimeLimit ()
double	getProbingDeterministicTimeLimit ()
Builder	setProbingDeterministicTimeLimit (double value)
Builder	clearProbingDeterministicTimeLimit ()
boolean	hasPresolveProbingDeterministicTimeLimit ()
double	getPresolveProbingDeterministicTimeLimit ()
Builder	setPresolveProbingDeterministicTimeLimit (double value)
Builder	clearPresolveProbingDeterministicTimeLimit ()
boolean	hasPresolveBlockedClause ()
boolean	getPresolveBlockedClause ()
Builder	setPresolveBlockedClause (boolean value)
Builder	clearPresolveBlockedClause ()
boolean	hasPresolveUseBva ()
boolean	getPresolveUseBva ()
Builder	setPresolveUseBva (boolean value)
Builder	clearPresolveUseBva ()
boolean	hasPresolveBvaThreshold ()
int	getPresolveBvaThreshold ()
Builder	setPresolveBvaThreshold (int value)
Builder	clearPresolveBvaThreshold ()
boolean	hasMaxPresolveIterations ()
int	getMaxPresolveIterations ()
Builder	setMaxPresolveIterations (int value)
Builder	clearMaxPresolveIterations ()
boolean	hasCpModelPresolve ()
boolean	getCpModelPresolve ()
Builder	setCpModelPresolve (boolean value)
Builder	clearCpModelPresolve ()
boolean	hasCpModelProbingLevel ()
int	getCpModelProbingLevel ()
Builder	setCpModelProbingLevel (int value)
Builder	clearCpModelProbingLevel ()
boolean	hasCpModelUseSatPresolve ()
boolean	getCpModelUseSatPresolve ()
Builder	setCpModelUseSatPresolve (boolean value)
Builder	clearCpModelUseSatPresolve ()
boolean	hasDetectTableWithCost ()
boolean	getDetectTableWithCost ()
Builder	setDetectTableWithCost (boolean value)
Builder	clearDetectTableWithCost ()
boolean	hasTableCompressionLevel ()
int	getTableCompressionLevel ()
Builder	setTableCompressionLevel (int value)
Builder	clearTableCompressionLevel ()
boolean	hasExpandAlldiffConstraints ()
boolean	getExpandAlldiffConstraints ()
Builder	setExpandAlldiffConstraints (boolean value)
Builder	clearExpandAlldiffConstraints ()
boolean	hasExpandReservoirConstraints ()
boolean	getExpandReservoirConstraints ()
Builder	setExpandReservoirConstraints (boolean value)
Builder	clearExpandReservoirConstraints ()
boolean	hasExpandReservoirUsingCircuit ()
boolean	getExpandReservoirUsingCircuit ()
Builder	setExpandReservoirUsingCircuit (boolean value)
Builder	clearExpandReservoirUsingCircuit ()
boolean	hasEncodeCumulativeAsReservoir ()
boolean	getEncodeCumulativeAsReservoir ()
Builder	setEncodeCumulativeAsReservoir (boolean value)
Builder	clearEncodeCumulativeAsReservoir ()
boolean	hasMaxLinMaxSizeForExpansion ()
int	getMaxLinMaxSizeForExpansion ()
Builder	setMaxLinMaxSizeForExpansion (int value)
Builder	clearMaxLinMaxSizeForExpansion ()
boolean	hasDisableConstraintExpansion ()
boolean	getDisableConstraintExpansion ()
Builder	setDisableConstraintExpansion (boolean value)
Builder	clearDisableConstraintExpansion ()
boolean	hasEncodeComplexLinearConstraintWithInteger ()
boolean	getEncodeComplexLinearConstraintWithInteger ()
Builder	setEncodeComplexLinearConstraintWithInteger (boolean value)
Builder	clearEncodeComplexLinearConstraintWithInteger ()
boolean	hasMergeNoOverlapWorkLimit ()
double	getMergeNoOverlapWorkLimit ()
Builder	setMergeNoOverlapWorkLimit (double value)
Builder	clearMergeNoOverlapWorkLimit ()
boolean	hasMergeAtMostOneWorkLimit ()
double	getMergeAtMostOneWorkLimit ()
Builder	setMergeAtMostOneWorkLimit (double value)
Builder	clearMergeAtMostOneWorkLimit ()
boolean	hasPresolveSubstitutionLevel ()
int	getPresolveSubstitutionLevel ()
Builder	setPresolveSubstitutionLevel (int value)
Builder	clearPresolveSubstitutionLevel ()
boolean	hasPresolveExtractIntegerEnforcement ()
boolean	getPresolveExtractIntegerEnforcement ()
Builder	setPresolveExtractIntegerEnforcement (boolean value)
Builder	clearPresolveExtractIntegerEnforcement ()
boolean	hasPresolveInclusionWorkLimit ()
long	getPresolveInclusionWorkLimit ()
Builder	setPresolveInclusionWorkLimit (long value)
Builder	clearPresolveInclusionWorkLimit ()
boolean	hasIgnoreNames ()
boolean	getIgnoreNames ()
Builder	setIgnoreNames (boolean value)
Builder	clearIgnoreNames ()
boolean	hasInferAllDiffs ()
boolean	getInferAllDiffs ()
Builder	setInferAllDiffs (boolean value)
Builder	clearInferAllDiffs ()
boolean	hasFindBigLinearOverlap ()
boolean	getFindBigLinearOverlap ()
Builder	setFindBigLinearOverlap (boolean value)
Builder	clearFindBigLinearOverlap ()
boolean	hasUseSatInprocessing ()
boolean	getUseSatInprocessing ()
Builder	setUseSatInprocessing (boolean value)
Builder	clearUseSatInprocessing ()
boolean	hasInprocessingDtimeRatio ()
double	getInprocessingDtimeRatio ()
Builder	setInprocessingDtimeRatio (double value)
Builder	clearInprocessingDtimeRatio ()
boolean	hasInprocessingProbingDtime ()
double	getInprocessingProbingDtime ()
Builder	setInprocessingProbingDtime (double value)
Builder	clearInprocessingProbingDtime ()
boolean	hasInprocessingMinimizationDtime ()
double	getInprocessingMinimizationDtime ()
Builder	setInprocessingMinimizationDtime (double value)
Builder	clearInprocessingMinimizationDtime ()
boolean	hasNumWorkers ()
int	getNumWorkers ()
Builder	setNumWorkers (int value)
Builder	clearNumWorkers ()
boolean	hasNumSearchWorkers ()
int	getNumSearchWorkers ()
Builder	setNumSearchWorkers (int value)
Builder	clearNumSearchWorkers ()
boolean	hasNumFullSubsolvers ()
int	getNumFullSubsolvers ()
Builder	setNumFullSubsolvers (int value)
Builder	clearNumFullSubsolvers ()
com.google.protobuf.ProtocolStringList	getSubsolversList ()
int	getSubsolversCount ()
java.lang.String	getSubsolvers (int index)
com.google.protobuf.ByteString	getSubsolversBytes (int index)
Builder	setSubsolvers (int index, java.lang.String value)
Builder	addSubsolvers (java.lang.String value)
Builder	addAllSubsolvers (java.lang.Iterable< java.lang.String > values)
Builder	clearSubsolvers ()
Builder	addSubsolversBytes (com.google.protobuf.ByteString value)
com.google.protobuf.ProtocolStringList	getExtraSubsolversList ()
int	getExtraSubsolversCount ()
java.lang.String	getExtraSubsolvers (int index)
com.google.protobuf.ByteString	getExtraSubsolversBytes (int index)
Builder	setExtraSubsolvers (int index, java.lang.String value)
Builder	addExtraSubsolvers (java.lang.String value)
Builder	addAllExtraSubsolvers (java.lang.Iterable< java.lang.String > values)
Builder	clearExtraSubsolvers ()
Builder	addExtraSubsolversBytes (com.google.protobuf.ByteString value)
com.google.protobuf.ProtocolStringList	getIgnoreSubsolversList ()
int	getIgnoreSubsolversCount ()
java.lang.String	getIgnoreSubsolvers (int index)
com.google.protobuf.ByteString	getIgnoreSubsolversBytes (int index)
Builder	setIgnoreSubsolvers (int index, java.lang.String value)
Builder	addIgnoreSubsolvers (java.lang.String value)
Builder	addAllIgnoreSubsolvers (java.lang.Iterable< java.lang.String > values)
Builder	clearIgnoreSubsolvers ()
Builder	addIgnoreSubsolversBytes (com.google.protobuf.ByteString value)
com.google.protobuf.ProtocolStringList	getFilterSubsolversList ()
int	getFilterSubsolversCount ()
java.lang.String	getFilterSubsolvers (int index)
com.google.protobuf.ByteString	getFilterSubsolversBytes (int index)
Builder	setFilterSubsolvers (int index, java.lang.String value)
Builder	addFilterSubsolvers (java.lang.String value)
Builder	addAllFilterSubsolvers (java.lang.Iterable< java.lang.String > values)
Builder	clearFilterSubsolvers ()
Builder	addFilterSubsolversBytes (com.google.protobuf.ByteString value)
java.util.List< com.google.ortools.sat.SatParameters >	getSubsolverParamsList ()
int	getSubsolverParamsCount ()
com.google.ortools.sat.SatParameters	getSubsolverParams (int index)
Builder	setSubsolverParams (int index, com.google.ortools.sat.SatParameters value)
Builder	setSubsolverParams (int index, com.google.ortools.sat.SatParameters.Builder builderForValue)
Builder	addSubsolverParams (com.google.ortools.sat.SatParameters value)
Builder	addSubsolverParams (int index, com.google.ortools.sat.SatParameters value)
Builder	addSubsolverParams (com.google.ortools.sat.SatParameters.Builder builderForValue)
Builder	addSubsolverParams (int index, com.google.ortools.sat.SatParameters.Builder builderForValue)
Builder	addAllSubsolverParams (java.lang.Iterable<? extends com.google.ortools.sat.SatParameters > values)
Builder	clearSubsolverParams ()
Builder	removeSubsolverParams (int index)
com.google.ortools.sat.SatParameters.Builder	getSubsolverParamsBuilder (int index)
com.google.ortools.sat.SatParametersOrBuilder	getSubsolverParamsOrBuilder (int index)
java.util.List<? extends com.google.ortools.sat.SatParametersOrBuilder >	getSubsolverParamsOrBuilderList ()
com.google.ortools.sat.SatParameters.Builder	addSubsolverParamsBuilder ()
com.google.ortools.sat.SatParameters.Builder	addSubsolverParamsBuilder (int index)
java.util.List< com.google.ortools.sat.SatParameters.Builder >	getSubsolverParamsBuilderList ()
boolean	hasInterleaveSearch ()
boolean	getInterleaveSearch ()
Builder	setInterleaveSearch (boolean value)
Builder	clearInterleaveSearch ()
boolean	hasInterleaveBatchSize ()
int	getInterleaveBatchSize ()
Builder	setInterleaveBatchSize (int value)
Builder	clearInterleaveBatchSize ()
boolean	hasShareObjectiveBounds ()
boolean	getShareObjectiveBounds ()
Builder	setShareObjectiveBounds (boolean value)
Builder	clearShareObjectiveBounds ()
boolean	hasShareLevelZeroBounds ()
boolean	getShareLevelZeroBounds ()
Builder	setShareLevelZeroBounds (boolean value)
Builder	clearShareLevelZeroBounds ()
boolean	hasShareBinaryClauses ()
boolean	getShareBinaryClauses ()
Builder	setShareBinaryClauses (boolean value)
Builder	clearShareBinaryClauses ()
boolean	hasShareGlueClauses ()
boolean	getShareGlueClauses ()
Builder	setShareGlueClauses (boolean value)
Builder	clearShareGlueClauses ()
boolean	hasDebugPostsolveWithFullSolver ()
boolean	getDebugPostsolveWithFullSolver ()
Builder	setDebugPostsolveWithFullSolver (boolean value)
Builder	clearDebugPostsolveWithFullSolver ()
boolean	hasDebugMaxNumPresolveOperations ()
int	getDebugMaxNumPresolveOperations ()
Builder	setDebugMaxNumPresolveOperations (int value)
Builder	clearDebugMaxNumPresolveOperations ()
boolean	hasDebugCrashOnBadHint ()
boolean	getDebugCrashOnBadHint ()
Builder	setDebugCrashOnBadHint (boolean value)
Builder	clearDebugCrashOnBadHint ()
boolean	hasUseOptimizationHints ()
boolean	getUseOptimizationHints ()
Builder	setUseOptimizationHints (boolean value)
Builder	clearUseOptimizationHints ()
boolean	hasCoreMinimizationLevel ()
int	getCoreMinimizationLevel ()
Builder	setCoreMinimizationLevel (int value)
Builder	clearCoreMinimizationLevel ()
boolean	hasFindMultipleCores ()
boolean	getFindMultipleCores ()
Builder	setFindMultipleCores (boolean value)
Builder	clearFindMultipleCores ()
boolean	hasCoverOptimization ()
boolean	getCoverOptimization ()
Builder	setCoverOptimization (boolean value)
Builder	clearCoverOptimization ()
boolean	hasMaxSatAssumptionOrder ()
com.google.ortools.sat.SatParameters.MaxSatAssumptionOrder	getMaxSatAssumptionOrder ()
Builder	setMaxSatAssumptionOrder (com.google.ortools.sat.SatParameters.MaxSatAssumptionOrder value)
Builder	clearMaxSatAssumptionOrder ()
boolean	hasMaxSatReverseAssumptionOrder ()
boolean	getMaxSatReverseAssumptionOrder ()
Builder	setMaxSatReverseAssumptionOrder (boolean value)
Builder	clearMaxSatReverseAssumptionOrder ()
boolean	hasMaxSatStratification ()
com.google.ortools.sat.SatParameters.MaxSatStratificationAlgorithm	getMaxSatStratification ()
Builder	setMaxSatStratification (com.google.ortools.sat.SatParameters.MaxSatStratificationAlgorithm value)
Builder	clearMaxSatStratification ()
boolean	hasPropagationLoopDetectionFactor ()
double	getPropagationLoopDetectionFactor ()
Builder	setPropagationLoopDetectionFactor (double value)
Builder	clearPropagationLoopDetectionFactor ()
boolean	hasUsePrecedencesInDisjunctiveConstraint ()
boolean	getUsePrecedencesInDisjunctiveConstraint ()
Builder	setUsePrecedencesInDisjunctiveConstraint (boolean value)
Builder	clearUsePrecedencesInDisjunctiveConstraint ()
boolean	hasMaxSizeToCreatePrecedenceLiteralsInDisjunctive ()
int	getMaxSizeToCreatePrecedenceLiteralsInDisjunctive ()
Builder	setMaxSizeToCreatePrecedenceLiteralsInDisjunctive (int value)
Builder	clearMaxSizeToCreatePrecedenceLiteralsInDisjunctive ()
boolean	hasUseStrongPropagationInDisjunctive ()
boolean	getUseStrongPropagationInDisjunctive ()
Builder	setUseStrongPropagationInDisjunctive (boolean value)
Builder	clearUseStrongPropagationInDisjunctive ()
boolean	hasUseDynamicPrecedenceInDisjunctive ()
boolean	getUseDynamicPrecedenceInDisjunctive ()
Builder	setUseDynamicPrecedenceInDisjunctive (boolean value)
Builder	clearUseDynamicPrecedenceInDisjunctive ()
boolean	hasUseDynamicPrecedenceInCumulative ()
boolean	getUseDynamicPrecedenceInCumulative ()
Builder	setUseDynamicPrecedenceInCumulative (boolean value)
Builder	clearUseDynamicPrecedenceInCumulative ()
boolean	hasUseOverloadCheckerInCumulative ()
boolean	getUseOverloadCheckerInCumulative ()
Builder	setUseOverloadCheckerInCumulative (boolean value)
Builder	clearUseOverloadCheckerInCumulative ()
boolean	hasUseConservativeScaleOverloadChecker ()
boolean	getUseConservativeScaleOverloadChecker ()
Builder	setUseConservativeScaleOverloadChecker (boolean value)
Builder	clearUseConservativeScaleOverloadChecker ()
boolean	hasUseTimetableEdgeFindingInCumulative ()
boolean	getUseTimetableEdgeFindingInCumulative ()
Builder	setUseTimetableEdgeFindingInCumulative (boolean value)
Builder	clearUseTimetableEdgeFindingInCumulative ()
boolean	hasMaxNumIntervalsForTimetableEdgeFinding ()
int	getMaxNumIntervalsForTimetableEdgeFinding ()
Builder	setMaxNumIntervalsForTimetableEdgeFinding (int value)
Builder	clearMaxNumIntervalsForTimetableEdgeFinding ()
boolean	hasUseHardPrecedencesInCumulative ()
boolean	getUseHardPrecedencesInCumulative ()
Builder	setUseHardPrecedencesInCumulative (boolean value)
Builder	clearUseHardPrecedencesInCumulative ()
boolean	hasExploitAllPrecedences ()
boolean	getExploitAllPrecedences ()
Builder	setExploitAllPrecedences (boolean value)
Builder	clearExploitAllPrecedences ()
boolean	hasUseDisjunctiveConstraintInCumulative ()
boolean	getUseDisjunctiveConstraintInCumulative ()
Builder	setUseDisjunctiveConstraintInCumulative (boolean value)
Builder	clearUseDisjunctiveConstraintInCumulative ()
boolean	hasUseTimetablingInNoOverlap2D ()
boolean	getUseTimetablingInNoOverlap2D ()
Builder	setUseTimetablingInNoOverlap2D (boolean value)
Builder	clearUseTimetablingInNoOverlap2D ()
boolean	hasUseEnergeticReasoningInNoOverlap2D ()
boolean	getUseEnergeticReasoningInNoOverlap2D ()
Builder	setUseEnergeticReasoningInNoOverlap2D (boolean value)
Builder	clearUseEnergeticReasoningInNoOverlap2D ()
boolean	hasUseAreaEnergeticReasoningInNoOverlap2D ()
boolean	getUseAreaEnergeticReasoningInNoOverlap2D ()
Builder	setUseAreaEnergeticReasoningInNoOverlap2D (boolean value)
Builder	clearUseAreaEnergeticReasoningInNoOverlap2D ()
boolean	hasMaxPairsPairwiseReasoningInNoOverlap2D ()
int	getMaxPairsPairwiseReasoningInNoOverlap2D ()
Builder	setMaxPairsPairwiseReasoningInNoOverlap2D (int value)
Builder	clearMaxPairsPairwiseReasoningInNoOverlap2D ()
boolean	hasUseDualSchedulingHeuristics ()
boolean	getUseDualSchedulingHeuristics ()
Builder	setUseDualSchedulingHeuristics (boolean value)
Builder	clearUseDualSchedulingHeuristics ()
boolean	hasSearchBranching ()
com.google.ortools.sat.SatParameters.SearchBranching	getSearchBranching ()
Builder	setSearchBranching (com.google.ortools.sat.SatParameters.SearchBranching value)
Builder	clearSearchBranching ()
boolean	hasHintConflictLimit ()
int	getHintConflictLimit ()
Builder	setHintConflictLimit (int value)
Builder	clearHintConflictLimit ()
boolean	hasRepairHint ()
boolean	getRepairHint ()
Builder	setRepairHint (boolean value)
Builder	clearRepairHint ()
boolean	hasFixVariablesToTheirHintedValue ()
boolean	getFixVariablesToTheirHintedValue ()
Builder	setFixVariablesToTheirHintedValue (boolean value)
Builder	clearFixVariablesToTheirHintedValue ()
boolean	hasUseProbingSearch ()
boolean	getUseProbingSearch ()
Builder	setUseProbingSearch (boolean value)
Builder	clearUseProbingSearch ()
boolean	hasUseExtendedProbing ()
boolean	getUseExtendedProbing ()
Builder	setUseExtendedProbing (boolean value)
Builder	clearUseExtendedProbing ()
boolean	hasProbingNumCombinationsLimit ()
int	getProbingNumCombinationsLimit ()
Builder	setProbingNumCombinationsLimit (int value)
Builder	clearProbingNumCombinationsLimit ()
boolean	hasUseShavingInProbingSearch ()
boolean	getUseShavingInProbingSearch ()
Builder	setUseShavingInProbingSearch (boolean value)
Builder	clearUseShavingInProbingSearch ()
boolean	hasShavingSearchDeterministicTime ()
double	getShavingSearchDeterministicTime ()
Builder	setShavingSearchDeterministicTime (double value)
Builder	clearShavingSearchDeterministicTime ()
boolean	hasShavingSearchThreshold ()
long	getShavingSearchThreshold ()
Builder	setShavingSearchThreshold (long value)
Builder	clearShavingSearchThreshold ()
boolean	hasUseObjectiveLbSearch ()
boolean	getUseObjectiveLbSearch ()
Builder	setUseObjectiveLbSearch (boolean value)
Builder	clearUseObjectiveLbSearch ()
boolean	hasUseObjectiveShavingSearch ()
boolean	getUseObjectiveShavingSearch ()
Builder	setUseObjectiveShavingSearch (boolean value)
Builder	clearUseObjectiveShavingSearch ()
boolean	hasUseVariablesShavingSearch ()
boolean	getUseVariablesShavingSearch ()
Builder	setUseVariablesShavingSearch (boolean value)
Builder	clearUseVariablesShavingSearch ()
boolean	hasPseudoCostReliabilityThreshold ()
long	getPseudoCostReliabilityThreshold ()
Builder	setPseudoCostReliabilityThreshold (long value)
Builder	clearPseudoCostReliabilityThreshold ()
boolean	hasOptimizeWithCore ()
boolean	getOptimizeWithCore ()
Builder	setOptimizeWithCore (boolean value)
Builder	clearOptimizeWithCore ()
boolean	hasOptimizeWithLbTreeSearch ()
boolean	getOptimizeWithLbTreeSearch ()
Builder	setOptimizeWithLbTreeSearch (boolean value)
Builder	clearOptimizeWithLbTreeSearch ()
boolean	hasSaveLpBasisInLbTreeSearch ()
boolean	getSaveLpBasisInLbTreeSearch ()
Builder	setSaveLpBasisInLbTreeSearch (boolean value)
Builder	clearSaveLpBasisInLbTreeSearch ()
boolean	hasBinarySearchNumConflicts ()
int	getBinarySearchNumConflicts ()
Builder	setBinarySearchNumConflicts (int value)
Builder	clearBinarySearchNumConflicts ()
boolean	hasOptimizeWithMaxHs ()
boolean	getOptimizeWithMaxHs ()
Builder	setOptimizeWithMaxHs (boolean value)
Builder	clearOptimizeWithMaxHs ()
boolean	hasUseFeasibilityJump ()
boolean	getUseFeasibilityJump ()
Builder	setUseFeasibilityJump (boolean value)
Builder	clearUseFeasibilityJump ()
boolean	hasUseLsOnly ()
boolean	getUseLsOnly ()
Builder	setUseLsOnly (boolean value)
Builder	clearUseLsOnly ()
boolean	hasFeasibilityJumpDecay ()
double	getFeasibilityJumpDecay ()
Builder	setFeasibilityJumpDecay (double value)
Builder	clearFeasibilityJumpDecay ()
boolean	hasFeasibilityJumpLinearizationLevel ()
int	getFeasibilityJumpLinearizationLevel ()
Builder	setFeasibilityJumpLinearizationLevel (int value)
Builder	clearFeasibilityJumpLinearizationLevel ()
boolean	hasFeasibilityJumpRestartFactor ()
int	getFeasibilityJumpRestartFactor ()
Builder	setFeasibilityJumpRestartFactor (int value)
Builder	clearFeasibilityJumpRestartFactor ()
boolean	hasFeasibilityJumpBatchDtime ()
double	getFeasibilityJumpBatchDtime ()
Builder	setFeasibilityJumpBatchDtime (double value)
Builder	clearFeasibilityJumpBatchDtime ()
boolean	hasFeasibilityJumpVarRandomizationProbability ()
double	getFeasibilityJumpVarRandomizationProbability ()
Builder	setFeasibilityJumpVarRandomizationProbability (double value)
Builder	clearFeasibilityJumpVarRandomizationProbability ()
boolean	hasFeasibilityJumpVarPerburbationRangeRatio ()
double	getFeasibilityJumpVarPerburbationRangeRatio ()
Builder	setFeasibilityJumpVarPerburbationRangeRatio (double value)
Builder	clearFeasibilityJumpVarPerburbationRangeRatio ()
boolean	hasFeasibilityJumpEnableRestarts ()
boolean	getFeasibilityJumpEnableRestarts ()
Builder	setFeasibilityJumpEnableRestarts (boolean value)
Builder	clearFeasibilityJumpEnableRestarts ()
boolean	hasFeasibilityJumpMaxExpandedConstraintSize ()
int	getFeasibilityJumpMaxExpandedConstraintSize ()
Builder	setFeasibilityJumpMaxExpandedConstraintSize (int value)
Builder	clearFeasibilityJumpMaxExpandedConstraintSize ()
boolean	hasNumViolationLs ()
int	getNumViolationLs ()
Builder	setNumViolationLs (int value)
Builder	clearNumViolationLs ()
boolean	hasViolationLsPerturbationPeriod ()
int	getViolationLsPerturbationPeriod ()
Builder	setViolationLsPerturbationPeriod (int value)
Builder	clearViolationLsPerturbationPeriod ()
boolean	hasViolationLsCompoundMoveProbability ()
double	getViolationLsCompoundMoveProbability ()
Builder	setViolationLsCompoundMoveProbability (double value)
Builder	clearViolationLsCompoundMoveProbability ()
boolean	hasSharedTreeNumWorkers ()
int	getSharedTreeNumWorkers ()
Builder	setSharedTreeNumWorkers (int value)
Builder	clearSharedTreeNumWorkers ()
boolean	hasUseSharedTreeSearch ()
boolean	getUseSharedTreeSearch ()
Builder	setUseSharedTreeSearch (boolean value)
Builder	clearUseSharedTreeSearch ()
boolean	hasSharedTreeWorkerObjectiveSplitProbability ()
double	getSharedTreeWorkerObjectiveSplitProbability ()
Builder	setSharedTreeWorkerObjectiveSplitProbability (double value)
Builder	clearSharedTreeWorkerObjectiveSplitProbability ()
boolean	hasSharedTreeWorkerMinRestartsPerSubtree ()
int	getSharedTreeWorkerMinRestartsPerSubtree ()
Builder	setSharedTreeWorkerMinRestartsPerSubtree (int value)
Builder	clearSharedTreeWorkerMinRestartsPerSubtree ()
boolean	hasSharedTreeWorkerEnableTrailSharing ()
boolean	getSharedTreeWorkerEnableTrailSharing ()
Builder	setSharedTreeWorkerEnableTrailSharing (boolean value)
Builder	clearSharedTreeWorkerEnableTrailSharing ()
boolean	hasSharedTreeOpenLeavesPerWorker ()
double	getSharedTreeOpenLeavesPerWorker ()
Builder	setSharedTreeOpenLeavesPerWorker (double value)
Builder	clearSharedTreeOpenLeavesPerWorker ()
boolean	hasSharedTreeMaxNodesPerWorker ()
int	getSharedTreeMaxNodesPerWorker ()
Builder	setSharedTreeMaxNodesPerWorker (int value)
Builder	clearSharedTreeMaxNodesPerWorker ()
boolean	hasSharedTreeSplitStrategy ()
com.google.ortools.sat.SatParameters.SharedTreeSplitStrategy	getSharedTreeSplitStrategy ()
Builder	setSharedTreeSplitStrategy (com.google.ortools.sat.SatParameters.SharedTreeSplitStrategy value)
Builder	clearSharedTreeSplitStrategy ()
boolean	hasEnumerateAllSolutions ()
boolean	getEnumerateAllSolutions ()
Builder	setEnumerateAllSolutions (boolean value)
Builder	clearEnumerateAllSolutions ()
boolean	hasKeepAllFeasibleSolutionsInPresolve ()
boolean	getKeepAllFeasibleSolutionsInPresolve ()
Builder	setKeepAllFeasibleSolutionsInPresolve (boolean value)
Builder	clearKeepAllFeasibleSolutionsInPresolve ()
boolean	hasFillTightenedDomainsInResponse ()
boolean	getFillTightenedDomainsInResponse ()
Builder	setFillTightenedDomainsInResponse (boolean value)
Builder	clearFillTightenedDomainsInResponse ()
boolean	hasFillAdditionalSolutionsInResponse ()
boolean	getFillAdditionalSolutionsInResponse ()
Builder	setFillAdditionalSolutionsInResponse (boolean value)
Builder	clearFillAdditionalSolutionsInResponse ()
boolean	hasInstantiateAllVariables ()
boolean	getInstantiateAllVariables ()
Builder	setInstantiateAllVariables (boolean value)
Builder	clearInstantiateAllVariables ()
boolean	hasAutoDetectGreaterThanAtLeastOneOf ()
boolean	getAutoDetectGreaterThanAtLeastOneOf ()
Builder	setAutoDetectGreaterThanAtLeastOneOf (boolean value)
Builder	clearAutoDetectGreaterThanAtLeastOneOf ()
boolean	hasStopAfterFirstSolution ()
boolean	getStopAfterFirstSolution ()
Builder	setStopAfterFirstSolution (boolean value)
Builder	clearStopAfterFirstSolution ()
boolean	hasStopAfterPresolve ()
boolean	getStopAfterPresolve ()
Builder	setStopAfterPresolve (boolean value)
Builder	clearStopAfterPresolve ()
boolean	hasStopAfterRootPropagation ()
boolean	getStopAfterRootPropagation ()
Builder	setStopAfterRootPropagation (boolean value)
Builder	clearStopAfterRootPropagation ()
boolean	hasUseLns ()
boolean	getUseLns ()
Builder	setUseLns (boolean value)
Builder	clearUseLns ()
boolean	hasUseLnsOnly ()
boolean	getUseLnsOnly ()
Builder	setUseLnsOnly (boolean value)
Builder	clearUseLnsOnly ()
boolean	hasSolutionPoolSize ()
int	getSolutionPoolSize ()
Builder	setSolutionPoolSize (int value)
Builder	clearSolutionPoolSize ()
boolean	hasUseRinsLns ()
boolean	getUseRinsLns ()
Builder	setUseRinsLns (boolean value)
Builder	clearUseRinsLns ()
boolean	hasUseFeasibilityPump ()
boolean	getUseFeasibilityPump ()
Builder	setUseFeasibilityPump (boolean value)
Builder	clearUseFeasibilityPump ()
boolean	hasUseLbRelaxLns ()
boolean	getUseLbRelaxLns ()
Builder	setUseLbRelaxLns (boolean value)
Builder	clearUseLbRelaxLns ()
boolean	hasFpRounding ()
com.google.ortools.sat.SatParameters.FPRoundingMethod	getFpRounding ()
Builder	setFpRounding (com.google.ortools.sat.SatParameters.FPRoundingMethod value)
Builder	clearFpRounding ()
boolean	hasDiversifyLnsParams ()
boolean	getDiversifyLnsParams ()
Builder	setDiversifyLnsParams (boolean value)
Builder	clearDiversifyLnsParams ()
boolean	hasRandomizeSearch ()
boolean	getRandomizeSearch ()
Builder	setRandomizeSearch (boolean value)
Builder	clearRandomizeSearch ()
boolean	hasSearchRandomVariablePoolSize ()
long	getSearchRandomVariablePoolSize ()
Builder	setSearchRandomVariablePoolSize (long value)
Builder	clearSearchRandomVariablePoolSize ()
boolean	hasPushAllTasksTowardStart ()
boolean	getPushAllTasksTowardStart ()
Builder	setPushAllTasksTowardStart (boolean value)
Builder	clearPushAllTasksTowardStart ()
boolean	hasUseOptionalVariables ()
boolean	getUseOptionalVariables ()
Builder	setUseOptionalVariables (boolean value)
Builder	clearUseOptionalVariables ()
boolean	hasUseExactLpReason ()
boolean	getUseExactLpReason ()
Builder	setUseExactLpReason (boolean value)
Builder	clearUseExactLpReason ()
boolean	hasUseCombinedNoOverlap ()
boolean	getUseCombinedNoOverlap ()
Builder	setUseCombinedNoOverlap (boolean value)
Builder	clearUseCombinedNoOverlap ()
boolean	hasAtMostOneMaxExpansionSize ()
int	getAtMostOneMaxExpansionSize ()
Builder	setAtMostOneMaxExpansionSize (int value)
Builder	clearAtMostOneMaxExpansionSize ()
boolean	hasCatchSigintSignal ()
boolean	getCatchSigintSignal ()
Builder	setCatchSigintSignal (boolean value)
Builder	clearCatchSigintSignal ()
boolean	hasUseImpliedBounds ()
boolean	getUseImpliedBounds ()
Builder	setUseImpliedBounds (boolean value)
Builder	clearUseImpliedBounds ()
boolean	hasPolishLpSolution ()
boolean	getPolishLpSolution ()
Builder	setPolishLpSolution (boolean value)
Builder	clearPolishLpSolution ()
boolean	hasLpPrimalTolerance ()
double	getLpPrimalTolerance ()
Builder	setLpPrimalTolerance (double value)
Builder	clearLpPrimalTolerance ()
boolean	hasLpDualTolerance ()
double	getLpDualTolerance ()
Builder	setLpDualTolerance (double value)
Builder	clearLpDualTolerance ()
boolean	hasConvertIntervals ()
boolean	getConvertIntervals ()
Builder	setConvertIntervals (boolean value)
Builder	clearConvertIntervals ()
boolean	hasSymmetryLevel ()
int	getSymmetryLevel ()
Builder	setSymmetryLevel (int value)
Builder	clearSymmetryLevel ()
boolean	hasNewLinearPropagation ()
boolean	getNewLinearPropagation ()
Builder	setNewLinearPropagation (boolean value)
Builder	clearNewLinearPropagation ()
boolean	hasLinearSplitSize ()
int	getLinearSplitSize ()
Builder	setLinearSplitSize (int value)
Builder	clearLinearSplitSize ()
boolean	hasLinearizationLevel ()
int	getLinearizationLevel ()
Builder	setLinearizationLevel (int value)
Builder	clearLinearizationLevel ()
boolean	hasBooleanEncodingLevel ()
int	getBooleanEncodingLevel ()
Builder	setBooleanEncodingLevel (int value)
Builder	clearBooleanEncodingLevel ()
boolean	hasMaxDomainSizeWhenEncodingEqNeqConstraints ()
int	getMaxDomainSizeWhenEncodingEqNeqConstraints ()
Builder	setMaxDomainSizeWhenEncodingEqNeqConstraints (int value)
Builder	clearMaxDomainSizeWhenEncodingEqNeqConstraints ()
boolean	hasMaxNumCuts ()
int	getMaxNumCuts ()
Builder	setMaxNumCuts (int value)
Builder	clearMaxNumCuts ()
boolean	hasCutLevel ()
int	getCutLevel ()
Builder	setCutLevel (int value)
Builder	clearCutLevel ()
boolean	hasOnlyAddCutsAtLevelZero ()
boolean	getOnlyAddCutsAtLevelZero ()
Builder	setOnlyAddCutsAtLevelZero (boolean value)
Builder	clearOnlyAddCutsAtLevelZero ()
boolean	hasAddObjectiveCut ()
boolean	getAddObjectiveCut ()
Builder	setAddObjectiveCut (boolean value)
Builder	clearAddObjectiveCut ()
boolean	hasAddCgCuts ()
boolean	getAddCgCuts ()
Builder	setAddCgCuts (boolean value)
Builder	clearAddCgCuts ()
boolean	hasAddMirCuts ()
boolean	getAddMirCuts ()
Builder	setAddMirCuts (boolean value)
Builder	clearAddMirCuts ()
boolean	hasAddZeroHalfCuts ()
boolean	getAddZeroHalfCuts ()
Builder	setAddZeroHalfCuts (boolean value)
Builder	clearAddZeroHalfCuts ()
boolean	hasAddCliqueCuts ()
boolean	getAddCliqueCuts ()
Builder	setAddCliqueCuts (boolean value)
Builder	clearAddCliqueCuts ()
boolean	hasAddRltCuts ()
boolean	getAddRltCuts ()
Builder	setAddRltCuts (boolean value)
Builder	clearAddRltCuts ()
boolean	hasMaxAllDiffCutSize ()
int	getMaxAllDiffCutSize ()
Builder	setMaxAllDiffCutSize (int value)
Builder	clearMaxAllDiffCutSize ()
boolean	hasAddLinMaxCuts ()
boolean	getAddLinMaxCuts ()
Builder	setAddLinMaxCuts (boolean value)
Builder	clearAddLinMaxCuts ()
boolean	hasMaxIntegerRoundingScaling ()
int	getMaxIntegerRoundingScaling ()
Builder	setMaxIntegerRoundingScaling (int value)
Builder	clearMaxIntegerRoundingScaling ()
boolean	hasAddLpConstraintsLazily ()
boolean	getAddLpConstraintsLazily ()
Builder	setAddLpConstraintsLazily (boolean value)
Builder	clearAddLpConstraintsLazily ()
boolean	hasRootLpIterations ()
int	getRootLpIterations ()
Builder	setRootLpIterations (int value)
Builder	clearRootLpIterations ()
boolean	hasMinOrthogonalityForLpConstraints ()
double	getMinOrthogonalityForLpConstraints ()
Builder	setMinOrthogonalityForLpConstraints (double value)
Builder	clearMinOrthogonalityForLpConstraints ()
boolean	hasMaxCutRoundsAtLevelZero ()
int	getMaxCutRoundsAtLevelZero ()
Builder	setMaxCutRoundsAtLevelZero (int value)
Builder	clearMaxCutRoundsAtLevelZero ()
boolean	hasMaxConsecutiveInactiveCount ()
int	getMaxConsecutiveInactiveCount ()
Builder	setMaxConsecutiveInactiveCount (int value)
Builder	clearMaxConsecutiveInactiveCount ()
boolean	hasCutMaxActiveCountValue ()
double	getCutMaxActiveCountValue ()
Builder	setCutMaxActiveCountValue (double value)
Builder	clearCutMaxActiveCountValue ()
boolean	hasCutActiveCountDecay ()
double	getCutActiveCountDecay ()
Builder	setCutActiveCountDecay (double value)
Builder	clearCutActiveCountDecay ()
boolean	hasCutCleanupTarget ()
int	getCutCleanupTarget ()
Builder	setCutCleanupTarget (int value)
Builder	clearCutCleanupTarget ()
boolean	hasNewConstraintsBatchSize ()
int	getNewConstraintsBatchSize ()
Builder	setNewConstraintsBatchSize (int value)
Builder	clearNewConstraintsBatchSize ()
boolean	hasExploitIntegerLpSolution ()
boolean	getExploitIntegerLpSolution ()
Builder	setExploitIntegerLpSolution (boolean value)
Builder	clearExploitIntegerLpSolution ()
boolean	hasExploitAllLpSolution ()
boolean	getExploitAllLpSolution ()
Builder	setExploitAllLpSolution (boolean value)
Builder	clearExploitAllLpSolution ()
boolean	hasExploitBestSolution ()
boolean	getExploitBestSolution ()
Builder	setExploitBestSolution (boolean value)
Builder	clearExploitBestSolution ()
boolean	hasExploitRelaxationSolution ()
boolean	getExploitRelaxationSolution ()
Builder	setExploitRelaxationSolution (boolean value)
Builder	clearExploitRelaxationSolution ()
boolean	hasExploitObjective ()
boolean	getExploitObjective ()
Builder	setExploitObjective (boolean value)
Builder	clearExploitObjective ()
boolean	hasDetectLinearizedProduct ()
boolean	getDetectLinearizedProduct ()
Builder	setDetectLinearizedProduct (boolean value)
Builder	clearDetectLinearizedProduct ()
boolean	hasMipMaxBound ()
double	getMipMaxBound ()
Builder	setMipMaxBound (double value)
Builder	clearMipMaxBound ()
boolean	hasMipVarScaling ()
double	getMipVarScaling ()
Builder	setMipVarScaling (double value)
Builder	clearMipVarScaling ()
boolean	hasMipScaleLargeDomain ()
boolean	getMipScaleLargeDomain ()
Builder	setMipScaleLargeDomain (boolean value)
Builder	clearMipScaleLargeDomain ()
boolean	hasMipAutomaticallyScaleVariables ()
boolean	getMipAutomaticallyScaleVariables ()
Builder	setMipAutomaticallyScaleVariables (boolean value)
Builder	clearMipAutomaticallyScaleVariables ()
boolean	hasOnlySolveIp ()
boolean	getOnlySolveIp ()
Builder	setOnlySolveIp (boolean value)
Builder	clearOnlySolveIp ()
boolean	hasMipWantedPrecision ()
double	getMipWantedPrecision ()
Builder	setMipWantedPrecision (double value)
Builder	clearMipWantedPrecision ()
boolean	hasMipMaxActivityExponent ()
int	getMipMaxActivityExponent ()
Builder	setMipMaxActivityExponent (int value)
Builder	clearMipMaxActivityExponent ()
boolean	hasMipCheckPrecision ()
double	getMipCheckPrecision ()
Builder	setMipCheckPrecision (double value)
Builder	clearMipCheckPrecision ()
boolean	hasMipComputeTrueObjectiveBound ()
boolean	getMipComputeTrueObjectiveBound ()
Builder	setMipComputeTrueObjectiveBound (boolean value)
Builder	clearMipComputeTrueObjectiveBound ()
boolean	hasMipMaxValidMagnitude ()
double	getMipMaxValidMagnitude ()
Builder	setMipMaxValidMagnitude (double value)
Builder	clearMipMaxValidMagnitude ()
boolean	hasMipTreatHighMagnitudeBoundsAsInfinity ()
boolean	getMipTreatHighMagnitudeBoundsAsInfinity ()
Builder	setMipTreatHighMagnitudeBoundsAsInfinity (boolean value)
Builder	clearMipTreatHighMagnitudeBoundsAsInfinity ()
boolean	hasMipDropTolerance ()
double	getMipDropTolerance ()
Builder	setMipDropTolerance (double value)
Builder	clearMipDropTolerance ()
boolean	hasMipPresolveLevel ()
int	getMipPresolveLevel ()
Builder	setMipPresolveLevel (int value)
Builder	clearMipPresolveLevel ()
Public Member Functions inherited from com.google.ortools.sat.SatParametersOrBuilder

Static Public Member Functions
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor ()

Protected Member Functions
com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable ()

Detailed Description

Contains the definitions for all the sat algorithm parameters and their
default values.

NEXT TAG: 296

Protobuf type operations_research.sat.SatParameters

Definition at line 14386 of file SatParameters.java.

Member Function Documentation

addAllExtraSubsolvers()

Builder com.google.ortools.sat.SatParameters.Builder.addAllExtraSubsolvers

(

java.lang.Iterable< java.lang.String >

values

)

A convenient way to add more workers types.
These will be added at the beginning of the list.

repeated string extra_subsolvers = 219;

Parameters

values

The extraSubsolvers to add.

Returns

This builder for chaining.

Definition at line 24468 of file SatParameters.java.

addAllFilterSubsolvers()

Builder com.google.ortools.sat.SatParameters.Builder.addAllFilterSubsolvers

(

java.lang.Iterable< java.lang.String >

values

)

repeated string filter_subsolvers = 293;

Parameters

values

The filterSubsolvers to add.

Returns

This builder for chaining.

Definition at line 24806 of file SatParameters.java.

addAllIgnoreSubsolvers()

Builder com.google.ortools.sat.SatParameters.Builder.addAllIgnoreSubsolvers

(

java.lang.Iterable< java.lang.String >

values

)

Rather than fully specifying subsolvers, it is often convenient to just
remove the ones that are not useful on a given problem or only keep
specific ones for testing. Each string is interpreted as a "glob", so we
support '*' and '?'.

The way this work is that we will only accept a name that match a filter
pattern (if non-empty) and do not match an ignore pattern. Note also that
these fields work on LNS or LS names even if these are currently not
specified via the subsolvers field.

repeated string ignore_subsolvers = 209;

Parameters

values

The ignoreSubsolvers to add.

Returns

This builder for chaining.

Definition at line 24672 of file SatParameters.java.

addAllRestartAlgorithms()

Builder com.google.ortools.sat.SatParameters.Builder.addAllRestartAlgorithms

(

java.lang.Iterable<? extends com.google.ortools.sat.SatParameters.RestartAlgorithm >

values

)

The restart strategies will change each time the strategy_counter is
increased. The current strategy will simply be the one at index
strategy_counter modulo the number of strategy. Note that if this list
includes a NO_RESTART, nothing will change when it is reached because the
strategy_counter will only increment after a restart.

The idea of switching of search strategy tailored for SAT/UNSAT comes from
Chanseok Oh with his COMiniSatPS solver, see http://cs.nyu.edu/~chanseok/.
But more generally, it seems REALLY beneficial to try different strategy.

repeated .operations_research.sat.SatParameters.RestartAlgorithm restart_algorithms = 61;

Parameters

values

The restartAlgorithms to add.

Returns

This builder for chaining.

Definition at line 19788 of file SatParameters.java.

addAllSubsolverParams()

Builder com.google.ortools.sat.SatParameters.Builder.addAllSubsolverParams

(

java.lang.Iterable<? extends com.google.ortools.sat.SatParameters >

values

)

It is possible to specify additional subsolver configuration. These can be
referred by their params.name() in the fields above. Note that only the
specified field will "overwrite" the ones of the base parameter. If a
subsolver_params has the name of an existing subsolver configuration, the
named parameters will be merged into the subsolver configuration.

repeated .operations_research.sat.SatParameters subsolver_params = 210;

Definition at line 25058 of file SatParameters.java.

addAllSubsolvers()

Builder com.google.ortools.sat.SatParameters.Builder.addAllSubsolvers

(

java.lang.Iterable< java.lang.String >

values

)

In multi-thread, the solver can be mainly seen as a portfolio of solvers
with different parameters. This field indicates the names of the parameters
that are used in multithread. This only applies to "full" subsolvers.

See cp_model_search.cc to see a list of the names and the default value (if
left empty) that looks like:
- default_lp           (linearization_level:1)
- fixed                (only if fixed search specified or scheduling)
- no_lp                (linearization_level:0)
- max_lp               (linearization_level:2)
- pseudo_costs         (only if objective, change search heuristic)
- reduced_costs        (only if objective, change search heuristic)
- quick_restart        (kind of probing)
- quick_restart_no_lp  (kind of probing with linearization_level:0)
- lb_tree_search       (to improve lower bound, MIP like tree search)
- probing              (continuous probing and shaving)

Also, note that some set of parameters will be ignored if they do not make
sense. For instance if there is no objective, pseudo_cost or reduced_cost
search will be ignored. Core based search will only work if the objective
has many terms. If there is no fixed strategy fixed will be ignored. And so
on.

The order is important, as only the first num_full_subsolvers will be
scheduled. You can see in the log which one are selected for a given run.

repeated string subsolvers = 207;

Parameters

values

The subsolvers to add.

Returns

This builder for chaining.

Definition at line 24267 of file SatParameters.java.

addExtraSubsolvers()

Builder com.google.ortools.sat.SatParameters.Builder.addExtraSubsolvers

(

java.lang.String

value

)

A convenient way to add more workers types.
These will be added at the beginning of the list.

repeated string extra_subsolvers = 219;

Parameters

value

The extraSubsolvers to add.

Returns

This builder for chaining.

Definition at line 24449 of file SatParameters.java.

addExtraSubsolversBytes()

Builder com.google.ortools.sat.SatParameters.Builder.addExtraSubsolversBytes

(

com.google.protobuf.ByteString

value

)

A convenient way to add more workers types.
These will be added at the beginning of the list.

repeated string extra_subsolvers = 219;

Parameters

value

The bytes of the extraSubsolvers to add.

Returns

This builder for chaining.

Definition at line 24503 of file SatParameters.java.

addFilterSubsolvers()

Builder com.google.ortools.sat.SatParameters.Builder.addFilterSubsolvers

(

java.lang.String

value

)

repeated string filter_subsolvers = 293;

Parameters

value

The filterSubsolvers to add.

Returns

This builder for chaining.

Definition at line 24792 of file SatParameters.java.

addFilterSubsolversBytes()

Builder com.google.ortools.sat.SatParameters.Builder.addFilterSubsolversBytes

(

com.google.protobuf.ByteString

value

)

repeated string filter_subsolvers = 293;

Parameters

value

The bytes of the filterSubsolvers to add.

Returns

This builder for chaining.

Definition at line 24831 of file SatParameters.java.

addIgnoreSubsolvers()

Builder com.google.ortools.sat.SatParameters.Builder.addIgnoreSubsolvers

(

java.lang.String

value

)

Rather than fully specifying subsolvers, it is often convenient to just
remove the ones that are not useful on a given problem or only keep
specific ones for testing. Each string is interpreted as a "glob", so we
support '*' and '?'.

The way this work is that we will only accept a name that match a filter
pattern (if non-empty) and do not match an ignore pattern. Note also that
these fields work on LNS or LS names even if these are currently not
specified via the subsolvers field.

repeated string ignore_subsolvers = 209;

Parameters

value

The ignoreSubsolvers to add.

Returns

This builder for chaining.

Definition at line 24646 of file SatParameters.java.

addIgnoreSubsolversBytes()

Builder com.google.ortools.sat.SatParameters.Builder.addIgnoreSubsolversBytes

(

com.google.protobuf.ByteString

value

)

Rather than fully specifying subsolvers, it is often convenient to just
remove the ones that are not useful on a given problem or only keep
specific ones for testing. Each string is interpreted as a "glob", so we
support '*' and '?'.

The way this work is that we will only accept a name that match a filter
pattern (if non-empty) and do not match an ignore pattern. Note also that
these fields work on LNS or LS names even if these are currently not
specified via the subsolvers field.

repeated string ignore_subsolvers = 209;

Parameters

value

The bytes of the ignoreSubsolvers to add.

Returns

This builder for chaining.

Definition at line 24721 of file SatParameters.java.

addRestartAlgorithms()

Builder com.google.ortools.sat.SatParameters.Builder.addRestartAlgorithms

(

com.google.ortools.sat.SatParameters.RestartAlgorithm

value

)

The restart strategies will change each time the strategy_counter is
increased. The current strategy will simply be the one at index
strategy_counter modulo the number of strategy. Note that if this list
includes a NO_RESTART, nothing will change when it is reached because the
strategy_counter will only increment after a restart.

The idea of switching of search strategy tailored for SAT/UNSAT comes from
Chanseok Oh with his COMiniSatPS solver, see http://cs.nyu.edu/~chanseok/.
But more generally, it seems REALLY beneficial to try different strategy.

repeated .operations_research.sat.SatParameters.RestartAlgorithm restart_algorithms = 61;

Parameters

value

The restartAlgorithms to add.

Returns

This builder for chaining.

Definition at line 19762 of file SatParameters.java.

addSubsolverParams() [1/4]

Builder com.google.ortools.sat.SatParameters.Builder.addSubsolverParams

(

com.google.ortools.sat.SatParameters

value

)

It is possible to specify additional subsolver configuration. These can be
referred by their params.name() in the fields above. Note that only the
specified field will "overwrite" the ones of the base parameter. If a
subsolver_params has the name of an existing subsolver configuration, the
named parameters will be merged into the subsolver configuration.

repeated .operations_research.sat.SatParameters subsolver_params = 210;

Definition at line 24965 of file SatParameters.java.

addSubsolverParams() [2/4]

Builder com.google.ortools.sat.SatParameters.Builder.addSubsolverParams

(

com.google.ortools.sat.SatParameters.Builder

builderForValue

)

It is possible to specify additional subsolver configuration. These can be
referred by their params.name() in the fields above. Note that only the
specified field will "overwrite" the ones of the base parameter. If a
subsolver_params has the name of an existing subsolver configuration, the
named parameters will be merged into the subsolver configuration.

repeated .operations_research.sat.SatParameters subsolver_params = 210;

Definition at line 25014 of file SatParameters.java.

addSubsolverParams() [3/4]

Builder com.google.ortools.sat.SatParameters.Builder.addSubsolverParams	(	int	index,
		com.google.ortools.sat.SatParameters	value )

It is possible to specify additional subsolver configuration. These can be
referred by their params.name() in the fields above. Note that only the
specified field will "overwrite" the ones of the base parameter. If a
subsolver_params has the name of an existing subsolver configuration, the
named parameters will be merged into the subsolver configuration.

repeated .operations_research.sat.SatParameters subsolver_params = 210;

Definition at line 24989 of file SatParameters.java.

addSubsolverParams() [4/4]

Builder com.google.ortools.sat.SatParameters.Builder.addSubsolverParams	(	int	index,
		com.google.ortools.sat.SatParameters.Builder	builderForValue )

It is possible to specify additional subsolver configuration. These can be
referred by their params.name() in the fields above. Note that only the
specified field will "overwrite" the ones of the base parameter. If a
subsolver_params has the name of an existing subsolver configuration, the
named parameters will be merged into the subsolver configuration.

repeated .operations_research.sat.SatParameters subsolver_params = 210;

Definition at line 25036 of file SatParameters.java.

addSubsolverParamsBuilder() [1/2]

com.google.ortools.sat.SatParameters.Builder com.google.ortools.sat.SatParameters.Builder.addSubsolverParamsBuilder

(

)

It is possible to specify additional subsolver configuration. These can be
referred by their params.name() in the fields above. Note that only the
specified field will "overwrite" the ones of the base parameter. If a
subsolver_params has the name of an existing subsolver configuration, the
named parameters will be merged into the subsolver configuration.

repeated .operations_research.sat.SatParameters subsolver_params = 210;

Definition at line 25175 of file SatParameters.java.

addSubsolverParamsBuilder() [2/2]

com.google.ortools.sat.SatParameters.Builder com.google.ortools.sat.SatParameters.Builder.addSubsolverParamsBuilder

(

int

index

)

It is possible to specify additional subsolver configuration. These can be
referred by their params.name() in the fields above. Note that only the
specified field will "overwrite" the ones of the base parameter. If a
subsolver_params has the name of an existing subsolver configuration, the
named parameters will be merged into the subsolver configuration.

repeated .operations_research.sat.SatParameters subsolver_params = 210;

Definition at line 25190 of file SatParameters.java.

addSubsolvers()

Builder com.google.ortools.sat.SatParameters.Builder.addSubsolvers

(

java.lang.String

value

)

In multi-thread, the solver can be mainly seen as a portfolio of solvers
with different parameters. This field indicates the names of the parameters
that are used in multithread. This only applies to "full" subsolvers.

See cp_model_search.cc to see a list of the names and the default value (if
left empty) that looks like:
- default_lp           (linearization_level:1)
- fixed                (only if fixed search specified or scheduling)
- no_lp                (linearization_level:0)
- max_lp               (linearization_level:2)
- pseudo_costs         (only if objective, change search heuristic)
- reduced_costs        (only if objective, change search heuristic)
- quick_restart        (kind of probing)
- quick_restart_no_lp  (kind of probing with linearization_level:0)
- lb_tree_search       (to improve lower bound, MIP like tree search)
- probing              (continuous probing and shaving)

Also, note that some set of parameters will be ignored if they do not make
sense. For instance if there is no objective, pseudo_cost or reduced_cost
search will be ignored. Core based search will only work if the objective
has many terms. If there is no fixed strategy fixed will be ignored. And so
on.

The order is important, as only the first num_full_subsolvers will be
scheduled. You can see in the log which one are selected for a given run.

repeated string subsolvers = 207;

Parameters

value

The subsolvers to add.

Returns

This builder for chaining.

Definition at line 24225 of file SatParameters.java.

addSubsolversBytes()

Builder com.google.ortools.sat.SatParameters.Builder.addSubsolversBytes

(

com.google.protobuf.ByteString

value

)

In multi-thread, the solver can be mainly seen as a portfolio of solvers
with different parameters. This field indicates the names of the parameters
that are used in multithread. This only applies to "full" subsolvers.

See cp_model_search.cc to see a list of the names and the default value (if
left empty) that looks like:
- default_lp           (linearization_level:1)
- fixed                (only if fixed search specified or scheduling)
- no_lp                (linearization_level:0)
- max_lp               (linearization_level:2)
- pseudo_costs         (only if objective, change search heuristic)
- reduced_costs        (only if objective, change search heuristic)
- quick_restart        (kind of probing)
- quick_restart_no_lp  (kind of probing with linearization_level:0)
- lb_tree_search       (to improve lower bound, MIP like tree search)
- probing              (continuous probing and shaving)

Also, note that some set of parameters will be ignored if they do not make
sense. For instance if there is no objective, pseudo_cost or reduced_cost
search will be ignored. Core based search will only work if the objective
has many terms. If there is no fixed strategy fixed will be ignored. And so
on.

The order is important, as only the first num_full_subsolvers will be
scheduled. You can see in the log which one are selected for a given run.

repeated string subsolvers = 207;

Parameters

value

The bytes of the subsolvers to add.

Returns

This builder for chaining.

Definition at line 24348 of file SatParameters.java.

build()

com.google.ortools.sat.SatParameters com.google.ortools.sat.SatParameters.Builder.build

(

)

Definition at line 14698 of file SatParameters.java.

buildPartial()

com.google.ortools.sat.SatParameters com.google.ortools.sat.SatParameters.Builder.buildPartial

(

)

Definition at line 14707 of file SatParameters.java.

clear()

Builder com.google.ortools.sat.SatParameters.Builder.clear

(

)

Definition at line 14414 of file SatParameters.java.

clearAbsoluteGapLimit()

Builder com.google.ortools.sat.SatParameters.Builder.clearAbsoluteGapLimit

(

)

Stop the search when the gap between the best feasible objective (O) and
our best objective bound (B) is smaller than a limit.
The exact definition is:
- Absolute: abs(O - B)
- Relative: abs(O - B) / max(1, abs(O)).

Important: The relative gap depends on the objective offset! If you
artificially shift the objective, you will get widely different value of
the relative gap.

Note that if the gap is reached, the search status will be OPTIMAL. But
one can check the best objective bound to see the actual gap.

If the objective is integer, then any absolute gap < 1 will lead to a true
optimal. If the objective is floating point, a gap of zero make little
sense so is is why we use a non-zero default value. At the end of the
search, we will display a warning if OPTIMAL is reported yet the gap is
greater than this absolute gap.

optional double absolute_gap_limit = 159 [default = 0.0001];

Returns

This builder for chaining.

Definition at line 20841 of file SatParameters.java.

clearAddCgCuts()

Builder com.google.ortools.sat.SatParameters.Builder.clearAddCgCuts

(

)

Whether we generate and add Chvatal-Gomory cuts to the LP at root node.
Note that for now, this is not heavily tuned.

optional bool add_cg_cuts = 117 [default = true];

Returns

This builder for chaining.

Definition at line 32488 of file SatParameters.java.

clearAddCliqueCuts()

Builder com.google.ortools.sat.SatParameters.Builder.clearAddCliqueCuts

(

)

Whether we generate clique cuts from the binary implication graph. Note
that as the search goes on, this graph will contains new binary clauses
learned by the SAT engine.

optional bool add_clique_cuts = 172 [default = true];

Returns

This builder for chaining.

Definition at line 32672 of file SatParameters.java.

clearAddLinMaxCuts()

Builder com.google.ortools.sat.SatParameters.Builder.clearAddLinMaxCuts

(

)

For the lin max constraints, generates the cuts described in "Strong
mixed-integer programming formulations for trained neural networks" by Ross
Anderson et. (https://arxiv.org/pdf/1811.01988.pdf)

optional bool add_lin_max_cuts = 152 [default = true];

Returns

This builder for chaining.

Definition at line 32860 of file SatParameters.java.

clearAddLpConstraintsLazily()

Builder com.google.ortools.sat.SatParameters.Builder.clearAddLpConstraintsLazily

(

)

If true, we start by an empty LP, and only add constraints not satisfied
by the current LP solution batch by batch. A constraint that is only added
like this is known as a "lazy" constraint in the literature, except that we
currently consider all constraints as lazy here.

optional bool add_lp_constraints_lazily = 112 [default = true];

Returns

This builder for chaining.

Definition at line 33012 of file SatParameters.java.

clearAddMirCuts()

Builder com.google.ortools.sat.SatParameters.Builder.clearAddMirCuts

(

)

Whether we generate MIR cuts at root node.
Note that for now, this is not heavily tuned.

optional bool add_mir_cuts = 120 [default = true];

Returns

This builder for chaining.

Definition at line 32548 of file SatParameters.java.

clearAddObjectiveCut()

Builder com.google.ortools.sat.SatParameters.Builder.clearAddObjectiveCut

(

)

When the LP objective is fractional, do we add the cut that forces the
linear objective expression to be greater or equal to this fractional value
rounded up? We can always do that since our objective is integer, and
combined with MIR heuristic to reduce the coefficient of such cut, it can
help.

optional bool add_objective_cut = 197 [default = false];

Returns

This builder for chaining.

Definition at line 32428 of file SatParameters.java.

clearAddRltCuts()

Builder com.google.ortools.sat.SatParameters.Builder.clearAddRltCuts

(

)

Whether we generate RLT cuts. This is still experimental but can help on
binary problem with a lot of clauses of size 3.

optional bool add_rlt_cuts = 279 [default = true];

Returns

This builder for chaining.

Definition at line 32732 of file SatParameters.java.

clearAddZeroHalfCuts()

Builder com.google.ortools.sat.SatParameters.Builder.clearAddZeroHalfCuts

(

)

Whether we generate Zero-Half cuts at root node.
Note that for now, this is not heavily tuned.

optional bool add_zero_half_cuts = 169 [default = true];

Returns

This builder for chaining.

Definition at line 32608 of file SatParameters.java.

clearAlsoBumpVariablesInConflictReasons()

Builder com.google.ortools.sat.SatParameters.Builder.clearAlsoBumpVariablesInConflictReasons

(

)

When this is true, then the variables that appear in any of the reason of
the variables in a conflict have their activity bumped. This is addition to
the variables in the conflict, and the one that were used during conflict
resolution.

optional bool also_bump_variables_in_conflict_reasons = 77 [default = false];

Returns

This builder for chaining.

Definition at line 18699 of file SatParameters.java.

clearAtMostOneMaxExpansionSize()

Builder com.google.ortools.sat.SatParameters.Builder.clearAtMostOneMaxExpansionSize

(

)

All at_most_one constraints with a size <= param will be replaced by a
quadratic number of binary implications.

optional int32 at_most_one_max_expansion_size = 270 [default = 3];

Returns

This builder for chaining.

Definition at line 31388 of file SatParameters.java.

clearAutoDetectGreaterThanAtLeastOneOf()

Builder com.google.ortools.sat.SatParameters.Builder.clearAutoDetectGreaterThanAtLeastOneOf

(

)

If true, then the precedences propagator try to detect for each variable if
it has a set of "optional incoming arc" for which at least one of them is
present. This is usually useful to have but can be slow on model with a lot
of precedence.

optional bool auto_detect_greater_than_at_least_one_of = 95 [default = true];

Returns

This builder for chaining.

Definition at line 30334 of file SatParameters.java.

clearBinaryMinimizationAlgorithm()

Builder com.google.ortools.sat.SatParameters.Builder.clearBinaryMinimizationAlgorithm

(

)

optional .operations_research.sat.SatParameters.BinaryMinizationAlgorithm binary_minimization_algorithm = 34 [default = BINARY_MINIMIZATION_FIRST];

Returns

This builder for chaining.

Definition at line 18783 of file SatParameters.java.

clearBinarySearchNumConflicts()

Builder com.google.ortools.sat.SatParameters.Builder.clearBinarySearchNumConflicts

(

)

If non-negative, perform a binary search on the objective variable in order
to find an [min, max] interval outside of which the solver proved unsat/sat
under this amount of conflict. This can quickly reduce the objective domain
on some problems.

optional int32 binary_search_num_conflicts = 99 [default = -1];

Returns

This builder for chaining.

Definition at line 28520 of file SatParameters.java.

clearBlockingRestartMultiplier()

Builder com.google.ortools.sat.SatParameters.Builder.clearBlockingRestartMultiplier

(

)

optional double blocking_restart_multiplier = 66 [default = 1.4];

Returns

This builder for chaining.

Definition at line 20253 of file SatParameters.java.

clearBlockingRestartWindowSize()

Builder com.google.ortools.sat.SatParameters.Builder.clearBlockingRestartWindowSize

(

)

optional int32 blocking_restart_window_size = 65 [default = 5000];

Returns

This builder for chaining.

Definition at line 20213 of file SatParameters.java.

clearBooleanEncodingLevel()

Builder com.google.ortools.sat.SatParameters.Builder.clearBooleanEncodingLevel

(

)

A non-negative level indicating how much we should try to fully encode
Integer variables as Boolean.

optional int32 boolean_encoding_level = 107 [default = 1];

Returns

This builder for chaining.

Definition at line 32092 of file SatParameters.java.

clearCatchSigintSignal()

Builder com.google.ortools.sat.SatParameters.Builder.clearCatchSigintSignal

(

)

Indicates if the CP-SAT layer should catch Control-C (SIGINT) signals
when calling solve. If set, catching the SIGINT signal will terminate the
search gracefully, as if a time limit was reached.

optional bool catch_sigint_signal = 135 [default = true];

Returns

This builder for chaining.

Definition at line 31452 of file SatParameters.java.

clearClauseActivityDecay()

Builder com.google.ortools.sat.SatParameters.Builder.clearClauseActivityDecay

(

)

Clause activity parameters (same effect as the one on the variables).

optional double clause_activity_decay = 17 [default = 0.999];

Returns

This builder for chaining.

Definition at line 19603 of file SatParameters.java.

clearClauseCleanupLbdBound()

Builder com.google.ortools.sat.SatParameters.Builder.clearClauseCleanupLbdBound

(

)

All the clauses with a LBD (literal blocks distance) lower or equal to this
parameters will always be kept.

optional int32 clause_cleanup_lbd_bound = 59 [default = 5];

Returns

This builder for chaining.

Definition at line 19133 of file SatParameters.java.

clearClauseCleanupOrdering()

Builder com.google.ortools.sat.SatParameters.Builder.clearClauseCleanupOrdering

(

)

optional .operations_research.sat.SatParameters.ClauseOrdering clause_cleanup_ordering = 60 [default = CLAUSE_ACTIVITY];

Returns

This builder for chaining.

Definition at line 19175 of file SatParameters.java.

clearClauseCleanupPeriod()

Builder com.google.ortools.sat.SatParameters.Builder.clearClauseCleanupPeriod

(

)

Trigger a cleanup when this number of "deletable" clauses is learned.

optional int32 clause_cleanup_period = 11 [default = 10000];

Returns

This builder for chaining.

Definition at line 18907 of file SatParameters.java.

clearClauseCleanupProtection()

Builder com.google.ortools.sat.SatParameters.Builder.clearClauseCleanupProtection

(

)

optional .operations_research.sat.SatParameters.ClauseProtection clause_cleanup_protection = 58 [default = PROTECTION_NONE];

Returns

This builder for chaining.

Definition at line 19073 of file SatParameters.java.

clearClauseCleanupRatio()

Builder com.google.ortools.sat.SatParameters.Builder.clearClauseCleanupRatio

(

)

During a cleanup, if clause_cleanup_target is 0, we will delete the
clause_cleanup_ratio of "deletable" clauses instead of aiming for a fixed
target of clauses to keep.

optional double clause_cleanup_ratio = 190 [default = 0.5];

Returns

This builder for chaining.

Definition at line 19031 of file SatParameters.java.

clearClauseCleanupTarget()

Builder com.google.ortools.sat.SatParameters.Builder.clearClauseCleanupTarget

(

)

During a cleanup, we will always keep that number of "deletable" clauses.
Note that this doesn't include the "protected" clauses.

optional int32 clause_cleanup_target = 13 [default = 0];

Returns

This builder for chaining.

Definition at line 18967 of file SatParameters.java.

clearConvertIntervals()

Builder com.google.ortools.sat.SatParameters.Builder.clearConvertIntervals

(

)

Temporary flag util the feature is more mature. This convert intervals to
the newer proto format that support affine start/var/end instead of just
variables.

optional bool convert_intervals = 177 [default = true];

Returns

This builder for chaining.

Definition at line 31760 of file SatParameters.java.

clearCoreMinimizationLevel()

Builder com.google.ortools.sat.SatParameters.Builder.clearCoreMinimizationLevel

(

)

If positive, we spend some effort on each core:
- At level 1, we use a simple heuristic to try to minimize an UNSAT core.
- At level 2, we use propagation to minimize the core but also identify
literal in at most one relationship in this core.

optional int32 core_minimization_level = 50 [default = 2];

Returns

This builder for chaining.

Definition at line 25878 of file SatParameters.java.

clearCountAssumptionLevelsInLbd()

Builder com.google.ortools.sat.SatParameters.Builder.clearCountAssumptionLevelsInLbd

(

)

Whether or not the assumption levels are taken into account during the LBD
computation. According to the reference below, not counting them improves
the solver in some situation. Note that this only impact solves under
assumptions.

Gilles Audemard, Jean-Marie Lagniez, Laurent Simon, "Improving Glucose for
Incremental SAT Solving with Assumptions: Application to MUS Extraction"
Theory and Applications of Satisfiability Testing - SAT 2013, Lecture Notes
in Computer Science Volume 7962, 2013, pp 309-317.

optional bool count_assumption_levels_in_lbd = 49 [default = true];

Returns

This builder for chaining.

Definition at line 21681 of file SatParameters.java.

clearCoverOptimization()

Builder com.google.ortools.sat.SatParameters.Builder.clearCoverOptimization

(

)

If true, when the max-sat algo find a core, we compute the minimal number
of literals in the core that needs to be true to have a feasible solution.
This is also called core exhaustion in more recent max-SAT papers.

optional bool cover_optimization = 89 [default = true];

Returns

This builder for chaining.

Definition at line 26002 of file SatParameters.java.

clearCpModelPresolve()

Builder com.google.ortools.sat.SatParameters.Builder.clearCpModelPresolve

(

)

Whether we presolve the cp_model before solving it.

optional bool cp_model_presolve = 86 [default = true];

Returns

This builder for chaining.

Definition at line 22221 of file SatParameters.java.

clearCpModelProbingLevel()

Builder com.google.ortools.sat.SatParameters.Builder.clearCpModelProbingLevel

(

)

How much effort do we spend on probing. 0 disables it completely.

optional int32 cp_model_probing_level = 110 [default = 2];

Returns

This builder for chaining.

Definition at line 22277 of file SatParameters.java.

clearCpModelUseSatPresolve()

Builder com.google.ortools.sat.SatParameters.Builder.clearCpModelUseSatPresolve

(

)

Whether we also use the sat presolve when cp_model_presolve is true.

optional bool cp_model_use_sat_presolve = 93 [default = true];

Returns

This builder for chaining.

Definition at line 22333 of file SatParameters.java.

clearCutActiveCountDecay()

Builder com.google.ortools.sat.SatParameters.Builder.clearCutActiveCountDecay

(

)

optional double cut_active_count_decay = 156 [default = 0.8];

Returns

This builder for chaining.

Definition at line 33376 of file SatParameters.java.

clearCutCleanupTarget()

Builder com.google.ortools.sat.SatParameters.Builder.clearCutCleanupTarget

(

)

Target number of constraints to remove during cleanup.

optional int32 cut_cleanup_target = 157 [default = 1000];

Returns

This builder for chaining.

Definition at line 33432 of file SatParameters.java.

clearCutLevel()

Builder com.google.ortools.sat.SatParameters.Builder.clearCutLevel

(

)

Control the global cut effort. Zero will turn off all cut. For now we just
have one level. Note also that most cuts are only used at linearization
level >= 2.

optional int32 cut_level = 196 [default = 1];

Returns

This builder for chaining.

Definition at line 32296 of file SatParameters.java.

clearCutMaxActiveCountValue()

Builder com.google.ortools.sat.SatParameters.Builder.clearCutMaxActiveCountValue

(

)

These parameters are similar to sat clause management activity parameters.
They are effective only if the number of generated cuts exceed the storage
limit. Default values are based on a few experiments on miplib instances.

optional double cut_max_active_count_value = 155 [default = 10000000000];

Returns

This builder for chaining.

Definition at line 33336 of file SatParameters.java.

clearDebugCrashOnBadHint()

Builder com.google.ortools.sat.SatParameters.Builder.clearDebugCrashOnBadHint

(

)

Crash if we do not manage to complete the hint into a full solution.

optional bool debug_crash_on_bad_hint = 195 [default = false];

Returns

This builder for chaining.

Definition at line 25742 of file SatParameters.java.

clearDebugMaxNumPresolveOperations()

Builder com.google.ortools.sat.SatParameters.Builder.clearDebugMaxNumPresolveOperations

(

)

If positive, try to stop just after that many presolve rules have been
applied. This is mainly useful for debugging presolve.

optional int32 debug_max_num_presolve_operations = 151 [default = 0];

Returns

This builder for chaining.

Definition at line 25686 of file SatParameters.java.

clearDebugPostsolveWithFullSolver()

Builder com.google.ortools.sat.SatParameters.Builder.clearDebugPostsolveWithFullSolver

(

)

We have two different postsolve code. The default one should be better and
it allows for a more powerful presolve, but it can be useful to postsolve
using the full solver instead.

optional bool debug_postsolve_with_full_solver = 162 [default = false];

Returns

This builder for chaining.

Definition at line 25626 of file SatParameters.java.

clearDefaultRestartAlgorithms()

Builder com.google.ortools.sat.SatParameters.Builder.clearDefaultRestartAlgorithms

(

)

optional string default_restart_algorithms = 70 [default = "LUBY_RESTART,LBD_MOVING_AVERAGE_RESTART,DL_MOVING_AVERAGE_RESTART"];

Returns

This builder for chaining.

Definition at line 19880 of file SatParameters.java.

clearDetectLinearizedProduct()

Builder com.google.ortools.sat.SatParameters.Builder.clearDetectLinearizedProduct

(

)

Infer products of Boolean or of Boolean time IntegerVariable from the
linear constrainst in the problem. This can be used in some cuts, altough
for now we don't really exploit it.

optional bool detect_linearized_product = 277 [default = false];

Returns

This builder for chaining.

Definition at line 33868 of file SatParameters.java.

clearDetectTableWithCost()

Builder com.google.ortools.sat.SatParameters.Builder.clearDetectTableWithCost

(

)

If true, we detect variable that are unique to a table constraint and only
there to encode a cost on each tuple. This is usually the case when a WCSP
(weighted constraint program) is encoded into CP-SAT format.

This can lead to a dramatic speed-up for such problems but is still
experimental at this point.

optional bool detect_table_with_cost = 216 [default = false];

Returns

This builder for chaining.

Definition at line 22409 of file SatParameters.java.

clearDisableConstraintExpansion()

Builder com.google.ortools.sat.SatParameters.Builder.clearDisableConstraintExpansion

(

)

If true, it disable all constraint expansion.
This should only be used to test the presolve of expanded constraints.

optional bool disable_constraint_expansion = 181 [default = false];

Returns

This builder for chaining.

Definition at line 22893 of file SatParameters.java.

clearDiversifyLnsParams()

Builder com.google.ortools.sat.SatParameters.Builder.clearDiversifyLnsParams

(

)

If true, registers more lns subsolvers with different parameters.

optional bool diversify_lns_params = 137 [default = false];

Returns

This builder for chaining.

Definition at line 30940 of file SatParameters.java.

clearEncodeComplexLinearConstraintWithInteger()

Builder com.google.ortools.sat.SatParameters.Builder.clearEncodeComplexLinearConstraintWithInteger

(

)

Linear constraint with a complex right hand side (more than a single
interval) need to be expanded, there is a couple of way to do that.

optional bool encode_complex_linear_constraint_with_integer = 223 [default = false];

Returns

This builder for chaining.

Definition at line 22953 of file SatParameters.java.

clearEncodeCumulativeAsReservoir()

Builder com.google.ortools.sat.SatParameters.Builder.clearEncodeCumulativeAsReservoir

(

)

Encore cumulative with fixed demands and capacity as a reservoir
constraint. The only reason you might want to do that is to test the
reservoir propagation code!

optional bool encode_cumulative_as_reservoir = 287 [default = false];

Returns

This builder for chaining.

Definition at line 22761 of file SatParameters.java.

clearEnumerateAllSolutions()

Builder com.google.ortools.sat.SatParameters.Builder.clearEnumerateAllSolutions

(

)

Whether we enumerate all solutions of a problem without objective. Note
that setting this to true automatically disable some presolve reduction
that can remove feasible solution. That is it has the same effect as
setting keep_all_feasible_solutions_in_presolve.

TODO(user): Do not do that and let the user choose what behavior is best by
setting keep_all_feasible_solutions_in_presolve ?

optional bool enumerate_all_solutions = 87 [default = false];

Returns

This builder for chaining.

Definition at line 29950 of file SatParameters.java.

clearExpandAlldiffConstraints()

Builder com.google.ortools.sat.SatParameters.Builder.clearExpandAlldiffConstraints

(

)

If true, expand all_different constraints that are not permutations.
Permutations (#Variables = #Values) are always expanded.

optional bool expand_alldiff_constraints = 170 [default = false];

Returns

This builder for chaining.

Definition at line 22537 of file SatParameters.java.

clearExpandReservoirConstraints()

Builder com.google.ortools.sat.SatParameters.Builder.clearExpandReservoirConstraints

(

)

If true, expand the reservoir constraints by creating booleans for all
possible precedences between event and encoding the constraint.

optional bool expand_reservoir_constraints = 182 [default = true];

Returns

This builder for chaining.

Definition at line 22597 of file SatParameters.java.

clearExpandReservoirUsingCircuit()

Builder com.google.ortools.sat.SatParameters.Builder.clearExpandReservoirUsingCircuit

(

)

Mainly useful for testing.

If this and expand_reservoir_constraints is true, we use a different
encoding of the reservoir constraint using circuit instead of precedences.
Note that this is usually slower, but can exercise different part of the
solver. Note that contrary to the precedence encoding, this easily support
variable demands.

WARNING: with this encoding, the constraint take a slighlty different
meaning. The level must be within the reservoir for any permutation of the
events. So we cannot have +100 and -100 at the same time if the maximum
level is 10 (as autorized by the reservoir constraint).

optional bool expand_reservoir_using_circuit = 288 [default = false];

Returns

This builder for chaining.

Definition at line 22697 of file SatParameters.java.

clearExploitAllLpSolution()

Builder com.google.ortools.sat.SatParameters.Builder.clearExploitAllLpSolution

(

)

If true and the Lp relaxation of the problem has a solution, try to exploit
it. This is same as above except in this case the lp solution might not be
an integer solution.

optional bool exploit_all_lp_solution = 116 [default = true];

Returns

This builder for chaining.

Definition at line 33624 of file SatParameters.java.

clearExploitAllPrecedences()

Builder com.google.ortools.sat.SatParameters.Builder.clearExploitAllPrecedences

(

)

optional bool exploit_all_precedences = 220 [default = false];

Returns

This builder for chaining.

Definition at line 26982 of file SatParameters.java.

clearExploitBestSolution()

Builder com.google.ortools.sat.SatParameters.Builder.clearExploitBestSolution

(

)

When branching on a variable, follow the last best solution value.

optional bool exploit_best_solution = 130 [default = false];

Returns

This builder for chaining.

Definition at line 33680 of file SatParameters.java.

clearExploitIntegerLpSolution()

Builder com.google.ortools.sat.SatParameters.Builder.clearExploitIntegerLpSolution

(

)

If true and the Lp relaxation of the problem has an integer optimal
solution, try to exploit it. Note that since the LP relaxation may not
contain all the constraints, such a solution is not necessarily a solution
of the full problem.

optional bool exploit_integer_lp_solution = 94 [default = true];

Returns

This builder for chaining.

Definition at line 33560 of file SatParameters.java.

clearExploitObjective()

Builder com.google.ortools.sat.SatParameters.Builder.clearExploitObjective

(

)

When branching an a variable that directly affect the objective,
branch on the value that lead to the best objective first.

optional bool exploit_objective = 131 [default = true];

Returns

This builder for chaining.

Definition at line 33804 of file SatParameters.java.

clearExploitRelaxationSolution()

Builder com.google.ortools.sat.SatParameters.Builder.clearExploitRelaxationSolution

(

)

When branching on a variable, follow the last best relaxation solution
value. We use the relaxation with the tightest bound on the objective as
the best relaxation solution.

optional bool exploit_relaxation_solution = 161 [default = false];

Returns

This builder for chaining.

Definition at line 33744 of file SatParameters.java.

clearExtraSubsolvers()

Builder com.google.ortools.sat.SatParameters.Builder.clearExtraSubsolvers

(

)

A convenient way to add more workers types.
These will be added at the beginning of the list.

repeated string extra_subsolvers = 219;

Returns

This builder for chaining.

Definition at line 24486 of file SatParameters.java.

clearFeasibilityJumpBatchDtime()

Builder com.google.ortools.sat.SatParameters.Builder.clearFeasibilityJumpBatchDtime

(

)

How much dtime for each LS batch.

optional double feasibility_jump_batch_dtime = 292 [default = 0.1];

Returns

This builder for chaining.

Definition at line 28952 of file SatParameters.java.

clearFeasibilityJumpDecay()

Builder com.google.ortools.sat.SatParameters.Builder.clearFeasibilityJumpDecay

(

)

On each restart, we randomly choose if we use decay (with this parameter)
or no decay.

optional double feasibility_jump_decay = 242 [default = 0.95];

Returns

This builder for chaining.

Definition at line 28780 of file SatParameters.java.

clearFeasibilityJumpEnableRestarts()

Builder com.google.ortools.sat.SatParameters.Builder.clearFeasibilityJumpEnableRestarts

(

)

When stagnating, feasibility jump will either restart from a default
solution (with some possible randomization), or randomly pertubate the
current solution. This parameter selects the first option.

optional bool feasibility_jump_enable_restarts = 250 [default = true];

Returns

This builder for chaining.

Definition at line 29136 of file SatParameters.java.

clearFeasibilityJumpLinearizationLevel()

Builder com.google.ortools.sat.SatParameters.Builder.clearFeasibilityJumpLinearizationLevel

(

)

How much do we linearize the problem in the local search code.

optional int32 feasibility_jump_linearization_level = 257 [default = 2];

Returns

This builder for chaining.

Definition at line 28836 of file SatParameters.java.

clearFeasibilityJumpMaxExpandedConstraintSize()

Builder com.google.ortools.sat.SatParameters.Builder.clearFeasibilityJumpMaxExpandedConstraintSize

(

)

Maximum size of no_overlap or no_overlap_2d constraint for a quadratic
expansion. This might look a lot, but by expanding such constraint, we get
a linear time evaluation per single variable moves instead of a slow O(n
log n) one.

optional int32 feasibility_jump_max_expanded_constraint_size = 264 [default = 500];

Returns

This builder for chaining.

Definition at line 29204 of file SatParameters.java.

clearFeasibilityJumpRestartFactor()

Builder com.google.ortools.sat.SatParameters.Builder.clearFeasibilityJumpRestartFactor

(

)

This is a factor that directly influence the work before each restart.
Increasing it leads to longer restart.

optional int32 feasibility_jump_restart_factor = 258 [default = 1];

Returns

This builder for chaining.

Definition at line 28896 of file SatParameters.java.

clearFeasibilityJumpVarPerburbationRangeRatio()

Builder com.google.ortools.sat.SatParameters.Builder.clearFeasibilityJumpVarPerburbationRangeRatio

(

)

Max distance between the default value and the pertubated value relative to
the range of the domain of the variable.

optional double feasibility_jump_var_perburbation_range_ratio = 248 [default = 0.2];

Returns

This builder for chaining.

Definition at line 29072 of file SatParameters.java.

clearFeasibilityJumpVarRandomizationProbability()

Builder com.google.ortools.sat.SatParameters.Builder.clearFeasibilityJumpVarRandomizationProbability

(

)

Probability for a variable to have a non default value upon restarts or
perturbations.

optional double feasibility_jump_var_randomization_probability = 247 [default = 0.05];

Returns

This builder for chaining.

Definition at line 29012 of file SatParameters.java.

clearFillAdditionalSolutionsInResponse()

Builder com.google.ortools.sat.SatParameters.Builder.clearFillAdditionalSolutionsInResponse

(

)

If true, the final response addition_solutions field will be filled with
all solutions from our solutions pool.

Note that if both this field and enumerate_all_solutions is true, we will
copy to the pool all of the solution found. So if solution_pool_size is big
enough, you can get all solutions this way instead of using the solution
callback.

Note that this only affect the "final" solution, not the one passed to the
solution callbacks.

optional bool fill_additional_solutions_in_response = 194 [default = false];

Returns

This builder for chaining.

Definition at line 30198 of file SatParameters.java.

clearFillTightenedDomainsInResponse()

Builder com.google.ortools.sat.SatParameters.Builder.clearFillTightenedDomainsInResponse

(

)

If true, add information about the derived variable domains to the
CpSolverResponse. It is an option because it makes the response slighly
bigger and there is a bit more work involved during the postsolve to
construct it, but it should still have a low overhead. See the
tightened_variables field in CpSolverResponse for more details.

optional bool fill_tightened_domains_in_response = 132 [default = false];

Returns

This builder for chaining.

Definition at line 30106 of file SatParameters.java.

clearFilterSubsolvers()

Builder com.google.ortools.sat.SatParameters.Builder.clearFilterSubsolvers

(

)

repeated string filter_subsolvers = 293;

Returns

This builder for chaining.

Definition at line 24819 of file SatParameters.java.

clearFindBigLinearOverlap()

Builder com.google.ortools.sat.SatParameters.Builder.clearFindBigLinearOverlap

(

)

Try to find large "rectangle" in the linear constraint matrix with
identical lines. If such rectangle is big enough, we can introduce a new
integer variable corresponding to the common expression and greatly reduce
the number of non-zero.

optional bool find_big_linear_overlap = 234 [default = true];

Returns

This builder for chaining.

Definition at line 23497 of file SatParameters.java.

clearFindMultipleCores()

Builder com.google.ortools.sat.SatParameters.Builder.clearFindMultipleCores

(

)

Whether we try to find more independent cores for a given set of
assumptions in the core based max-SAT algorithms.

optional bool find_multiple_cores = 84 [default = true];

Returns

This builder for chaining.

Definition at line 25938 of file SatParameters.java.

clearFixVariablesToTheirHintedValue()

Builder com.google.ortools.sat.SatParameters.Builder.clearFixVariablesToTheirHintedValue

(

)

If true, variables appearing in the solution hints will be fixed to their
hinted value.

optional bool fix_variables_to_their_hinted_value = 192 [default = false];

Returns

This builder for chaining.

Definition at line 27628 of file SatParameters.java.

clearFpRounding()

Builder com.google.ortools.sat.SatParameters.Builder.clearFpRounding

(

)

optional .operations_research.sat.SatParameters.FPRoundingMethod fp_rounding = 165 [default = PROPAGATION_ASSISTED];

Returns

This builder for chaining.

Definition at line 30884 of file SatParameters.java.

clearGlucoseDecayIncrement()

Builder com.google.ortools.sat.SatParameters.Builder.clearGlucoseDecayIncrement

(

)

optional double glucose_decay_increment = 23 [default = 0.01];

Returns

This builder for chaining.

Definition at line 19507 of file SatParameters.java.

clearGlucoseDecayIncrementPeriod()

Builder com.google.ortools.sat.SatParameters.Builder.clearGlucoseDecayIncrementPeriod

(

)

optional int32 glucose_decay_increment_period = 24 [default = 5000];

Returns

This builder for chaining.

Definition at line 19547 of file SatParameters.java.

clearGlucoseMaxDecay()

Builder com.google.ortools.sat.SatParameters.Builder.clearGlucoseMaxDecay

(

)

The activity starts at 0.8 and increment by 0.01 every 5000 conflicts until
0.95. This "hack" seems to work well and comes from:

Glucose 2.3 in the SAT 2013 Competition - SAT Competition 2013
http://edacc4.informatik.uni-ulm.de/SC13/solver-description-download/136

optional double glucose_max_decay = 22 [default = 0.95];

Returns

This builder for chaining.

Definition at line 19467 of file SatParameters.java.

clearHintConflictLimit()

Builder com.google.ortools.sat.SatParameters.Builder.clearHintConflictLimit

(

)

Conflict limit used in the phase that exploit the solution hint.

optional int32 hint_conflict_limit = 153 [default = 10];

Returns

This builder for chaining.

Definition at line 27500 of file SatParameters.java.

clearIgnoreNames()

Builder com.google.ortools.sat.SatParameters.Builder.clearIgnoreNames

(

)

If true, we don't keep names in our internal copy of the user given model.

optional bool ignore_names = 202 [default = true];

Returns

This builder for chaining.

Definition at line 23345 of file SatParameters.java.

clearIgnoreSubsolvers()

Builder com.google.ortools.sat.SatParameters.Builder.clearIgnoreSubsolvers

(

)

Rather than fully specifying subsolvers, it is often convenient to just
remove the ones that are not useful on a given problem or only keep
specific ones for testing. Each string is interpreted as a "glob", so we
support '*' and '?'.

The way this work is that we will only accept a name that match a filter
pattern (if non-empty) and do not match an ignore pattern. Note also that
these fields work on LNS or LS names even if these are currently not
specified via the subsolvers field.

repeated string ignore_subsolvers = 209;

Returns

This builder for chaining.

Definition at line 24697 of file SatParameters.java.

clearInferAllDiffs()

Builder com.google.ortools.sat.SatParameters.Builder.clearInferAllDiffs

(

)

Run a max-clique code amongst all the x != y we can find and try to infer
set of variables that are all different. This allows to close neos16.mps
for instance. Note that we only run this code if there is no all_diff
already in the model so that if a user want to add some all_diff, we assume
it is well done and do not try to add more.

This will also detect and add no_overlap constraints, if all the relations
x != y have "offsets" between them. I.e. x > y + offset.

optional bool infer_all_diffs = 233 [default = true];

Returns

This builder for chaining.

Definition at line 23429 of file SatParameters.java.

clearInitialPolarity()

Builder com.google.ortools.sat.SatParameters.Builder.clearInitialPolarity

(

)

optional .operations_research.sat.SatParameters.Polarity initial_polarity = 2 [default = POLARITY_FALSE];

Returns

This builder for chaining.

Definition at line 18195 of file SatParameters.java.

clearInitialVariablesActivity()

Builder com.google.ortools.sat.SatParameters.Builder.clearInitialVariablesActivity

(

)

The initial value of the variables activity. A non-zero value only make
sense when use_erwa_heuristic is true. Experiments with a value of 1e-2
together with the ERWA heuristic showed slighthly better result than simply
using zero. The idea is that when the "learning rate" of a variable becomes
lower than this value, then we prefer to branch on never explored before
variables. This is not in the ERWA paper.

optional double initial_variables_activity = 76 [default = 0];

Returns

This builder for chaining.

Definition at line 18631 of file SatParameters.java.

clearInprocessingDtimeRatio()

Builder com.google.ortools.sat.SatParameters.Builder.clearInprocessingDtimeRatio

(

)

Proportion of deterministic time we should spend on inprocessing.
At each "restart", if the proportion is below this ratio, we will do some
inprocessing, otherwise, we skip it for this restart.

optional double inprocessing_dtime_ratio = 273 [default = 0.2];

Returns

This builder for chaining.

Definition at line 23621 of file SatParameters.java.

clearInprocessingMinimizationDtime()

Builder com.google.ortools.sat.SatParameters.Builder.clearInprocessingMinimizationDtime

(

)

Parameters for an heuristic similar to the one described in "An effective
learnt clause minimization approach for CDCL Sat Solvers",
https://www.ijcai.org/proceedings/2017/0098.pdf

This is the amount of dtime we should spend on this technique during each
inprocessing phase.

The minimization technique is the same as the one used to minimize core in
max-sat. We also minimize problem clauses and not just the learned clause
that we keep forever like in the paper.

optional double inprocessing_minimization_dtime = 275 [default = 1];

Returns

This builder for chaining.

Definition at line 23769 of file SatParameters.java.

clearInprocessingProbingDtime()

Builder com.google.ortools.sat.SatParameters.Builder.clearInprocessingProbingDtime

(

)

The amount of dtime we should spend on probing for each inprocessing round.

optional double inprocessing_probing_dtime = 274 [default = 1];

Returns

This builder for chaining.

Definition at line 23677 of file SatParameters.java.

clearInstantiateAllVariables()

Builder com.google.ortools.sat.SatParameters.Builder.clearInstantiateAllVariables

(

)

If true, the solver will add a default integer branching strategy to the
already defined search strategy. If not, some variable might still not be
fixed at the end of the search. For now we assume these variable can just
be set to their lower bound.

optional bool instantiate_all_variables = 106 [default = true];

Returns

This builder for chaining.

Definition at line 30266 of file SatParameters.java.

clearInterleaveBatchSize()

Builder com.google.ortools.sat.SatParameters.Builder.clearInterleaveBatchSize

(

)

optional int32 interleave_batch_size = 134 [default = 0];

Returns

This builder for chaining.

Definition at line 25334 of file SatParameters.java.

clearInterleaveSearch()

Builder com.google.ortools.sat.SatParameters.Builder.clearInterleaveSearch

(

)

Experimental. If this is true, then we interleave all our major search
strategy and distribute the work amongst num_workers.

The search is deterministic (independently of num_workers!), and we
schedule and wait for interleave_batch_size task to be completed before
synchronizing and scheduling the next batch of tasks.

optional bool interleave_search = 136 [default = false];

Returns

This builder for chaining.

Definition at line 25294 of file SatParameters.java.

clearKeepAllFeasibleSolutionsInPresolve()

Builder com.google.ortools.sat.SatParameters.Builder.clearKeepAllFeasibleSolutionsInPresolve

(

)

If true, we disable the presolve reductions that remove feasible solutions
from the search space. Such solution are usually dominated by a "better"
solution that is kept, but depending on the situation, we might want to
keep all solutions.

A trivial example is when a variable is unused. If this is true, then the
presolve will not fix it to an arbitrary value and it will stay in the
search space.

optional bool keep_all_feasible_solutions_in_presolve = 173 [default = false];

Returns

This builder for chaining.

Definition at line 30034 of file SatParameters.java.

clearLinearizationLevel()

Builder com.google.ortools.sat.SatParameters.Builder.clearLinearizationLevel

(

)

A non-negative level indicating the type of constraints we consider in the
LP relaxation. At level zero, no LP relaxation is used. At level 1, only
the linear constraint and full encoding are added. At level 2, we also add
all the Boolean constraints.

optional int32 linearization_level = 90 [default = 1];

Returns

This builder for chaining.

Definition at line 32032 of file SatParameters.java.

clearLinearSplitSize()

Builder com.google.ortools.sat.SatParameters.Builder.clearLinearSplitSize

(

)

Linear constraints that are not pseudo-Boolean and that are longer than
this size will be split into sqrt(size) intermediate sums in order to have
faster propation in the CP engine.

optional int32 linear_split_size = 256 [default = 100];

Returns

This builder for chaining.

Definition at line 31964 of file SatParameters.java.

clearLogPrefix()

Builder com.google.ortools.sat.SatParameters.Builder.clearLogPrefix

(

)

Add a prefix to all logs.

optional string log_prefix = 185 [default = ""];

Returns

This builder for chaining.

Definition at line 21328 of file SatParameters.java.

clearLogSearchProgress()

Builder com.google.ortools.sat.SatParameters.Builder.clearLogSearchProgress

(

)

Whether the solver should log the search progress. This is the maing
logging parameter and if this is false, none of the logging (callbacks,
log_to_stdout, log_to_response, ...) will do anything.

optional bool log_search_progress = 41 [default = false];

Returns

This builder for chaining.

Definition at line 21173 of file SatParameters.java.

clearLogSubsolverStatistics()

Builder com.google.ortools.sat.SatParameters.Builder.clearLogSubsolverStatistics

(

)

Whether the solver should display per sub-solver search statistics.
This is only useful is log_search_progress is set to true, and if the
number of search workers is > 1. Note that in all case we display a bit
of stats with one line per subsolver.

optional bool log_subsolver_statistics = 189 [default = false];

Returns

This builder for chaining.

Definition at line 21241 of file SatParameters.java.

clearLogToResponse()

Builder com.google.ortools.sat.SatParameters.Builder.clearLogToResponse

(

)

Log to response proto.

optional bool log_to_response = 187 [default = false];

Returns

This builder for chaining.

Definition at line 21457 of file SatParameters.java.

clearLogToStdout()

Builder com.google.ortools.sat.SatParameters.Builder.clearLogToStdout

(

)

Log to stdout.

optional bool log_to_stdout = 186 [default = true];

Returns

This builder for chaining.

Definition at line 21401 of file SatParameters.java.

clearLpDualTolerance()

Builder com.google.ortools.sat.SatParameters.Builder.clearLpDualTolerance

(

)

optional double lp_dual_tolerance = 267 [default = 1e-07];

Returns

This builder for chaining.

Definition at line 31696 of file SatParameters.java.

clearLpPrimalTolerance()

Builder com.google.ortools.sat.SatParameters.Builder.clearLpPrimalTolerance

(

)

The internal LP tolerances used by CP-SAT. These applies to the internal
and scaled problem. If the domains of your variables are large it might be
good to use lower tolerances. If your problem is binary with low
coefficients, it might be good to use higher ones to speed-up the lp
solves.

optional double lp_primal_tolerance = 266 [default = 1e-07];

Returns

This builder for chaining.

Definition at line 31656 of file SatParameters.java.

clearMaxAllDiffCutSize()

Builder com.google.ortools.sat.SatParameters.Builder.clearMaxAllDiffCutSize

(

)

Cut generator for all diffs can add too many cuts for large all_diff
constraints. This parameter restricts the large all_diff constraints to
have a cut generator.

optional int32 max_all_diff_cut_size = 148 [default = 64];

Returns

This builder for chaining.

Definition at line 32796 of file SatParameters.java.

clearMaxClauseActivityValue()

Builder com.google.ortools.sat.SatParameters.Builder.clearMaxClauseActivityValue

(

)

optional double max_clause_activity_value = 18 [default = 1e+20];

Returns

This builder for chaining.

Definition at line 19643 of file SatParameters.java.

clearMaxConsecutiveInactiveCount()

Builder com.google.ortools.sat.SatParameters.Builder.clearMaxConsecutiveInactiveCount

(

)

If a constraint/cut in LP is not active for that many consecutive OPTIMAL
solves, remove it from the LP. Note that it might be added again later if
it become violated by the current LP solution.

optional int32 max_consecutive_inactive_count = 121 [default = 100];

Returns

This builder for chaining.

Definition at line 33272 of file SatParameters.java.

clearMaxCutRoundsAtLevelZero()

Builder com.google.ortools.sat.SatParameters.Builder.clearMaxCutRoundsAtLevelZero

(

)

Max number of time we perform cut generation and resolve the LP at level 0.

optional int32 max_cut_rounds_at_level_zero = 154 [default = 1];

Returns

This builder for chaining.

Definition at line 33208 of file SatParameters.java.

clearMaxDeterministicTime()

Builder com.google.ortools.sat.SatParameters.Builder.clearMaxDeterministicTime

(

)

Maximum time allowed in deterministic time to solve a problem.
The deterministic time should be correlated with the real time used by the
solver, the time unit being as close as possible to a second.

optional double max_deterministic_time = 67 [default = inf];

Returns

This builder for chaining.

Definition at line 20501 of file SatParameters.java.

clearMaxDomainSizeWhenEncodingEqNeqConstraints()

Builder com.google.ortools.sat.SatParameters.Builder.clearMaxDomainSizeWhenEncodingEqNeqConstraints

(

)

When loading a*x + b*y ==/!= c when x and y are both fully encoded.
The solver may decide to replace the linear equation by a set of clauses.
This is triggered if the sizes of the domains of x and y are below the
threshold.

optional int32 max_domain_size_when_encoding_eq_neq_constraints = 191 [default = 16];

Returns

This builder for chaining.

Definition at line 32160 of file SatParameters.java.

clearMaxIntegerRoundingScaling()

Builder com.google.ortools.sat.SatParameters.Builder.clearMaxIntegerRoundingScaling

(

)

In the integer rounding procedure used for MIR and Gomory cut, the maximum
"scaling" we use (must be positive). The lower this is, the lower the
integer coefficients of the cut will be. Note that cut generated by lower
values are not necessarily worse than cut generated by larger value. There
is no strict dominance relationship.

Setting this to 2 result in the "strong fractional rouding" of Letchford
and Lodi.

optional int32 max_integer_rounding_scaling = 119 [default = 600];

Returns

This builder for chaining.

Definition at line 32944 of file SatParameters.java.

clearMaxLinMaxSizeForExpansion()

Builder com.google.ortools.sat.SatParameters.Builder.clearMaxLinMaxSizeForExpansion

(

)

If the number of expressions in the lin_max is less that the max size
parameter, model expansion replaces target = max(xi) by linear constraint
with the introduction of new booleans bi such that bi => target == xi.

This is mainly for experimenting compared to a custom lin_max propagator.

optional int32 max_lin_max_size_for_expansion = 280 [default = 0];

Returns

This builder for chaining.

Definition at line 22833 of file SatParameters.java.

clearMaxMemoryInMb()

Builder com.google.ortools.sat.SatParameters.Builder.clearMaxMemoryInMb

(

)

Maximum memory allowed for the whole thread containing the solver. The
solver will abort as soon as it detects that this limit is crossed. As a
result, this limit is approximative, but usually the solver will not go too
much over.

TODO(user): This is only used by the pure SAT solver, generalize to CP-SAT.

optional int64 max_memory_in_mb = 40 [default = 10000];

Returns

This builder for chaining.

Definition at line 20717 of file SatParameters.java.

clearMaxNumberOfConflicts()

Builder com.google.ortools.sat.SatParameters.Builder.clearMaxNumberOfConflicts

(

)

Maximum number of conflicts allowed to solve a problem.

TODO(user): Maybe change the way the conflict limit is enforced?
currently it is enforced on each independent internal SAT solve, rather
than on the overall number of conflicts across all solves. So in the
context of an optimization problem, this is not really usable directly by a
client.

optional int64 max_number_of_conflicts = 37 [default = 9223372036854775807];

Returns

This builder for chaining.

Definition at line 20641 of file SatParameters.java.

clearMaxNumCuts()

Builder com.google.ortools.sat.SatParameters.Builder.clearMaxNumCuts

(

)

The limit on the number of cuts in our cut pool. When this is reached we do
not generate cuts anymore.

TODO(user): We should probably remove this parameters, and just always
generate cuts but only keep the best n or something.

optional int32 max_num_cuts = 91 [default = 10000];

Returns

This builder for chaining.

Definition at line 32232 of file SatParameters.java.

clearMaxNumDeterministicBatches()

Builder com.google.ortools.sat.SatParameters.Builder.clearMaxNumDeterministicBatches

(

)

Stops after that number of batches has been scheduled. This only make sense
when interleave_search is true.

optional int32 max_num_deterministic_batches = 291 [default = 0];

Returns

This builder for chaining.

Definition at line 20561 of file SatParameters.java.

clearMaxNumIntervalsForTimetableEdgeFinding()

Builder com.google.ortools.sat.SatParameters.Builder.clearMaxNumIntervalsForTimetableEdgeFinding

(

)

Max number of intervals for the timetable_edge_finding algorithm to
propagate. A value of 0 disables the constraint.

optional int32 max_num_intervals_for_timetable_edge_finding = 260 [default = 100];

Returns

This builder for chaining.

Definition at line 26866 of file SatParameters.java.

clearMaxPairsPairwiseReasoningInNoOverlap2D()

Builder com.google.ortools.sat.SatParameters.Builder.clearMaxPairsPairwiseReasoningInNoOverlap2D

(

)

If the number of pairs to look is below this threshold, do an extra step of
propagation in the no_overlap_2d constraint by looking at all pairs of
intervals.

optional int32 max_pairs_pairwise_reasoning_in_no_overlap_2d = 276 [default = 1250];

Returns

This builder for chaining.

Definition at line 27338 of file SatParameters.java.

clearMaxPresolveIterations()

Builder com.google.ortools.sat.SatParameters.Builder.clearMaxPresolveIterations

(

)

In case of large reduction in a presolve iteration, we perform multiple
presolve iterations. This parameter controls the maximum number of such
presolve iterations.

optional int32 max_presolve_iterations = 138 [default = 3];

Returns

This builder for chaining.

Definition at line 22165 of file SatParameters.java.

clearMaxSatAssumptionOrder()

Builder com.google.ortools.sat.SatParameters.Builder.clearMaxSatAssumptionOrder

(

)

optional .operations_research.sat.SatParameters.MaxSatAssumptionOrder max_sat_assumption_order = 51 [default = DEFAULT_ASSUMPTION_ORDER];

Returns

This builder for chaining.

Definition at line 26044 of file SatParameters.java.

clearMaxSatReverseAssumptionOrder()

Builder com.google.ortools.sat.SatParameters.Builder.clearMaxSatReverseAssumptionOrder

(

)

If true, adds the assumption in the reverse order of the one defined by
max_sat_assumption_order.

optional bool max_sat_reverse_assumption_order = 52 [default = false];

Returns

This builder for chaining.

Definition at line 26104 of file SatParameters.java.

clearMaxSatStratification()

Builder com.google.ortools.sat.SatParameters.Builder.clearMaxSatStratification

(

)

optional .operations_research.sat.SatParameters.MaxSatStratificationAlgorithm max_sat_stratification = 53 [default = STRATIFICATION_DESCENT];

Returns

This builder for chaining.

Definition at line 26146 of file SatParameters.java.

clearMaxSizeToCreatePrecedenceLiteralsInDisjunctive()

Builder com.google.ortools.sat.SatParameters.Builder.clearMaxSizeToCreatePrecedenceLiteralsInDisjunctive

(

)

Create one literal for each disjunction of two pairs of tasks. This slows
down the solve time, but improves the lower bound of the objective in the
makespan case. This will be triggered if the number of intervals is less or
equal than the parameter and if use_strong_propagation_in_disjunctive is
true.

optional int32 max_size_to_create_precedence_literals_in_disjunctive = 229 [default = 60];

Returns

This builder for chaining.

Definition at line 26394 of file SatParameters.java.

clearMaxTimeInSeconds()

Builder com.google.ortools.sat.SatParameters.Builder.clearMaxTimeInSeconds

(

)

Maximum time allowed in seconds to solve a problem.
The counter will starts at the beginning of the Solve() call.

optional double max_time_in_seconds = 36 [default = inf];

Returns

This builder for chaining.

Definition at line 20437 of file SatParameters.java.

clearMaxVariableActivityValue()

Builder com.google.ortools.sat.SatParameters.Builder.clearMaxVariableActivityValue

(

)

optional double max_variable_activity_value = 16 [default = 1e+100];

Returns

This builder for chaining.

Definition at line 19395 of file SatParameters.java.

clearMergeAtMostOneWorkLimit()

Builder com.google.ortools.sat.SatParameters.Builder.clearMergeAtMostOneWorkLimit

(

)

optional double merge_at_most_one_work_limit = 146 [default = 100000000];

Returns

This builder for chaining.

Definition at line 23065 of file SatParameters.java.

clearMergeNoOverlapWorkLimit()

Builder com.google.ortools.sat.SatParameters.Builder.clearMergeNoOverlapWorkLimit

(

)

During presolve, we use a maximum clique heuristic to merge together
no-overlap constraints or at most one constraints. This code can be slow,
so we have a limit in place on the number of explored nodes in the
underlying graph. The internal limit is an int64, but we use double here to
simplify manual input.

optional double merge_no_overlap_work_limit = 145 [default = 1000000000000];

Returns

This builder for chaining.

Definition at line 23025 of file SatParameters.java.

clearMinimizationAlgorithm()

Builder com.google.ortools.sat.SatParameters.Builder.clearMinimizationAlgorithm

(

)

optional .operations_research.sat.SatParameters.ConflictMinimizationAlgorithm minimization_algorithm = 4 [default = RECURSIVE];

Returns

This builder for chaining.

Definition at line 18741 of file SatParameters.java.

clearMinimizeReductionDuringPbResolution()

Builder com.google.ortools.sat.SatParameters.Builder.clearMinimizeReductionDuringPbResolution

(

)

A different algorithm during PB resolution. It minimizes the number of
calls to ReduceCoefficients() which can be time consuming. However, the
search space will be different and if the coefficients are large, this may
lead to integer overflows that could otherwise be prevented.

optional bool minimize_reduction_during_pb_resolution = 48 [default = false];

Returns

This builder for chaining.

Definition at line 21593 of file SatParameters.java.

clearMinOrthogonalityForLpConstraints()

Builder com.google.ortools.sat.SatParameters.Builder.clearMinOrthogonalityForLpConstraints

(

)

While adding constraints, skip the constraints which have orthogonality
less than 'min_orthogonality_for_lp_constraints' with already added
constraints during current call. Orthogonality is defined as 1 -
cosine(vector angle between constraints). A value of zero disable this
feature.

optional double min_orthogonality_for_lp_constraints = 115 [default = 0.05];

Returns

This builder for chaining.

Definition at line 33152 of file SatParameters.java.

clearMipAutomaticallyScaleVariables()

Builder com.google.ortools.sat.SatParameters.Builder.clearMipAutomaticallyScaleVariables

(

)

If true, some continuous variable might be automatically scaled. For now,
this is only the case where we detect that a variable is actually an
integer multiple of a constant. For instance, variables of the form k * 0.5
are quite frequent, and if we detect this, we will scale such variable
domain by 2 to make it implied integer.

optional bool mip_automatically_scale_variables = 166 [default = true];

Returns

This builder for chaining.

Definition at line 34132 of file SatParameters.java.

clearMipCheckPrecision()

Builder com.google.ortools.sat.SatParameters.Builder.clearMipCheckPrecision

(

)

As explained in mip_precision and mip_max_activity_exponent, we cannot
always reach the wanted precision during scaling. We use this threshold to
enphasize in the logs when the precision seems bad.

optional double mip_check_precision = 128 [default = 0.0001];

Returns

This builder for chaining.

Definition at line 34500 of file SatParameters.java.

clearMipComputeTrueObjectiveBound()

Builder com.google.ortools.sat.SatParameters.Builder.clearMipComputeTrueObjectiveBound

(

)

Even if we make big error when scaling the objective, we can always derive
a correct lower bound on the original objective by using the exact lower
bound on the scaled integer version of the objective. This should be fast,
but if you don't care about having a precise lower bound, you can turn it
off.

optional bool mip_compute_true_objective_bound = 198 [default = true];

Returns

This builder for chaining.

Definition at line 34572 of file SatParameters.java.

clearMipDropTolerance()

Builder com.google.ortools.sat.SatParameters.Builder.clearMipDropTolerance

(

)

Any value in the input mip with a magnitude lower than this will be set to
zero. This is to avoid some issue in LP presolving.

optional double mip_drop_tolerance = 232 [default = 1e-16];

Returns

This builder for chaining.

Definition at line 34780 of file SatParameters.java.

clearMipMaxActivityExponent()

Builder com.google.ortools.sat.SatParameters.Builder.clearMipMaxActivityExponent

(

)

To avoid integer overflow, we always force the maximum possible constraint
activity (and objective value) according to the initial variable domain to
be smaller than 2 to this given power. Because of this, we cannot always
reach the "mip_wanted_precision" parameter above.

This can go as high as 62, but some internal algo currently abort early if
they might run into integer overflow, so it is better to keep it a bit
lower than this.

optional int32 mip_max_activity_exponent = 127 [default = 53];

Returns

This builder for chaining.

Definition at line 34436 of file SatParameters.java.

clearMipMaxBound()

Builder com.google.ortools.sat.SatParameters.Builder.clearMipMaxBound

(

)

We need to bound the maximum magnitude of the variables for CP-SAT, and
that is the bound we use. If the MIP model expect larger variable value in
the solution, then the converted model will likely not be relevant.

optional double mip_max_bound = 124 [default = 10000000];

Returns

This builder for chaining.

Definition at line 33932 of file SatParameters.java.

clearMipMaxValidMagnitude()

Builder com.google.ortools.sat.SatParameters.Builder.clearMipMaxValidMagnitude

(

)

Any finite values in the input MIP must be below this threshold, otherwise
the model will be reported invalid. This is needed to avoid floating point
overflow when evaluating bounds * coeff for instance. We are a bit more
defensive, but in practice, users shouldn't use super large values in a
MIP.

optional double mip_max_valid_magnitude = 199 [default = 1e+20];

Returns

This builder for chaining.

Definition at line 34644 of file SatParameters.java.

clearMipPresolveLevel()

Builder com.google.ortools.sat.SatParameters.Builder.clearMipPresolveLevel

(

)

When solving a MIP, we do some basic floating point presolving before
scaling the problem to integer to be handled by CP-SAT. This control how
much of that presolve we do. It can help to better scale floating point
model, but it is not always behaving nicely.

optional int32 mip_presolve_level = 261 [default = 2];

Returns

This builder for chaining.

Definition at line 34848 of file SatParameters.java.

clearMipScaleLargeDomain()

Builder com.google.ortools.sat.SatParameters.Builder.clearMipScaleLargeDomain

(

)

If this is false, then mip_var_scaling is only applied to variables with
"small" domain. If it is true, we scale all floating point variable
independenlty of their domain.

optional bool mip_scale_large_domain = 225 [default = false];

Returns

This builder for chaining.

Definition at line 34060 of file SatParameters.java.

clearMipTreatHighMagnitudeBoundsAsInfinity()

Builder com.google.ortools.sat.SatParameters.Builder.clearMipTreatHighMagnitudeBoundsAsInfinity

(

)

By default, any variable/constraint bound with a finite value and a
magnitude greater than the mip_max_valid_magnitude will result with a
invalid model. This flags change the behavior such that such bounds are
silently transformed to +∞ or -∞.

It is recommended to keep it at false, and create valid bounds.

optional bool mip_treat_high_magnitude_bounds_as_infinity = 278 [default = false];

Returns

This builder for chaining.

Definition at line 34720 of file SatParameters.java.

clearMipVarScaling()

Builder com.google.ortools.sat.SatParameters.Builder.clearMipVarScaling

(

)

All continuous variable of the problem will be multiplied by this factor.
By default, we don't do any variable scaling and rely on the MIP model to
specify continuous variable domain with the wanted precision.

optional double mip_var_scaling = 125 [default = 1];

Returns

This builder for chaining.

Definition at line 33996 of file SatParameters.java.

clearMipWantedPrecision()

Builder com.google.ortools.sat.SatParameters.Builder.clearMipWantedPrecision

(

)

When scaling constraint with double coefficients to integer coefficients,
we will multiply by a power of 2 and round the coefficients. We will choose
the lowest power such that we have no potential overflow (see
mip_max_activity_exponent) and the worst case constraint activity error
does not exceed this threshold.

Note that we also detect constraint with rational coefficients and scale
them accordingly when it seems better instead of using a power of 2.

We also relax all constraint bounds by this absolute value. For pure
integer constraint, if this value if lower than one, this will not change
anything. However it is needed when scaling MIP problems.

If we manage to scale a constraint correctly, the maximum error we can make
will be twice this value (once for the scaling error and once for the
relaxed bounds). If we are not able to scale that well, we will display
that fact but still scale as best as we can.

optional double mip_wanted_precision = 126 [default = 1e-06];

Returns

This builder for chaining.

Definition at line 34352 of file SatParameters.java.

clearName()

Builder com.google.ortools.sat.SatParameters.Builder.clearName

(

)

In some context, like in a portfolio of search, it makes sense to name a
given parameters set for logging purpose.

optional string name = 171 [default = ""];

Returns

This builder for chaining.

Definition at line 18093 of file SatParameters.java.

clearNewConstraintsBatchSize()

Builder com.google.ortools.sat.SatParameters.Builder.clearNewConstraintsBatchSize

(

)

Add that many lazy constraints (or cuts) at once in the LP. Note that at
the beginning of the solve, we do add more than this.

optional int32 new_constraints_batch_size = 122 [default = 50];

Returns

This builder for chaining.

Definition at line 33492 of file SatParameters.java.

clearNewLinearPropagation()

Builder com.google.ortools.sat.SatParameters.Builder.clearNewLinearPropagation

(

)

The new linear propagation code treat all constraints at once and use
an adaptation of Bellman-Ford-Tarjan to propagate constraint in a smarter
order and potentially detect propagation cycle earlier.

optional bool new_linear_propagation = 224 [default = true];

Returns

This builder for chaining.

Definition at line 31900 of file SatParameters.java.

clearNumConflictsBeforeStrategyChanges()

Builder com.google.ortools.sat.SatParameters.Builder.clearNumConflictsBeforeStrategyChanges

(

)

After each restart, if the number of conflict since the last strategy
change is greater that this, then we increment a "strategy_counter" that
can be use to change the search strategy used by the following restarts.

optional int32 num_conflicts_before_strategy_changes = 68 [default = 0];

Returns

This builder for chaining.

Definition at line 20317 of file SatParameters.java.

clearNumFullSubsolvers()

Builder com.google.ortools.sat.SatParameters.Builder.clearNumFullSubsolvers

(

)

We distinguish subsolvers that consume a full thread, and the ones that are
always interleaved. If left at zero, we will fix this with a default
formula that depends on num_workers. But if you start modifying what runs,
you might want to fix that to a given value depending on the num_workers
you use.

optional int32 num_full_subsolvers = 294 [default = 0];

Returns

This builder for chaining.

Definition at line 23989 of file SatParameters.java.

clearNumSearchWorkers()

Builder com.google.ortools.sat.SatParameters.Builder.clearNumSearchWorkers

(

)

optional int32 num_search_workers = 100 [default = 0];

Returns

This builder for chaining.

Definition at line 23917 of file SatParameters.java.

clearNumViolationLs()

Builder com.google.ortools.sat.SatParameters.Builder.clearNumViolationLs

(

)

This will create incomplete subsolvers (that are not LNS subsolvers)
that use the feasibility jump code to find improving solution, treating
the objective improvement as a hard constraint.

optional int32 num_violation_ls = 244 [default = 0];

Returns

This builder for chaining.

Definition at line 29268 of file SatParameters.java.

clearNumWorkers()

Builder com.google.ortools.sat.SatParameters.Builder.clearNumWorkers

(

)

Specify the number of parallel workers (i.e. threads) to use during search.
This should usually be lower than your number of available cpus +
hyperthread in your machine.

A value of 0 means the solver will try to use all cores on the machine.
A number of 1 means no parallelism.

Note that 'num_workers' is the preferred name, but if it is set to zero,
we will still read the deprecated 'num_search_workers'.

As of 2020-04-10, if you're using SAT via MPSolver (to solve integer
programs) this field is overridden with a value of 8, if the field is not
set *explicitly*. Thus, always set this field explicitly or via
MPSolver::SetNumThreads().

optional int32 num_workers = 206 [default = 0];

Returns

This builder for chaining.

Definition at line 23877 of file SatParameters.java.

clearOnlyAddCutsAtLevelZero()

Builder com.google.ortools.sat.SatParameters.Builder.clearOnlyAddCutsAtLevelZero

(

)

For the cut that can be generated at any level, this control if we only
try to generate them at the root node.

optional bool only_add_cuts_at_level_zero = 92 [default = false];

Returns

This builder for chaining.

Definition at line 32356 of file SatParameters.java.

clearOnlySolveIp()

Builder com.google.ortools.sat.SatParameters.Builder.clearOnlySolveIp

(

)

If one try to solve a MIP model with CP-SAT, because we assume all variable
to be integer after scaling, we will not necessarily have the correct
optimal. Note however that all feasible solutions are valid since we will
just solve a more restricted version of the original problem.

This parameters is here to prevent user to think the solution is optimal
when it might not be. One will need to manually set this to false to solve
a MIP model where the optimal might be different.

Note that this is tested after some MIP presolve steps, so even if not
all original variable are integer, we might end up with a pure IP after
presolve and after implied integer detection.

optional bool only_solve_ip = 222 [default = false];

Returns

This builder for chaining.

Definition at line 34232 of file SatParameters.java.

clearOptimizeWithCore()

Builder com.google.ortools.sat.SatParameters.Builder.clearOptimizeWithCore

(

)

The default optimization method is a simple "linear scan", each time trying
to find a better solution than the previous one. If this is true, then we
use a core-based approach (like in max-SAT) when we try to increase the
lower bound instead.

optional bool optimize_with_core = 83 [default = false];

Returns

This builder for chaining.

Definition at line 28304 of file SatParameters.java.

clearOptimizeWithLbTreeSearch()

Builder com.google.ortools.sat.SatParameters.Builder.clearOptimizeWithLbTreeSearch

(

)

Do a more conventional tree search (by opposition to SAT based one) where
we keep all the explored node in a tree. This is meant to be used in a
portfolio and focus on improving the objective lower bound. Keeping the
whole tree allow us to report a better objective lower bound coming from
the worst open node in the tree.

optional bool optimize_with_lb_tree_search = 188 [default = false];

Returns

This builder for chaining.

Definition at line 28376 of file SatParameters.java.

clearOptimizeWithMaxHs()

Builder com.google.ortools.sat.SatParameters.Builder.clearOptimizeWithMaxHs

(

)

This has no effect if optimize_with_core is false. If true, use a different
core-based algorithm similar to the max-HS algo for max-SAT. This is a
hybrid MIP/CP approach and it uses a MIP solver in addition to the CP/SAT
one. This is also related to the PhD work of tobyodavies@
"Automatic Logic-Based Benders Decomposition with MiniZinc"
http://aaai.org/ocs/index.php/AAAI/AAAI17/paper/view/14489

optional bool optimize_with_max_hs = 85 [default = false];

Returns

This builder for chaining.

Definition at line 28596 of file SatParameters.java.

clearPbCleanupIncrement()

Builder com.google.ortools.sat.SatParameters.Builder.clearPbCleanupIncrement

(

)

Same as for the clauses, but for the learned pseudo-Boolean constraints.

optional int32 pb_cleanup_increment = 46 [default = 200];

Returns

This builder for chaining.

Definition at line 19231 of file SatParameters.java.

clearPbCleanupRatio()

Builder com.google.ortools.sat.SatParameters.Builder.clearPbCleanupRatio

(

)

optional double pb_cleanup_ratio = 47 [default = 0.5];

Returns

This builder for chaining.

Definition at line 19271 of file SatParameters.java.

clearPermutePresolveConstraintOrder()

Builder com.google.ortools.sat.SatParameters.Builder.clearPermutePresolveConstraintOrder

(

)

optional bool permute_presolve_constraint_order = 179 [default = false];

Returns

This builder for chaining.

Definition at line 21069 of file SatParameters.java.

clearPermuteVariableRandomly()

Builder com.google.ortools.sat.SatParameters.Builder.clearPermuteVariableRandomly

(

)

This is mainly here to test the solver variability. Note that in tests, if
not explicitly set to false, all 3 options will be set to true so that
clients do not rely on the solver returning a specific solution if they are
many equivalent optimal solutions.

optional bool permute_variable_randomly = 178 [default = false];

Returns

This builder for chaining.

Definition at line 21029 of file SatParameters.java.

clearPolarityRephaseIncrement()

Builder com.google.ortools.sat.SatParameters.Builder.clearPolarityRephaseIncrement

(

)

If non-zero, then we change the polarity heuristic after that many number
of conflicts in an arithmetically increasing fashion. So x the first time,
2 * x the second time, etc...

optional int32 polarity_rephase_increment = 168 [default = 1000];

Returns

This builder for chaining.

Definition at line 18355 of file SatParameters.java.

clearPolishLpSolution()

Builder com.google.ortools.sat.SatParameters.Builder.clearPolishLpSolution

(

)

Whether we try to do a few degenerate iteration at the end of an LP solve
to minimize the fractionality of the integer variable in the basis. This
helps on some problems, but not so much on others. It also cost of bit of
time to do such polish step.

optional bool polish_lp_solution = 175 [default = false];

Returns

This builder for chaining.

Definition at line 31584 of file SatParameters.java.

clearPreferredVariableOrder()

Builder com.google.ortools.sat.SatParameters.Builder.clearPreferredVariableOrder

(

)

optional .operations_research.sat.SatParameters.VariableOrder preferred_variable_order = 1 [default = IN_ORDER];

Returns

This builder for chaining.

Definition at line 18153 of file SatParameters.java.

clearPresolveBlockedClause()

Builder com.google.ortools.sat.SatParameters.Builder.clearPresolveBlockedClause

(

)

Whether we use an heuristic to detect some basic case of blocked clause
in the SAT presolve.

optional bool presolve_blocked_clause = 88 [default = true];

Returns

This builder for chaining.

Definition at line 21977 of file SatParameters.java.

clearPresolveBvaThreshold()

Builder com.google.ortools.sat.SatParameters.Builder.clearPresolveBvaThreshold

(

)

Apply Bounded Variable Addition (BVA) if the number of clauses is reduced
by stricly more than this threshold. The algorithm described in the paper
uses 0, but quick experiments showed that 1 is a good value. It may not be
worth it to add a new variable just to remove one clause.

optional int32 presolve_bva_threshold = 73 [default = 1];

Returns

This builder for chaining.

Definition at line 22101 of file SatParameters.java.

clearPresolveBveClauseWeight()

Builder com.google.ortools.sat.SatParameters.Builder.clearPresolveBveClauseWeight

(

)

During presolve, we apply BVE only if this weight times the number of
clauses plus the number of clause literals is not increased.

optional int32 presolve_bve_clause_weight = 55 [default = 3];

Returns

This builder for chaining.

Definition at line 21805 of file SatParameters.java.

clearPresolveBveThreshold()

Builder com.google.ortools.sat.SatParameters.Builder.clearPresolveBveThreshold

(

)

During presolve, only try to perform the bounded variable elimination (BVE)
of a variable x if the number of occurrences of x times the number of
occurrences of not(x) is not greater than this parameter.

optional int32 presolve_bve_threshold = 54 [default = 500];

Returns

This builder for chaining.

Definition at line 21745 of file SatParameters.java.

clearPresolveExtractIntegerEnforcement()

Builder com.google.ortools.sat.SatParameters.Builder.clearPresolveExtractIntegerEnforcement

(

)

If true, we will extract from linear constraints, enforcement literals of
the form "integer variable at bound => simplified constraint". This should
always be beneficial except that we don't always handle them as efficiently
as we could for now. This causes problem on manna81.mps (LP relaxation not
as tight it seems) and on neos-3354841-apure.mps.gz (too many literals
created this way).

optional bool presolve_extract_integer_enforcement = 174 [default = false];

Returns

This builder for chaining.

Definition at line 23209 of file SatParameters.java.

clearPresolveInclusionWorkLimit()

Builder com.google.ortools.sat.SatParameters.Builder.clearPresolveInclusionWorkLimit

(

)

A few presolve operations involve detecting constraints included in other
constraint. Since there can be a quadratic number of such pairs, and
processing them usually involve scanning them, the complexity of these
operations can be big. This enforce a local deterministic limit on the
number of entries scanned. Default is 1e8.

A value of zero will disable these presolve rules completely.

optional int64 presolve_inclusion_work_limit = 201 [default = 100000000];

Returns

This builder for chaining.

Definition at line 23289 of file SatParameters.java.

clearPresolveProbingDeterministicTimeLimit()

Builder com.google.ortools.sat.SatParameters.Builder.clearPresolveProbingDeterministicTimeLimit

(

)

optional double presolve_probing_deterministic_time_limit = 57 [default = 30];

Returns

This builder for chaining.

Definition at line 21917 of file SatParameters.java.

clearPresolveSubstitutionLevel()

Builder com.google.ortools.sat.SatParameters.Builder.clearPresolveSubstitutionLevel

(

)

How much substitution (also called free variable aggregation in MIP
litterature) should we perform at presolve. This currently only concerns
variable appearing only in linear constraints. For now the value 0 turns it
off and any positive value performs substitution.

optional int32 presolve_substitution_level = 147 [default = 1];

Returns

This builder for chaining.

Definition at line 23133 of file SatParameters.java.

clearPresolveUseBva()

Builder com.google.ortools.sat.SatParameters.Builder.clearPresolveUseBva

(

)

Whether or not we use Bounded Variable Addition (BVA) in the presolve.

optional bool presolve_use_bva = 72 [default = true];

Returns

This builder for chaining.

Definition at line 22033 of file SatParameters.java.

clearProbingDeterministicTimeLimit()

Builder com.google.ortools.sat.SatParameters.Builder.clearProbingDeterministicTimeLimit

(

)

The maximum "deterministic" time limit to spend in probing. A value of
zero will disable the probing.

TODO(user): Clean up. The first one is used in CP-SAT, the other in pure
SAT presolve.

optional double probing_deterministic_time_limit = 226 [default = 1];

Returns

This builder for chaining.

Definition at line 21877 of file SatParameters.java.

clearProbingNumCombinationsLimit()

Builder com.google.ortools.sat.SatParameters.Builder.clearProbingNumCombinationsLimit

(

)

How many combinations of pairs or triplets of variables we want to scan.

optional int32 probing_num_combinations_limit = 272 [default = 20000];

Returns

This builder for chaining.

Definition at line 27804 of file SatParameters.java.

clearPropagationLoopDetectionFactor()

Builder com.google.ortools.sat.SatParameters.Builder.clearPropagationLoopDetectionFactor

(

)

Some search decisions might cause a really large number of propagations to
happen when integer variables with large domains are only reduced by 1 at
each step. If we propagate more than the number of variable times this
parameters we try to take counter-measure. Setting this to 0.0 disable this
feature.

TODO(user): Setting this to something like 10 helps in most cases, but the
code is currently buggy and can cause the solve to enter a bad state where
no progress is made.

optional double propagation_loop_detection_factor = 221 [default = 10];

Returns

This builder for chaining.

Definition at line 26234 of file SatParameters.java.

clearPseudoCostReliabilityThreshold()

Builder com.google.ortools.sat.SatParameters.Builder.clearPseudoCostReliabilityThreshold

(

)

The solver ignores the pseudo costs of variables with number of recordings
less than this threshold.

optional int64 pseudo_cost_reliability_threshold = 123 [default = 100];

Returns

This builder for chaining.

Definition at line 28236 of file SatParameters.java.

clearPushAllTasksTowardStart()

Builder com.google.ortools.sat.SatParameters.Builder.clearPushAllTasksTowardStart

(

)

Experimental code: specify if the objective pushes all tasks toward the
start of the schedule.

optional bool push_all_tasks_toward_start = 262 [default = false];

Returns

This builder for chaining.

Definition at line 31120 of file SatParameters.java.

clearRandomBranchesRatio()

Builder com.google.ortools.sat.SatParameters.Builder.clearRandomBranchesRatio

(

)

A number between 0 and 1 that indicates the proportion of branching
variables that are selected randomly instead of choosing the first variable
from the given variable_ordering strategy.

optional double random_branches_ratio = 32 [default = 0];

Returns

This builder for chaining.

Definition at line 18491 of file SatParameters.java.

clearRandomizeSearch()

Builder com.google.ortools.sat.SatParameters.Builder.clearRandomizeSearch

(

)

Randomize fixed search.

optional bool randomize_search = 103 [default = false];

Returns

This builder for chaining.

Definition at line 30996 of file SatParameters.java.

clearRandomPolarityRatio()

Builder com.google.ortools.sat.SatParameters.Builder.clearRandomPolarityRatio

(

)

The proportion of polarity chosen at random. Note that this take
precedence over the phase saving heuristic. This is different from
initial_polarity:POLARITY_RANDOM because it will select a new random
polarity each time the variable is branched upon instead of selecting one
initially and then always taking this choice.

optional double random_polarity_ratio = 45 [default = 0];

Returns

This builder for chaining.

Definition at line 18427 of file SatParameters.java.

clearRandomSeed()

Builder com.google.ortools.sat.SatParameters.Builder.clearRandomSeed

(

)

At the beginning of each solve, the random number generator used in some
part of the solver is reinitialized to this seed. If you change the random
seed, the solver may make different choices during the solving process.

For some problems, the running time may vary a lot depending on small
change in the solving algorithm. Running the solver with different seeds
enables to have more robust benchmarks when evaluating new features.

optional int32 random_seed = 31 [default = 1];

Returns

This builder for chaining.

Definition at line 20961 of file SatParameters.java.

clearRelativeGapLimit()

Builder com.google.ortools.sat.SatParameters.Builder.clearRelativeGapLimit

(

)

optional double relative_gap_limit = 160 [default = 0];

Returns

This builder for chaining.

Definition at line 20881 of file SatParameters.java.

clearRepairHint()

Builder com.google.ortools.sat.SatParameters.Builder.clearRepairHint

(

)

If true, the solver tries to repair the solution given in the hint. This
search terminates after the 'hint_conflict_limit' is reached and the solver
switches to regular search. If false, then  we do a FIXED_SEARCH using the
hint until the hint_conflict_limit is reached.

optional bool repair_hint = 167 [default = false];

Returns

This builder for chaining.

Definition at line 27568 of file SatParameters.java.

clearRestartAlgorithms()

Builder com.google.ortools.sat.SatParameters.Builder.clearRestartAlgorithms

(

)

The restart strategies will change each time the strategy_counter is
increased. The current strategy will simply be the one at index
strategy_counter modulo the number of strategy. Note that if this list
includes a NO_RESTART, nothing will change when it is reached because the
strategy_counter will only increment after a restart.

The idea of switching of search strategy tailored for SAT/UNSAT comes from
Chanseok Oh with his COMiniSatPS solver, see http://cs.nyu.edu/~chanseok/.
But more generally, it seems REALLY beneficial to try different strategy.

repeated .operations_research.sat.SatParameters.RestartAlgorithm restart_algorithms = 61;

Returns

This builder for chaining.

Definition at line 19813 of file SatParameters.java.

clearRestartDlAverageRatio()

Builder com.google.ortools.sat.SatParameters.Builder.clearRestartDlAverageRatio

(

)

In the moving average restart algorithms, a restart is triggered if the
window average times this ratio is greater that the global average.

optional double restart_dl_average_ratio = 63 [default = 1];

Returns

This builder for chaining.

Definition at line 20069 of file SatParameters.java.

clearRestartLbdAverageRatio()

Builder com.google.ortools.sat.SatParameters.Builder.clearRestartLbdAverageRatio

(

)

optional double restart_lbd_average_ratio = 71 [default = 1];

Returns

This builder for chaining.

Definition at line 20109 of file SatParameters.java.

clearRestartPeriod()

Builder com.google.ortools.sat.SatParameters.Builder.clearRestartPeriod

(

)

Restart period for the FIXED_RESTART strategy. This is also the multiplier
used by the LUBY_RESTART strategy.

optional int32 restart_period = 30 [default = 50];

Returns

This builder for chaining.

Definition at line 19953 of file SatParameters.java.

clearRestartRunningWindowSize()

Builder com.google.ortools.sat.SatParameters.Builder.clearRestartRunningWindowSize

(

)

Size of the window for the moving average restarts.

optional int32 restart_running_window_size = 62 [default = 50];

Returns

This builder for chaining.

Definition at line 20009 of file SatParameters.java.

clearRootLpIterations()

Builder com.google.ortools.sat.SatParameters.Builder.clearRootLpIterations

(

)

Even at the root node, we do not want to spend too much time on the LP if
it is "difficult". So we solve it in "chunks" of that many iterations. The
solve will be continued down in the tree or the next time we go back to the
root node.

optional int32 root_lp_iterations = 227 [default = 2000];

Returns

This builder for chaining.

Definition at line 33080 of file SatParameters.java.

clearSaveLpBasisInLbTreeSearch()

Builder com.google.ortools.sat.SatParameters.Builder.clearSaveLpBasisInLbTreeSearch

(

)

Experimental. Save the current LP basis at each node of the search tree so
that when we jump around, we can load it and reduce the number of LP
iterations needed.

It currently works okay if we do not change the lp with cuts or
simplification... More work is needed to make it robust in all cases.

optional bool save_lp_basis_in_lb_tree_search = 284 [default = false];

Returns

This builder for chaining.

Definition at line 28452 of file SatParameters.java.

clearSearchBranching()

Builder com.google.ortools.sat.SatParameters.Builder.clearSearchBranching

(

)

optional .operations_research.sat.SatParameters.SearchBranching search_branching = 82 [default = AUTOMATIC_SEARCH];

Returns

This builder for chaining.

Definition at line 27444 of file SatParameters.java.

clearSearchRandomVariablePoolSize()

Builder com.google.ortools.sat.SatParameters.Builder.clearSearchRandomVariablePoolSize

(

)

Search randomization will collect the top
'search_random_variable_pool_size' valued variables, and pick one randomly.
The value of the variable is specific to each strategy.

optional int64 search_random_variable_pool_size = 104 [default = 0];

Returns

This builder for chaining.

Definition at line 31060 of file SatParameters.java.

clearShareBinaryClauses()

Builder com.google.ortools.sat.SatParameters.Builder.clearShareBinaryClauses

(

)

Allows sharing of new learned binary clause between workers.

optional bool share_binary_clauses = 203 [default = true];

Returns

This builder for chaining.

Definition at line 25502 of file SatParameters.java.

clearSharedTreeMaxNodesPerWorker()

Builder com.google.ortools.sat.SatParameters.Builder.clearSharedTreeMaxNodesPerWorker

(

)

In order to limit total shared memory and communication overhead, limit the
total number of nodes that may be generated in the shared tree. If the
shared tree runs out of unassigned leaves, workers act as portfolio
workers. Note: this limit includes interior nodes, not just leaves.

optional int32 shared_tree_max_nodes_per_worker = 238 [default = 100000];

Returns

This builder for chaining.

Definition at line 29828 of file SatParameters.java.

clearSharedTreeNumWorkers()

Builder com.google.ortools.sat.SatParameters.Builder.clearSharedTreeNumWorkers

(

)

Enables experimental workstealing-like shared tree search.
If non-zero, start this many complete worker threads to explore a shared
search tree. These workers communicate objective bounds and simple decision
nogoods relating to the shared prefix of the tree, and will avoid exploring
the same subtrees as one another.

optional int32 shared_tree_num_workers = 235 [default = 0];

Returns

This builder for chaining.

Definition at line 29456 of file SatParameters.java.

clearSharedTreeOpenLeavesPerWorker()

Builder com.google.ortools.sat.SatParameters.Builder.clearSharedTreeOpenLeavesPerWorker

(

)

How many open leaf nodes should the shared tree maintain per worker.

optional double shared_tree_open_leaves_per_worker = 281 [default = 2];

Returns

This builder for chaining.

Definition at line 29760 of file SatParameters.java.

clearSharedTreeSplitStrategy()

Builder com.google.ortools.sat.SatParameters.Builder.clearSharedTreeSplitStrategy

(

)

optional .operations_research.sat.SatParameters.SharedTreeSplitStrategy shared_tree_split_strategy = 239 [default = SPLIT_STRATEGY_AUTO];

Returns

This builder for chaining.

Definition at line 29870 of file SatParameters.java.

clearSharedTreeWorkerEnableTrailSharing()

Builder com.google.ortools.sat.SatParameters.Builder.clearSharedTreeWorkerEnableTrailSharing

(

)

If true, workers share more of the information from their local trail.
Specifically, literals implied by the shared tree decisions and
the longest conflict-free assignment from the last restart (to enable
cross-worker phase-saving).

optional bool shared_tree_worker_enable_trail_sharing = 295 [default = true];

Returns

This builder for chaining.

Definition at line 29704 of file SatParameters.java.

clearSharedTreeWorkerMinRestartsPerSubtree()

Builder com.google.ortools.sat.SatParameters.Builder.clearSharedTreeWorkerMinRestartsPerSubtree

(

)

Minimum number of restarts before a worker will replace a subtree
that looks "bad" based on the average LBD of learned clauses.

optional int32 shared_tree_worker_min_restarts_per_subtree = 282 [default = 1];

Returns

This builder for chaining.

Definition at line 29636 of file SatParameters.java.

clearSharedTreeWorkerObjectiveSplitProbability()

Builder com.google.ortools.sat.SatParameters.Builder.clearSharedTreeWorkerObjectiveSplitProbability

(

)

After their assigned prefix, shared tree workers will branch on the
objective with this probability. Higher numbers cause the shared tree
search to focus on improving the lower bound over finding primal solutions.

optional double shared_tree_worker_objective_split_probability = 237 [default = 0.5];

Returns

This builder for chaining.

Definition at line 29576 of file SatParameters.java.

clearShareGlueClauses()

Builder com.google.ortools.sat.SatParameters.Builder.clearShareGlueClauses

(

)

Allows sharing of short glue clauses between workers.
Implicitly disabled if share_binary_clauses is false.

optional bool share_glue_clauses = 285 [default = false];

Returns

This builder for chaining.

Definition at line 25562 of file SatParameters.java.

clearShareLevelZeroBounds()

Builder com.google.ortools.sat.SatParameters.Builder.clearShareLevelZeroBounds

(

)

Allows sharing of the bounds of modified variables at level 0.

optional bool share_level_zero_bounds = 114 [default = true];

Returns

This builder for chaining.

Definition at line 25446 of file SatParameters.java.

clearShareObjectiveBounds()

Builder com.google.ortools.sat.SatParameters.Builder.clearShareObjectiveBounds

(

)

Allows objective sharing between workers.

optional bool share_objective_bounds = 113 [default = true];

Returns

This builder for chaining.

Definition at line 25390 of file SatParameters.java.

clearShavingSearchDeterministicTime()

Builder com.google.ortools.sat.SatParameters.Builder.clearShavingSearchDeterministicTime

(

)

Specifies the amount of deterministic time spent of each try at shaving a
bound in the shaving search.

optional double shaving_search_deterministic_time = 205 [default = 0.001];

Returns

This builder for chaining.

Definition at line 27924 of file SatParameters.java.

clearShavingSearchThreshold()

Builder com.google.ortools.sat.SatParameters.Builder.clearShavingSearchThreshold

(

)

Specifies the threshold between two modes in the shaving procedure.
If the range of the variable/objective is less than this threshold, then
the shaving procedure will try to remove values one by one. Otherwise, it
will try to remove one range at a time.

optional int64 shaving_search_threshold = 290 [default = 64];

Returns

This builder for chaining.

Definition at line 27992 of file SatParameters.java.

clearSolutionPoolSize()

Builder com.google.ortools.sat.SatParameters.Builder.clearSolutionPoolSize

(

)

Size of the top-n different solutions kept by the solver.
This parameter must be > 0.
Currently this only impact the "base" solution chosen for a LNS fragment.

optional int32 solution_pool_size = 193 [default = 3];

Returns

This builder for chaining.

Definition at line 30666 of file SatParameters.java.

clearStopAfterFirstSolution()

Builder com.google.ortools.sat.SatParameters.Builder.clearStopAfterFirstSolution

(

)

For an optimization problem, stop the solver as soon as we have a solution.

optional bool stop_after_first_solution = 98 [default = false];

Returns

This builder for chaining.

Definition at line 30390 of file SatParameters.java.

clearStopAfterPresolve()

Builder com.google.ortools.sat.SatParameters.Builder.clearStopAfterPresolve

(

)

Mainly used when improving the presolver. When true, stops the solver after
the presolve is complete (or after loading and root level propagation).

optional bool stop_after_presolve = 149 [default = false];

Returns

This builder for chaining.

Definition at line 30450 of file SatParameters.java.

clearStopAfterRootPropagation()

Builder com.google.ortools.sat.SatParameters.Builder.clearStopAfterRootPropagation

(

)

optional bool stop_after_root_propagation = 252 [default = false];

Returns

This builder for chaining.

Definition at line 30490 of file SatParameters.java.

clearStrategyChangeIncreaseRatio()

Builder com.google.ortools.sat.SatParameters.Builder.clearStrategyChangeIncreaseRatio

(

)

The parameter num_conflicts_before_strategy_changes is increased by that
much after each strategy change.

optional double strategy_change_increase_ratio = 69 [default = 0];

Returns

This builder for chaining.

Definition at line 20377 of file SatParameters.java.

clearSubsolverParams()

Builder com.google.ortools.sat.SatParameters.Builder.clearSubsolverParams

(

)

It is possible to specify additional subsolver configuration. These can be
referred by their params.name() in the fields above. Note that only the
specified field will "overwrite" the ones of the base parameter. If a
subsolver_params has the name of an existing subsolver configuration, the
named parameters will be merged into the subsolver configuration.

repeated .operations_research.sat.SatParameters subsolver_params = 210;

Definition at line 25081 of file SatParameters.java.

clearSubsolvers()

Builder com.google.ortools.sat.SatParameters.Builder.clearSubsolvers

(

)

In multi-thread, the solver can be mainly seen as a portfolio of solvers
with different parameters. This field indicates the names of the parameters
that are used in multithread. This only applies to "full" subsolvers.

See cp_model_search.cc to see a list of the names and the default value (if
left empty) that looks like:
- default_lp           (linearization_level:1)
- fixed                (only if fixed search specified or scheduling)
- no_lp                (linearization_level:0)
- max_lp               (linearization_level:2)
- pseudo_costs         (only if objective, change search heuristic)
- reduced_costs        (only if objective, change search heuristic)
- quick_restart        (kind of probing)
- quick_restart_no_lp  (kind of probing with linearization_level:0)
- lb_tree_search       (to improve lower bound, MIP like tree search)
- probing              (continuous probing and shaving)

Also, note that some set of parameters will be ignored if they do not make
sense. For instance if there is no objective, pseudo_cost or reduced_cost
search will be ignored. Core based search will only work if the objective
has many terms. If there is no fixed strategy fixed will be ignored. And so
on.

The order is important, as only the first num_full_subsolvers will be
scheduled. You can see in the log which one are selected for a given run.

repeated string subsolvers = 207;

Returns

This builder for chaining.

Definition at line 24308 of file SatParameters.java.

clearSubsumptionDuringConflictAnalysis()

Builder com.google.ortools.sat.SatParameters.Builder.clearSubsumptionDuringConflictAnalysis

(

)

At a really low cost, during the 1-UIP conflict computation, it is easy to
detect if some of the involved reasons are subsumed by the current
conflict. When this is true, such clauses are detached and later removed
from the problem.

optional bool subsumption_during_conflict_analysis = 56 [default = true];

Returns

This builder for chaining.

Definition at line 18851 of file SatParameters.java.

clearSymmetryLevel()

Builder com.google.ortools.sat.SatParameters.Builder.clearSymmetryLevel

(

)

Whether we try to automatically detect the symmetries in a model and
exploit them. Currently, at level 1 we detect them in presolve and try
to fix Booleans. At level 2, we also do some form of dynamic symmetry
breaking during search. At level 3, we also detect symmetries for very
large models, which can be slow. At level 4, we try to break as much
symmetry as possible in presolve.

optional int32 symmetry_level = 183 [default = 2];

Returns

This builder for chaining.

Definition at line 31836 of file SatParameters.java.

clearTableCompressionLevel()

Builder com.google.ortools.sat.SatParameters.Builder.clearTableCompressionLevel

(

)

How much we try to "compress" a table constraint. Compressing more leads to
less Booleans and faster propagation but can reduced the quality of the lp
relaxation. Values goes from 0 to 3 where we always try to fully compress a
table. At 2, we try to automatically decide if it is worth it.

optional int32 table_compression_level = 217 [default = 2];

Returns

This builder for chaining.

Definition at line 22477 of file SatParameters.java.

clearUseAbslRandom()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseAbslRandom

(

)

optional bool use_absl_random = 180 [default = false];

Returns

This builder for chaining.

Definition at line 21109 of file SatParameters.java.

clearUseAreaEnergeticReasoningInNoOverlap2D()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseAreaEnergeticReasoningInNoOverlap2D

(

)

When this is true, the no_overlap_2d constraint is reinforced with
an energetic reasoning that uses an area-based energy. This can be combined
with the two other overlap heuristics above.

optional bool use_area_energetic_reasoning_in_no_overlap_2d = 271 [default = false];

Returns

This builder for chaining.

Definition at line 27274 of file SatParameters.java.

clearUseBlockingRestart()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseBlockingRestart

(

)

Block a moving restart algorithm if the trail size of the current conflict
is greater than the multiplier times the moving average of the trail size
at the previous conflicts.

optional bool use_blocking_restart = 64 [default = false];

Returns

This builder for chaining.

Definition at line 20173 of file SatParameters.java.

clearUseCombinedNoOverlap()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseCombinedNoOverlap

(

)

This can be beneficial if there is a lot of no-overlap constraints but a
relatively low number of different intervals in the problem. Like 1000
intervals, but 1M intervals in the no-overlap constraints covering them.

optional bool use_combined_no_overlap = 133 [default = false];

Returns

This builder for chaining.

Definition at line 31328 of file SatParameters.java.

clearUseConservativeScaleOverloadChecker()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseConservativeScaleOverloadChecker

(

)

Enable a heuristic to solve cumulative constraints using a modified energy
constraint. We modify the usual energy definition by applying a
super-additive function (also called "conservative scale" or "dual-feasible
function") to the demand and the durations of the tasks.

This heuristic is fast but for most problems it does not help much to find
a solution.

optional bool use_conservative_scale_overload_checker = 286 [default = false];

Returns

This builder for chaining.

Definition at line 26726 of file SatParameters.java.

clearUseDisjunctiveConstraintInCumulative()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseDisjunctiveConstraintInCumulative

(

)

When this is true, the cumulative constraint is reinforced with propagators
from the disjunctive constraint to improve the inference on a set of tasks
that are disjunctive at the root of the problem. This additional level
supplements the default level of reasoning.

Propagators of the cumulative constraint will not be used at all if all the
tasks are disjunctive at root node.

This always result in better propagation, but it is usually slow, so
depending on the problem, turning this off may lead to a faster solution.

optional bool use_disjunctive_constraint_in_cumulative = 80 [default = true];

Returns

This builder for chaining.

Definition at line 27074 of file SatParameters.java.

clearUseDualSchedulingHeuristics()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseDualSchedulingHeuristics

(

)

When set, it activates a few scheduling parameters to improve the lower
bound of scheduling problems. This is only effective with multiple workers
as it modifies the reduced_cost, lb_tree_search, and probing workers.

optional bool use_dual_scheduling_heuristics = 214 [default = true];

Returns

This builder for chaining.

Definition at line 27402 of file SatParameters.java.

clearUseDynamicPrecedenceInCumulative()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseDynamicPrecedenceInCumulative

(

)

optional bool use_dynamic_precedence_in_cumulative = 268 [default = false];

Returns

This builder for chaining.

Definition at line 26566 of file SatParameters.java.

clearUseDynamicPrecedenceInDisjunctive()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseDynamicPrecedenceInDisjunctive

(

)

Whether we try to branch on decision "interval A before interval B" rather
than on intervals bounds. This usually works better, but slow down a bit
the time to find the first solution.

These parameters are still EXPERIMENTAL, the result should be correct, but
it some corner cases, they can cause some failing CHECK in the solver.

optional bool use_dynamic_precedence_in_disjunctive = 263 [default = false];

Returns

This builder for chaining.

Definition at line 26526 of file SatParameters.java.

clearUseEnergeticReasoningInNoOverlap2D()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseEnergeticReasoningInNoOverlap2D

(

)

When this is true, the no_overlap_2d constraint is reinforced with
energetic reasoning. This additional level supplements the default level of
reasoning.

optional bool use_energetic_reasoning_in_no_overlap_2d = 213 [default = false];

Returns

This builder for chaining.

Definition at line 27210 of file SatParameters.java.

clearUseErwaHeuristic()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseErwaHeuristic

(

)

Whether we use the ERWA (Exponential Recency Weighted Average) heuristic as
described in "Learning Rate Based Branching Heuristic for SAT solvers",
J.H.Liang, V. Ganesh, P. Poupart, K.Czarnecki, SAT 2016.

optional bool use_erwa_heuristic = 75 [default = false];

Returns

This builder for chaining.

Definition at line 18555 of file SatParameters.java.

clearUseExactLpReason()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseExactLpReason

(

)

The solver usually exploit the LP relaxation of a model. If this option is
true, then whatever is infered by the LP will be used like an heuristic to
compute EXACT propagation on the IP. So with this option, there is no
numerical imprecision issues.

optional bool use_exact_lp_reason = 109 [default = true];

Returns

This builder for chaining.

Definition at line 31264 of file SatParameters.java.

clearUseExtendedProbing()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseExtendedProbing

(

)

Use extended probing (probe bool_or, at_most_one, exactly_one).

optional bool use_extended_probing = 269 [default = true];

Returns

This builder for chaining.

Definition at line 27748 of file SatParameters.java.

clearUseFeasibilityJump()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseFeasibilityJump

(

)

Parameters for an heuristic similar to the one described in the paper:
"Feasibility Jump: an LP-free Lagrangian MIP heuristic", Bjørnar
Luteberget, Giorgio Sartor, 2023, Mathematical Programming Computation.

optional bool use_feasibility_jump = 265 [default = true];

Returns

This builder for chaining.

Definition at line 28660 of file SatParameters.java.

clearUseFeasibilityPump()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseFeasibilityPump

(

)

Adds a feasibility pump subsolver along with lns subsolvers.

optional bool use_feasibility_pump = 164 [default = true];

Returns

This builder for chaining.

Definition at line 30778 of file SatParameters.java.

clearUseHardPrecedencesInCumulative()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseHardPrecedencesInCumulative

(

)

If true, detect and create constraint for integer variable that are "after"
a set of intervals in the same cumulative constraint.

Experimental: by default we just use "direct" precedences. If
exploit_all_precedences is true, we explore the full precedence graph. This
assumes we have a DAG otherwise it fails.

optional bool use_hard_precedences_in_cumulative = 215 [default = false];

Returns

This builder for chaining.

Definition at line 26942 of file SatParameters.java.

clearUseImpliedBounds()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseImpliedBounds

(

)

Stores and exploits "implied-bounds" in the solver. That is, relations of
the form literal => (var >= bound). This is currently used to derive
stronger cuts.

optional bool use_implied_bounds = 144 [default = true];

Returns

This builder for chaining.

Definition at line 31516 of file SatParameters.java.

clearUseLbRelaxLns()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseLbRelaxLns

(

)

Turns on neighborhood generator based on local branching LP. Based on Huang
et al., "Local Branching Relaxation Heuristics for Integer Linear
Programs", 2023.

optional bool use_lb_relax_lns = 255 [default = false];

Returns

This builder for chaining.

Definition at line 30842 of file SatParameters.java.

clearUseLns()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseLns

(

)

Testing parameters used to disable all lns workers.

optional bool use_lns = 283 [default = true];

Returns

This builder for chaining.

Definition at line 30546 of file SatParameters.java.

clearUseLnsOnly()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseLnsOnly

(

)

Experimental parameters to disable everything but lns.

optional bool use_lns_only = 101 [default = false];

Returns

This builder for chaining.

Definition at line 30602 of file SatParameters.java.

clearUseLsOnly()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseLsOnly

(

)

Disable every other type of subsolver, setting this turns CP-SAT into a
pure local-search solver.

optional bool use_ls_only = 240 [default = false];

Returns

This builder for chaining.

Definition at line 28720 of file SatParameters.java.

clearUseObjectiveLbSearch()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseObjectiveLbSearch

(

)

If true, search will search in ascending max objective value (when
minimizing) starting from the lower bound of the objective.

optional bool use_objective_lb_search = 228 [default = false];

Returns

This builder for chaining.

Definition at line 28052 of file SatParameters.java.

clearUseObjectiveShavingSearch()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseObjectiveShavingSearch

(

)

This search differs from the previous search as it will not use assumptions
to bound the objective, and it will recreate a full model with the
hardcoded objective value.

optional bool use_objective_shaving_search = 253 [default = false];

Returns

This builder for chaining.

Definition at line 28116 of file SatParameters.java.

clearUseOptimizationHints()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseOptimizationHints

(

)

For an optimization problem, whether we follow some hints in order to find
a better first solution. For a variable with hint, the solver will always
try to follow the hint. It will revert to the variable_branching default
otherwise.

optional bool use_optimization_hints = 35 [default = true];

Returns

This builder for chaining.

Definition at line 25810 of file SatParameters.java.

clearUseOptionalVariables()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseOptionalVariables

(

)

If true, we automatically detect variables whose constraint are always
enforced by the same literal and we mark them as optional. This allows
to propagate them as if they were present in some situation.

TODO(user): This is experimental and seems to lead to wrong optimal in
some situation. It should however gives correct solutions. Fix.

optional bool use_optional_variables = 108 [default = false];

Returns

This builder for chaining.

Definition at line 31196 of file SatParameters.java.

clearUseOverloadCheckerInCumulative()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseOverloadCheckerInCumulative

(

)

When this is true, the cumulative constraint is reinforced with overload
checking, i.e., an additional level of reasoning based on energy. This
additional level supplements the default level of reasoning as well as
timetable edge finding.

This always result in better propagation, but it is usually slow, so
depending on the problem, turning this off may lead to a faster solution.

optional bool use_overload_checker_in_cumulative = 78 [default = false];

Returns

This builder for chaining.

Definition at line 26646 of file SatParameters.java.

clearUsePbResolution()

Builder com.google.ortools.sat.SatParameters.Builder.clearUsePbResolution

(

)

Whether to use pseudo-Boolean resolution to analyze a conflict. Note that
this option only make sense if your problem is modelized using
pseudo-Boolean constraints. If you only have clauses, this shouldn't change
anything (except slow the solver down).

optional bool use_pb_resolution = 43 [default = false];

Returns

This builder for chaining.

Definition at line 21525 of file SatParameters.java.

clearUsePhaseSaving()

Builder com.google.ortools.sat.SatParameters.Builder.clearUsePhaseSaving

(

)

If this is true, then the polarity of a variable will be the last value it
was assigned to, or its default polarity if it was never assigned since the
call to ResetDecisionHeuristic().

Actually, we use a newer version where we follow the last value in the
longest non-conflicting partial assignment in the current phase.

This is called 'literal phase saving'. For details see 'A Lightweight
Component Caching Scheme for Satisfiability Solvers' K. Pipatsrisawat and
A.Darwiche, In 10th International Conference on Theory and Applications of
Satisfiability Testing, 2007.

optional bool use_phase_saving = 44 [default = true];

Returns

This builder for chaining.

Definition at line 18291 of file SatParameters.java.

clearUsePrecedencesInDisjunctiveConstraint()

Builder com.google.ortools.sat.SatParameters.Builder.clearUsePrecedencesInDisjunctiveConstraint

(

)

When this is true, then a disjunctive constraint will try to use the
precedence relations between time intervals to propagate their bounds
further. For instance if task A and B are both before C and task A and B
are in disjunction, then we can deduce that task C must start after
duration(A) + duration(B) instead of simply max(duration(A), duration(B)),
provided that the start time for all task was currently zero.

This always result in better propagation, but it is usually slow, so
depending on the problem, turning this off may lead to a faster solution.

optional bool use_precedences_in_disjunctive_constraint = 74 [default = true];

Returns

This builder for chaining.

Definition at line 26322 of file SatParameters.java.

clearUseProbingSearch()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseProbingSearch

(

)

If true, search will continuously probe Boolean variables, and integer
variable bounds. This parameter is set to true in parallel on the probing
worker.

optional bool use_probing_search = 176 [default = false];

Returns

This builder for chaining.

Definition at line 27692 of file SatParameters.java.

clearUseRinsLns()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseRinsLns

(

)

Turns on relaxation induced neighborhood generator.

optional bool use_rins_lns = 129 [default = true];

Returns

This builder for chaining.

Definition at line 30722 of file SatParameters.java.

clearUseSatInprocessing()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseSatInprocessing

(

)

Enable or disable "inprocessing" which is some SAT presolving done at
each restart to the root level.

optional bool use_sat_inprocessing = 163 [default = true];

Returns

This builder for chaining.

Definition at line 23557 of file SatParameters.java.

clearUseSharedTreeSearch()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseSharedTreeSearch

(

)

Set on shared subtree workers. Users should not set this directly.

optional bool use_shared_tree_search = 236 [default = false];

Returns

This builder for chaining.

Definition at line 29512 of file SatParameters.java.

clearUseShavingInProbingSearch()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseShavingInProbingSearch

(

)

Add a shaving phase (where the solver tries to prove that the lower or
upper bound of a variable are infeasible) to the probing search.

optional bool use_shaving_in_probing_search = 204 [default = true];

Returns

This builder for chaining.

Definition at line 27864 of file SatParameters.java.

clearUseStrongPropagationInDisjunctive()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseStrongPropagationInDisjunctive

(

)

Enable stronger and more expensive propagation on no_overlap constraint.

optional bool use_strong_propagation_in_disjunctive = 230 [default = false];

Returns

This builder for chaining.

Definition at line 26450 of file SatParameters.java.

clearUseTimetableEdgeFindingInCumulative()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseTimetableEdgeFindingInCumulative

(

)

When this is true, the cumulative constraint is reinforced with timetable
edge finding, i.e., an additional level of reasoning based on the
conjunction of energy and mandatory parts. This additional level
supplements the default level of reasoning as well as overload_checker.

This always result in better propagation, but it is usually slow, so
depending on the problem, turning this off may lead to a faster solution.

optional bool use_timetable_edge_finding_in_cumulative = 79 [default = false];

Returns

This builder for chaining.

Definition at line 26806 of file SatParameters.java.

clearUseTimetablingInNoOverlap2D()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseTimetablingInNoOverlap2D

(

)

When this is true, the no_overlap_2d constraint is reinforced with
propagators from the cumulative constraints. It consists of ignoring the
position of rectangles in one position and projecting the no_overlap_2d on
the other dimension to create a cumulative constraint. This is done on both
axis. This additional level supplements the default level of reasoning.

optional bool use_timetabling_in_no_overlap_2d = 200 [default = false];

Returns

This builder for chaining.

Definition at line 27146 of file SatParameters.java.

clearUseVariablesShavingSearch()

Builder com.google.ortools.sat.SatParameters.Builder.clearUseVariablesShavingSearch

(

)

This search takes all Boolean or integer variables, and maximize or
minimize them in order to reduce their domain.

optional bool use_variables_shaving_search = 289 [default = false];

Returns

This builder for chaining.

Definition at line 28176 of file SatParameters.java.

clearVariableActivityDecay()

Builder com.google.ortools.sat.SatParameters.Builder.clearVariableActivityDecay

(

)

Each time a conflict is found, the activities of some variables are
increased by one. Then, the activity of all variables are multiplied by
variable_activity_decay.

To implement this efficiently, the activity of all the variables is not
decayed at each conflict. Instead, the activity increment is multiplied by
1 / decay. When an activity reach max_variable_activity_value, all the
activity are multiplied by 1 / max_variable_activity_value.

optional double variable_activity_decay = 15 [default = 0.8];

Returns

This builder for chaining.

Definition at line 19355 of file SatParameters.java.

clearViolationLsCompoundMoveProbability()

Builder com.google.ortools.sat.SatParameters.Builder.clearViolationLsCompoundMoveProbability

(

)

Probability of using compound move search each restart.
TODO(user): Add reference to paper when published.

optional double violation_ls_compound_move_probability = 259 [default = 0.5];

Returns

This builder for chaining.

Definition at line 29384 of file SatParameters.java.

clearViolationLsPerturbationPeriod()

Builder com.google.ortools.sat.SatParameters.Builder.clearViolationLsPerturbationPeriod

(

)

How long violation_ls should wait before perturbating a solution.

optional int32 violation_ls_perturbation_period = 249 [default = 100];

Returns

This builder for chaining.

Definition at line 29324 of file SatParameters.java.

getAbsoluteGapLimit()

double com.google.ortools.sat.SatParameters.Builder.getAbsoluteGapLimit

(

)

Stop the search when the gap between the best feasible objective (O) and
our best objective bound (B) is smaller than a limit.
The exact definition is:
- Absolute: abs(O - B)
- Relative: abs(O - B) / max(1, abs(O)).

Important: The relative gap depends on the objective offset! If you
artificially shift the objective, you will get widely different value of
the relative gap.

Note that if the gap is reached, the search status will be OPTIMAL. But
one can check the best objective bound to see the actual gap.

If the objective is integer, then any absolute gap < 1 will lead to a true
optimal. If the objective is floating point, a gap of zero make little
sense so is is why we use a non-zero default value. At the end of the
search, we will display a warning if OPTIMAL is reported yet the gap is
greater than this absolute gap.

optional double absolute_gap_limit = 159 [default = 0.0001];

Returns

The absoluteGapLimit.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 20780 of file SatParameters.java.

getAddCgCuts()

boolean com.google.ortools.sat.SatParameters.Builder.getAddCgCuts

(

)

Whether we generate and add Chvatal-Gomory cuts to the LP at root node.
Note that for now, this is not heavily tuned.

optional bool add_cg_cuts = 117 [default = true];

Returns

The addCgCuts.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 32459 of file SatParameters.java.

getAddCliqueCuts()

boolean com.google.ortools.sat.SatParameters.Builder.getAddCliqueCuts

(

)

Whether we generate clique cuts from the binary implication graph. Note
that as the search goes on, this graph will contains new binary clauses
learned by the SAT engine.

optional bool add_clique_cuts = 172 [default = true];

Returns

The addCliqueCuts.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 32641 of file SatParameters.java.

getAddLinMaxCuts()

boolean com.google.ortools.sat.SatParameters.Builder.getAddLinMaxCuts

(

)

For the lin max constraints, generates the cuts described in "Strong
mixed-integer programming formulations for trained neural networks" by Ross
Anderson et. (https://arxiv.org/pdf/1811.01988.pdf)

optional bool add_lin_max_cuts = 152 [default = true];

Returns

The addLinMaxCuts.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 32829 of file SatParameters.java.

getAddLpConstraintsLazily()

boolean com.google.ortools.sat.SatParameters.Builder.getAddLpConstraintsLazily

(

)

If true, we start by an empty LP, and only add constraints not satisfied
by the current LP solution batch by batch. A constraint that is only added
like this is known as a "lazy" constraint in the literature, except that we
currently consider all constraints as lazy here.

optional bool add_lp_constraints_lazily = 112 [default = true];

Returns

The addLpConstraintsLazily.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 32979 of file SatParameters.java.

getAddMirCuts()

boolean com.google.ortools.sat.SatParameters.Builder.getAddMirCuts

(

)

Whether we generate MIR cuts at root node.
Note that for now, this is not heavily tuned.

optional bool add_mir_cuts = 120 [default = true];

Returns

The addMirCuts.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 32519 of file SatParameters.java.

getAddObjectiveCut()

boolean com.google.ortools.sat.SatParameters.Builder.getAddObjectiveCut

(

)

When the LP objective is fractional, do we add the cut that forces the
linear objective expression to be greater or equal to this fractional value
rounded up? We can always do that since our objective is integer, and
combined with MIR heuristic to reduce the coefficient of such cut, it can
help.

optional bool add_objective_cut = 197 [default = false];

Returns

The addObjectiveCut.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 32393 of file SatParameters.java.

getAddRltCuts()

boolean com.google.ortools.sat.SatParameters.Builder.getAddRltCuts

(

)

Whether we generate RLT cuts. This is still experimental but can help on
binary problem with a lot of clauses of size 3.

optional bool add_rlt_cuts = 279 [default = true];

Returns

The addRltCuts.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 32703 of file SatParameters.java.

getAddZeroHalfCuts()

boolean com.google.ortools.sat.SatParameters.Builder.getAddZeroHalfCuts

(

)

Whether we generate Zero-Half cuts at root node.
Note that for now, this is not heavily tuned.

optional bool add_zero_half_cuts = 169 [default = true];

Returns

The addZeroHalfCuts.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 32579 of file SatParameters.java.

getAlsoBumpVariablesInConflictReasons()

boolean com.google.ortools.sat.SatParameters.Builder.getAlsoBumpVariablesInConflictReasons

(

)

When this is true, then the variables that appear in any of the reason of
the variables in a conflict have their activity bumped. This is addition to
the variables in the conflict, and the one that were used during conflict
resolution.

optional bool also_bump_variables_in_conflict_reasons = 77 [default = false];

Returns

The alsoBumpVariablesInConflictReasons.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 18666 of file SatParameters.java.

getAtMostOneMaxExpansionSize()

int com.google.ortools.sat.SatParameters.Builder.getAtMostOneMaxExpansionSize

(

)

All at_most_one constraints with a size <= param will be replaced by a
quadratic number of binary implications.

optional int32 at_most_one_max_expansion_size = 270 [default = 3];

Returns

The atMostOneMaxExpansionSize.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 31359 of file SatParameters.java.

getAutoDetectGreaterThanAtLeastOneOf()

boolean com.google.ortools.sat.SatParameters.Builder.getAutoDetectGreaterThanAtLeastOneOf

(

)

If true, then the precedences propagator try to detect for each variable if
it has a set of "optional incoming arc" for which at least one of them is
present. This is usually useful to have but can be slow on model with a lot
of precedence.

optional bool auto_detect_greater_than_at_least_one_of = 95 [default = true];

Returns

The autoDetectGreaterThanAtLeastOneOf.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 30301 of file SatParameters.java.

getBinaryMinimizationAlgorithm()

com.google.ortools.sat.SatParameters.BinaryMinizationAlgorithm com.google.ortools.sat.SatParameters.Builder.getBinaryMinimizationAlgorithm

(

)

optional .operations_research.sat.SatParameters.BinaryMinizationAlgorithm binary_minimization_algorithm = 34 [default = BINARY_MINIMIZATION_FIRST];

Returns

The binaryMinimizationAlgorithm.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 18761 of file SatParameters.java.

getBinarySearchNumConflicts()

int com.google.ortools.sat.SatParameters.Builder.getBinarySearchNumConflicts

(

)

If non-negative, perform a binary search on the objective variable in order
to find an [min, max] interval outside of which the solver proved unsat/sat
under this amount of conflict. This can quickly reduce the objective domain
on some problems.

optional int32 binary_search_num_conflicts = 99 [default = -1];

Returns

The binarySearchNumConflicts.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 28487 of file SatParameters.java.

getBlockingRestartMultiplier()

double com.google.ortools.sat.SatParameters.Builder.getBlockingRestartMultiplier

(

)

optional double blocking_restart_multiplier = 66 [default = 1.4];

Returns

The blockingRestartMultiplier.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 20234 of file SatParameters.java.

getBlockingRestartWindowSize()

int com.google.ortools.sat.SatParameters.Builder.getBlockingRestartWindowSize

(

)

optional int32 blocking_restart_window_size = 65 [default = 5000];

Returns

The blockingRestartWindowSize.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 20194 of file SatParameters.java.

getBooleanEncodingLevel()

int com.google.ortools.sat.SatParameters.Builder.getBooleanEncodingLevel

(

)

A non-negative level indicating how much we should try to fully encode
Integer variables as Boolean.

optional int32 boolean_encoding_level = 107 [default = 1];

Returns

The booleanEncodingLevel.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 32063 of file SatParameters.java.

getCatchSigintSignal()

boolean com.google.ortools.sat.SatParameters.Builder.getCatchSigintSignal

(

)

Indicates if the CP-SAT layer should catch Control-C (SIGINT) signals
when calling solve. If set, catching the SIGINT signal will terminate the
search gracefully, as if a time limit was reached.

optional bool catch_sigint_signal = 135 [default = true];

Returns

The catchSigintSignal.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 31421 of file SatParameters.java.

getClauseActivityDecay()

double com.google.ortools.sat.SatParameters.Builder.getClauseActivityDecay

(

)

Clause activity parameters (same effect as the one on the variables).

optional double clause_activity_decay = 17 [default = 0.999];

Returns

The clauseActivityDecay.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19576 of file SatParameters.java.

getClauseCleanupLbdBound()

int com.google.ortools.sat.SatParameters.Builder.getClauseCleanupLbdBound

(

)

All the clauses with a LBD (literal blocks distance) lower or equal to this
parameters will always be kept.

optional int32 clause_cleanup_lbd_bound = 59 [default = 5];

Returns

The clauseCleanupLbdBound.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19104 of file SatParameters.java.

getClauseCleanupOrdering()

com.google.ortools.sat.SatParameters.ClauseOrdering com.google.ortools.sat.SatParameters.Builder.getClauseCleanupOrdering

(

)

optional .operations_research.sat.SatParameters.ClauseOrdering clause_cleanup_ordering = 60 [default = CLAUSE_ACTIVITY];

Returns

The clauseCleanupOrdering.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19153 of file SatParameters.java.

getClauseCleanupPeriod()

int com.google.ortools.sat.SatParameters.Builder.getClauseCleanupPeriod

(

)

Trigger a cleanup when this number of "deletable" clauses is learned.

optional int32 clause_cleanup_period = 11 [default = 10000];

Returns

The clauseCleanupPeriod.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 18880 of file SatParameters.java.

getClauseCleanupProtection()

com.google.ortools.sat.SatParameters.ClauseProtection com.google.ortools.sat.SatParameters.Builder.getClauseCleanupProtection

(

)

optional .operations_research.sat.SatParameters.ClauseProtection clause_cleanup_protection = 58 [default = PROTECTION_NONE];

Returns

The clauseCleanupProtection.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19051 of file SatParameters.java.

getClauseCleanupRatio()

double com.google.ortools.sat.SatParameters.Builder.getClauseCleanupRatio

(

)

During a cleanup, if clause_cleanup_target is 0, we will delete the
clause_cleanup_ratio of "deletable" clauses instead of aiming for a fixed
target of clauses to keep.

optional double clause_cleanup_ratio = 190 [default = 0.5];

Returns

The clauseCleanupRatio.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19000 of file SatParameters.java.

getClauseCleanupTarget()

int com.google.ortools.sat.SatParameters.Builder.getClauseCleanupTarget

(

)

During a cleanup, we will always keep that number of "deletable" clauses.
Note that this doesn't include the "protected" clauses.

optional int32 clause_cleanup_target = 13 [default = 0];

Returns

The clauseCleanupTarget.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 18938 of file SatParameters.java.

getConvertIntervals()

boolean com.google.ortools.sat.SatParameters.Builder.getConvertIntervals

(

)

Temporary flag util the feature is more mature. This convert intervals to
the newer proto format that support affine start/var/end instead of just
variables.

optional bool convert_intervals = 177 [default = true];

Returns

The convertIntervals.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 31729 of file SatParameters.java.

getCoreMinimizationLevel()

int com.google.ortools.sat.SatParameters.Builder.getCoreMinimizationLevel

(

)

If positive, we spend some effort on each core:
- At level 1, we use a simple heuristic to try to minimize an UNSAT core.
- At level 2, we use propagation to minimize the core but also identify
literal in at most one relationship in this core.

optional int32 core_minimization_level = 50 [default = 2];

Returns

The coreMinimizationLevel.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 25845 of file SatParameters.java.

getCountAssumptionLevelsInLbd()

boolean com.google.ortools.sat.SatParameters.Builder.getCountAssumptionLevelsInLbd

(

)

Whether or not the assumption levels are taken into account during the LBD
computation. According to the reference below, not counting them improves
the solver in some situation. Note that this only impact solves under
assumptions.

Gilles Audemard, Jean-Marie Lagniez, Laurent Simon, "Improving Glucose for
Incremental SAT Solving with Assumptions: Application to MUS Extraction"
Theory and Applications of Satisfiability Testing - SAT 2013, Lecture Notes
in Computer Science Volume 7962, 2013, pp 309-317.

optional bool count_assumption_levels_in_lbd = 49 [default = true];

Returns

The countAssumptionLevelsInLbd.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 21638 of file SatParameters.java.

getCoverOptimization()

boolean com.google.ortools.sat.SatParameters.Builder.getCoverOptimization

(

)

If true, when the max-sat algo find a core, we compute the minimal number
of literals in the core that needs to be true to have a feasible solution.
This is also called core exhaustion in more recent max-SAT papers.

optional bool cover_optimization = 89 [default = true];

Returns

The coverOptimization.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 25971 of file SatParameters.java.

getCpModelPresolve()

boolean com.google.ortools.sat.SatParameters.Builder.getCpModelPresolve

(

)

Whether we presolve the cp_model before solving it.

optional bool cp_model_presolve = 86 [default = true];

Returns

The cpModelPresolve.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 22194 of file SatParameters.java.

getCpModelProbingLevel()

int com.google.ortools.sat.SatParameters.Builder.getCpModelProbingLevel

(

)

How much effort do we spend on probing. 0 disables it completely.

optional int32 cp_model_probing_level = 110 [default = 2];

Returns

The cpModelProbingLevel.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 22250 of file SatParameters.java.

getCpModelUseSatPresolve()

boolean com.google.ortools.sat.SatParameters.Builder.getCpModelUseSatPresolve

(

)

Whether we also use the sat presolve when cp_model_presolve is true.

optional bool cp_model_use_sat_presolve = 93 [default = true];

Returns

The cpModelUseSatPresolve.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 22306 of file SatParameters.java.

getCutActiveCountDecay()

double com.google.ortools.sat.SatParameters.Builder.getCutActiveCountDecay

(

)

optional double cut_active_count_decay = 156 [default = 0.8];

Returns

The cutActiveCountDecay.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 33357 of file SatParameters.java.

getCutCleanupTarget()

int com.google.ortools.sat.SatParameters.Builder.getCutCleanupTarget

(

)

Target number of constraints to remove during cleanup.

optional int32 cut_cleanup_target = 157 [default = 1000];

Returns

The cutCleanupTarget.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 33405 of file SatParameters.java.

getCutLevel()

int com.google.ortools.sat.SatParameters.Builder.getCutLevel

(

)

Control the global cut effort. Zero will turn off all cut. For now we just
have one level. Note also that most cuts are only used at linearization
level >= 2.

optional int32 cut_level = 196 [default = 1];

Returns

The cutLevel.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 32265 of file SatParameters.java.

getCutMaxActiveCountValue()

double com.google.ortools.sat.SatParameters.Builder.getCutMaxActiveCountValue

(

)

These parameters are similar to sat clause management activity parameters.
They are effective only if the number of generated cuts exceed the storage
limit. Default values are based on a few experiments on miplib instances.

optional double cut_max_active_count_value = 155 [default = 10000000000];

Returns

The cutMaxActiveCountValue.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 33305 of file SatParameters.java.

getDebugCrashOnBadHint()

boolean com.google.ortools.sat.SatParameters.Builder.getDebugCrashOnBadHint

(

)

Crash if we do not manage to complete the hint into a full solution.

optional bool debug_crash_on_bad_hint = 195 [default = false];

Returns

The debugCrashOnBadHint.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 25715 of file SatParameters.java.

getDebugMaxNumPresolveOperations()

int com.google.ortools.sat.SatParameters.Builder.getDebugMaxNumPresolveOperations

(

)

If positive, try to stop just after that many presolve rules have been
applied. This is mainly useful for debugging presolve.

optional int32 debug_max_num_presolve_operations = 151 [default = 0];

Returns

The debugMaxNumPresolveOperations.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 25657 of file SatParameters.java.

getDebugPostsolveWithFullSolver()

boolean com.google.ortools.sat.SatParameters.Builder.getDebugPostsolveWithFullSolver

(

)

We have two different postsolve code. The default one should be better and
it allows for a more powerful presolve, but it can be useful to postsolve
using the full solver instead.

optional bool debug_postsolve_with_full_solver = 162 [default = false];

Returns

The debugPostsolveWithFullSolver.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 25595 of file SatParameters.java.

getDefaultInstanceForType()

com.google.ortools.sat.SatParameters com.google.ortools.sat.SatParameters.Builder.getDefaultInstanceForType

(

)

Definition at line 14693 of file SatParameters.java.

getDefaultRestartAlgorithms()

java.lang.String com.google.ortools.sat.SatParameters.Builder.getDefaultRestartAlgorithms

(

)

optional string default_restart_algorithms = 70 [default = "LUBY_RESTART,LBD_MOVING_AVERAGE_RESTART,DL_MOVING_AVERAGE_RESTART"];

Returns

The defaultRestartAlgorithms.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19832 of file SatParameters.java.

getDefaultRestartAlgorithmsBytes()

com.google.protobuf.ByteString com.google.ortools.sat.SatParameters.Builder.getDefaultRestartAlgorithmsBytes

(

)

optional string default_restart_algorithms = 70 [default = "LUBY_RESTART,LBD_MOVING_AVERAGE_RESTART,DL_MOVING_AVERAGE_RESTART"];

Returns

The bytes for defaultRestartAlgorithms.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19851 of file SatParameters.java.

getDescriptor()

static final com.google.protobuf.Descriptors.Descriptor com.google.ortools.sat.SatParameters.Builder.getDescriptor ( )

static

Definition at line 14391 of file SatParameters.java.

getDescriptorForType()

com.google.protobuf.Descriptors.Descriptor com.google.ortools.sat.SatParameters.Builder.getDescriptorForType

(

)

Definition at line 14688 of file SatParameters.java.

getDetectLinearizedProduct()

boolean com.google.ortools.sat.SatParameters.Builder.getDetectLinearizedProduct

(

)

Infer products of Boolean or of Boolean time IntegerVariable from the
linear constrainst in the problem. This can be used in some cuts, altough
for now we don't really exploit it.

optional bool detect_linearized_product = 277 [default = false];

Returns

The detectLinearizedProduct.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 33837 of file SatParameters.java.

getDetectTableWithCost()

boolean com.google.ortools.sat.SatParameters.Builder.getDetectTableWithCost

(

)

If true, we detect variable that are unique to a table constraint and only
there to encode a cost on each tuple. This is usually the case when a WCSP
(weighted constraint program) is encoded into CP-SAT format.

This can lead to a dramatic speed-up for such problems but is still
experimental at this point.

optional bool detect_table_with_cost = 216 [default = false];

Returns

The detectTableWithCost.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 22372 of file SatParameters.java.

getDisableConstraintExpansion()

boolean com.google.ortools.sat.SatParameters.Builder.getDisableConstraintExpansion

(

)

If true, it disable all constraint expansion.
This should only be used to test the presolve of expanded constraints.

optional bool disable_constraint_expansion = 181 [default = false];

Returns

The disableConstraintExpansion.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 22864 of file SatParameters.java.

getDiversifyLnsParams()

boolean com.google.ortools.sat.SatParameters.Builder.getDiversifyLnsParams

(

)

If true, registers more lns subsolvers with different parameters.

optional bool diversify_lns_params = 137 [default = false];

Returns

The diversifyLnsParams.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 30913 of file SatParameters.java.

getEncodeComplexLinearConstraintWithInteger()

boolean com.google.ortools.sat.SatParameters.Builder.getEncodeComplexLinearConstraintWithInteger

(

)

Linear constraint with a complex right hand side (more than a single
interval) need to be expanded, there is a couple of way to do that.

optional bool encode_complex_linear_constraint_with_integer = 223 [default = false];

Returns

The encodeComplexLinearConstraintWithInteger.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 22924 of file SatParameters.java.

getEncodeCumulativeAsReservoir()

boolean com.google.ortools.sat.SatParameters.Builder.getEncodeCumulativeAsReservoir

(

)

Encore cumulative with fixed demands and capacity as a reservoir
constraint. The only reason you might want to do that is to test the
reservoir propagation code!

optional bool encode_cumulative_as_reservoir = 287 [default = false];

Returns

The encodeCumulativeAsReservoir.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 22730 of file SatParameters.java.

getEnumerateAllSolutions()

boolean com.google.ortools.sat.SatParameters.Builder.getEnumerateAllSolutions

(

)

Whether we enumerate all solutions of a problem without objective. Note
that setting this to true automatically disable some presolve reduction
that can remove feasible solution. That is it has the same effect as
setting keep_all_feasible_solutions_in_presolve.

TODO(user): Do not do that and let the user choose what behavior is best by
setting keep_all_feasible_solutions_in_presolve ?

optional bool enumerate_all_solutions = 87 [default = false];

Returns

The enumerateAllSolutions.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 29911 of file SatParameters.java.

getExpandAlldiffConstraints()

boolean com.google.ortools.sat.SatParameters.Builder.getExpandAlldiffConstraints

(

)

If true, expand all_different constraints that are not permutations.
Permutations (#Variables = #Values) are always expanded.

optional bool expand_alldiff_constraints = 170 [default = false];

Returns

The expandAlldiffConstraints.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 22508 of file SatParameters.java.

getExpandReservoirConstraints()

boolean com.google.ortools.sat.SatParameters.Builder.getExpandReservoirConstraints

(

)

If true, expand the reservoir constraints by creating booleans for all
possible precedences between event and encoding the constraint.

optional bool expand_reservoir_constraints = 182 [default = true];

Returns

The expandReservoirConstraints.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 22568 of file SatParameters.java.

getExpandReservoirUsingCircuit()

boolean com.google.ortools.sat.SatParameters.Builder.getExpandReservoirUsingCircuit

(

)

Mainly useful for testing.

If this and expand_reservoir_constraints is true, we use a different
encoding of the reservoir constraint using circuit instead of precedences.
Note that this is usually slower, but can exercise different part of the
solver. Note that contrary to the precedence encoding, this easily support
variable demands.

WARNING: with this encoding, the constraint take a slighlty different
meaning. The level must be within the reservoir for any permutation of the
events. So we cannot have +100 and -100 at the same time if the maximum
level is 10 (as autorized by the reservoir constraint).

optional bool expand_reservoir_using_circuit = 288 [default = false];

Returns

The expandReservoirUsingCircuit.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 22648 of file SatParameters.java.

getExploitAllLpSolution()

boolean com.google.ortools.sat.SatParameters.Builder.getExploitAllLpSolution

(

)

If true and the Lp relaxation of the problem has a solution, try to exploit
it. This is same as above except in this case the lp solution might not be
an integer solution.

optional bool exploit_all_lp_solution = 116 [default = true];

Returns

The exploitAllLpSolution.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 33593 of file SatParameters.java.

getExploitAllPrecedences()

boolean com.google.ortools.sat.SatParameters.Builder.getExploitAllPrecedences

(

)

optional bool exploit_all_precedences = 220 [default = false];

Returns

The exploitAllPrecedences.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 26963 of file SatParameters.java.

getExploitBestSolution()

boolean com.google.ortools.sat.SatParameters.Builder.getExploitBestSolution

(

)

When branching on a variable, follow the last best solution value.

optional bool exploit_best_solution = 130 [default = false];

Returns

The exploitBestSolution.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 33653 of file SatParameters.java.

getExploitIntegerLpSolution()

boolean com.google.ortools.sat.SatParameters.Builder.getExploitIntegerLpSolution

(

)

If true and the Lp relaxation of the problem has an integer optimal
solution, try to exploit it. Note that since the LP relaxation may not
contain all the constraints, such a solution is not necessarily a solution
of the full problem.

optional bool exploit_integer_lp_solution = 94 [default = true];

Returns

The exploitIntegerLpSolution.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 33527 of file SatParameters.java.

getExploitObjective()

boolean com.google.ortools.sat.SatParameters.Builder.getExploitObjective

(

)

When branching an a variable that directly affect the objective,
branch on the value that lead to the best objective first.

optional bool exploit_objective = 131 [default = true];

Returns

The exploitObjective.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 33775 of file SatParameters.java.

getExploitRelaxationSolution()

boolean com.google.ortools.sat.SatParameters.Builder.getExploitRelaxationSolution

(

)

When branching on a variable, follow the last best relaxation solution
value. We use the relaxation with the tightest bound on the objective as
the best relaxation solution.

optional bool exploit_relaxation_solution = 161 [default = false];

Returns

The exploitRelaxationSolution.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 33713 of file SatParameters.java.

getExtraSubsolvers()

java.lang.String com.google.ortools.sat.SatParameters.Builder.getExtraSubsolvers

(

int

index

)

A convenient way to add more workers types.
These will be added at the beginning of the list.

repeated string extra_subsolvers = 219;

Parameters

index

The index of the element to return.

Returns

The extraSubsolvers at the given index.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 24402 of file SatParameters.java.

getExtraSubsolversBytes()

com.google.protobuf.ByteString com.google.ortools.sat.SatParameters.Builder.getExtraSubsolversBytes

(

int

index

)

A convenient way to add more workers types.
These will be added at the beginning of the list.

repeated string extra_subsolvers = 219;

Parameters

index

The index of the value to return.

Returns

The bytes of the extraSubsolvers at the given index.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 24416 of file SatParameters.java.

getExtraSubsolversCount()

int com.google.ortools.sat.SatParameters.Builder.getExtraSubsolversCount

(

)

A convenient way to add more workers types.
These will be added at the beginning of the list.

repeated string extra_subsolvers = 219;

Returns

The count of extraSubsolvers.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 24389 of file SatParameters.java.

getExtraSubsolversList()

com.google.protobuf.ProtocolStringList com.google.ortools.sat.SatParameters.Builder.getExtraSubsolversList

(

)

A convenient way to add more workers types.
These will be added at the beginning of the list.

repeated string extra_subsolvers = 219;

Returns

A list containing the extraSubsolvers.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 24376 of file SatParameters.java.

getFeasibilityJumpBatchDtime()

double com.google.ortools.sat.SatParameters.Builder.getFeasibilityJumpBatchDtime

(

)

How much dtime for each LS batch.

optional double feasibility_jump_batch_dtime = 292 [default = 0.1];

Returns

The feasibilityJumpBatchDtime.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 28925 of file SatParameters.java.

getFeasibilityJumpDecay()

double com.google.ortools.sat.SatParameters.Builder.getFeasibilityJumpDecay

(

)

On each restart, we randomly choose if we use decay (with this parameter)
or no decay.

optional double feasibility_jump_decay = 242 [default = 0.95];

Returns

The feasibilityJumpDecay.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 28751 of file SatParameters.java.

getFeasibilityJumpEnableRestarts()

boolean com.google.ortools.sat.SatParameters.Builder.getFeasibilityJumpEnableRestarts

(

)

When stagnating, feasibility jump will either restart from a default
solution (with some possible randomization), or randomly pertubate the
current solution. This parameter selects the first option.

optional bool feasibility_jump_enable_restarts = 250 [default = true];

Returns

The feasibilityJumpEnableRestarts.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 29105 of file SatParameters.java.

getFeasibilityJumpLinearizationLevel()

int com.google.ortools.sat.SatParameters.Builder.getFeasibilityJumpLinearizationLevel

(

)

How much do we linearize the problem in the local search code.

optional int32 feasibility_jump_linearization_level = 257 [default = 2];

Returns

The feasibilityJumpLinearizationLevel.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 28809 of file SatParameters.java.

getFeasibilityJumpMaxExpandedConstraintSize()

int com.google.ortools.sat.SatParameters.Builder.getFeasibilityJumpMaxExpandedConstraintSize

(

)

Maximum size of no_overlap or no_overlap_2d constraint for a quadratic
expansion. This might look a lot, but by expanding such constraint, we get
a linear time evaluation per single variable moves instead of a slow O(n
log n) one.

optional int32 feasibility_jump_max_expanded_constraint_size = 264 [default = 500];

Returns

The feasibilityJumpMaxExpandedConstraintSize.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 29171 of file SatParameters.java.

getFeasibilityJumpRestartFactor()

int com.google.ortools.sat.SatParameters.Builder.getFeasibilityJumpRestartFactor

(

)

This is a factor that directly influence the work before each restart.
Increasing it leads to longer restart.

optional int32 feasibility_jump_restart_factor = 258 [default = 1];

Returns

The feasibilityJumpRestartFactor.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 28867 of file SatParameters.java.

getFeasibilityJumpVarPerburbationRangeRatio()

double com.google.ortools.sat.SatParameters.Builder.getFeasibilityJumpVarPerburbationRangeRatio

(

)

Max distance between the default value and the pertubated value relative to
the range of the domain of the variable.

optional double feasibility_jump_var_perburbation_range_ratio = 248 [default = 0.2];

Returns

The feasibilityJumpVarPerburbationRangeRatio.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 29043 of file SatParameters.java.

getFeasibilityJumpVarRandomizationProbability()

double com.google.ortools.sat.SatParameters.Builder.getFeasibilityJumpVarRandomizationProbability

(

)

Probability for a variable to have a non default value upon restarts or
perturbations.

optional double feasibility_jump_var_randomization_probability = 247 [default = 0.05];

Returns

The feasibilityJumpVarRandomizationProbability.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 28983 of file SatParameters.java.

getFillAdditionalSolutionsInResponse()

boolean com.google.ortools.sat.SatParameters.Builder.getFillAdditionalSolutionsInResponse

(

)

If true, the final response addition_solutions field will be filled with
all solutions from our solutions pool.

Note that if both this field and enumerate_all_solutions is true, we will
copy to the pool all of the solution found. So if solution_pool_size is big
enough, you can get all solutions this way instead of using the solution
callback.

Note that this only affect the "final" solution, not the one passed to the
solution callbacks.

optional bool fill_additional_solutions_in_response = 194 [default = false];

Returns

The fillAdditionalSolutionsInResponse.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 30153 of file SatParameters.java.

getFillTightenedDomainsInResponse()

boolean com.google.ortools.sat.SatParameters.Builder.getFillTightenedDomainsInResponse

(

)

If true, add information about the derived variable domains to the
CpSolverResponse. It is an option because it makes the response slighly
bigger and there is a bit more work involved during the postsolve to
construct it, but it should still have a low overhead. See the
tightened_variables field in CpSolverResponse for more details.

optional bool fill_tightened_domains_in_response = 132 [default = false];

Returns

The fillTightenedDomainsInResponse.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 30071 of file SatParameters.java.

getFilterSubsolvers()

java.lang.String com.google.ortools.sat.SatParameters.Builder.getFilterSubsolvers

(

int

index

)

repeated string filter_subsolvers = 293;

Parameters

index

The index of the element to return.

Returns

The filterSubsolvers at the given index.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 24760 of file SatParameters.java.

getFilterSubsolversBytes()

com.google.protobuf.ByteString com.google.ortools.sat.SatParameters.Builder.getFilterSubsolversBytes

(

int

index

)

repeated string filter_subsolvers = 293;

Parameters

index

The index of the value to return.

Returns

The bytes of the filterSubsolvers at the given index.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 24769 of file SatParameters.java.

getFilterSubsolversCount()

int com.google.ortools.sat.SatParameters.Builder.getFilterSubsolversCount

(

)

repeated string filter_subsolvers = 293;

Returns

The count of filterSubsolvers.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 24752 of file SatParameters.java.

getFilterSubsolversList()

com.google.protobuf.ProtocolStringList com.google.ortools.sat.SatParameters.Builder.getFilterSubsolversList

(

)

repeated string filter_subsolvers = 293;

Returns

A list containing the filterSubsolvers.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 24744 of file SatParameters.java.

getFindBigLinearOverlap()

boolean com.google.ortools.sat.SatParameters.Builder.getFindBigLinearOverlap

(

)

Try to find large "rectangle" in the linear constraint matrix with
identical lines. If such rectangle is big enough, we can introduce a new
integer variable corresponding to the common expression and greatly reduce
the number of non-zero.

optional bool find_big_linear_overlap = 234 [default = true];

Returns

The findBigLinearOverlap.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 23464 of file SatParameters.java.

getFindMultipleCores()

boolean com.google.ortools.sat.SatParameters.Builder.getFindMultipleCores

(

)

Whether we try to find more independent cores for a given set of
assumptions in the core based max-SAT algorithms.

optional bool find_multiple_cores = 84 [default = true];

Returns

The findMultipleCores.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 25909 of file SatParameters.java.

getFixVariablesToTheirHintedValue()

boolean com.google.ortools.sat.SatParameters.Builder.getFixVariablesToTheirHintedValue

(

)

If true, variables appearing in the solution hints will be fixed to their
hinted value.

optional bool fix_variables_to_their_hinted_value = 192 [default = false];

Returns

The fixVariablesToTheirHintedValue.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 27599 of file SatParameters.java.

getFpRounding()

com.google.ortools.sat.SatParameters.FPRoundingMethod com.google.ortools.sat.SatParameters.Builder.getFpRounding

(

)

optional .operations_research.sat.SatParameters.FPRoundingMethod fp_rounding = 165 [default = PROPAGATION_ASSISTED];

Returns

The fpRounding.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 30862 of file SatParameters.java.

getGlucoseDecayIncrement()

double com.google.ortools.sat.SatParameters.Builder.getGlucoseDecayIncrement

(

)

optional double glucose_decay_increment = 23 [default = 0.01];

Returns

The glucoseDecayIncrement.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19488 of file SatParameters.java.

getGlucoseDecayIncrementPeriod()

int com.google.ortools.sat.SatParameters.Builder.getGlucoseDecayIncrementPeriod

(

)

optional int32 glucose_decay_increment_period = 24 [default = 5000];

Returns

The glucoseDecayIncrementPeriod.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19528 of file SatParameters.java.

getGlucoseMaxDecay()

double com.google.ortools.sat.SatParameters.Builder.getGlucoseMaxDecay

(

)

The activity starts at 0.8 and increment by 0.01 every 5000 conflicts until
0.95. This "hack" seems to work well and comes from:

Glucose 2.3 in the SAT 2013 Competition - SAT Competition 2013
http://edacc4.informatik.uni-ulm.de/SC13/solver-description-download/136

optional double glucose_max_decay = 22 [default = 0.95];

Returns

The glucoseMaxDecay.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19432 of file SatParameters.java.

getHintConflictLimit()

int com.google.ortools.sat.SatParameters.Builder.getHintConflictLimit

(

)

Conflict limit used in the phase that exploit the solution hint.

optional int32 hint_conflict_limit = 153 [default = 10];

Returns

The hintConflictLimit.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 27473 of file SatParameters.java.

getIgnoreNames()

boolean com.google.ortools.sat.SatParameters.Builder.getIgnoreNames

(

)

If true, we don't keep names in our internal copy of the user given model.

optional bool ignore_names = 202 [default = true];

Returns

The ignoreNames.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 23318 of file SatParameters.java.

getIgnoreSubsolvers()

java.lang.String com.google.ortools.sat.SatParameters.Builder.getIgnoreSubsolvers

(

int

index

)

Rather than fully specifying subsolvers, it is often convenient to just
remove the ones that are not useful on a given problem or only keep
specific ones for testing. Each string is interpreted as a "glob", so we
support '*' and '?'.

The way this work is that we will only accept a name that match a filter
pattern (if non-empty) and do not match an ignore pattern. Note also that
these fields work on LNS or LS names even if these are currently not
specified via the subsolvers field.

repeated string ignore_subsolvers = 209;

Parameters

index

The index of the element to return.

Returns

The ignoreSubsolvers at the given index.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 24578 of file SatParameters.java.

getIgnoreSubsolversBytes()

com.google.protobuf.ByteString com.google.ortools.sat.SatParameters.Builder.getIgnoreSubsolversBytes

(

int

index

)

Rather than fully specifying subsolvers, it is often convenient to just
remove the ones that are not useful on a given problem or only keep
specific ones for testing. Each string is interpreted as a "glob", so we
support '*' and '?'.

The way this work is that we will only accept a name that match a filter
pattern (if non-empty) and do not match an ignore pattern. Note also that
these fields work on LNS or LS names even if these are currently not
specified via the subsolvers field.

repeated string ignore_subsolvers = 209;

Parameters

index

The index of the value to return.

Returns

The bytes of the ignoreSubsolvers at the given index.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 24599 of file SatParameters.java.

getIgnoreSubsolversCount()

int com.google.ortools.sat.SatParameters.Builder.getIgnoreSubsolversCount

(

)

Rather than fully specifying subsolvers, it is often convenient to just
remove the ones that are not useful on a given problem or only keep
specific ones for testing. Each string is interpreted as a "glob", so we
support '*' and '?'.

The way this work is that we will only accept a name that match a filter
pattern (if non-empty) and do not match an ignore pattern. Note also that
these fields work on LNS or LS names even if these are currently not
specified via the subsolvers field.

repeated string ignore_subsolvers = 209;

Returns

The count of ignoreSubsolvers.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 24558 of file SatParameters.java.

getIgnoreSubsolversList()

com.google.protobuf.ProtocolStringList com.google.ortools.sat.SatParameters.Builder.getIgnoreSubsolversList

(

)

Rather than fully specifying subsolvers, it is often convenient to just
remove the ones that are not useful on a given problem or only keep
specific ones for testing. Each string is interpreted as a "glob", so we
support '*' and '?'.

The way this work is that we will only accept a name that match a filter
pattern (if non-empty) and do not match an ignore pattern. Note also that
these fields work on LNS or LS names even if these are currently not
specified via the subsolvers field.

repeated string ignore_subsolvers = 209;

Returns

A list containing the ignoreSubsolvers.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 24538 of file SatParameters.java.

getInferAllDiffs()

boolean com.google.ortools.sat.SatParameters.Builder.getInferAllDiffs

(

)

Run a max-clique code amongst all the x != y we can find and try to infer
set of variables that are all different. This allows to close neos16.mps
for instance. Note that we only run this code if there is no all_diff
already in the model so that if a user want to add some all_diff, we assume
it is well done and do not try to add more.

This will also detect and add no_overlap constraints, if all the relations
x != y have "offsets" between them. I.e. x > y + offset.

optional bool infer_all_diffs = 233 [default = true];

Returns

The inferAllDiffs.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 23388 of file SatParameters.java.

getInitialPolarity()

com.google.ortools.sat.SatParameters.Polarity com.google.ortools.sat.SatParameters.Builder.getInitialPolarity

(

)

optional .operations_research.sat.SatParameters.Polarity initial_polarity = 2 [default = POLARITY_FALSE];

Returns

The initialPolarity.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 18173 of file SatParameters.java.

getInitialVariablesActivity()

double com.google.ortools.sat.SatParameters.Builder.getInitialVariablesActivity

(

)

The initial value of the variables activity. A non-zero value only make
sense when use_erwa_heuristic is true. Experiments with a value of 1e-2
together with the ERWA heuristic showed slighthly better result than simply
using zero. The idea is that when the "learning rate" of a variable becomes
lower than this value, then we prefer to branch on never explored before
variables. This is not in the ERWA paper.

optional double initial_variables_activity = 76 [default = 0];

Returns

The initialVariablesActivity.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 18594 of file SatParameters.java.

getInprocessingDtimeRatio()

double com.google.ortools.sat.SatParameters.Builder.getInprocessingDtimeRatio

(

)

Proportion of deterministic time we should spend on inprocessing.
At each "restart", if the proportion is below this ratio, we will do some
inprocessing, otherwise, we skip it for this restart.

optional double inprocessing_dtime_ratio = 273 [default = 0.2];

Returns

The inprocessingDtimeRatio.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 23590 of file SatParameters.java.

getInprocessingMinimizationDtime()

double com.google.ortools.sat.SatParameters.Builder.getInprocessingMinimizationDtime

(

)

Parameters for an heuristic similar to the one described in "An effective
learnt clause minimization approach for CDCL Sat Solvers",
https://www.ijcai.org/proceedings/2017/0098.pdf

This is the amount of dtime we should spend on this technique during each
inprocessing phase.

The minimization technique is the same as the one used to minimize core in
max-sat. We also minimize problem clauses and not just the learned clause
that we keep forever like in the paper.

optional double inprocessing_minimization_dtime = 275 [default = 1];

Returns

The inprocessingMinimizationDtime.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 23724 of file SatParameters.java.

getInprocessingProbingDtime()

double com.google.ortools.sat.SatParameters.Builder.getInprocessingProbingDtime

(

)

The amount of dtime we should spend on probing for each inprocessing round.

optional double inprocessing_probing_dtime = 274 [default = 1];

Returns

The inprocessingProbingDtime.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 23650 of file SatParameters.java.

getInstantiateAllVariables()

boolean com.google.ortools.sat.SatParameters.Builder.getInstantiateAllVariables

(

)

If true, the solver will add a default integer branching strategy to the
already defined search strategy. If not, some variable might still not be
fixed at the end of the search. For now we assume these variable can just
be set to their lower bound.

optional bool instantiate_all_variables = 106 [default = true];

Returns

The instantiateAllVariables.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 30233 of file SatParameters.java.

getInterleaveBatchSize()

int com.google.ortools.sat.SatParameters.Builder.getInterleaveBatchSize

(

)

optional int32 interleave_batch_size = 134 [default = 0];

Returns

The interleaveBatchSize.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 25315 of file SatParameters.java.

getInterleaveSearch()

boolean com.google.ortools.sat.SatParameters.Builder.getInterleaveSearch

(

)

Experimental. If this is true, then we interleave all our major search
strategy and distribute the work amongst num_workers.

The search is deterministic (independently of num_workers!), and we
schedule and wait for interleave_batch_size task to be completed before
synchronizing and scheduling the next batch of tasks.

optional bool interleave_search = 136 [default = false];

Returns

The interleaveSearch.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 25257 of file SatParameters.java.

getKeepAllFeasibleSolutionsInPresolve()

boolean com.google.ortools.sat.SatParameters.Builder.getKeepAllFeasibleSolutionsInPresolve

(

)

If true, we disable the presolve reductions that remove feasible solutions
from the search space. Such solution are usually dominated by a "better"
solution that is kept, but depending on the situation, we might want to
keep all solutions.

A trivial example is when a variable is unused. If this is true, then the
presolve will not fix it to an arbitrary value and it will stay in the
search space.

optional bool keep_all_feasible_solutions_in_presolve = 173 [default = false];

Returns

The keepAllFeasibleSolutionsInPresolve.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 29993 of file SatParameters.java.

getLinearizationLevel()

int com.google.ortools.sat.SatParameters.Builder.getLinearizationLevel

(

)

A non-negative level indicating the type of constraints we consider in the
LP relaxation. At level zero, no LP relaxation is used. At level 1, only
the linear constraint and full encoding are added. At level 2, we also add
all the Boolean constraints.

optional int32 linearization_level = 90 [default = 1];

Returns

The linearizationLevel.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 31999 of file SatParameters.java.

getLinearSplitSize()

int com.google.ortools.sat.SatParameters.Builder.getLinearSplitSize

(

)

Linear constraints that are not pseudo-Boolean and that are longer than
this size will be split into sqrt(size) intermediate sums in order to have
faster propation in the CP engine.

optional int32 linear_split_size = 256 [default = 100];

Returns

The linearSplitSize.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 31933 of file SatParameters.java.

getLogPrefix()

java.lang.String com.google.ortools.sat.SatParameters.Builder.getLogPrefix

(

)

Add a prefix to all logs.

optional string log_prefix = 185 [default = ""];

Returns

The logPrefix.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 21268 of file SatParameters.java.

getLogPrefixBytes()

com.google.protobuf.ByteString com.google.ortools.sat.SatParameters.Builder.getLogPrefixBytes

(

)

Add a prefix to all logs.

optional string log_prefix = 185 [default = ""];

Returns

The bytes for logPrefix.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 21291 of file SatParameters.java.

getLogSearchProgress()

boolean com.google.ortools.sat.SatParameters.Builder.getLogSearchProgress

(

)

Whether the solver should log the search progress. This is the maing
logging parameter and if this is false, none of the logging (callbacks,
log_to_stdout, log_to_response, ...) will do anything.

optional bool log_search_progress = 41 [default = false];

Returns

The logSearchProgress.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 21142 of file SatParameters.java.

getLogSubsolverStatistics()

boolean com.google.ortools.sat.SatParameters.Builder.getLogSubsolverStatistics

(

)

Whether the solver should display per sub-solver search statistics.
This is only useful is log_search_progress is set to true, and if the
number of search workers is > 1. Note that in all case we display a bit
of stats with one line per subsolver.

optional bool log_subsolver_statistics = 189 [default = false];

Returns

The logSubsolverStatistics.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 21208 of file SatParameters.java.

getLogToResponse()

boolean com.google.ortools.sat.SatParameters.Builder.getLogToResponse

(

)

Log to response proto.

optional bool log_to_response = 187 [default = false];

Returns

The logToResponse.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 21430 of file SatParameters.java.

getLogToStdout()

boolean com.google.ortools.sat.SatParameters.Builder.getLogToStdout

(

)

Log to stdout.

optional bool log_to_stdout = 186 [default = true];

Returns

The logToStdout.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 21374 of file SatParameters.java.

getLpDualTolerance()

double com.google.ortools.sat.SatParameters.Builder.getLpDualTolerance

(

)

optional double lp_dual_tolerance = 267 [default = 1e-07];

Returns

The lpDualTolerance.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 31677 of file SatParameters.java.

getLpPrimalTolerance()

double com.google.ortools.sat.SatParameters.Builder.getLpPrimalTolerance

(

)

The internal LP tolerances used by CP-SAT. These applies to the internal
and scaled problem. If the domains of your variables are large it might be
good to use lower tolerances. If your problem is binary with low
coefficients, it might be good to use higher ones to speed-up the lp
solves.

optional double lp_primal_tolerance = 266 [default = 1e-07];

Returns

The lpPrimalTolerance.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 31621 of file SatParameters.java.

getMaxAllDiffCutSize()

int com.google.ortools.sat.SatParameters.Builder.getMaxAllDiffCutSize

(

)

Cut generator for all diffs can add too many cuts for large all_diff
constraints. This parameter restricts the large all_diff constraints to
have a cut generator.

optional int32 max_all_diff_cut_size = 148 [default = 64];

Returns

The maxAllDiffCutSize.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 32765 of file SatParameters.java.

getMaxClauseActivityValue()

double com.google.ortools.sat.SatParameters.Builder.getMaxClauseActivityValue

(

)

optional double max_clause_activity_value = 18 [default = 1e+20];

Returns

The maxClauseActivityValue.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19624 of file SatParameters.java.

getMaxConsecutiveInactiveCount()

int com.google.ortools.sat.SatParameters.Builder.getMaxConsecutiveInactiveCount

(

)

If a constraint/cut in LP is not active for that many consecutive OPTIMAL
solves, remove it from the LP. Note that it might be added again later if
it become violated by the current LP solution.

optional int32 max_consecutive_inactive_count = 121 [default = 100];

Returns

The maxConsecutiveInactiveCount.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 33241 of file SatParameters.java.

getMaxCutRoundsAtLevelZero()

int com.google.ortools.sat.SatParameters.Builder.getMaxCutRoundsAtLevelZero

(

)

Max number of time we perform cut generation and resolve the LP at level 0.

optional int32 max_cut_rounds_at_level_zero = 154 [default = 1];

Returns

The maxCutRoundsAtLevelZero.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 33181 of file SatParameters.java.

getMaxDeterministicTime()

double com.google.ortools.sat.SatParameters.Builder.getMaxDeterministicTime

(

)

Maximum time allowed in deterministic time to solve a problem.
The deterministic time should be correlated with the real time used by the
solver, the time unit being as close as possible to a second.

optional double max_deterministic_time = 67 [default = inf];

Returns

The maxDeterministicTime.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 20470 of file SatParameters.java.

getMaxDomainSizeWhenEncodingEqNeqConstraints()

int com.google.ortools.sat.SatParameters.Builder.getMaxDomainSizeWhenEncodingEqNeqConstraints

(

)

When loading a*x + b*y ==/!= c when x and y are both fully encoded.
The solver may decide to replace the linear equation by a set of clauses.
This is triggered if the sizes of the domains of x and y are below the
threshold.

optional int32 max_domain_size_when_encoding_eq_neq_constraints = 191 [default = 16];

Returns

The maxDomainSizeWhenEncodingEqNeqConstraints.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 32127 of file SatParameters.java.

getMaxIntegerRoundingScaling()

int com.google.ortools.sat.SatParameters.Builder.getMaxIntegerRoundingScaling

(

)

In the integer rounding procedure used for MIR and Gomory cut, the maximum
"scaling" we use (must be positive). The lower this is, the lower the
integer coefficients of the cut will be. Note that cut generated by lower
values are not necessarily worse than cut generated by larger value. There
is no strict dominance relationship.

Setting this to 2 result in the "strong fractional rouding" of Letchford
and Lodi.

optional int32 max_integer_rounding_scaling = 119 [default = 600];

Returns

The maxIntegerRoundingScaling.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 32903 of file SatParameters.java.

getMaxLinMaxSizeForExpansion()

int com.google.ortools.sat.SatParameters.Builder.getMaxLinMaxSizeForExpansion

(

)

If the number of expressions in the lin_max is less that the max size
parameter, model expansion replaces target = max(xi) by linear constraint
with the introduction of new booleans bi such that bi => target == xi.

This is mainly for experimenting compared to a custom lin_max propagator.

optional int32 max_lin_max_size_for_expansion = 280 [default = 0];

Returns

The maxLinMaxSizeForExpansion.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 22798 of file SatParameters.java.

getMaxMemoryInMb()

long com.google.ortools.sat.SatParameters.Builder.getMaxMemoryInMb

(

)

Maximum memory allowed for the whole thread containing the solver. The
solver will abort as soon as it detects that this limit is crossed. As a
result, this limit is approximative, but usually the solver will not go too
much over.

TODO(user): This is only used by the pure SAT solver, generalize to CP-SAT.

optional int64 max_memory_in_mb = 40 [default = 10000];

Returns

The maxMemoryInMb.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 20680 of file SatParameters.java.

getMaxNumberOfConflicts()

long com.google.ortools.sat.SatParameters.Builder.getMaxNumberOfConflicts

(

)

Maximum number of conflicts allowed to solve a problem.

TODO(user): Maybe change the way the conflict limit is enforced?
currently it is enforced on each independent internal SAT solve, rather
than on the overall number of conflicts across all solves. So in the
context of an optimization problem, this is not really usable directly by a
client.

optional int64 max_number_of_conflicts = 37 [default = 9223372036854775807];

Returns

The maxNumberOfConflicts.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 20602 of file SatParameters.java.

getMaxNumCuts()

int com.google.ortools.sat.SatParameters.Builder.getMaxNumCuts

(

)

The limit on the number of cuts in our cut pool. When this is reached we do
not generate cuts anymore.

TODO(user): We should probably remove this parameters, and just always
generate cuts but only keep the best n or something.

optional int32 max_num_cuts = 91 [default = 10000];

Returns

The maxNumCuts.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 32197 of file SatParameters.java.

getMaxNumDeterministicBatches()

int com.google.ortools.sat.SatParameters.Builder.getMaxNumDeterministicBatches

(

)

Stops after that number of batches has been scheduled. This only make sense
when interleave_search is true.

optional int32 max_num_deterministic_batches = 291 [default = 0];

Returns

The maxNumDeterministicBatches.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 20532 of file SatParameters.java.

getMaxNumIntervalsForTimetableEdgeFinding()

int com.google.ortools.sat.SatParameters.Builder.getMaxNumIntervalsForTimetableEdgeFinding

(

)

Max number of intervals for the timetable_edge_finding algorithm to
propagate. A value of 0 disables the constraint.

optional int32 max_num_intervals_for_timetable_edge_finding = 260 [default = 100];

Returns

The maxNumIntervalsForTimetableEdgeFinding.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 26837 of file SatParameters.java.

getMaxPairsPairwiseReasoningInNoOverlap2D()

int com.google.ortools.sat.SatParameters.Builder.getMaxPairsPairwiseReasoningInNoOverlap2D

(

)

If the number of pairs to look is below this threshold, do an extra step of
propagation in the no_overlap_2d constraint by looking at all pairs of
intervals.

optional int32 max_pairs_pairwise_reasoning_in_no_overlap_2d = 276 [default = 1250];

Returns

The maxPairsPairwiseReasoningInNoOverlap2d.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 27307 of file SatParameters.java.

getMaxPresolveIterations()

int com.google.ortools.sat.SatParameters.Builder.getMaxPresolveIterations

(

)

In case of large reduction in a presolve iteration, we perform multiple
presolve iterations. This parameter controls the maximum number of such
presolve iterations.

optional int32 max_presolve_iterations = 138 [default = 3];

Returns

The maxPresolveIterations.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 22134 of file SatParameters.java.

getMaxSatAssumptionOrder()

com.google.ortools.sat.SatParameters.MaxSatAssumptionOrder com.google.ortools.sat.SatParameters.Builder.getMaxSatAssumptionOrder

(

)

optional .operations_research.sat.SatParameters.MaxSatAssumptionOrder max_sat_assumption_order = 51 [default = DEFAULT_ASSUMPTION_ORDER];

Returns

The maxSatAssumptionOrder.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 26022 of file SatParameters.java.

getMaxSatReverseAssumptionOrder()

boolean com.google.ortools.sat.SatParameters.Builder.getMaxSatReverseAssumptionOrder

(

)

If true, adds the assumption in the reverse order of the one defined by
max_sat_assumption_order.

optional bool max_sat_reverse_assumption_order = 52 [default = false];

Returns

The maxSatReverseAssumptionOrder.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 26075 of file SatParameters.java.

getMaxSatStratification()

com.google.ortools.sat.SatParameters.MaxSatStratificationAlgorithm com.google.ortools.sat.SatParameters.Builder.getMaxSatStratification

(

)

optional .operations_research.sat.SatParameters.MaxSatStratificationAlgorithm max_sat_stratification = 53 [default = STRATIFICATION_DESCENT];

Returns

The maxSatStratification.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 26124 of file SatParameters.java.

getMaxSizeToCreatePrecedenceLiteralsInDisjunctive()

int com.google.ortools.sat.SatParameters.Builder.getMaxSizeToCreatePrecedenceLiteralsInDisjunctive

(

)

Create one literal for each disjunction of two pairs of tasks. This slows
down the solve time, but improves the lower bound of the objective in the
makespan case. This will be triggered if the number of intervals is less or
equal than the parameter and if use_strong_propagation_in_disjunctive is
true.

optional int32 max_size_to_create_precedence_literals_in_disjunctive = 229 [default = 60];

Returns

The maxSizeToCreatePrecedenceLiteralsInDisjunctive.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 26359 of file SatParameters.java.

getMaxTimeInSeconds()

double com.google.ortools.sat.SatParameters.Builder.getMaxTimeInSeconds

(

)

Maximum time allowed in seconds to solve a problem.
The counter will starts at the beginning of the Solve() call.

optional double max_time_in_seconds = 36 [default = inf];

Returns

The maxTimeInSeconds.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 20408 of file SatParameters.java.

getMaxVariableActivityValue()

double com.google.ortools.sat.SatParameters.Builder.getMaxVariableActivityValue

(

)

optional double max_variable_activity_value = 16 [default = 1e+100];

Returns

The maxVariableActivityValue.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19376 of file SatParameters.java.

getMergeAtMostOneWorkLimit()

double com.google.ortools.sat.SatParameters.Builder.getMergeAtMostOneWorkLimit

(

)

optional double merge_at_most_one_work_limit = 146 [default = 100000000];

Returns

The mergeAtMostOneWorkLimit.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 23046 of file SatParameters.java.

getMergeNoOverlapWorkLimit()

double com.google.ortools.sat.SatParameters.Builder.getMergeNoOverlapWorkLimit

(

)

During presolve, we use a maximum clique heuristic to merge together
no-overlap constraints or at most one constraints. This code can be slow,
so we have a limit in place on the number of explored nodes in the
underlying graph. The internal limit is an int64, but we use double here to
simplify manual input.

optional double merge_no_overlap_work_limit = 145 [default = 1000000000000];

Returns

The mergeNoOverlapWorkLimit.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 22990 of file SatParameters.java.

getMinimizationAlgorithm()

com.google.ortools.sat.SatParameters.ConflictMinimizationAlgorithm com.google.ortools.sat.SatParameters.Builder.getMinimizationAlgorithm

(

)

optional .operations_research.sat.SatParameters.ConflictMinimizationAlgorithm minimization_algorithm = 4 [default = RECURSIVE];

Returns

The minimizationAlgorithm.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 18719 of file SatParameters.java.

getMinimizeReductionDuringPbResolution()

boolean com.google.ortools.sat.SatParameters.Builder.getMinimizeReductionDuringPbResolution

(

)

A different algorithm during PB resolution. It minimizes the number of
calls to ReduceCoefficients() which can be time consuming. However, the
search space will be different and if the coefficients are large, this may
lead to integer overflows that could otherwise be prevented.

optional bool minimize_reduction_during_pb_resolution = 48 [default = false];

Returns

The minimizeReductionDuringPbResolution.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 21560 of file SatParameters.java.

getMinOrthogonalityForLpConstraints()

double com.google.ortools.sat.SatParameters.Builder.getMinOrthogonalityForLpConstraints

(

)

While adding constraints, skip the constraints which have orthogonality
less than 'min_orthogonality_for_lp_constraints' with already added
constraints during current call. Orthogonality is defined as 1 -
cosine(vector angle between constraints). A value of zero disable this
feature.

optional double min_orthogonality_for_lp_constraints = 115 [default = 0.05];

Returns

The minOrthogonalityForLpConstraints.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 33117 of file SatParameters.java.

getMipAutomaticallyScaleVariables()

boolean com.google.ortools.sat.SatParameters.Builder.getMipAutomaticallyScaleVariables

(

)

If true, some continuous variable might be automatically scaled. For now,
this is only the case where we detect that a variable is actually an
integer multiple of a constant. For instance, variables of the form k * 0.5
are quite frequent, and if we detect this, we will scale such variable
domain by 2 to make it implied integer.

optional bool mip_automatically_scale_variables = 166 [default = true];

Returns

The mipAutomaticallyScaleVariables.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 34097 of file SatParameters.java.

getMipCheckPrecision()

double com.google.ortools.sat.SatParameters.Builder.getMipCheckPrecision

(

)

As explained in mip_precision and mip_max_activity_exponent, we cannot
always reach the wanted precision during scaling. We use this threshold to
enphasize in the logs when the precision seems bad.

optional double mip_check_precision = 128 [default = 0.0001];

Returns

The mipCheckPrecision.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 34469 of file SatParameters.java.

getMipComputeTrueObjectiveBound()

boolean com.google.ortools.sat.SatParameters.Builder.getMipComputeTrueObjectiveBound

(

)

Even if we make big error when scaling the objective, we can always derive
a correct lower bound on the original objective by using the exact lower
bound on the scaled integer version of the objective. This should be fast,
but if you don't care about having a precise lower bound, you can turn it
off.

optional bool mip_compute_true_objective_bound = 198 [default = true];

Returns

The mipComputeTrueObjectiveBound.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 34537 of file SatParameters.java.

getMipDropTolerance()

double com.google.ortools.sat.SatParameters.Builder.getMipDropTolerance

(

)

Any value in the input mip with a magnitude lower than this will be set to
zero. This is to avoid some issue in LP presolving.

optional double mip_drop_tolerance = 232 [default = 1e-16];

Returns

The mipDropTolerance.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 34751 of file SatParameters.java.

getMipMaxActivityExponent()

int com.google.ortools.sat.SatParameters.Builder.getMipMaxActivityExponent

(

)

To avoid integer overflow, we always force the maximum possible constraint
activity (and objective value) according to the initial variable domain to
be smaller than 2 to this given power. Because of this, we cannot always
reach the "mip_wanted_precision" parameter above.

This can go as high as 62, but some internal algo currently abort early if
they might run into integer overflow, so it is better to keep it a bit
lower than this.

optional int32 mip_max_activity_exponent = 127 [default = 53];

Returns

The mipMaxActivityExponent.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 34395 of file SatParameters.java.

getMipMaxBound()

double com.google.ortools.sat.SatParameters.Builder.getMipMaxBound

(

)

We need to bound the maximum magnitude of the variables for CP-SAT, and
that is the bound we use. If the MIP model expect larger variable value in
the solution, then the converted model will likely not be relevant.

optional double mip_max_bound = 124 [default = 10000000];

Returns

The mipMaxBound.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 33901 of file SatParameters.java.

getMipMaxValidMagnitude()

double com.google.ortools.sat.SatParameters.Builder.getMipMaxValidMagnitude

(

)

Any finite values in the input MIP must be below this threshold, otherwise
the model will be reported invalid. This is needed to avoid floating point
overflow when evaluating bounds * coeff for instance. We are a bit more
defensive, but in practice, users shouldn't use super large values in a
MIP.

optional double mip_max_valid_magnitude = 199 [default = 1e+20];

Returns

The mipMaxValidMagnitude.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 34609 of file SatParameters.java.

getMipPresolveLevel()

int com.google.ortools.sat.SatParameters.Builder.getMipPresolveLevel

(

)

When solving a MIP, we do some basic floating point presolving before
scaling the problem to integer to be handled by CP-SAT. This control how
much of that presolve we do. It can help to better scale floating point
model, but it is not always behaving nicely.

optional int32 mip_presolve_level = 261 [default = 2];

Returns

The mipPresolveLevel.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 34815 of file SatParameters.java.

getMipScaleLargeDomain()

boolean com.google.ortools.sat.SatParameters.Builder.getMipScaleLargeDomain

(

)

If this is false, then mip_var_scaling is only applied to variables with
"small" domain. If it is true, we scale all floating point variable
independenlty of their domain.

optional bool mip_scale_large_domain = 225 [default = false];

Returns

The mipScaleLargeDomain.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 34029 of file SatParameters.java.

getMipTreatHighMagnitudeBoundsAsInfinity()

boolean com.google.ortools.sat.SatParameters.Builder.getMipTreatHighMagnitudeBoundsAsInfinity

(

)

By default, any variable/constraint bound with a finite value and a
magnitude greater than the mip_max_valid_magnitude will result with a
invalid model. This flags change the behavior such that such bounds are
silently transformed to +∞ or -∞.

It is recommended to keep it at false, and create valid bounds.

optional bool mip_treat_high_magnitude_bounds_as_infinity = 278 [default = false];

Returns

The mipTreatHighMagnitudeBoundsAsInfinity.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 34683 of file SatParameters.java.

getMipVarScaling()

double com.google.ortools.sat.SatParameters.Builder.getMipVarScaling

(

)

All continuous variable of the problem will be multiplied by this factor.
By default, we don't do any variable scaling and rely on the MIP model to
specify continuous variable domain with the wanted precision.

optional double mip_var_scaling = 125 [default = 1];

Returns

The mipVarScaling.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 33965 of file SatParameters.java.

getMipWantedPrecision()

double com.google.ortools.sat.SatParameters.Builder.getMipWantedPrecision

(

)

When scaling constraint with double coefficients to integer coefficients,
we will multiply by a power of 2 and round the coefficients. We will choose
the lowest power such that we have no potential overflow (see
mip_max_activity_exponent) and the worst case constraint activity error
does not exceed this threshold.

Note that we also detect constraint with rational coefficients and scale
them accordingly when it seems better instead of using a power of 2.

We also relax all constraint bounds by this absolute value. For pure
integer constraint, if this value if lower than one, this will not change
anything. However it is needed when scaling MIP problems.

If we manage to scale a constraint correctly, the maximum error we can make
will be twice this value (once for the scaling error and once for the
relaxed bounds). If we are not able to scale that well, we will display
that fact but still scale as best as we can.

optional double mip_wanted_precision = 126 [default = 1e-06];

Returns

The mipWantedPrecision.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 34293 of file SatParameters.java.

getName()

java.lang.String com.google.ortools.sat.SatParameters.Builder.getName

(

)

In some context, like in a portfolio of search, it makes sense to name a
given parameters set for logging purpose.

optional string name = 171 [default = ""];

Returns

The name.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 18030 of file SatParameters.java.

getNameBytes()

com.google.protobuf.ByteString com.google.ortools.sat.SatParameters.Builder.getNameBytes

(

)

In some context, like in a portfolio of search, it makes sense to name a
given parameters set for logging purpose.

optional string name = 171 [default = ""];

Returns

The bytes for name.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 18054 of file SatParameters.java.

getNewConstraintsBatchSize()

int com.google.ortools.sat.SatParameters.Builder.getNewConstraintsBatchSize

(

)

Add that many lazy constraints (or cuts) at once in the LP. Note that at
the beginning of the solve, we do add more than this.

optional int32 new_constraints_batch_size = 122 [default = 50];

Returns

The newConstraintsBatchSize.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 33463 of file SatParameters.java.

getNewLinearPropagation()

boolean com.google.ortools.sat.SatParameters.Builder.getNewLinearPropagation

(

)

The new linear propagation code treat all constraints at once and use
an adaptation of Bellman-Ford-Tarjan to propagate constraint in a smarter
order and potentially detect propagation cycle earlier.

optional bool new_linear_propagation = 224 [default = true];

Returns

The newLinearPropagation.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 31869 of file SatParameters.java.

getNumConflictsBeforeStrategyChanges()

int com.google.ortools.sat.SatParameters.Builder.getNumConflictsBeforeStrategyChanges

(

)

After each restart, if the number of conflict since the last strategy
change is greater that this, then we increment a "strategy_counter" that
can be use to change the search strategy used by the following restarts.

optional int32 num_conflicts_before_strategy_changes = 68 [default = 0];

Returns

The numConflictsBeforeStrategyChanges.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 20286 of file SatParameters.java.

getNumFullSubsolvers()

int com.google.ortools.sat.SatParameters.Builder.getNumFullSubsolvers

(

)

We distinguish subsolvers that consume a full thread, and the ones that are
always interleaved. If left at zero, we will fix this with a default
formula that depends on num_workers. But if you start modifying what runs,
you might want to fix that to a given value depending on the num_workers
you use.

optional int32 num_full_subsolvers = 294 [default = 0];

Returns

The numFullSubsolvers.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 23954 of file SatParameters.java.

getNumSearchWorkers()

int com.google.ortools.sat.SatParameters.Builder.getNumSearchWorkers

(

)

optional int32 num_search_workers = 100 [default = 0];

Returns

The numSearchWorkers.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 23898 of file SatParameters.java.

getNumViolationLs()

int com.google.ortools.sat.SatParameters.Builder.getNumViolationLs

(

)

This will create incomplete subsolvers (that are not LNS subsolvers)
that use the feasibility jump code to find improving solution, treating
the objective improvement as a hard constraint.

optional int32 num_violation_ls = 244 [default = 0];

Returns

The numViolationLs.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 29237 of file SatParameters.java.

getNumWorkers()

int com.google.ortools.sat.SatParameters.Builder.getNumWorkers

(

)

Specify the number of parallel workers (i.e. threads) to use during search.
This should usually be lower than your number of available cpus +
hyperthread in your machine.

A value of 0 means the solver will try to use all cores on the machine.
A number of 1 means no parallelism.

Note that 'num_workers' is the preferred name, but if it is set to zero,
we will still read the deprecated 'num_search_workers'.

As of 2020-04-10, if you're using SAT via MPSolver (to solve integer
programs) this field is overridden with a value of 8, if the field is not
set *explicitly*. Thus, always set this field explicitly or via
MPSolver::SetNumThreads().

optional int32 num_workers = 206 [default = 0];

Returns

The numWorkers.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 23824 of file SatParameters.java.

getOnlyAddCutsAtLevelZero()

boolean com.google.ortools.sat.SatParameters.Builder.getOnlyAddCutsAtLevelZero

(

)

For the cut that can be generated at any level, this control if we only
try to generate them at the root node.

optional bool only_add_cuts_at_level_zero = 92 [default = false];

Returns

The onlyAddCutsAtLevelZero.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 32327 of file SatParameters.java.

getOnlySolveIp()

boolean com.google.ortools.sat.SatParameters.Builder.getOnlySolveIp

(

)

If one try to solve a MIP model with CP-SAT, because we assume all variable
to be integer after scaling, we will not necessarily have the correct
optimal. Note however that all feasible solutions are valid since we will
just solve a more restricted version of the original problem.

This parameters is here to prevent user to think the solution is optimal
when it might not be. One will need to manually set this to false to solve
a MIP model where the optimal might be different.

Note that this is tested after some MIP presolve steps, so even if not
all original variable are integer, we might end up with a pure IP after
presolve and after implied integer detection.

optional bool only_solve_ip = 222 [default = false];

Returns

The onlySolveIp.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 34183 of file SatParameters.java.

getOptimizeWithCore()

boolean com.google.ortools.sat.SatParameters.Builder.getOptimizeWithCore

(

)

The default optimization method is a simple "linear scan", each time trying
to find a better solution than the previous one. If this is true, then we
use a core-based approach (like in max-SAT) when we try to increase the
lower bound instead.

optional bool optimize_with_core = 83 [default = false];

Returns

The optimizeWithCore.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 28271 of file SatParameters.java.

getOptimizeWithLbTreeSearch()

boolean com.google.ortools.sat.SatParameters.Builder.getOptimizeWithLbTreeSearch

(

)

Do a more conventional tree search (by opposition to SAT based one) where
we keep all the explored node in a tree. This is meant to be used in a
portfolio and focus on improving the objective lower bound. Keeping the
whole tree allow us to report a better objective lower bound coming from
the worst open node in the tree.

optional bool optimize_with_lb_tree_search = 188 [default = false];

Returns

The optimizeWithLbTreeSearch.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 28341 of file SatParameters.java.

getOptimizeWithMaxHs()

boolean com.google.ortools.sat.SatParameters.Builder.getOptimizeWithMaxHs

(

)

This has no effect if optimize_with_core is false. If true, use a different
core-based algorithm similar to the max-HS algo for max-SAT. This is a
hybrid MIP/CP approach and it uses a MIP solver in addition to the CP/SAT
one. This is also related to the PhD work of tobyodavies@
"Automatic Logic-Based Benders Decomposition with MiniZinc"
http://aaai.org/ocs/index.php/AAAI/AAAI17/paper/view/14489

optional bool optimize_with_max_hs = 85 [default = false];

Returns

The optimizeWithMaxHs.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 28559 of file SatParameters.java.

getPbCleanupIncrement()

int com.google.ortools.sat.SatParameters.Builder.getPbCleanupIncrement

(

)

Same as for the clauses, but for the learned pseudo-Boolean constraints.

optional int32 pb_cleanup_increment = 46 [default = 200];

Returns

The pbCleanupIncrement.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19204 of file SatParameters.java.

getPbCleanupRatio()

double com.google.ortools.sat.SatParameters.Builder.getPbCleanupRatio

(

)

optional double pb_cleanup_ratio = 47 [default = 0.5];

Returns

The pbCleanupRatio.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19252 of file SatParameters.java.

getPermutePresolveConstraintOrder()

boolean com.google.ortools.sat.SatParameters.Builder.getPermutePresolveConstraintOrder

(

)

optional bool permute_presolve_constraint_order = 179 [default = false];

Returns

The permutePresolveConstraintOrder.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 21050 of file SatParameters.java.

getPermuteVariableRandomly()

boolean com.google.ortools.sat.SatParameters.Builder.getPermuteVariableRandomly

(

)

This is mainly here to test the solver variability. Note that in tests, if
not explicitly set to false, all 3 options will be set to true so that
clients do not rely on the solver returning a specific solution if they are
many equivalent optimal solutions.

optional bool permute_variable_randomly = 178 [default = false];

Returns

The permuteVariableRandomly.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 20996 of file SatParameters.java.

getPolarityRephaseIncrement()

int com.google.ortools.sat.SatParameters.Builder.getPolarityRephaseIncrement

(

)

If non-zero, then we change the polarity heuristic after that many number
of conflicts in an arithmetically increasing fashion. So x the first time,
2 * x the second time, etc...

optional int32 polarity_rephase_increment = 168 [default = 1000];

Returns

The polarityRephaseIncrement.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 18324 of file SatParameters.java.

getPolishLpSolution()

boolean com.google.ortools.sat.SatParameters.Builder.getPolishLpSolution

(

)

Whether we try to do a few degenerate iteration at the end of an LP solve
to minimize the fractionality of the integer variable in the basis. This
helps on some problems, but not so much on others. It also cost of bit of
time to do such polish step.

optional bool polish_lp_solution = 175 [default = false];

Returns

The polishLpSolution.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 31551 of file SatParameters.java.

getPreferredVariableOrder()

com.google.ortools.sat.SatParameters.VariableOrder com.google.ortools.sat.SatParameters.Builder.getPreferredVariableOrder

(

)

optional .operations_research.sat.SatParameters.VariableOrder preferred_variable_order = 1 [default = IN_ORDER];

Returns

The preferredVariableOrder.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 18131 of file SatParameters.java.

getPresolveBlockedClause()

boolean com.google.ortools.sat.SatParameters.Builder.getPresolveBlockedClause

(

)

Whether we use an heuristic to detect some basic case of blocked clause
in the SAT presolve.

optional bool presolve_blocked_clause = 88 [default = true];

Returns

The presolveBlockedClause.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 21948 of file SatParameters.java.

getPresolveBvaThreshold()

int com.google.ortools.sat.SatParameters.Builder.getPresolveBvaThreshold

(

)

Apply Bounded Variable Addition (BVA) if the number of clauses is reduced
by stricly more than this threshold. The algorithm described in the paper
uses 0, but quick experiments showed that 1 is a good value. It may not be
worth it to add a new variable just to remove one clause.

optional int32 presolve_bva_threshold = 73 [default = 1];

Returns

The presolveBvaThreshold.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 22068 of file SatParameters.java.

getPresolveBveClauseWeight()

int com.google.ortools.sat.SatParameters.Builder.getPresolveBveClauseWeight

(

)

During presolve, we apply BVE only if this weight times the number of
clauses plus the number of clause literals is not increased.

optional int32 presolve_bve_clause_weight = 55 [default = 3];

Returns

The presolveBveClauseWeight.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 21776 of file SatParameters.java.

getPresolveBveThreshold()

int com.google.ortools.sat.SatParameters.Builder.getPresolveBveThreshold

(

)

During presolve, only try to perform the bounded variable elimination (BVE)
of a variable x if the number of occurrences of x times the number of
occurrences of not(x) is not greater than this parameter.

optional int32 presolve_bve_threshold = 54 [default = 500];

Returns

The presolveBveThreshold.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 21714 of file SatParameters.java.

getPresolveExtractIntegerEnforcement()

boolean com.google.ortools.sat.SatParameters.Builder.getPresolveExtractIntegerEnforcement

(

)

If true, we will extract from linear constraints, enforcement literals of
the form "integer variable at bound => simplified constraint". This should
always be beneficial except that we don't always handle them as efficiently
as we could for now. This causes problem on manna81.mps (LP relaxation not
as tight it seems) and on neos-3354841-apure.mps.gz (too many literals
created this way).

optional bool presolve_extract_integer_enforcement = 174 [default = false];

Returns

The presolveExtractIntegerEnforcement.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 23172 of file SatParameters.java.

getPresolveInclusionWorkLimit()

long com.google.ortools.sat.SatParameters.Builder.getPresolveInclusionWorkLimit

(

)

A few presolve operations involve detecting constraints included in other
constraint. Since there can be a quadratic number of such pairs, and
processing them usually involve scanning them, the complexity of these
operations can be big. This enforce a local deterministic limit on the
number of entries scanned. Default is 1e8.

A value of zero will disable these presolve rules completely.

optional int64 presolve_inclusion_work_limit = 201 [default = 100000000];

Returns

The presolveInclusionWorkLimit.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 23250 of file SatParameters.java.

getPresolveProbingDeterministicTimeLimit()

double com.google.ortools.sat.SatParameters.Builder.getPresolveProbingDeterministicTimeLimit

(

)

optional double presolve_probing_deterministic_time_limit = 57 [default = 30];

Returns

The presolveProbingDeterministicTimeLimit.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 21898 of file SatParameters.java.

getPresolveSubstitutionLevel()

int com.google.ortools.sat.SatParameters.Builder.getPresolveSubstitutionLevel

(

)

How much substitution (also called free variable aggregation in MIP
litterature) should we perform at presolve. This currently only concerns
variable appearing only in linear constraints. For now the value 0 turns it
off and any positive value performs substitution.

optional int32 presolve_substitution_level = 147 [default = 1];

Returns

The presolveSubstitutionLevel.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 23100 of file SatParameters.java.

getPresolveUseBva()

boolean com.google.ortools.sat.SatParameters.Builder.getPresolveUseBva

(

)

Whether or not we use Bounded Variable Addition (BVA) in the presolve.

optional bool presolve_use_bva = 72 [default = true];

Returns

The presolveUseBva.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 22006 of file SatParameters.java.

getProbingDeterministicTimeLimit()

double com.google.ortools.sat.SatParameters.Builder.getProbingDeterministicTimeLimit

(

)

The maximum "deterministic" time limit to spend in probing. A value of
zero will disable the probing.

TODO(user): Clean up. The first one is used in CP-SAT, the other in pure
SAT presolve.

optional double probing_deterministic_time_limit = 226 [default = 1];

Returns

The probingDeterministicTimeLimit.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 21842 of file SatParameters.java.

getProbingNumCombinationsLimit()

int com.google.ortools.sat.SatParameters.Builder.getProbingNumCombinationsLimit

(

)

How many combinations of pairs or triplets of variables we want to scan.

optional int32 probing_num_combinations_limit = 272 [default = 20000];

Returns

The probingNumCombinationsLimit.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 27777 of file SatParameters.java.

getPropagationLoopDetectionFactor()

double com.google.ortools.sat.SatParameters.Builder.getPropagationLoopDetectionFactor

(

)

Some search decisions might cause a really large number of propagations to
happen when integer variables with large domains are only reduced by 1 at
each step. If we propagate more than the number of variable times this
parameters we try to take counter-measure. Setting this to 0.0 disable this
feature.

TODO(user): Setting this to something like 10 helps in most cases, but the
code is currently buggy and can cause the solve to enter a bad state where
no progress is made.

optional double propagation_loop_detection_factor = 221 [default = 10];

Returns

The propagationLoopDetectionFactor.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 26191 of file SatParameters.java.

getPseudoCostReliabilityThreshold()

long com.google.ortools.sat.SatParameters.Builder.getPseudoCostReliabilityThreshold

(

)

The solver ignores the pseudo costs of variables with number of recordings
less than this threshold.

optional int64 pseudo_cost_reliability_threshold = 123 [default = 100];

Returns

The pseudoCostReliabilityThreshold.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 28207 of file SatParameters.java.

getPushAllTasksTowardStart()

boolean com.google.ortools.sat.SatParameters.Builder.getPushAllTasksTowardStart

(

)

Experimental code: specify if the objective pushes all tasks toward the
start of the schedule.

optional bool push_all_tasks_toward_start = 262 [default = false];

Returns

The pushAllTasksTowardStart.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 31091 of file SatParameters.java.

getRandomBranchesRatio()

double com.google.ortools.sat.SatParameters.Builder.getRandomBranchesRatio

(

)

A number between 0 and 1 that indicates the proportion of branching
variables that are selected randomly instead of choosing the first variable
from the given variable_ordering strategy.

optional double random_branches_ratio = 32 [default = 0];

Returns

The randomBranchesRatio.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 18460 of file SatParameters.java.

getRandomizeSearch()

boolean com.google.ortools.sat.SatParameters.Builder.getRandomizeSearch

(

)

Randomize fixed search.

optional bool randomize_search = 103 [default = false];

Returns

The randomizeSearch.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 30969 of file SatParameters.java.

getRandomPolarityRatio()

double com.google.ortools.sat.SatParameters.Builder.getRandomPolarityRatio

(

)

The proportion of polarity chosen at random. Note that this take
precedence over the phase saving heuristic. This is different from
initial_polarity:POLARITY_RANDOM because it will select a new random
polarity each time the variable is branched upon instead of selecting one
initially and then always taking this choice.

optional double random_polarity_ratio = 45 [default = 0];

Returns

The randomPolarityRatio.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 18392 of file SatParameters.java.

getRandomSeed()

int com.google.ortools.sat.SatParameters.Builder.getRandomSeed

(

)

At the beginning of each solve, the random number generator used in some
part of the solver is reinitialized to this seed. If you change the random
seed, the solver may make different choices during the solving process.

For some problems, the running time may vary a lot depending on small
change in the solving algorithm. Running the solver with different seeds
enables to have more robust benchmarks when evaluating new features.

optional int32 random_seed = 31 [default = 1];

Returns

The randomSeed.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 20922 of file SatParameters.java.

getRelativeGapLimit()

double com.google.ortools.sat.SatParameters.Builder.getRelativeGapLimit

(

)

optional double relative_gap_limit = 160 [default = 0];

Returns

The relativeGapLimit.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 20862 of file SatParameters.java.

getRepairHint()

boolean com.google.ortools.sat.SatParameters.Builder.getRepairHint

(

)

If true, the solver tries to repair the solution given in the hint. This
search terminates after the 'hint_conflict_limit' is reached and the solver
switches to regular search. If false, then  we do a FIXED_SEARCH using the
hint until the hint_conflict_limit is reached.

optional bool repair_hint = 167 [default = false];

Returns

The repairHint.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 27535 of file SatParameters.java.

getRestartAlgorithms()

com.google.ortools.sat.SatParameters.RestartAlgorithm com.google.ortools.sat.SatParameters.Builder.getRestartAlgorithms

(

int

index

)

The restart strategies will change each time the strategy_counter is
increased. The current strategy will simply be the one at index
strategy_counter modulo the number of strategy. Note that if this list
includes a NO_RESTART, nothing will change when it is reached because the
strategy_counter will only increment after a restart.

The idea of switching of search strategy tailored for SAT/UNSAT comes from
Chanseok Oh with his COMiniSatPS solver, see http://cs.nyu.edu/~chanseok/.
But more generally, it seems REALLY beneficial to try different strategy.

repeated .operations_research.sat.SatParameters.RestartAlgorithm restart_algorithms = 61;

Parameters

index

The index of the element to return.

Returns

The restartAlgorithms at the given index.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19714 of file SatParameters.java.

getRestartAlgorithmsCount()

int com.google.ortools.sat.SatParameters.Builder.getRestartAlgorithmsCount

(

)

The restart strategies will change each time the strategy_counter is
increased. The current strategy will simply be the one at index
strategy_counter modulo the number of strategy. Note that if this list
includes a NO_RESTART, nothing will change when it is reached because the
strategy_counter will only increment after a restart.

The idea of switching of search strategy tailored for SAT/UNSAT comes from
Chanseok Oh with his COMiniSatPS solver, see http://cs.nyu.edu/~chanseok/.
But more generally, it seems REALLY beneficial to try different strategy.

repeated .operations_research.sat.SatParameters.RestartAlgorithm restart_algorithms = 61;

Returns

The count of restartAlgorithms.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19694 of file SatParameters.java.

getRestartAlgorithmsList()

java.util.List< com.google.ortools.sat.SatParameters.RestartAlgorithm > com.google.ortools.sat.SatParameters.Builder.getRestartAlgorithmsList

(

)

The restart strategies will change each time the strategy_counter is
increased. The current strategy will simply be the one at index
strategy_counter modulo the number of strategy. Note that if this list
includes a NO_RESTART, nothing will change when it is reached because the
strategy_counter will only increment after a restart.

The idea of switching of search strategy tailored for SAT/UNSAT comes from
Chanseok Oh with his COMiniSatPS solver, see http://cs.nyu.edu/~chanseok/.
But more generally, it seems REALLY beneficial to try different strategy.

repeated .operations_research.sat.SatParameters.RestartAlgorithm restart_algorithms = 61;

Returns

A list containing the restartAlgorithms.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19674 of file SatParameters.java.

getRestartDlAverageRatio()

double com.google.ortools.sat.SatParameters.Builder.getRestartDlAverageRatio

(

)

In the moving average restart algorithms, a restart is triggered if the
window average times this ratio is greater that the global average.

optional double restart_dl_average_ratio = 63 [default = 1];

Returns

The restartDlAverageRatio.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 20040 of file SatParameters.java.

getRestartLbdAverageRatio()

double com.google.ortools.sat.SatParameters.Builder.getRestartLbdAverageRatio

(

)

optional double restart_lbd_average_ratio = 71 [default = 1];

Returns

The restartLbdAverageRatio.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 20090 of file SatParameters.java.

getRestartPeriod()

int com.google.ortools.sat.SatParameters.Builder.getRestartPeriod

(

)

Restart period for the FIXED_RESTART strategy. This is also the multiplier
used by the LUBY_RESTART strategy.

optional int32 restart_period = 30 [default = 50];

Returns

The restartPeriod.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19924 of file SatParameters.java.

getRestartRunningWindowSize()

int com.google.ortools.sat.SatParameters.Builder.getRestartRunningWindowSize

(

)

Size of the window for the moving average restarts.

optional int32 restart_running_window_size = 62 [default = 50];

Returns

The restartRunningWindowSize.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19982 of file SatParameters.java.

getRootLpIterations()

int com.google.ortools.sat.SatParameters.Builder.getRootLpIterations

(

)

Even at the root node, we do not want to spend too much time on the LP if
it is "difficult". So we solve it in "chunks" of that many iterations. The
solve will be continued down in the tree or the next time we go back to the
root node.

optional int32 root_lp_iterations = 227 [default = 2000];

Returns

The rootLpIterations.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 33047 of file SatParameters.java.

getSaveLpBasisInLbTreeSearch()

boolean com.google.ortools.sat.SatParameters.Builder.getSaveLpBasisInLbTreeSearch

(

)

Experimental. Save the current LP basis at each node of the search tree so
that when we jump around, we can load it and reduce the number of LP
iterations needed.

It currently works okay if we do not change the lp with cuts or
simplification... More work is needed to make it robust in all cases.

optional bool save_lp_basis_in_lb_tree_search = 284 [default = false];

Returns

The saveLpBasisInLbTreeSearch.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 28415 of file SatParameters.java.

getSearchBranching()

com.google.ortools.sat.SatParameters.SearchBranching com.google.ortools.sat.SatParameters.Builder.getSearchBranching

(

)

optional .operations_research.sat.SatParameters.SearchBranching search_branching = 82 [default = AUTOMATIC_SEARCH];

Returns

The searchBranching.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 27422 of file SatParameters.java.

getSearchRandomVariablePoolSize()

long com.google.ortools.sat.SatParameters.Builder.getSearchRandomVariablePoolSize

(

)

Search randomization will collect the top
'search_random_variable_pool_size' valued variables, and pick one randomly.
The value of the variable is specific to each strategy.

optional int64 search_random_variable_pool_size = 104 [default = 0];

Returns

The searchRandomVariablePoolSize.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 31029 of file SatParameters.java.

getShareBinaryClauses()

boolean com.google.ortools.sat.SatParameters.Builder.getShareBinaryClauses

(

)

Allows sharing of new learned binary clause between workers.

optional bool share_binary_clauses = 203 [default = true];

Returns

The shareBinaryClauses.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 25475 of file SatParameters.java.

getSharedTreeMaxNodesPerWorker()

int com.google.ortools.sat.SatParameters.Builder.getSharedTreeMaxNodesPerWorker

(

)

In order to limit total shared memory and communication overhead, limit the
total number of nodes that may be generated in the shared tree. If the
shared tree runs out of unassigned leaves, workers act as portfolio
workers. Note: this limit includes interior nodes, not just leaves.

optional int32 shared_tree_max_nodes_per_worker = 238 [default = 100000];

Returns

The sharedTreeMaxNodesPerWorker.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 29795 of file SatParameters.java.

getSharedTreeNumWorkers()

int com.google.ortools.sat.SatParameters.Builder.getSharedTreeNumWorkers

(

)

Enables experimental workstealing-like shared tree search.
If non-zero, start this many complete worker threads to explore a shared
search tree. These workers communicate objective bounds and simple decision
nogoods relating to the shared prefix of the tree, and will avoid exploring
the same subtrees as one another.

optional int32 shared_tree_num_workers = 235 [default = 0];

Returns

The sharedTreeNumWorkers.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 29421 of file SatParameters.java.

getSharedTreeOpenLeavesPerWorker()

double com.google.ortools.sat.SatParameters.Builder.getSharedTreeOpenLeavesPerWorker

(

)

How many open leaf nodes should the shared tree maintain per worker.

optional double shared_tree_open_leaves_per_worker = 281 [default = 2];

Returns

The sharedTreeOpenLeavesPerWorker.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 29733 of file SatParameters.java.

getSharedTreeSplitStrategy()

com.google.ortools.sat.SatParameters.SharedTreeSplitStrategy com.google.ortools.sat.SatParameters.Builder.getSharedTreeSplitStrategy

(

)

optional .operations_research.sat.SatParameters.SharedTreeSplitStrategy shared_tree_split_strategy = 239 [default = SPLIT_STRATEGY_AUTO];

Returns

The sharedTreeSplitStrategy.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 29848 of file SatParameters.java.

getSharedTreeWorkerEnableTrailSharing()

boolean com.google.ortools.sat.SatParameters.Builder.getSharedTreeWorkerEnableTrailSharing

(

)

If true, workers share more of the information from their local trail.
Specifically, literals implied by the shared tree decisions and
the longest conflict-free assignment from the last restart (to enable
cross-worker phase-saving).

optional bool shared_tree_worker_enable_trail_sharing = 295 [default = true];

Returns

The sharedTreeWorkerEnableTrailSharing.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 29671 of file SatParameters.java.

getSharedTreeWorkerMinRestartsPerSubtree()

int com.google.ortools.sat.SatParameters.Builder.getSharedTreeWorkerMinRestartsPerSubtree

(

)

Minimum number of restarts before a worker will replace a subtree
that looks "bad" based on the average LBD of learned clauses.

optional int32 shared_tree_worker_min_restarts_per_subtree = 282 [default = 1];

Returns

The sharedTreeWorkerMinRestartsPerSubtree.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 29607 of file SatParameters.java.

getSharedTreeWorkerObjectiveSplitProbability()

double com.google.ortools.sat.SatParameters.Builder.getSharedTreeWorkerObjectiveSplitProbability

(

)

After their assigned prefix, shared tree workers will branch on the
objective with this probability. Higher numbers cause the shared tree
search to focus on improving the lower bound over finding primal solutions.

optional double shared_tree_worker_objective_split_probability = 237 [default = 0.5];

Returns

The sharedTreeWorkerObjectiveSplitProbability.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 29545 of file SatParameters.java.

getShareGlueClauses()

boolean com.google.ortools.sat.SatParameters.Builder.getShareGlueClauses

(

)

Allows sharing of short glue clauses between workers.
Implicitly disabled if share_binary_clauses is false.

optional bool share_glue_clauses = 285 [default = false];

Returns

The shareGlueClauses.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 25533 of file SatParameters.java.

getShareLevelZeroBounds()

boolean com.google.ortools.sat.SatParameters.Builder.getShareLevelZeroBounds

(

)

Allows sharing of the bounds of modified variables at level 0.

optional bool share_level_zero_bounds = 114 [default = true];

Returns

The shareLevelZeroBounds.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 25419 of file SatParameters.java.

getShareObjectiveBounds()

boolean com.google.ortools.sat.SatParameters.Builder.getShareObjectiveBounds

(

)

Allows objective sharing between workers.

optional bool share_objective_bounds = 113 [default = true];

Returns

The shareObjectiveBounds.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 25363 of file SatParameters.java.

getShavingSearchDeterministicTime()

double com.google.ortools.sat.SatParameters.Builder.getShavingSearchDeterministicTime

(

)

Specifies the amount of deterministic time spent of each try at shaving a
bound in the shaving search.

optional double shaving_search_deterministic_time = 205 [default = 0.001];

Returns

The shavingSearchDeterministicTime.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 27895 of file SatParameters.java.

getShavingSearchThreshold()

long com.google.ortools.sat.SatParameters.Builder.getShavingSearchThreshold

(

)

Specifies the threshold between two modes in the shaving procedure.
If the range of the variable/objective is less than this threshold, then
the shaving procedure will try to remove values one by one. Otherwise, it
will try to remove one range at a time.

optional int64 shaving_search_threshold = 290 [default = 64];

Returns

The shavingSearchThreshold.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 27959 of file SatParameters.java.

getSolutionPoolSize()

int com.google.ortools.sat.SatParameters.Builder.getSolutionPoolSize

(

)

Size of the top-n different solutions kept by the solver.
This parameter must be > 0.
Currently this only impact the "base" solution chosen for a LNS fragment.

optional int32 solution_pool_size = 193 [default = 3];

Returns

The solutionPoolSize.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 30635 of file SatParameters.java.

getStopAfterFirstSolution()

boolean com.google.ortools.sat.SatParameters.Builder.getStopAfterFirstSolution

(

)

For an optimization problem, stop the solver as soon as we have a solution.

optional bool stop_after_first_solution = 98 [default = false];

Returns

The stopAfterFirstSolution.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 30363 of file SatParameters.java.

getStopAfterPresolve()

boolean com.google.ortools.sat.SatParameters.Builder.getStopAfterPresolve

(

)

Mainly used when improving the presolver. When true, stops the solver after
the presolve is complete (or after loading and root level propagation).

optional bool stop_after_presolve = 149 [default = false];

Returns

The stopAfterPresolve.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 30421 of file SatParameters.java.

getStopAfterRootPropagation()

boolean com.google.ortools.sat.SatParameters.Builder.getStopAfterRootPropagation

(

)

optional bool stop_after_root_propagation = 252 [default = false];

Returns

The stopAfterRootPropagation.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 30471 of file SatParameters.java.

getStrategyChangeIncreaseRatio()

double com.google.ortools.sat.SatParameters.Builder.getStrategyChangeIncreaseRatio

(

)

The parameter num_conflicts_before_strategy_changes is increased by that
much after each strategy change.

optional double strategy_change_increase_ratio = 69 [default = 0];

Returns

The strategyChangeIncreaseRatio.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 20348 of file SatParameters.java.

getSubsolverParams()

com.google.ortools.sat.SatParameters com.google.ortools.sat.SatParameters.Builder.getSubsolverParams

(

int

index

)

It is possible to specify additional subsolver configuration. These can be
referred by their params.name() in the fields above. Note that only the
specified field will "overwrite" the ones of the base parameter. If a
subsolver_params has the name of an existing subsolver configuration, the
named parameters will be merged into the subsolver configuration.

repeated .operations_research.sat.SatParameters subsolver_params = 210;

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 24900 of file SatParameters.java.

getSubsolverParamsBuilder()

com.google.ortools.sat.SatParameters.Builder com.google.ortools.sat.SatParameters.Builder.getSubsolverParamsBuilder

(

int

index

)

It is possible to specify additional subsolver configuration. These can be
referred by their params.name() in the fields above. Note that only the
specified field will "overwrite" the ones of the base parameter. If a
subsolver_params has the name of an existing subsolver configuration, the
named parameters will be merged into the subsolver configuration.

repeated .operations_research.sat.SatParameters subsolver_params = 210;

Definition at line 25123 of file SatParameters.java.

getSubsolverParamsBuilderList()

java.util.List< com.google.ortools.sat.SatParameters.Builder > com.google.ortools.sat.SatParameters.Builder.getSubsolverParamsBuilderList

(

)

It is possible to specify additional subsolver configuration. These can be
referred by their params.name() in the fields above. Note that only the
specified field will "overwrite" the ones of the base parameter. If a
subsolver_params has the name of an existing subsolver configuration, the
named parameters will be merged into the subsolver configuration.

repeated .operations_research.sat.SatParameters subsolver_params = 210;

Definition at line 25207 of file SatParameters.java.

getSubsolverParamsCount()

int com.google.ortools.sat.SatParameters.Builder.getSubsolverParamsCount

(

)

It is possible to specify additional subsolver configuration. These can be
referred by their params.name() in the fields above. Note that only the
specified field will "overwrite" the ones of the base parameter. If a
subsolver_params has the name of an existing subsolver configuration, the
named parameters will be merged into the subsolver configuration.

repeated .operations_research.sat.SatParameters subsolver_params = 210;

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 24882 of file SatParameters.java.

getSubsolverParamsList()

java.util.List< com.google.ortools.sat.SatParameters > com.google.ortools.sat.SatParameters.Builder.getSubsolverParamsList

(

)

It is possible to specify additional subsolver configuration. These can be
referred by their params.name() in the fields above. Note that only the
specified field will "overwrite" the ones of the base parameter. If a
subsolver_params has the name of an existing subsolver configuration, the
named parameters will be merged into the subsolver configuration.

repeated .operations_research.sat.SatParameters subsolver_params = 210;

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 24864 of file SatParameters.java.

getSubsolverParamsOrBuilder()

com.google.ortools.sat.SatParametersOrBuilder com.google.ortools.sat.SatParameters.Builder.getSubsolverParamsOrBuilder

(

int

index

)

It is possible to specify additional subsolver configuration. These can be
referred by their params.name() in the fields above. Note that only the
specified field will "overwrite" the ones of the base parameter. If a
subsolver_params has the name of an existing subsolver configuration, the
named parameters will be merged into the subsolver configuration.

repeated .operations_research.sat.SatParameters subsolver_params = 210;

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 25138 of file SatParameters.java.

getSubsolverParamsOrBuilderList()

java.util.List<? extends com.google.ortools.sat.SatParametersOrBuilder > com.google.ortools.sat.SatParameters.Builder.getSubsolverParamsOrBuilderList

(

)

It is possible to specify additional subsolver configuration. These can be
referred by their params.name() in the fields above. Note that only the
specified field will "overwrite" the ones of the base parameter. If a
subsolver_params has the name of an existing subsolver configuration, the
named parameters will be merged into the subsolver configuration.

repeated .operations_research.sat.SatParameters subsolver_params = 210;

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 25157 of file SatParameters.java.

getSubsolvers()

java.lang.String com.google.ortools.sat.SatParameters.Builder.getSubsolvers

(

int

index

)

In multi-thread, the solver can be mainly seen as a portfolio of solvers
with different parameters. This field indicates the names of the parameters
that are used in multithread. This only applies to "full" subsolvers.

See cp_model_search.cc to see a list of the names and the default value (if
left empty) that looks like:
- default_lp           (linearization_level:1)
- fixed                (only if fixed search specified or scheduling)
- no_lp                (linearization_level:0)
- max_lp               (linearization_level:2)
- pseudo_costs         (only if objective, change search heuristic)
- reduced_costs        (only if objective, change search heuristic)
- quick_restart        (kind of probing)
- quick_restart_no_lp  (kind of probing with linearization_level:0)
- lb_tree_search       (to improve lower bound, MIP like tree search)
- probing              (continuous probing and shaving)

Also, note that some set of parameters will be ignored if they do not make
sense. For instance if there is no objective, pseudo_cost or reduced_cost
search will be ignored. Core based search will only work if the objective
has many terms. If there is no fixed strategy fixed will be ignored. And so
on.

The order is important, as only the first num_full_subsolvers will be
scheduled. You can see in the log which one are selected for a given run.

repeated string subsolvers = 207;

Parameters

index

The index of the element to return.

Returns

The subsolvers at the given index.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 24109 of file SatParameters.java.

getSubsolversBytes()

com.google.protobuf.ByteString com.google.ortools.sat.SatParameters.Builder.getSubsolversBytes

(

int

index

)

In multi-thread, the solver can be mainly seen as a portfolio of solvers
with different parameters. This field indicates the names of the parameters
that are used in multithread. This only applies to "full" subsolvers.

See cp_model_search.cc to see a list of the names and the default value (if
left empty) that looks like:
- default_lp           (linearization_level:1)
- fixed                (only if fixed search specified or scheduling)
- no_lp                (linearization_level:0)
- max_lp               (linearization_level:2)
- pseudo_costs         (only if objective, change search heuristic)
- reduced_costs        (only if objective, change search heuristic)
- quick_restart        (kind of probing)
- quick_restart_no_lp  (kind of probing with linearization_level:0)
- lb_tree_search       (to improve lower bound, MIP like tree search)
- probing              (continuous probing and shaving)

Also, note that some set of parameters will be ignored if they do not make
sense. For instance if there is no objective, pseudo_cost or reduced_cost
search will be ignored. Core based search will only work if the objective
has many terms. If there is no fixed strategy fixed will be ignored. And so
on.

The order is important, as only the first num_full_subsolvers will be
scheduled. You can see in the log which one are selected for a given run.

repeated string subsolvers = 207;

Parameters

index

The index of the value to return.

Returns

The bytes of the subsolvers at the given index.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 24146 of file SatParameters.java.

getSubsolversCount()

int com.google.ortools.sat.SatParameters.Builder.getSubsolversCount

(

)

In multi-thread, the solver can be mainly seen as a portfolio of solvers
with different parameters. This field indicates the names of the parameters
that are used in multithread. This only applies to "full" subsolvers.

See cp_model_search.cc to see a list of the names and the default value (if
left empty) that looks like:
- default_lp           (linearization_level:1)
- fixed                (only if fixed search specified or scheduling)
- no_lp                (linearization_level:0)
- max_lp               (linearization_level:2)
- pseudo_costs         (only if objective, change search heuristic)
- reduced_costs        (only if objective, change search heuristic)
- quick_restart        (kind of probing)
- quick_restart_no_lp  (kind of probing with linearization_level:0)
- lb_tree_search       (to improve lower bound, MIP like tree search)
- probing              (continuous probing and shaving)

Also, note that some set of parameters will be ignored if they do not make
sense. For instance if there is no objective, pseudo_cost or reduced_cost
search will be ignored. Core based search will only work if the objective
has many terms. If there is no fixed strategy fixed will be ignored. And so
on.

The order is important, as only the first num_full_subsolvers will be
scheduled. You can see in the log which one are selected for a given run.

repeated string subsolvers = 207;

Returns

The count of subsolvers.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 24073 of file SatParameters.java.

getSubsolversList()

com.google.protobuf.ProtocolStringList com.google.ortools.sat.SatParameters.Builder.getSubsolversList

(

)

In multi-thread, the solver can be mainly seen as a portfolio of solvers
with different parameters. This field indicates the names of the parameters
that are used in multithread. This only applies to "full" subsolvers.

See cp_model_search.cc to see a list of the names and the default value (if
left empty) that looks like:
- default_lp           (linearization_level:1)
- fixed                (only if fixed search specified or scheduling)
- no_lp                (linearization_level:0)
- max_lp               (linearization_level:2)
- pseudo_costs         (only if objective, change search heuristic)
- reduced_costs        (only if objective, change search heuristic)
- quick_restart        (kind of probing)
- quick_restart_no_lp  (kind of probing with linearization_level:0)
- lb_tree_search       (to improve lower bound, MIP like tree search)
- probing              (continuous probing and shaving)

Also, note that some set of parameters will be ignored if they do not make
sense. For instance if there is no objective, pseudo_cost or reduced_cost
search will be ignored. Core based search will only work if the objective
has many terms. If there is no fixed strategy fixed will be ignored. And so
on.

The order is important, as only the first num_full_subsolvers will be
scheduled. You can see in the log which one are selected for a given run.

repeated string subsolvers = 207;

Returns

A list containing the subsolvers.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 24037 of file SatParameters.java.

getSubsumptionDuringConflictAnalysis()

boolean com.google.ortools.sat.SatParameters.Builder.getSubsumptionDuringConflictAnalysis

(

)

At a really low cost, during the 1-UIP conflict computation, it is easy to
detect if some of the involved reasons are subsumed by the current
conflict. When this is true, such clauses are detached and later removed
from the problem.

optional bool subsumption_during_conflict_analysis = 56 [default = true];

Returns

The subsumptionDuringConflictAnalysis.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 18818 of file SatParameters.java.

getSymmetryLevel()

int com.google.ortools.sat.SatParameters.Builder.getSymmetryLevel

(

)

Whether we try to automatically detect the symmetries in a model and
exploit them. Currently, at level 1 we detect them in presolve and try
to fix Booleans. At level 2, we also do some form of dynamic symmetry
breaking during search. At level 3, we also detect symmetries for very
large models, which can be slow. At level 4, we try to break as much
symmetry as possible in presolve.

optional int32 symmetry_level = 183 [default = 2];

Returns

The symmetryLevel.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 31799 of file SatParameters.java.

getTableCompressionLevel()

int com.google.ortools.sat.SatParameters.Builder.getTableCompressionLevel

(

)

How much we try to "compress" a table constraint. Compressing more leads to
less Booleans and faster propagation but can reduced the quality of the lp
relaxation. Values goes from 0 to 3 where we always try to fully compress a
table. At 2, we try to automatically decide if it is worth it.

optional int32 table_compression_level = 217 [default = 2];

Returns

The tableCompressionLevel.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 22444 of file SatParameters.java.

getUseAbslRandom()

boolean com.google.ortools.sat.SatParameters.Builder.getUseAbslRandom

(

)

optional bool use_absl_random = 180 [default = false];

Returns

The useAbslRandom.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 21090 of file SatParameters.java.

getUseAreaEnergeticReasoningInNoOverlap2D()

boolean com.google.ortools.sat.SatParameters.Builder.getUseAreaEnergeticReasoningInNoOverlap2D

(

)

When this is true, the no_overlap_2d constraint is reinforced with
an energetic reasoning that uses an area-based energy. This can be combined
with the two other overlap heuristics above.

optional bool use_area_energetic_reasoning_in_no_overlap_2d = 271 [default = false];

Returns

The useAreaEnergeticReasoningInNoOverlap2d.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 27243 of file SatParameters.java.

getUseBlockingRestart()

boolean com.google.ortools.sat.SatParameters.Builder.getUseBlockingRestart

(

)

Block a moving restart algorithm if the trail size of the current conflict
is greater than the multiplier times the moving average of the trail size
at the previous conflicts.

optional bool use_blocking_restart = 64 [default = false];

Returns

The useBlockingRestart.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 20142 of file SatParameters.java.

getUseCombinedNoOverlap()

boolean com.google.ortools.sat.SatParameters.Builder.getUseCombinedNoOverlap

(

)

This can be beneficial if there is a lot of no-overlap constraints but a
relatively low number of different intervals in the problem. Like 1000
intervals, but 1M intervals in the no-overlap constraints covering them.

optional bool use_combined_no_overlap = 133 [default = false];

Returns

The useCombinedNoOverlap.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 31297 of file SatParameters.java.

getUseConservativeScaleOverloadChecker()

boolean com.google.ortools.sat.SatParameters.Builder.getUseConservativeScaleOverloadChecker

(

)

Enable a heuristic to solve cumulative constraints using a modified energy
constraint. We modify the usual energy definition by applying a
super-additive function (also called "conservative scale" or "dual-feasible
function") to the demand and the durations of the tasks.

This heuristic is fast but for most problems it does not help much to find
a solution.

optional bool use_conservative_scale_overload_checker = 286 [default = false];

Returns

The useConservativeScaleOverloadChecker.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 26687 of file SatParameters.java.

getUseDisjunctiveConstraintInCumulative()

boolean com.google.ortools.sat.SatParameters.Builder.getUseDisjunctiveConstraintInCumulative

(

)

When this is true, the cumulative constraint is reinforced with propagators
from the disjunctive constraint to improve the inference on a set of tasks
that are disjunctive at the root of the problem. This additional level
supplements the default level of reasoning.

Propagators of the cumulative constraint will not be used at all if all the
tasks are disjunctive at root node.

This always result in better propagation, but it is usually slow, so
depending on the problem, turning this off may lead to a faster solution.

optional bool use_disjunctive_constraint_in_cumulative = 80 [default = true];

Returns

The useDisjunctiveConstraintInCumulative.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 27029 of file SatParameters.java.

getUseDualSchedulingHeuristics()

boolean com.google.ortools.sat.SatParameters.Builder.getUseDualSchedulingHeuristics

(

)

When set, it activates a few scheduling parameters to improve the lower
bound of scheduling problems. This is only effective with multiple workers
as it modifies the reduced_cost, lb_tree_search, and probing workers.

optional bool use_dual_scheduling_heuristics = 214 [default = true];

Returns

The useDualSchedulingHeuristics.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 27371 of file SatParameters.java.

getUseDynamicPrecedenceInCumulative()

boolean com.google.ortools.sat.SatParameters.Builder.getUseDynamicPrecedenceInCumulative

(

)

optional bool use_dynamic_precedence_in_cumulative = 268 [default = false];

Returns

The useDynamicPrecedenceInCumulative.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 26547 of file SatParameters.java.

getUseDynamicPrecedenceInDisjunctive()

boolean com.google.ortools.sat.SatParameters.Builder.getUseDynamicPrecedenceInDisjunctive

(

)

Whether we try to branch on decision "interval A before interval B" rather
than on intervals bounds. This usually works better, but slow down a bit
the time to find the first solution.

These parameters are still EXPERIMENTAL, the result should be correct, but
it some corner cases, they can cause some failing CHECK in the solver.

optional bool use_dynamic_precedence_in_disjunctive = 263 [default = false];

Returns

The useDynamicPrecedenceInDisjunctive.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 26489 of file SatParameters.java.

getUseEnergeticReasoningInNoOverlap2D()

boolean com.google.ortools.sat.SatParameters.Builder.getUseEnergeticReasoningInNoOverlap2D

(

)

When this is true, the no_overlap_2d constraint is reinforced with
energetic reasoning. This additional level supplements the default level of
reasoning.

optional bool use_energetic_reasoning_in_no_overlap_2d = 213 [default = false];

Returns

The useEnergeticReasoningInNoOverlap2d.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 27179 of file SatParameters.java.

getUseErwaHeuristic()

boolean com.google.ortools.sat.SatParameters.Builder.getUseErwaHeuristic

(

)

Whether we use the ERWA (Exponential Recency Weighted Average) heuristic as
described in "Learning Rate Based Branching Heuristic for SAT solvers",
J.H.Liang, V. Ganesh, P. Poupart, K.Czarnecki, SAT 2016.

optional bool use_erwa_heuristic = 75 [default = false];

Returns

The useErwaHeuristic.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 18524 of file SatParameters.java.

getUseExactLpReason()

boolean com.google.ortools.sat.SatParameters.Builder.getUseExactLpReason

(

)

The solver usually exploit the LP relaxation of a model. If this option is
true, then whatever is infered by the LP will be used like an heuristic to
compute EXACT propagation on the IP. So with this option, there is no
numerical imprecision issues.

optional bool use_exact_lp_reason = 109 [default = true];

Returns

The useExactLpReason.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 31231 of file SatParameters.java.

getUseExtendedProbing()

boolean com.google.ortools.sat.SatParameters.Builder.getUseExtendedProbing

(

)

Use extended probing (probe bool_or, at_most_one, exactly_one).

optional bool use_extended_probing = 269 [default = true];

Returns

The useExtendedProbing.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 27721 of file SatParameters.java.

getUseFeasibilityJump()

boolean com.google.ortools.sat.SatParameters.Builder.getUseFeasibilityJump

(

)

Parameters for an heuristic similar to the one described in the paper:
"Feasibility Jump: an LP-free Lagrangian MIP heuristic", Bjørnar
Luteberget, Giorgio Sartor, 2023, Mathematical Programming Computation.

optional bool use_feasibility_jump = 265 [default = true];

Returns

The useFeasibilityJump.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 28629 of file SatParameters.java.

getUseFeasibilityPump()

boolean com.google.ortools.sat.SatParameters.Builder.getUseFeasibilityPump

(

)

Adds a feasibility pump subsolver along with lns subsolvers.

optional bool use_feasibility_pump = 164 [default = true];

Returns

The useFeasibilityPump.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 30751 of file SatParameters.java.

getUseHardPrecedencesInCumulative()

boolean com.google.ortools.sat.SatParameters.Builder.getUseHardPrecedencesInCumulative

(

)

If true, detect and create constraint for integer variable that are "after"
a set of intervals in the same cumulative constraint.

Experimental: by default we just use "direct" precedences. If
exploit_all_precedences is true, we explore the full precedence graph. This
assumes we have a DAG otherwise it fails.

optional bool use_hard_precedences_in_cumulative = 215 [default = false];

Returns

The useHardPrecedencesInCumulative.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 26905 of file SatParameters.java.

getUseImpliedBounds()

boolean com.google.ortools.sat.SatParameters.Builder.getUseImpliedBounds

(

)

Stores and exploits "implied-bounds" in the solver. That is, relations of
the form literal => (var >= bound). This is currently used to derive
stronger cuts.

optional bool use_implied_bounds = 144 [default = true];

Returns

The useImpliedBounds.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 31485 of file SatParameters.java.

getUseLbRelaxLns()

boolean com.google.ortools.sat.SatParameters.Builder.getUseLbRelaxLns

(

)

Turns on neighborhood generator based on local branching LP. Based on Huang
et al., "Local Branching Relaxation Heuristics for Integer Linear
Programs", 2023.

optional bool use_lb_relax_lns = 255 [default = false];

Returns

The useLbRelaxLns.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 30811 of file SatParameters.java.

getUseLns()

boolean com.google.ortools.sat.SatParameters.Builder.getUseLns

(

)

Testing parameters used to disable all lns workers.

optional bool use_lns = 283 [default = true];

Returns

The useLns.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 30519 of file SatParameters.java.

getUseLnsOnly()

boolean com.google.ortools.sat.SatParameters.Builder.getUseLnsOnly

(

)

Experimental parameters to disable everything but lns.

optional bool use_lns_only = 101 [default = false];

Returns

The useLnsOnly.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 30575 of file SatParameters.java.

getUseLsOnly()

boolean com.google.ortools.sat.SatParameters.Builder.getUseLsOnly

(

)

Disable every other type of subsolver, setting this turns CP-SAT into a
pure local-search solver.

optional bool use_ls_only = 240 [default = false];

Returns

The useLsOnly.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 28691 of file SatParameters.java.

getUseObjectiveLbSearch()

boolean com.google.ortools.sat.SatParameters.Builder.getUseObjectiveLbSearch

(

)

If true, search will search in ascending max objective value (when
minimizing) starting from the lower bound of the objective.

optional bool use_objective_lb_search = 228 [default = false];

Returns

The useObjectiveLbSearch.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 28023 of file SatParameters.java.

getUseObjectiveShavingSearch()

boolean com.google.ortools.sat.SatParameters.Builder.getUseObjectiveShavingSearch

(

)

This search differs from the previous search as it will not use assumptions
to bound the objective, and it will recreate a full model with the
hardcoded objective value.

optional bool use_objective_shaving_search = 253 [default = false];

Returns

The useObjectiveShavingSearch.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 28085 of file SatParameters.java.

getUseOptimizationHints()

boolean com.google.ortools.sat.SatParameters.Builder.getUseOptimizationHints

(

)

For an optimization problem, whether we follow some hints in order to find
a better first solution. For a variable with hint, the solver will always
try to follow the hint. It will revert to the variable_branching default
otherwise.

optional bool use_optimization_hints = 35 [default = true];

Returns

The useOptimizationHints.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 25777 of file SatParameters.java.

getUseOptionalVariables()

boolean com.google.ortools.sat.SatParameters.Builder.getUseOptionalVariables

(

)

If true, we automatically detect variables whose constraint are always
enforced by the same literal and we mark them as optional. This allows
to propagate them as if they were present in some situation.

TODO(user): This is experimental and seems to lead to wrong optimal in
some situation. It should however gives correct solutions. Fix.

optional bool use_optional_variables = 108 [default = false];

Returns

The useOptionalVariables.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 31159 of file SatParameters.java.

getUseOverloadCheckerInCumulative()

boolean com.google.ortools.sat.SatParameters.Builder.getUseOverloadCheckerInCumulative

(

)

When this is true, the cumulative constraint is reinforced with overload
checking, i.e., an additional level of reasoning based on energy. This
additional level supplements the default level of reasoning as well as
timetable edge finding.

This always result in better propagation, but it is usually slow, so
depending on the problem, turning this off may lead to a faster solution.

optional bool use_overload_checker_in_cumulative = 78 [default = false];

Returns

The useOverloadCheckerInCumulative.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 26607 of file SatParameters.java.

getUsePbResolution()

boolean com.google.ortools.sat.SatParameters.Builder.getUsePbResolution

(

)

Whether to use pseudo-Boolean resolution to analyze a conflict. Note that
this option only make sense if your problem is modelized using
pseudo-Boolean constraints. If you only have clauses, this shouldn't change
anything (except slow the solver down).

optional bool use_pb_resolution = 43 [default = false];

Returns

The usePbResolution.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 21492 of file SatParameters.java.

getUsePhaseSaving()

boolean com.google.ortools.sat.SatParameters.Builder.getUsePhaseSaving

(

)

If this is true, then the polarity of a variable will be the last value it
was assigned to, or its default polarity if it was never assigned since the
call to ResetDecisionHeuristic().

Actually, we use a newer version where we follow the last value in the
longest non-conflicting partial assignment in the current phase.

This is called 'literal phase saving'. For details see 'A Lightweight
Component Caching Scheme for Satisfiability Solvers' K. Pipatsrisawat and
A.Darwiche, In 10th International Conference on Theory and Applications of
Satisfiability Testing, 2007.

optional bool use_phase_saving = 44 [default = true];

Returns

The usePhaseSaving.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 18244 of file SatParameters.java.

getUsePrecedencesInDisjunctiveConstraint()

boolean com.google.ortools.sat.SatParameters.Builder.getUsePrecedencesInDisjunctiveConstraint

(

)

When this is true, then a disjunctive constraint will try to use the
precedence relations between time intervals to propagate their bounds
further. For instance if task A and B are both before C and task A and B
are in disjunction, then we can deduce that task C must start after
duration(A) + duration(B) instead of simply max(duration(A), duration(B)),
provided that the start time for all task was currently zero.

This always result in better propagation, but it is usually slow, so
depending on the problem, turning this off may lead to a faster solution.

optional bool use_precedences_in_disjunctive_constraint = 74 [default = true];

Returns

The usePrecedencesInDisjunctiveConstraint.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 26279 of file SatParameters.java.

getUseProbingSearch()

boolean com.google.ortools.sat.SatParameters.Builder.getUseProbingSearch

(

)

If true, search will continuously probe Boolean variables, and integer
variable bounds. This parameter is set to true in parallel on the probing
worker.

optional bool use_probing_search = 176 [default = false];

Returns

The useProbingSearch.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 27661 of file SatParameters.java.

getUseRinsLns()

boolean com.google.ortools.sat.SatParameters.Builder.getUseRinsLns

(

)

Turns on relaxation induced neighborhood generator.

optional bool use_rins_lns = 129 [default = true];

Returns

The useRinsLns.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 30695 of file SatParameters.java.

getUseSatInprocessing()

boolean com.google.ortools.sat.SatParameters.Builder.getUseSatInprocessing

(

)

Enable or disable "inprocessing" which is some SAT presolving done at
each restart to the root level.

optional bool use_sat_inprocessing = 163 [default = true];

Returns

The useSatInprocessing.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 23528 of file SatParameters.java.

getUseSharedTreeSearch()

boolean com.google.ortools.sat.SatParameters.Builder.getUseSharedTreeSearch

(

)

Set on shared subtree workers. Users should not set this directly.

optional bool use_shared_tree_search = 236 [default = false];

Returns

The useSharedTreeSearch.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 29485 of file SatParameters.java.

getUseShavingInProbingSearch()

boolean com.google.ortools.sat.SatParameters.Builder.getUseShavingInProbingSearch

(

)

Add a shaving phase (where the solver tries to prove that the lower or
upper bound of a variable are infeasible) to the probing search.

optional bool use_shaving_in_probing_search = 204 [default = true];

Returns

The useShavingInProbingSearch.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 27835 of file SatParameters.java.

getUseStrongPropagationInDisjunctive()

boolean com.google.ortools.sat.SatParameters.Builder.getUseStrongPropagationInDisjunctive

(

)

Enable stronger and more expensive propagation on no_overlap constraint.

optional bool use_strong_propagation_in_disjunctive = 230 [default = false];

Returns

The useStrongPropagationInDisjunctive.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 26423 of file SatParameters.java.

getUseTimetableEdgeFindingInCumulative()

boolean com.google.ortools.sat.SatParameters.Builder.getUseTimetableEdgeFindingInCumulative

(

)

When this is true, the cumulative constraint is reinforced with timetable
edge finding, i.e., an additional level of reasoning based on the
conjunction of energy and mandatory parts. This additional level
supplements the default level of reasoning as well as overload_checker.

This always result in better propagation, but it is usually slow, so
depending on the problem, turning this off may lead to a faster solution.

optional bool use_timetable_edge_finding_in_cumulative = 79 [default = false];

Returns

The useTimetableEdgeFindingInCumulative.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 26767 of file SatParameters.java.

getUseTimetablingInNoOverlap2D()

boolean com.google.ortools.sat.SatParameters.Builder.getUseTimetablingInNoOverlap2D

(

)

When this is true, the no_overlap_2d constraint is reinforced with
propagators from the cumulative constraints. It consists of ignoring the
position of rectangles in one position and projecting the no_overlap_2d on
the other dimension to create a cumulative constraint. This is done on both
axis. This additional level supplements the default level of reasoning.

optional bool use_timetabling_in_no_overlap_2d = 200 [default = false];

Returns

The useTimetablingInNoOverlap2d.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 27111 of file SatParameters.java.

getUseVariablesShavingSearch()

boolean com.google.ortools.sat.SatParameters.Builder.getUseVariablesShavingSearch

(

)

This search takes all Boolean or integer variables, and maximize or
minimize them in order to reduce their domain.

optional bool use_variables_shaving_search = 289 [default = false];

Returns

The useVariablesShavingSearch.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 28147 of file SatParameters.java.

getVariableActivityDecay()

double com.google.ortools.sat.SatParameters.Builder.getVariableActivityDecay

(

)

Each time a conflict is found, the activities of some variables are
increased by one. Then, the activity of all variables are multiplied by
variable_activity_decay.

To implement this efficiently, the activity of all the variables is not
decayed at each conflict. Instead, the activity increment is multiplied by
1 / decay. When an activity reach max_variable_activity_value, all the
activity are multiplied by 1 / max_variable_activity_value.

optional double variable_activity_decay = 15 [default = 0.8];

Returns

The variableActivityDecay.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19314 of file SatParameters.java.

getViolationLsCompoundMoveProbability()

double com.google.ortools.sat.SatParameters.Builder.getViolationLsCompoundMoveProbability

(

)

Probability of using compound move search each restart.
TODO(user): Add reference to paper when published.

optional double violation_ls_compound_move_probability = 259 [default = 0.5];

Returns

The violationLsCompoundMoveProbability.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 29355 of file SatParameters.java.

getViolationLsPerturbationPeriod()

int com.google.ortools.sat.SatParameters.Builder.getViolationLsPerturbationPeriod

(

)

How long violation_ls should wait before perturbating a solution.

optional int32 violation_ls_perturbation_period = 249 [default = 100];

Returns

The violationLsPerturbationPeriod.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 29297 of file SatParameters.java.

hasAbsoluteGapLimit()

boolean com.google.ortools.sat.SatParameters.Builder.hasAbsoluteGapLimit

(

)

Stop the search when the gap between the best feasible objective (O) and
our best objective bound (B) is smaller than a limit.
The exact definition is:
- Absolute: abs(O - B)
- Relative: abs(O - B) / max(1, abs(O)).

Important: The relative gap depends on the objective offset! If you
artificially shift the objective, you will get widely different value of
the relative gap.

Note that if the gap is reached, the search status will be OPTIMAL. But
one can check the best objective bound to see the actual gap.

If the objective is integer, then any absolute gap < 1 will lead to a true
optimal. If the objective is floating point, a gap of zero make little
sense so is is why we use a non-zero default value. At the end of the
search, we will display a warning if OPTIMAL is reported yet the gap is
greater than this absolute gap.

optional double absolute_gap_limit = 159 [default = 0.0001];

Returns

Whether the absoluteGapLimit field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 20751 of file SatParameters.java.

hasAddCgCuts()

boolean com.google.ortools.sat.SatParameters.Builder.hasAddCgCuts

(

)

Whether we generate and add Chvatal-Gomory cuts to the LP at root node.
Note that for now, this is not heavily tuned.

optional bool add_cg_cuts = 117 [default = true];

Returns

Whether the addCgCuts field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 32446 of file SatParameters.java.

hasAddCliqueCuts()

boolean com.google.ortools.sat.SatParameters.Builder.hasAddCliqueCuts

(

)

Whether we generate clique cuts from the binary implication graph. Note
that as the search goes on, this graph will contains new binary clauses
learned by the SAT engine.

optional bool add_clique_cuts = 172 [default = true];

Returns

Whether the addCliqueCuts field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 32627 of file SatParameters.java.

hasAddLinMaxCuts()

boolean com.google.ortools.sat.SatParameters.Builder.hasAddLinMaxCuts

(

)

For the lin max constraints, generates the cuts described in "Strong
mixed-integer programming formulations for trained neural networks" by Ross
Anderson et. (https://arxiv.org/pdf/1811.01988.pdf)

optional bool add_lin_max_cuts = 152 [default = true];

Returns

Whether the addLinMaxCuts field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 32815 of file SatParameters.java.

hasAddLpConstraintsLazily()

boolean com.google.ortools.sat.SatParameters.Builder.hasAddLpConstraintsLazily

(

)

If true, we start by an empty LP, and only add constraints not satisfied
by the current LP solution batch by batch. A constraint that is only added
like this is known as a "lazy" constraint in the literature, except that we
currently consider all constraints as lazy here.

optional bool add_lp_constraints_lazily = 112 [default = true];

Returns

Whether the addLpConstraintsLazily field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 32964 of file SatParameters.java.

hasAddMirCuts()

boolean com.google.ortools.sat.SatParameters.Builder.hasAddMirCuts

(

)

Whether we generate MIR cuts at root node.
Note that for now, this is not heavily tuned.

optional bool add_mir_cuts = 120 [default = true];

Returns

Whether the addMirCuts field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 32506 of file SatParameters.java.

hasAddObjectiveCut()

boolean com.google.ortools.sat.SatParameters.Builder.hasAddObjectiveCut

(

)

When the LP objective is fractional, do we add the cut that forces the
linear objective expression to be greater or equal to this fractional value
rounded up? We can always do that since our objective is integer, and
combined with MIR heuristic to reduce the coefficient of such cut, it can
help.

optional bool add_objective_cut = 197 [default = false];

Returns

Whether the addObjectiveCut field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 32377 of file SatParameters.java.

hasAddRltCuts()

boolean com.google.ortools.sat.SatParameters.Builder.hasAddRltCuts

(

)

Whether we generate RLT cuts. This is still experimental but can help on
binary problem with a lot of clauses of size 3.

optional bool add_rlt_cuts = 279 [default = true];

Returns

Whether the addRltCuts field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 32690 of file SatParameters.java.

hasAddZeroHalfCuts()

boolean com.google.ortools.sat.SatParameters.Builder.hasAddZeroHalfCuts

(

)

Whether we generate Zero-Half cuts at root node.
Note that for now, this is not heavily tuned.

optional bool add_zero_half_cuts = 169 [default = true];

Returns

Whether the addZeroHalfCuts field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 32566 of file SatParameters.java.

hasAlsoBumpVariablesInConflictReasons()

boolean com.google.ortools.sat.SatParameters.Builder.hasAlsoBumpVariablesInConflictReasons

(

)

When this is true, then the variables that appear in any of the reason of
the variables in a conflict have their activity bumped. This is addition to
the variables in the conflict, and the one that were used during conflict
resolution.

optional bool also_bump_variables_in_conflict_reasons = 77 [default = false];

Returns

Whether the alsoBumpVariablesInConflictReasons field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 18651 of file SatParameters.java.

hasAtMostOneMaxExpansionSize()

boolean com.google.ortools.sat.SatParameters.Builder.hasAtMostOneMaxExpansionSize

(

)

All at_most_one constraints with a size <= param will be replaced by a
quadratic number of binary implications.

optional int32 at_most_one_max_expansion_size = 270 [default = 3];

Returns

Whether the atMostOneMaxExpansionSize field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 31346 of file SatParameters.java.

hasAutoDetectGreaterThanAtLeastOneOf()

boolean com.google.ortools.sat.SatParameters.Builder.hasAutoDetectGreaterThanAtLeastOneOf

(

)

If true, then the precedences propagator try to detect for each variable if
it has a set of "optional incoming arc" for which at least one of them is
present. This is usually useful to have but can be slow on model with a lot
of precedence.

optional bool auto_detect_greater_than_at_least_one_of = 95 [default = true];

Returns

Whether the autoDetectGreaterThanAtLeastOneOf field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 30286 of file SatParameters.java.

hasBinaryMinimizationAlgorithm()

boolean com.google.ortools.sat.SatParameters.Builder.hasBinaryMinimizationAlgorithm

(

)

optional .operations_research.sat.SatParameters.BinaryMinizationAlgorithm binary_minimization_algorithm = 34 [default = BINARY_MINIMIZATION_FIRST];

Returns

Whether the binaryMinimizationAlgorithm field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 18753 of file SatParameters.java.

hasBinarySearchNumConflicts()

boolean com.google.ortools.sat.SatParameters.Builder.hasBinarySearchNumConflicts

(

)

If non-negative, perform a binary search on the objective variable in order
to find an [min, max] interval outside of which the solver proved unsat/sat
under this amount of conflict. This can quickly reduce the objective domain
on some problems.

optional int32 binary_search_num_conflicts = 99 [default = -1];

Returns

Whether the binarySearchNumConflicts field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 28472 of file SatParameters.java.

hasBlockingRestartMultiplier()

boolean com.google.ortools.sat.SatParameters.Builder.hasBlockingRestartMultiplier

(

)

optional double blocking_restart_multiplier = 66 [default = 1.4];

Returns

Whether the blockingRestartMultiplier field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 20226 of file SatParameters.java.

hasBlockingRestartWindowSize()

boolean com.google.ortools.sat.SatParameters.Builder.hasBlockingRestartWindowSize

(

)

optional int32 blocking_restart_window_size = 65 [default = 5000];

Returns

Whether the blockingRestartWindowSize field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 20186 of file SatParameters.java.

hasBooleanEncodingLevel()

boolean com.google.ortools.sat.SatParameters.Builder.hasBooleanEncodingLevel

(

)

A non-negative level indicating how much we should try to fully encode
Integer variables as Boolean.

optional int32 boolean_encoding_level = 107 [default = 1];

Returns

Whether the booleanEncodingLevel field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 32050 of file SatParameters.java.

hasCatchSigintSignal()

boolean com.google.ortools.sat.SatParameters.Builder.hasCatchSigintSignal

(

)

Indicates if the CP-SAT layer should catch Control-C (SIGINT) signals
when calling solve. If set, catching the SIGINT signal will terminate the
search gracefully, as if a time limit was reached.

optional bool catch_sigint_signal = 135 [default = true];

Returns

Whether the catchSigintSignal field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 31407 of file SatParameters.java.

hasClauseActivityDecay()

boolean com.google.ortools.sat.SatParameters.Builder.hasClauseActivityDecay

(

)

Clause activity parameters (same effect as the one on the variables).

optional double clause_activity_decay = 17 [default = 0.999];

Returns

Whether the clauseActivityDecay field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19564 of file SatParameters.java.

hasClauseCleanupLbdBound()

boolean com.google.ortools.sat.SatParameters.Builder.hasClauseCleanupLbdBound

(

)

All the clauses with a LBD (literal blocks distance) lower or equal to this
parameters will always be kept.

optional int32 clause_cleanup_lbd_bound = 59 [default = 5];

Returns

Whether the clauseCleanupLbdBound field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19091 of file SatParameters.java.

hasClauseCleanupOrdering()

boolean com.google.ortools.sat.SatParameters.Builder.hasClauseCleanupOrdering

(

)

optional .operations_research.sat.SatParameters.ClauseOrdering clause_cleanup_ordering = 60 [default = CLAUSE_ACTIVITY];

Returns

Whether the clauseCleanupOrdering field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19145 of file SatParameters.java.

hasClauseCleanupPeriod()

boolean com.google.ortools.sat.SatParameters.Builder.hasClauseCleanupPeriod

(

)

Trigger a cleanup when this number of "deletable" clauses is learned.

optional int32 clause_cleanup_period = 11 [default = 10000];

Returns

Whether the clauseCleanupPeriod field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 18868 of file SatParameters.java.

hasClauseCleanupProtection()

boolean com.google.ortools.sat.SatParameters.Builder.hasClauseCleanupProtection

(

)

optional .operations_research.sat.SatParameters.ClauseProtection clause_cleanup_protection = 58 [default = PROTECTION_NONE];

Returns

Whether the clauseCleanupProtection field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19043 of file SatParameters.java.

hasClauseCleanupRatio()

boolean com.google.ortools.sat.SatParameters.Builder.hasClauseCleanupRatio

(

)

During a cleanup, if clause_cleanup_target is 0, we will delete the
clause_cleanup_ratio of "deletable" clauses instead of aiming for a fixed
target of clauses to keep.

optional double clause_cleanup_ratio = 190 [default = 0.5];

Returns

Whether the clauseCleanupRatio field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 18986 of file SatParameters.java.

hasClauseCleanupTarget()

boolean com.google.ortools.sat.SatParameters.Builder.hasClauseCleanupTarget

(

)

During a cleanup, we will always keep that number of "deletable" clauses.
Note that this doesn't include the "protected" clauses.

optional int32 clause_cleanup_target = 13 [default = 0];

Returns

Whether the clauseCleanupTarget field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 18925 of file SatParameters.java.

hasConvertIntervals()

boolean com.google.ortools.sat.SatParameters.Builder.hasConvertIntervals

(

)

Temporary flag util the feature is more mature. This convert intervals to
the newer proto format that support affine start/var/end instead of just
variables.

optional bool convert_intervals = 177 [default = true];

Returns

Whether the convertIntervals field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 31715 of file SatParameters.java.

hasCoreMinimizationLevel()

boolean com.google.ortools.sat.SatParameters.Builder.hasCoreMinimizationLevel

(

)

If positive, we spend some effort on each core:
- At level 1, we use a simple heuristic to try to minimize an UNSAT core.
- At level 2, we use propagation to minimize the core but also identify
literal in at most one relationship in this core.

optional int32 core_minimization_level = 50 [default = 2];

Returns

Whether the coreMinimizationLevel field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 25830 of file SatParameters.java.

hasCountAssumptionLevelsInLbd()

boolean com.google.ortools.sat.SatParameters.Builder.hasCountAssumptionLevelsInLbd

(

)

Whether or not the assumption levels are taken into account during the LBD
computation. According to the reference below, not counting them improves
the solver in some situation. Note that this only impact solves under
assumptions.

Gilles Audemard, Jean-Marie Lagniez, Laurent Simon, "Improving Glucose for
Incremental SAT Solving with Assumptions: Application to MUS Extraction"
Theory and Applications of Satisfiability Testing - SAT 2013, Lecture Notes
in Computer Science Volume 7962, 2013, pp 309-317.

optional bool count_assumption_levels_in_lbd = 49 [default = true];

Returns

Whether the countAssumptionLevelsInLbd field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 21618 of file SatParameters.java.

hasCoverOptimization()

boolean com.google.ortools.sat.SatParameters.Builder.hasCoverOptimization

(

)

If true, when the max-sat algo find a core, we compute the minimal number
of literals in the core that needs to be true to have a feasible solution.
This is also called core exhaustion in more recent max-SAT papers.

optional bool cover_optimization = 89 [default = true];

Returns

Whether the coverOptimization field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 25957 of file SatParameters.java.

hasCpModelPresolve()

boolean com.google.ortools.sat.SatParameters.Builder.hasCpModelPresolve

(

)

Whether we presolve the cp_model before solving it.

optional bool cp_model_presolve = 86 [default = true];

Returns

Whether the cpModelPresolve field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 22182 of file SatParameters.java.

hasCpModelProbingLevel()

boolean com.google.ortools.sat.SatParameters.Builder.hasCpModelProbingLevel

(

)

How much effort do we spend on probing. 0 disables it completely.

optional int32 cp_model_probing_level = 110 [default = 2];

Returns

Whether the cpModelProbingLevel field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 22238 of file SatParameters.java.

hasCpModelUseSatPresolve()

boolean com.google.ortools.sat.SatParameters.Builder.hasCpModelUseSatPresolve

(

)

Whether we also use the sat presolve when cp_model_presolve is true.

optional bool cp_model_use_sat_presolve = 93 [default = true];

Returns

Whether the cpModelUseSatPresolve field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 22294 of file SatParameters.java.

hasCutActiveCountDecay()

boolean com.google.ortools.sat.SatParameters.Builder.hasCutActiveCountDecay

(

)

optional double cut_active_count_decay = 156 [default = 0.8];

Returns

Whether the cutActiveCountDecay field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 33349 of file SatParameters.java.

hasCutCleanupTarget()

boolean com.google.ortools.sat.SatParameters.Builder.hasCutCleanupTarget

(

)

Target number of constraints to remove during cleanup.

optional int32 cut_cleanup_target = 157 [default = 1000];

Returns

Whether the cutCleanupTarget field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 33393 of file SatParameters.java.

hasCutLevel()

boolean com.google.ortools.sat.SatParameters.Builder.hasCutLevel

(

)

Control the global cut effort. Zero will turn off all cut. For now we just
have one level. Note also that most cuts are only used at linearization
level >= 2.

optional int32 cut_level = 196 [default = 1];

Returns

Whether the cutLevel field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 32251 of file SatParameters.java.

hasCutMaxActiveCountValue()

boolean com.google.ortools.sat.SatParameters.Builder.hasCutMaxActiveCountValue

(

)

These parameters are similar to sat clause management activity parameters.
They are effective only if the number of generated cuts exceed the storage
limit. Default values are based on a few experiments on miplib instances.

optional double cut_max_active_count_value = 155 [default = 10000000000];

Returns

Whether the cutMaxActiveCountValue field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 33291 of file SatParameters.java.

hasDebugCrashOnBadHint()

boolean com.google.ortools.sat.SatParameters.Builder.hasDebugCrashOnBadHint

(

)

Crash if we do not manage to complete the hint into a full solution.

optional bool debug_crash_on_bad_hint = 195 [default = false];

Returns

Whether the debugCrashOnBadHint field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 25703 of file SatParameters.java.

hasDebugMaxNumPresolveOperations()

boolean com.google.ortools.sat.SatParameters.Builder.hasDebugMaxNumPresolveOperations

(

)

If positive, try to stop just after that many presolve rules have been
applied. This is mainly useful for debugging presolve.

optional int32 debug_max_num_presolve_operations = 151 [default = 0];

Returns

Whether the debugMaxNumPresolveOperations field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 25644 of file SatParameters.java.

hasDebugPostsolveWithFullSolver()

boolean com.google.ortools.sat.SatParameters.Builder.hasDebugPostsolveWithFullSolver

(

)

We have two different postsolve code. The default one should be better and
it allows for a more powerful presolve, but it can be useful to postsolve
using the full solver instead.

optional bool debug_postsolve_with_full_solver = 162 [default = false];

Returns

Whether the debugPostsolveWithFullSolver field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 25581 of file SatParameters.java.

hasDefaultRestartAlgorithms()

boolean com.google.ortools.sat.SatParameters.Builder.hasDefaultRestartAlgorithms

(

)

optional string default_restart_algorithms = 70 [default = "LUBY_RESTART,LBD_MOVING_AVERAGE_RESTART,DL_MOVING_AVERAGE_RESTART"];

Returns

Whether the defaultRestartAlgorithms field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19825 of file SatParameters.java.

hasDetectLinearizedProduct()

boolean com.google.ortools.sat.SatParameters.Builder.hasDetectLinearizedProduct

(

)

Infer products of Boolean or of Boolean time IntegerVariable from the
linear constrainst in the problem. This can be used in some cuts, altough
for now we don't really exploit it.

optional bool detect_linearized_product = 277 [default = false];

Returns

Whether the detectLinearizedProduct field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 33823 of file SatParameters.java.

hasDetectTableWithCost()

boolean com.google.ortools.sat.SatParameters.Builder.hasDetectTableWithCost

(

)

If true, we detect variable that are unique to a table constraint and only
there to encode a cost on each tuple. This is usually the case when a WCSP
(weighted constraint program) is encoded into CP-SAT format.

This can lead to a dramatic speed-up for such problems but is still
experimental at this point.

optional bool detect_table_with_cost = 216 [default = false];

Returns

Whether the detectTableWithCost field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 22355 of file SatParameters.java.

hasDisableConstraintExpansion()

boolean com.google.ortools.sat.SatParameters.Builder.hasDisableConstraintExpansion

(

)

If true, it disable all constraint expansion.
This should only be used to test the presolve of expanded constraints.

optional bool disable_constraint_expansion = 181 [default = false];

Returns

Whether the disableConstraintExpansion field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 22851 of file SatParameters.java.

hasDiversifyLnsParams()

boolean com.google.ortools.sat.SatParameters.Builder.hasDiversifyLnsParams

(

)

If true, registers more lns subsolvers with different parameters.

optional bool diversify_lns_params = 137 [default = false];

Returns

Whether the diversifyLnsParams field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 30901 of file SatParameters.java.

hasEncodeComplexLinearConstraintWithInteger()

boolean com.google.ortools.sat.SatParameters.Builder.hasEncodeComplexLinearConstraintWithInteger

(

)

Linear constraint with a complex right hand side (more than a single
interval) need to be expanded, there is a couple of way to do that.

optional bool encode_complex_linear_constraint_with_integer = 223 [default = false];

Returns

Whether the encodeComplexLinearConstraintWithInteger field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 22911 of file SatParameters.java.

hasEncodeCumulativeAsReservoir()

boolean com.google.ortools.sat.SatParameters.Builder.hasEncodeCumulativeAsReservoir

(

)

Encore cumulative with fixed demands and capacity as a reservoir
constraint. The only reason you might want to do that is to test the
reservoir propagation code!

optional bool encode_cumulative_as_reservoir = 287 [default = false];

Returns

Whether the encodeCumulativeAsReservoir field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 22716 of file SatParameters.java.

hasEnumerateAllSolutions()

boolean com.google.ortools.sat.SatParameters.Builder.hasEnumerateAllSolutions

(

)

Whether we enumerate all solutions of a problem without objective. Note
that setting this to true automatically disable some presolve reduction
that can remove feasible solution. That is it has the same effect as
setting keep_all_feasible_solutions_in_presolve.

TODO(user): Do not do that and let the user choose what behavior is best by
setting keep_all_feasible_solutions_in_presolve ?

optional bool enumerate_all_solutions = 87 [default = false];

Returns

Whether the enumerateAllSolutions field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 29893 of file SatParameters.java.

hasExpandAlldiffConstraints()

boolean com.google.ortools.sat.SatParameters.Builder.hasExpandAlldiffConstraints

(

)

If true, expand all_different constraints that are not permutations.
Permutations (#Variables = #Values) are always expanded.

optional bool expand_alldiff_constraints = 170 [default = false];

Returns

Whether the expandAlldiffConstraints field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 22495 of file SatParameters.java.

hasExpandReservoirConstraints()

boolean com.google.ortools.sat.SatParameters.Builder.hasExpandReservoirConstraints

(

)

If true, expand the reservoir constraints by creating booleans for all
possible precedences between event and encoding the constraint.

optional bool expand_reservoir_constraints = 182 [default = true];

Returns

Whether the expandReservoirConstraints field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 22555 of file SatParameters.java.

hasExpandReservoirUsingCircuit()

boolean com.google.ortools.sat.SatParameters.Builder.hasExpandReservoirUsingCircuit

(

)

Mainly useful for testing.

If this and expand_reservoir_constraints is true, we use a different
encoding of the reservoir constraint using circuit instead of precedences.
Note that this is usually slower, but can exercise different part of the
solver. Note that contrary to the precedence encoding, this easily support
variable demands.

WARNING: with this encoding, the constraint take a slighlty different
meaning. The level must be within the reservoir for any permutation of the
events. So we cannot have +100 and -100 at the same time if the maximum
level is 10 (as autorized by the reservoir constraint).

optional bool expand_reservoir_using_circuit = 288 [default = false];

Returns

Whether the expandReservoirUsingCircuit field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 22625 of file SatParameters.java.

hasExploitAllLpSolution()

boolean com.google.ortools.sat.SatParameters.Builder.hasExploitAllLpSolution

(

)

If true and the Lp relaxation of the problem has a solution, try to exploit
it. This is same as above except in this case the lp solution might not be
an integer solution.

optional bool exploit_all_lp_solution = 116 [default = true];

Returns

Whether the exploitAllLpSolution field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 33579 of file SatParameters.java.

hasExploitAllPrecedences()

boolean com.google.ortools.sat.SatParameters.Builder.hasExploitAllPrecedences

(

)

optional bool exploit_all_precedences = 220 [default = false];

Returns

Whether the exploitAllPrecedences field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 26955 of file SatParameters.java.

hasExploitBestSolution()

boolean com.google.ortools.sat.SatParameters.Builder.hasExploitBestSolution

(

)

When branching on a variable, follow the last best solution value.

optional bool exploit_best_solution = 130 [default = false];

Returns

Whether the exploitBestSolution field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 33641 of file SatParameters.java.

hasExploitIntegerLpSolution()

boolean com.google.ortools.sat.SatParameters.Builder.hasExploitIntegerLpSolution

(

)

If true and the Lp relaxation of the problem has an integer optimal
solution, try to exploit it. Note that since the LP relaxation may not
contain all the constraints, such a solution is not necessarily a solution
of the full problem.

optional bool exploit_integer_lp_solution = 94 [default = true];

Returns

Whether the exploitIntegerLpSolution field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 33512 of file SatParameters.java.

hasExploitObjective()

boolean com.google.ortools.sat.SatParameters.Builder.hasExploitObjective

(

)

When branching an a variable that directly affect the objective,
branch on the value that lead to the best objective first.

optional bool exploit_objective = 131 [default = true];

Returns

Whether the exploitObjective field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 33762 of file SatParameters.java.

hasExploitRelaxationSolution()

boolean com.google.ortools.sat.SatParameters.Builder.hasExploitRelaxationSolution

(

)

When branching on a variable, follow the last best relaxation solution
value. We use the relaxation with the tightest bound on the objective as
the best relaxation solution.

optional bool exploit_relaxation_solution = 161 [default = false];

Returns

Whether the exploitRelaxationSolution field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 33699 of file SatParameters.java.

hasFeasibilityJumpBatchDtime()

boolean com.google.ortools.sat.SatParameters.Builder.hasFeasibilityJumpBatchDtime

(

)

How much dtime for each LS batch.

optional double feasibility_jump_batch_dtime = 292 [default = 0.1];

Returns

Whether the feasibilityJumpBatchDtime field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 28913 of file SatParameters.java.

hasFeasibilityJumpDecay()

boolean com.google.ortools.sat.SatParameters.Builder.hasFeasibilityJumpDecay

(

)

On each restart, we randomly choose if we use decay (with this parameter)
or no decay.

optional double feasibility_jump_decay = 242 [default = 0.95];

Returns

Whether the feasibilityJumpDecay field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 28738 of file SatParameters.java.

hasFeasibilityJumpEnableRestarts()

boolean com.google.ortools.sat.SatParameters.Builder.hasFeasibilityJumpEnableRestarts

(

)

When stagnating, feasibility jump will either restart from a default
solution (with some possible randomization), or randomly pertubate the
current solution. This parameter selects the first option.

optional bool feasibility_jump_enable_restarts = 250 [default = true];

Returns

Whether the feasibilityJumpEnableRestarts field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 29091 of file SatParameters.java.

hasFeasibilityJumpLinearizationLevel()

boolean com.google.ortools.sat.SatParameters.Builder.hasFeasibilityJumpLinearizationLevel

(

)

How much do we linearize the problem in the local search code.

optional int32 feasibility_jump_linearization_level = 257 [default = 2];

Returns

Whether the feasibilityJumpLinearizationLevel field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 28797 of file SatParameters.java.

hasFeasibilityJumpMaxExpandedConstraintSize()

boolean com.google.ortools.sat.SatParameters.Builder.hasFeasibilityJumpMaxExpandedConstraintSize

(

)

Maximum size of no_overlap or no_overlap_2d constraint for a quadratic
expansion. This might look a lot, but by expanding such constraint, we get
a linear time evaluation per single variable moves instead of a slow O(n
log n) one.

optional int32 feasibility_jump_max_expanded_constraint_size = 264 [default = 500];

Returns

Whether the feasibilityJumpMaxExpandedConstraintSize field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 29156 of file SatParameters.java.

hasFeasibilityJumpRestartFactor()

boolean com.google.ortools.sat.SatParameters.Builder.hasFeasibilityJumpRestartFactor

(

)

This is a factor that directly influence the work before each restart.
Increasing it leads to longer restart.

optional int32 feasibility_jump_restart_factor = 258 [default = 1];

Returns

Whether the feasibilityJumpRestartFactor field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 28854 of file SatParameters.java.

hasFeasibilityJumpVarPerburbationRangeRatio()

boolean com.google.ortools.sat.SatParameters.Builder.hasFeasibilityJumpVarPerburbationRangeRatio

(

)

Max distance between the default value and the pertubated value relative to
the range of the domain of the variable.

optional double feasibility_jump_var_perburbation_range_ratio = 248 [default = 0.2];

Returns

Whether the feasibilityJumpVarPerburbationRangeRatio field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 29030 of file SatParameters.java.

hasFeasibilityJumpVarRandomizationProbability()

boolean com.google.ortools.sat.SatParameters.Builder.hasFeasibilityJumpVarRandomizationProbability

(

)

Probability for a variable to have a non default value upon restarts or
perturbations.

optional double feasibility_jump_var_randomization_probability = 247 [default = 0.05];

Returns

Whether the feasibilityJumpVarRandomizationProbability field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 28970 of file SatParameters.java.

hasFillAdditionalSolutionsInResponse()

boolean com.google.ortools.sat.SatParameters.Builder.hasFillAdditionalSolutionsInResponse

(

)

If true, the final response addition_solutions field will be filled with
all solutions from our solutions pool.

Note that if both this field and enumerate_all_solutions is true, we will
copy to the pool all of the solution found. So if solution_pool_size is big
enough, you can get all solutions this way instead of using the solution
callback.

Note that this only affect the "final" solution, not the one passed to the
solution callbacks.

optional bool fill_additional_solutions_in_response = 194 [default = false];

Returns

Whether the fillAdditionalSolutionsInResponse field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 30132 of file SatParameters.java.

hasFillTightenedDomainsInResponse()

boolean com.google.ortools.sat.SatParameters.Builder.hasFillTightenedDomainsInResponse

(

)

If true, add information about the derived variable domains to the
CpSolverResponse. It is an option because it makes the response slighly
bigger and there is a bit more work involved during the postsolve to
construct it, but it should still have a low overhead. See the
tightened_variables field in CpSolverResponse for more details.

optional bool fill_tightened_domains_in_response = 132 [default = false];

Returns

Whether the fillTightenedDomainsInResponse field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 30055 of file SatParameters.java.

hasFindBigLinearOverlap()

boolean com.google.ortools.sat.SatParameters.Builder.hasFindBigLinearOverlap

(

)

Try to find large "rectangle" in the linear constraint matrix with
identical lines. If such rectangle is big enough, we can introduce a new
integer variable corresponding to the common expression and greatly reduce
the number of non-zero.

optional bool find_big_linear_overlap = 234 [default = true];

Returns

Whether the findBigLinearOverlap field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 23449 of file SatParameters.java.

hasFindMultipleCores()

boolean com.google.ortools.sat.SatParameters.Builder.hasFindMultipleCores

(

)

Whether we try to find more independent cores for a given set of
assumptions in the core based max-SAT algorithms.

optional bool find_multiple_cores = 84 [default = true];

Returns

Whether the findMultipleCores field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 25896 of file SatParameters.java.

hasFixVariablesToTheirHintedValue()

boolean com.google.ortools.sat.SatParameters.Builder.hasFixVariablesToTheirHintedValue

(

)

If true, variables appearing in the solution hints will be fixed to their
hinted value.

optional bool fix_variables_to_their_hinted_value = 192 [default = false];

Returns

Whether the fixVariablesToTheirHintedValue field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 27586 of file SatParameters.java.

hasFpRounding()

boolean com.google.ortools.sat.SatParameters.Builder.hasFpRounding

(

)

optional .operations_research.sat.SatParameters.FPRoundingMethod fp_rounding = 165 [default = PROPAGATION_ASSISTED];

Returns

Whether the fpRounding field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 30854 of file SatParameters.java.

hasGlucoseDecayIncrement()

boolean com.google.ortools.sat.SatParameters.Builder.hasGlucoseDecayIncrement

(

)

optional double glucose_decay_increment = 23 [default = 0.01];

Returns

Whether the glucoseDecayIncrement field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19480 of file SatParameters.java.

hasGlucoseDecayIncrementPeriod()

boolean com.google.ortools.sat.SatParameters.Builder.hasGlucoseDecayIncrementPeriod

(

)

optional int32 glucose_decay_increment_period = 24 [default = 5000];

Returns

Whether the glucoseDecayIncrementPeriod field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19520 of file SatParameters.java.

hasGlucoseMaxDecay()

boolean com.google.ortools.sat.SatParameters.Builder.hasGlucoseMaxDecay

(

)

The activity starts at 0.8 and increment by 0.01 every 5000 conflicts until
0.95. This "hack" seems to work well and comes from:

Glucose 2.3 in the SAT 2013 Competition - SAT Competition 2013
http://edacc4.informatik.uni-ulm.de/SC13/solver-description-download/136

optional double glucose_max_decay = 22 [default = 0.95];

Returns

Whether the glucoseMaxDecay field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19416 of file SatParameters.java.

hasHintConflictLimit()

boolean com.google.ortools.sat.SatParameters.Builder.hasHintConflictLimit

(

)

Conflict limit used in the phase that exploit the solution hint.

optional int32 hint_conflict_limit = 153 [default = 10];

Returns

Whether the hintConflictLimit field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 27461 of file SatParameters.java.

hasIgnoreNames()

boolean com.google.ortools.sat.SatParameters.Builder.hasIgnoreNames

(

)

If true, we don't keep names in our internal copy of the user given model.

optional bool ignore_names = 202 [default = true];

Returns

Whether the ignoreNames field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 23306 of file SatParameters.java.

hasInferAllDiffs()

boolean com.google.ortools.sat.SatParameters.Builder.hasInferAllDiffs

(

)

Run a max-clique code amongst all the x != y we can find and try to infer
set of variables that are all different. This allows to close neos16.mps
for instance. Note that we only run this code if there is no all_diff
already in the model so that if a user want to add some all_diff, we assume
it is well done and do not try to add more.

This will also detect and add no_overlap constraints, if all the relations
x != y have "offsets" between them. I.e. x > y + offset.

optional bool infer_all_diffs = 233 [default = true];

Returns

Whether the inferAllDiffs field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 23369 of file SatParameters.java.

hasInitialPolarity()

boolean com.google.ortools.sat.SatParameters.Builder.hasInitialPolarity

(

)

optional .operations_research.sat.SatParameters.Polarity initial_polarity = 2 [default = POLARITY_FALSE];

Returns

Whether the initialPolarity field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 18165 of file SatParameters.java.

hasInitialVariablesActivity()

boolean com.google.ortools.sat.SatParameters.Builder.hasInitialVariablesActivity

(

)

The initial value of the variables activity. A non-zero value only make
sense when use_erwa_heuristic is true. Experiments with a value of 1e-2
together with the ERWA heuristic showed slighthly better result than simply
using zero. The idea is that when the "learning rate" of a variable becomes
lower than this value, then we prefer to branch on never explored before
variables. This is not in the ERWA paper.

optional double initial_variables_activity = 76 [default = 0];

Returns

Whether the initialVariablesActivity field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 18577 of file SatParameters.java.

hasInprocessingDtimeRatio()

boolean com.google.ortools.sat.SatParameters.Builder.hasInprocessingDtimeRatio

(

)

Proportion of deterministic time we should spend on inprocessing.
At each "restart", if the proportion is below this ratio, we will do some
inprocessing, otherwise, we skip it for this restart.

optional double inprocessing_dtime_ratio = 273 [default = 0.2];

Returns

Whether the inprocessingDtimeRatio field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 23576 of file SatParameters.java.

hasInprocessingMinimizationDtime()

boolean com.google.ortools.sat.SatParameters.Builder.hasInprocessingMinimizationDtime

(

)

Parameters for an heuristic similar to the one described in "An effective
learnt clause minimization approach for CDCL Sat Solvers",
https://www.ijcai.org/proceedings/2017/0098.pdf

This is the amount of dtime we should spend on this technique during each
inprocessing phase.

The minimization technique is the same as the one used to minimize core in
max-sat. We also minimize problem clauses and not just the learned clause
that we keep forever like in the paper.

optional double inprocessing_minimization_dtime = 275 [default = 1];

Returns

Whether the inprocessingMinimizationDtime field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 23703 of file SatParameters.java.

hasInprocessingProbingDtime()

boolean com.google.ortools.sat.SatParameters.Builder.hasInprocessingProbingDtime

(

)

The amount of dtime we should spend on probing for each inprocessing round.

optional double inprocessing_probing_dtime = 274 [default = 1];

Returns

Whether the inprocessingProbingDtime field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 23638 of file SatParameters.java.

hasInstantiateAllVariables()

boolean com.google.ortools.sat.SatParameters.Builder.hasInstantiateAllVariables

(

)

If true, the solver will add a default integer branching strategy to the
already defined search strategy. If not, some variable might still not be
fixed at the end of the search. For now we assume these variable can just
be set to their lower bound.

optional bool instantiate_all_variables = 106 [default = true];

Returns

Whether the instantiateAllVariables field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 30218 of file SatParameters.java.

hasInterleaveBatchSize()

boolean com.google.ortools.sat.SatParameters.Builder.hasInterleaveBatchSize

(

)

optional int32 interleave_batch_size = 134 [default = 0];

Returns

Whether the interleaveBatchSize field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 25307 of file SatParameters.java.

hasInterleaveSearch()

boolean com.google.ortools.sat.SatParameters.Builder.hasInterleaveSearch

(

)

Experimental. If this is true, then we interleave all our major search
strategy and distribute the work amongst num_workers.

The search is deterministic (independently of num_workers!), and we
schedule and wait for interleave_batch_size task to be completed before
synchronizing and scheduling the next batch of tasks.

optional bool interleave_search = 136 [default = false];

Returns

Whether the interleaveSearch field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 25240 of file SatParameters.java.

hasKeepAllFeasibleSolutionsInPresolve()

boolean com.google.ortools.sat.SatParameters.Builder.hasKeepAllFeasibleSolutionsInPresolve

(

)

If true, we disable the presolve reductions that remove feasible solutions
from the search space. Such solution are usually dominated by a "better"
solution that is kept, but depending on the situation, we might want to
keep all solutions.

A trivial example is when a variable is unused. If this is true, then the
presolve will not fix it to an arbitrary value and it will stay in the
search space.

optional bool keep_all_feasible_solutions_in_presolve = 173 [default = false];

Returns

Whether the keepAllFeasibleSolutionsInPresolve field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 29974 of file SatParameters.java.

hasLinearizationLevel()

boolean com.google.ortools.sat.SatParameters.Builder.hasLinearizationLevel

(

)

A non-negative level indicating the type of constraints we consider in the
LP relaxation. At level zero, no LP relaxation is used. At level 1, only
the linear constraint and full encoding are added. At level 2, we also add
all the Boolean constraints.

optional int32 linearization_level = 90 [default = 1];

Returns

Whether the linearizationLevel field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 31984 of file SatParameters.java.

hasLinearSplitSize()

boolean com.google.ortools.sat.SatParameters.Builder.hasLinearSplitSize

(

)

Linear constraints that are not pseudo-Boolean and that are longer than
this size will be split into sqrt(size) intermediate sums in order to have
faster propation in the CP engine.

optional int32 linear_split_size = 256 [default = 100];

Returns

Whether the linearSplitSize field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 31919 of file SatParameters.java.

hasLogPrefix()

boolean com.google.ortools.sat.SatParameters.Builder.hasLogPrefix

(

)

Add a prefix to all logs.

optional string log_prefix = 185 [default = ""];

Returns

Whether the logPrefix field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 21257 of file SatParameters.java.

hasLogSearchProgress()

boolean com.google.ortools.sat.SatParameters.Builder.hasLogSearchProgress

(

)

Whether the solver should log the search progress. This is the maing
logging parameter and if this is false, none of the logging (callbacks,
log_to_stdout, log_to_response, ...) will do anything.

optional bool log_search_progress = 41 [default = false];

Returns

Whether the logSearchProgress field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 21128 of file SatParameters.java.

hasLogSubsolverStatistics()

boolean com.google.ortools.sat.SatParameters.Builder.hasLogSubsolverStatistics

(

)

Whether the solver should display per sub-solver search statistics.
This is only useful is log_search_progress is set to true, and if the
number of search workers is > 1. Note that in all case we display a bit
of stats with one line per subsolver.

optional bool log_subsolver_statistics = 189 [default = false];

Returns

Whether the logSubsolverStatistics field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 21193 of file SatParameters.java.

hasLogToResponse()

boolean com.google.ortools.sat.SatParameters.Builder.hasLogToResponse

(

)

Log to response proto.

optional bool log_to_response = 187 [default = false];

Returns

Whether the logToResponse field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 21418 of file SatParameters.java.

hasLogToStdout()

boolean com.google.ortools.sat.SatParameters.Builder.hasLogToStdout

(

)

Log to stdout.

optional bool log_to_stdout = 186 [default = true];

Returns

Whether the logToStdout field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 21362 of file SatParameters.java.

hasLpDualTolerance()

boolean com.google.ortools.sat.SatParameters.Builder.hasLpDualTolerance

(

)

optional double lp_dual_tolerance = 267 [default = 1e-07];

Returns

Whether the lpDualTolerance field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 31669 of file SatParameters.java.

hasLpPrimalTolerance()

boolean com.google.ortools.sat.SatParameters.Builder.hasLpPrimalTolerance

(

)

The internal LP tolerances used by CP-SAT. These applies to the internal
and scaled problem. If the domains of your variables are large it might be
good to use lower tolerances. If your problem is binary with low
coefficients, it might be good to use higher ones to speed-up the lp
solves.

optional double lp_primal_tolerance = 266 [default = 1e-07];

Returns

Whether the lpPrimalTolerance field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 31605 of file SatParameters.java.

hasMaxAllDiffCutSize()

boolean com.google.ortools.sat.SatParameters.Builder.hasMaxAllDiffCutSize

(

)

Cut generator for all diffs can add too many cuts for large all_diff
constraints. This parameter restricts the large all_diff constraints to
have a cut generator.

optional int32 max_all_diff_cut_size = 148 [default = 64];

Returns

Whether the maxAllDiffCutSize field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 32751 of file SatParameters.java.

hasMaxClauseActivityValue()

boolean com.google.ortools.sat.SatParameters.Builder.hasMaxClauseActivityValue

(

)

optional double max_clause_activity_value = 18 [default = 1e+20];

Returns

Whether the maxClauseActivityValue field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19616 of file SatParameters.java.

hasMaxConsecutiveInactiveCount()

boolean com.google.ortools.sat.SatParameters.Builder.hasMaxConsecutiveInactiveCount

(

)

If a constraint/cut in LP is not active for that many consecutive OPTIMAL
solves, remove it from the LP. Note that it might be added again later if
it become violated by the current LP solution.

optional int32 max_consecutive_inactive_count = 121 [default = 100];

Returns

Whether the maxConsecutiveInactiveCount field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 33227 of file SatParameters.java.

hasMaxCutRoundsAtLevelZero()

boolean com.google.ortools.sat.SatParameters.Builder.hasMaxCutRoundsAtLevelZero

(

)

Max number of time we perform cut generation and resolve the LP at level 0.

optional int32 max_cut_rounds_at_level_zero = 154 [default = 1];

Returns

Whether the maxCutRoundsAtLevelZero field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 33169 of file SatParameters.java.

hasMaxDeterministicTime()

boolean com.google.ortools.sat.SatParameters.Builder.hasMaxDeterministicTime

(

)

Maximum time allowed in deterministic time to solve a problem.
The deterministic time should be correlated with the real time used by the
solver, the time unit being as close as possible to a second.

optional double max_deterministic_time = 67 [default = inf];

Returns

Whether the maxDeterministicTime field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 20456 of file SatParameters.java.

hasMaxDomainSizeWhenEncodingEqNeqConstraints()

boolean com.google.ortools.sat.SatParameters.Builder.hasMaxDomainSizeWhenEncodingEqNeqConstraints

(

)

When loading a*x + b*y ==/!= c when x and y are both fully encoded.
The solver may decide to replace the linear equation by a set of clauses.
This is triggered if the sizes of the domains of x and y are below the
threshold.

optional int32 max_domain_size_when_encoding_eq_neq_constraints = 191 [default = 16];

Returns

Whether the maxDomainSizeWhenEncodingEqNeqConstraints field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 32112 of file SatParameters.java.

hasMaxIntegerRoundingScaling()

boolean com.google.ortools.sat.SatParameters.Builder.hasMaxIntegerRoundingScaling

(

)

In the integer rounding procedure used for MIR and Gomory cut, the maximum
"scaling" we use (must be positive). The lower this is, the lower the
integer coefficients of the cut will be. Note that cut generated by lower
values are not necessarily worse than cut generated by larger value. There
is no strict dominance relationship.

Setting this to 2 result in the "strong fractional rouding" of Letchford
and Lodi.

optional int32 max_integer_rounding_scaling = 119 [default = 600];

Returns

Whether the maxIntegerRoundingScaling field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 32884 of file SatParameters.java.

hasMaxLinMaxSizeForExpansion()

boolean com.google.ortools.sat.SatParameters.Builder.hasMaxLinMaxSizeForExpansion

(

)

If the number of expressions in the lin_max is less that the max size
parameter, model expansion replaces target = max(xi) by linear constraint
with the introduction of new booleans bi such that bi => target == xi.

This is mainly for experimenting compared to a custom lin_max propagator.

optional int32 max_lin_max_size_for_expansion = 280 [default = 0];

Returns

Whether the maxLinMaxSizeForExpansion field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 22782 of file SatParameters.java.

hasMaxMemoryInMb()

boolean com.google.ortools.sat.SatParameters.Builder.hasMaxMemoryInMb

(

)

Maximum memory allowed for the whole thread containing the solver. The
solver will abort as soon as it detects that this limit is crossed. As a
result, this limit is approximative, but usually the solver will not go too
much over.

TODO(user): This is only used by the pure SAT solver, generalize to CP-SAT.

optional int64 max_memory_in_mb = 40 [default = 10000];

Returns

Whether the maxMemoryInMb field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 20663 of file SatParameters.java.

hasMaxNumberOfConflicts()

boolean com.google.ortools.sat.SatParameters.Builder.hasMaxNumberOfConflicts

(

)

Maximum number of conflicts allowed to solve a problem.

TODO(user): Maybe change the way the conflict limit is enforced?
currently it is enforced on each independent internal SAT solve, rather
than on the overall number of conflicts across all solves. So in the
context of an optimization problem, this is not really usable directly by a
client.

optional int64 max_number_of_conflicts = 37 [default = 9223372036854775807];

Returns

Whether the maxNumberOfConflicts field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 20584 of file SatParameters.java.

hasMaxNumCuts()

boolean com.google.ortools.sat.SatParameters.Builder.hasMaxNumCuts

(

)

The limit on the number of cuts in our cut pool. When this is reached we do
not generate cuts anymore.

TODO(user): We should probably remove this parameters, and just always
generate cuts but only keep the best n or something.

optional int32 max_num_cuts = 91 [default = 10000];

Returns

Whether the maxNumCuts field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 32181 of file SatParameters.java.

hasMaxNumDeterministicBatches()

boolean com.google.ortools.sat.SatParameters.Builder.hasMaxNumDeterministicBatches

(

)

Stops after that number of batches has been scheduled. This only make sense
when interleave_search is true.

optional int32 max_num_deterministic_batches = 291 [default = 0];

Returns

Whether the maxNumDeterministicBatches field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 20519 of file SatParameters.java.

hasMaxNumIntervalsForTimetableEdgeFinding()

boolean com.google.ortools.sat.SatParameters.Builder.hasMaxNumIntervalsForTimetableEdgeFinding

(

)

Max number of intervals for the timetable_edge_finding algorithm to
propagate. A value of 0 disables the constraint.

optional int32 max_num_intervals_for_timetable_edge_finding = 260 [default = 100];

Returns

Whether the maxNumIntervalsForTimetableEdgeFinding field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 26824 of file SatParameters.java.

hasMaxPairsPairwiseReasoningInNoOverlap2D()

boolean com.google.ortools.sat.SatParameters.Builder.hasMaxPairsPairwiseReasoningInNoOverlap2D

(

)

If the number of pairs to look is below this threshold, do an extra step of
propagation in the no_overlap_2d constraint by looking at all pairs of
intervals.

optional int32 max_pairs_pairwise_reasoning_in_no_overlap_2d = 276 [default = 1250];

Returns

Whether the maxPairsPairwiseReasoningInNoOverlap2d field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 27293 of file SatParameters.java.

hasMaxPresolveIterations()

boolean com.google.ortools.sat.SatParameters.Builder.hasMaxPresolveIterations

(

)

In case of large reduction in a presolve iteration, we perform multiple
presolve iterations. This parameter controls the maximum number of such
presolve iterations.

optional int32 max_presolve_iterations = 138 [default = 3];

Returns

Whether the maxPresolveIterations field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 22120 of file SatParameters.java.

hasMaxSatAssumptionOrder()

boolean com.google.ortools.sat.SatParameters.Builder.hasMaxSatAssumptionOrder

(

)

optional .operations_research.sat.SatParameters.MaxSatAssumptionOrder max_sat_assumption_order = 51 [default = DEFAULT_ASSUMPTION_ORDER];

Returns

Whether the maxSatAssumptionOrder field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 26014 of file SatParameters.java.

hasMaxSatReverseAssumptionOrder()

boolean com.google.ortools.sat.SatParameters.Builder.hasMaxSatReverseAssumptionOrder

(

)

If true, adds the assumption in the reverse order of the one defined by
max_sat_assumption_order.

optional bool max_sat_reverse_assumption_order = 52 [default = false];

Returns

Whether the maxSatReverseAssumptionOrder field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 26062 of file SatParameters.java.

hasMaxSatStratification()

boolean com.google.ortools.sat.SatParameters.Builder.hasMaxSatStratification

(

)

optional .operations_research.sat.SatParameters.MaxSatStratificationAlgorithm max_sat_stratification = 53 [default = STRATIFICATION_DESCENT];

Returns

Whether the maxSatStratification field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 26116 of file SatParameters.java.

hasMaxSizeToCreatePrecedenceLiteralsInDisjunctive()

boolean com.google.ortools.sat.SatParameters.Builder.hasMaxSizeToCreatePrecedenceLiteralsInDisjunctive

(

)

Create one literal for each disjunction of two pairs of tasks. This slows
down the solve time, but improves the lower bound of the objective in the
makespan case. This will be triggered if the number of intervals is less or
equal than the parameter and if use_strong_propagation_in_disjunctive is
true.

optional int32 max_size_to_create_precedence_literals_in_disjunctive = 229 [default = 60];

Returns

Whether the maxSizeToCreatePrecedenceLiteralsInDisjunctive field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 26343 of file SatParameters.java.

hasMaxTimeInSeconds()

boolean com.google.ortools.sat.SatParameters.Builder.hasMaxTimeInSeconds

(

)

Maximum time allowed in seconds to solve a problem.
The counter will starts at the beginning of the Solve() call.

optional double max_time_in_seconds = 36 [default = inf];

Returns

Whether the maxTimeInSeconds field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 20395 of file SatParameters.java.

hasMaxVariableActivityValue()

boolean com.google.ortools.sat.SatParameters.Builder.hasMaxVariableActivityValue

(

)

optional double max_variable_activity_value = 16 [default = 1e+100];

Returns

Whether the maxVariableActivityValue field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19368 of file SatParameters.java.

hasMergeAtMostOneWorkLimit()

boolean com.google.ortools.sat.SatParameters.Builder.hasMergeAtMostOneWorkLimit

(

)

optional double merge_at_most_one_work_limit = 146 [default = 100000000];

Returns

Whether the mergeAtMostOneWorkLimit field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 23038 of file SatParameters.java.

hasMergeNoOverlapWorkLimit()

boolean com.google.ortools.sat.SatParameters.Builder.hasMergeNoOverlapWorkLimit

(

)

During presolve, we use a maximum clique heuristic to merge together
no-overlap constraints or at most one constraints. This code can be slow,
so we have a limit in place on the number of explored nodes in the
underlying graph. The internal limit is an int64, but we use double here to
simplify manual input.

optional double merge_no_overlap_work_limit = 145 [default = 1000000000000];

Returns

Whether the mergeNoOverlapWorkLimit field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 22974 of file SatParameters.java.

hasMinimizationAlgorithm()

boolean com.google.ortools.sat.SatParameters.Builder.hasMinimizationAlgorithm

(

)

optional .operations_research.sat.SatParameters.ConflictMinimizationAlgorithm minimization_algorithm = 4 [default = RECURSIVE];

Returns

Whether the minimizationAlgorithm field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 18711 of file SatParameters.java.

hasMinimizeReductionDuringPbResolution()

boolean com.google.ortools.sat.SatParameters.Builder.hasMinimizeReductionDuringPbResolution

(

)

A different algorithm during PB resolution. It minimizes the number of
calls to ReduceCoefficients() which can be time consuming. However, the
search space will be different and if the coefficients are large, this may
lead to integer overflows that could otherwise be prevented.

optional bool minimize_reduction_during_pb_resolution = 48 [default = false];

Returns

Whether the minimizeReductionDuringPbResolution field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 21545 of file SatParameters.java.

hasMinOrthogonalityForLpConstraints()

boolean com.google.ortools.sat.SatParameters.Builder.hasMinOrthogonalityForLpConstraints

(

)

While adding constraints, skip the constraints which have orthogonality
less than 'min_orthogonality_for_lp_constraints' with already added
constraints during current call. Orthogonality is defined as 1 -
cosine(vector angle between constraints). A value of zero disable this
feature.

optional double min_orthogonality_for_lp_constraints = 115 [default = 0.05];

Returns

Whether the minOrthogonalityForLpConstraints field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 33101 of file SatParameters.java.

hasMipAutomaticallyScaleVariables()

boolean com.google.ortools.sat.SatParameters.Builder.hasMipAutomaticallyScaleVariables

(

)

If true, some continuous variable might be automatically scaled. For now,
this is only the case where we detect that a variable is actually an
integer multiple of a constant. For instance, variables of the form k * 0.5
are quite frequent, and if we detect this, we will scale such variable
domain by 2 to make it implied integer.

optional bool mip_automatically_scale_variables = 166 [default = true];

Returns

Whether the mipAutomaticallyScaleVariables field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 34081 of file SatParameters.java.

hasMipCheckPrecision()

boolean com.google.ortools.sat.SatParameters.Builder.hasMipCheckPrecision

(

)

As explained in mip_precision and mip_max_activity_exponent, we cannot
always reach the wanted precision during scaling. We use this threshold to
enphasize in the logs when the precision seems bad.

optional double mip_check_precision = 128 [default = 0.0001];

Returns

Whether the mipCheckPrecision field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 34455 of file SatParameters.java.

hasMipComputeTrueObjectiveBound()

boolean com.google.ortools.sat.SatParameters.Builder.hasMipComputeTrueObjectiveBound

(

)

Even if we make big error when scaling the objective, we can always derive
a correct lower bound on the original objective by using the exact lower
bound on the scaled integer version of the objective. This should be fast,
but if you don't care about having a precise lower bound, you can turn it
off.

optional bool mip_compute_true_objective_bound = 198 [default = true];

Returns

Whether the mipComputeTrueObjectiveBound field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 34521 of file SatParameters.java.

hasMipDropTolerance()

boolean com.google.ortools.sat.SatParameters.Builder.hasMipDropTolerance

(

)

Any value in the input mip with a magnitude lower than this will be set to
zero. This is to avoid some issue in LP presolving.

optional double mip_drop_tolerance = 232 [default = 1e-16];

Returns

Whether the mipDropTolerance field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 34738 of file SatParameters.java.

hasMipMaxActivityExponent()

boolean com.google.ortools.sat.SatParameters.Builder.hasMipMaxActivityExponent

(

)

To avoid integer overflow, we always force the maximum possible constraint
activity (and objective value) according to the initial variable domain to
be smaller than 2 to this given power. Because of this, we cannot always
reach the "mip_wanted_precision" parameter above.

This can go as high as 62, but some internal algo currently abort early if
they might run into integer overflow, so it is better to keep it a bit
lower than this.

optional int32 mip_max_activity_exponent = 127 [default = 53];

Returns

Whether the mipMaxActivityExponent field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 34376 of file SatParameters.java.

hasMipMaxBound()

boolean com.google.ortools.sat.SatParameters.Builder.hasMipMaxBound

(

)

We need to bound the maximum magnitude of the variables for CP-SAT, and
that is the bound we use. If the MIP model expect larger variable value in
the solution, then the converted model will likely not be relevant.

optional double mip_max_bound = 124 [default = 10000000];

Returns

Whether the mipMaxBound field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 33887 of file SatParameters.java.

hasMipMaxValidMagnitude()

boolean com.google.ortools.sat.SatParameters.Builder.hasMipMaxValidMagnitude

(

)

Any finite values in the input MIP must be below this threshold, otherwise
the model will be reported invalid. This is needed to avoid floating point
overflow when evaluating bounds * coeff for instance. We are a bit more
defensive, but in practice, users shouldn't use super large values in a
MIP.

optional double mip_max_valid_magnitude = 199 [default = 1e+20];

Returns

Whether the mipMaxValidMagnitude field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 34593 of file SatParameters.java.

hasMipPresolveLevel()

boolean com.google.ortools.sat.SatParameters.Builder.hasMipPresolveLevel

(

)

When solving a MIP, we do some basic floating point presolving before
scaling the problem to integer to be handled by CP-SAT. This control how
much of that presolve we do. It can help to better scale floating point
model, but it is not always behaving nicely.

optional int32 mip_presolve_level = 261 [default = 2];

Returns

Whether the mipPresolveLevel field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 34800 of file SatParameters.java.

hasMipScaleLargeDomain()

boolean com.google.ortools.sat.SatParameters.Builder.hasMipScaleLargeDomain

(

)

If this is false, then mip_var_scaling is only applied to variables with
"small" domain. If it is true, we scale all floating point variable
independenlty of their domain.

optional bool mip_scale_large_domain = 225 [default = false];

Returns

Whether the mipScaleLargeDomain field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 34015 of file SatParameters.java.

hasMipTreatHighMagnitudeBoundsAsInfinity()

boolean com.google.ortools.sat.SatParameters.Builder.hasMipTreatHighMagnitudeBoundsAsInfinity

(

)

By default, any variable/constraint bound with a finite value and a
magnitude greater than the mip_max_valid_magnitude will result with a
invalid model. This flags change the behavior such that such bounds are
silently transformed to +∞ or -∞.

It is recommended to keep it at false, and create valid bounds.

optional bool mip_treat_high_magnitude_bounds_as_infinity = 278 [default = false];

Returns

Whether the mipTreatHighMagnitudeBoundsAsInfinity field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 34666 of file SatParameters.java.

hasMipVarScaling()

boolean com.google.ortools.sat.SatParameters.Builder.hasMipVarScaling

(

)

All continuous variable of the problem will be multiplied by this factor.
By default, we don't do any variable scaling and rely on the MIP model to
specify continuous variable domain with the wanted precision.

optional double mip_var_scaling = 125 [default = 1];

Returns

Whether the mipVarScaling field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 33951 of file SatParameters.java.

hasMipWantedPrecision()

boolean com.google.ortools.sat.SatParameters.Builder.hasMipWantedPrecision

(

)

When scaling constraint with double coefficients to integer coefficients,
we will multiply by a power of 2 and round the coefficients. We will choose
the lowest power such that we have no potential overflow (see
mip_max_activity_exponent) and the worst case constraint activity error
does not exceed this threshold.

Note that we also detect constraint with rational coefficients and scale
them accordingly when it seems better instead of using a power of 2.

We also relax all constraint bounds by this absolute value. For pure
integer constraint, if this value if lower than one, this will not change
anything. However it is needed when scaling MIP problems.

If we manage to scale a constraint correctly, the maximum error we can make
will be twice this value (once for the scaling error and once for the
relaxed bounds). If we are not able to scale that well, we will display
that fact but still scale as best as we can.

optional double mip_wanted_precision = 126 [default = 1e-06];

Returns

Whether the mipWantedPrecision field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 34265 of file SatParameters.java.

hasName()

boolean com.google.ortools.sat.SatParameters.Builder.hasName

(

)

In some context, like in a portfolio of search, it makes sense to name a
given parameters set for logging purpose.

optional string name = 171 [default = ""];

Returns

Whether the name field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 18018 of file SatParameters.java.

hasNewConstraintsBatchSize()

boolean com.google.ortools.sat.SatParameters.Builder.hasNewConstraintsBatchSize

(

)

Add that many lazy constraints (or cuts) at once in the LP. Note that at
the beginning of the solve, we do add more than this.

optional int32 new_constraints_batch_size = 122 [default = 50];

Returns

Whether the newConstraintsBatchSize field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 33450 of file SatParameters.java.

hasNewLinearPropagation()

boolean com.google.ortools.sat.SatParameters.Builder.hasNewLinearPropagation

(

)

The new linear propagation code treat all constraints at once and use
an adaptation of Bellman-Ford-Tarjan to propagate constraint in a smarter
order and potentially detect propagation cycle earlier.

optional bool new_linear_propagation = 224 [default = true];

Returns

Whether the newLinearPropagation field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 31855 of file SatParameters.java.

hasNumConflictsBeforeStrategyChanges()

boolean com.google.ortools.sat.SatParameters.Builder.hasNumConflictsBeforeStrategyChanges

(

)

After each restart, if the number of conflict since the last strategy
change is greater that this, then we increment a "strategy_counter" that
can be use to change the search strategy used by the following restarts.

optional int32 num_conflicts_before_strategy_changes = 68 [default = 0];

Returns

Whether the numConflictsBeforeStrategyChanges field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 20272 of file SatParameters.java.

hasNumFullSubsolvers()

boolean com.google.ortools.sat.SatParameters.Builder.hasNumFullSubsolvers

(

)

We distinguish subsolvers that consume a full thread, and the ones that are
always interleaved. If left at zero, we will fix this with a default
formula that depends on num_workers. But if you start modifying what runs,
you might want to fix that to a given value depending on the num_workers
you use.

optional int32 num_full_subsolvers = 294 [default = 0];

Returns

Whether the numFullSubsolvers field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 23938 of file SatParameters.java.

hasNumSearchWorkers()

boolean com.google.ortools.sat.SatParameters.Builder.hasNumSearchWorkers

(

)

optional int32 num_search_workers = 100 [default = 0];

Returns

Whether the numSearchWorkers field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 23890 of file SatParameters.java.

hasNumViolationLs()

boolean com.google.ortools.sat.SatParameters.Builder.hasNumViolationLs

(

)

This will create incomplete subsolvers (that are not LNS subsolvers)
that use the feasibility jump code to find improving solution, treating
the objective improvement as a hard constraint.

optional int32 num_violation_ls = 244 [default = 0];

Returns

Whether the numViolationLs field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 29223 of file SatParameters.java.

hasNumWorkers()

boolean com.google.ortools.sat.SatParameters.Builder.hasNumWorkers

(

)

Specify the number of parallel workers (i.e. threads) to use during search.
This should usually be lower than your number of available cpus +
hyperthread in your machine.

A value of 0 means the solver will try to use all cores on the machine.
A number of 1 means no parallelism.

Note that 'num_workers' is the preferred name, but if it is set to zero,
we will still read the deprecated 'num_search_workers'.

As of 2020-04-10, if you're using SAT via MPSolver (to solve integer
programs) this field is overridden with a value of 8, if the field is not
set *explicitly*. Thus, always set this field explicitly or via
MPSolver::SetNumThreads().

optional int32 num_workers = 206 [default = 0];

Returns

Whether the numWorkers field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 23799 of file SatParameters.java.

hasOnlyAddCutsAtLevelZero()

boolean com.google.ortools.sat.SatParameters.Builder.hasOnlyAddCutsAtLevelZero

(

)

For the cut that can be generated at any level, this control if we only
try to generate them at the root node.

optional bool only_add_cuts_at_level_zero = 92 [default = false];

Returns

Whether the onlyAddCutsAtLevelZero field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 32314 of file SatParameters.java.

hasOnlySolveIp()

boolean com.google.ortools.sat.SatParameters.Builder.hasOnlySolveIp

(

)

If one try to solve a MIP model with CP-SAT, because we assume all variable
to be integer after scaling, we will not necessarily have the correct
optimal. Note however that all feasible solutions are valid since we will
just solve a more restricted version of the original problem.

This parameters is here to prevent user to think the solution is optimal
when it might not be. One will need to manually set this to false to solve
a MIP model where the optimal might be different.

Note that this is tested after some MIP presolve steps, so even if not
all original variable are integer, we might end up with a pure IP after
presolve and after implied integer detection.

optional bool only_solve_ip = 222 [default = false];

Returns

Whether the onlySolveIp field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 34160 of file SatParameters.java.

hasOptimizeWithCore()

boolean com.google.ortools.sat.SatParameters.Builder.hasOptimizeWithCore

(

)

The default optimization method is a simple "linear scan", each time trying
to find a better solution than the previous one. If this is true, then we
use a core-based approach (like in max-SAT) when we try to increase the
lower bound instead.

optional bool optimize_with_core = 83 [default = false];

Returns

Whether the optimizeWithCore field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 28256 of file SatParameters.java.

hasOptimizeWithLbTreeSearch()

boolean com.google.ortools.sat.SatParameters.Builder.hasOptimizeWithLbTreeSearch

(

)

Do a more conventional tree search (by opposition to SAT based one) where
we keep all the explored node in a tree. This is meant to be used in a
portfolio and focus on improving the objective lower bound. Keeping the
whole tree allow us to report a better objective lower bound coming from
the worst open node in the tree.

optional bool optimize_with_lb_tree_search = 188 [default = false];

Returns

Whether the optimizeWithLbTreeSearch field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 28325 of file SatParameters.java.

hasOptimizeWithMaxHs()

boolean com.google.ortools.sat.SatParameters.Builder.hasOptimizeWithMaxHs

(

)

This has no effect if optimize_with_core is false. If true, use a different
core-based algorithm similar to the max-HS algo for max-SAT. This is a
hybrid MIP/CP approach and it uses a MIP solver in addition to the CP/SAT
one. This is also related to the PhD work of tobyodavies@
"Automatic Logic-Based Benders Decomposition with MiniZinc"
http://aaai.org/ocs/index.php/AAAI/AAAI17/paper/view/14489

optional bool optimize_with_max_hs = 85 [default = false];

Returns

Whether the optimizeWithMaxHs field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 28542 of file SatParameters.java.

hasPbCleanupIncrement()

boolean com.google.ortools.sat.SatParameters.Builder.hasPbCleanupIncrement

(

)

Same as for the clauses, but for the learned pseudo-Boolean constraints.

optional int32 pb_cleanup_increment = 46 [default = 200];

Returns

Whether the pbCleanupIncrement field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19192 of file SatParameters.java.

hasPbCleanupRatio()

boolean com.google.ortools.sat.SatParameters.Builder.hasPbCleanupRatio

(

)

optional double pb_cleanup_ratio = 47 [default = 0.5];

Returns

Whether the pbCleanupRatio field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19244 of file SatParameters.java.

hasPermutePresolveConstraintOrder()

boolean com.google.ortools.sat.SatParameters.Builder.hasPermutePresolveConstraintOrder

(

)

optional bool permute_presolve_constraint_order = 179 [default = false];

Returns

Whether the permutePresolveConstraintOrder field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 21042 of file SatParameters.java.

hasPermuteVariableRandomly()

boolean com.google.ortools.sat.SatParameters.Builder.hasPermuteVariableRandomly

(

)

This is mainly here to test the solver variability. Note that in tests, if
not explicitly set to false, all 3 options will be set to true so that
clients do not rely on the solver returning a specific solution if they are
many equivalent optimal solutions.

optional bool permute_variable_randomly = 178 [default = false];

Returns

Whether the permuteVariableRandomly field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 20981 of file SatParameters.java.

hasPolarityRephaseIncrement()

boolean com.google.ortools.sat.SatParameters.Builder.hasPolarityRephaseIncrement

(

)

If non-zero, then we change the polarity heuristic after that many number
of conflicts in an arithmetically increasing fashion. So x the first time,
2 * x the second time, etc...

optional int32 polarity_rephase_increment = 168 [default = 1000];

Returns

Whether the polarityRephaseIncrement field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 18310 of file SatParameters.java.

hasPolishLpSolution()

boolean com.google.ortools.sat.SatParameters.Builder.hasPolishLpSolution

(

)

Whether we try to do a few degenerate iteration at the end of an LP solve
to minimize the fractionality of the integer variable in the basis. This
helps on some problems, but not so much on others. It also cost of bit of
time to do such polish step.

optional bool polish_lp_solution = 175 [default = false];

Returns

Whether the polishLpSolution field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 31536 of file SatParameters.java.

hasPreferredVariableOrder()

boolean com.google.ortools.sat.SatParameters.Builder.hasPreferredVariableOrder

(

)

optional .operations_research.sat.SatParameters.VariableOrder preferred_variable_order = 1 [default = IN_ORDER];

Returns

Whether the preferredVariableOrder field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 18123 of file SatParameters.java.

hasPresolveBlockedClause()

boolean com.google.ortools.sat.SatParameters.Builder.hasPresolveBlockedClause

(

)

Whether we use an heuristic to detect some basic case of blocked clause
in the SAT presolve.

optional bool presolve_blocked_clause = 88 [default = true];

Returns

Whether the presolveBlockedClause field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 21935 of file SatParameters.java.

hasPresolveBvaThreshold()

boolean com.google.ortools.sat.SatParameters.Builder.hasPresolveBvaThreshold

(

)

Apply Bounded Variable Addition (BVA) if the number of clauses is reduced
by stricly more than this threshold. The algorithm described in the paper
uses 0, but quick experiments showed that 1 is a good value. It may not be
worth it to add a new variable just to remove one clause.

optional int32 presolve_bva_threshold = 73 [default = 1];

Returns

Whether the presolveBvaThreshold field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 22053 of file SatParameters.java.

hasPresolveBveClauseWeight()

boolean com.google.ortools.sat.SatParameters.Builder.hasPresolveBveClauseWeight

(

)

During presolve, we apply BVE only if this weight times the number of
clauses plus the number of clause literals is not increased.

optional int32 presolve_bve_clause_weight = 55 [default = 3];

Returns

Whether the presolveBveClauseWeight field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 21763 of file SatParameters.java.

hasPresolveBveThreshold()

boolean com.google.ortools.sat.SatParameters.Builder.hasPresolveBveThreshold

(

)

During presolve, only try to perform the bounded variable elimination (BVE)
of a variable x if the number of occurrences of x times the number of
occurrences of not(x) is not greater than this parameter.

optional int32 presolve_bve_threshold = 54 [default = 500];

Returns

Whether the presolveBveThreshold field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 21700 of file SatParameters.java.

hasPresolveExtractIntegerEnforcement()

boolean com.google.ortools.sat.SatParameters.Builder.hasPresolveExtractIntegerEnforcement

(

)

If true, we will extract from linear constraints, enforcement literals of
the form "integer variable at bound => simplified constraint". This should
always be beneficial except that we don't always handle them as efficiently
as we could for now. This causes problem on manna81.mps (LP relaxation not
as tight it seems) and on neos-3354841-apure.mps.gz (too many literals
created this way).

optional bool presolve_extract_integer_enforcement = 174 [default = false];

Returns

Whether the presolveExtractIntegerEnforcement field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 23155 of file SatParameters.java.

hasPresolveInclusionWorkLimit()

boolean com.google.ortools.sat.SatParameters.Builder.hasPresolveInclusionWorkLimit

(

)

A few presolve operations involve detecting constraints included in other
constraint. Since there can be a quadratic number of such pairs, and
processing them usually involve scanning them, the complexity of these
operations can be big. This enforce a local deterministic limit on the
number of entries scanned. Default is 1e8.

A value of zero will disable these presolve rules completely.

optional int64 presolve_inclusion_work_limit = 201 [default = 100000000];

Returns

Whether the presolveInclusionWorkLimit field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 23232 of file SatParameters.java.

hasPresolveProbingDeterministicTimeLimit()

boolean com.google.ortools.sat.SatParameters.Builder.hasPresolveProbingDeterministicTimeLimit

(

)

optional double presolve_probing_deterministic_time_limit = 57 [default = 30];

Returns

Whether the presolveProbingDeterministicTimeLimit field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 21890 of file SatParameters.java.

hasPresolveSubstitutionLevel()

boolean com.google.ortools.sat.SatParameters.Builder.hasPresolveSubstitutionLevel

(

)

How much substitution (also called free variable aggregation in MIP
litterature) should we perform at presolve. This currently only concerns
variable appearing only in linear constraints. For now the value 0 turns it
off and any positive value performs substitution.

optional int32 presolve_substitution_level = 147 [default = 1];

Returns

Whether the presolveSubstitutionLevel field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 23085 of file SatParameters.java.

hasPresolveUseBva()

boolean com.google.ortools.sat.SatParameters.Builder.hasPresolveUseBva

(

)

Whether or not we use Bounded Variable Addition (BVA) in the presolve.

optional bool presolve_use_bva = 72 [default = true];

Returns

Whether the presolveUseBva field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 21994 of file SatParameters.java.

hasProbingDeterministicTimeLimit()

boolean com.google.ortools.sat.SatParameters.Builder.hasProbingDeterministicTimeLimit

(

)

The maximum "deterministic" time limit to spend in probing. A value of
zero will disable the probing.

TODO(user): Clean up. The first one is used in CP-SAT, the other in pure
SAT presolve.

optional double probing_deterministic_time_limit = 226 [default = 1];

Returns

Whether the probingDeterministicTimeLimit field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 21826 of file SatParameters.java.

hasProbingNumCombinationsLimit()

boolean com.google.ortools.sat.SatParameters.Builder.hasProbingNumCombinationsLimit

(

)

How many combinations of pairs or triplets of variables we want to scan.

optional int32 probing_num_combinations_limit = 272 [default = 20000];

Returns

Whether the probingNumCombinationsLimit field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 27765 of file SatParameters.java.

hasPropagationLoopDetectionFactor()

boolean com.google.ortools.sat.SatParameters.Builder.hasPropagationLoopDetectionFactor

(

)

Some search decisions might cause a really large number of propagations to
happen when integer variables with large domains are only reduced by 1 at
each step. If we propagate more than the number of variable times this
parameters we try to take counter-measure. Setting this to 0.0 disable this
feature.

TODO(user): Setting this to something like 10 helps in most cases, but the
code is currently buggy and can cause the solve to enter a bad state where
no progress is made.

optional double propagation_loop_detection_factor = 221 [default = 10];

Returns

Whether the propagationLoopDetectionFactor field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 26171 of file SatParameters.java.

hasPseudoCostReliabilityThreshold()

boolean com.google.ortools.sat.SatParameters.Builder.hasPseudoCostReliabilityThreshold

(

)

The solver ignores the pseudo costs of variables with number of recordings
less than this threshold.

optional int64 pseudo_cost_reliability_threshold = 123 [default = 100];

Returns

Whether the pseudoCostReliabilityThreshold field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 28194 of file SatParameters.java.

hasPushAllTasksTowardStart()

boolean com.google.ortools.sat.SatParameters.Builder.hasPushAllTasksTowardStart

(

)

Experimental code: specify if the objective pushes all tasks toward the
start of the schedule.

optional bool push_all_tasks_toward_start = 262 [default = false];

Returns

Whether the pushAllTasksTowardStart field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 31078 of file SatParameters.java.

hasRandomBranchesRatio()

boolean com.google.ortools.sat.SatParameters.Builder.hasRandomBranchesRatio

(

)

A number between 0 and 1 that indicates the proportion of branching
variables that are selected randomly instead of choosing the first variable
from the given variable_ordering strategy.

optional double random_branches_ratio = 32 [default = 0];

Returns

Whether the randomBranchesRatio field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 18446 of file SatParameters.java.

hasRandomizeSearch()

boolean com.google.ortools.sat.SatParameters.Builder.hasRandomizeSearch

(

)

Randomize fixed search.

optional bool randomize_search = 103 [default = false];

Returns

Whether the randomizeSearch field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 30957 of file SatParameters.java.

hasRandomPolarityRatio()

boolean com.google.ortools.sat.SatParameters.Builder.hasRandomPolarityRatio

(

)

The proportion of polarity chosen at random. Note that this take
precedence over the phase saving heuristic. This is different from
initial_polarity:POLARITY_RANDOM because it will select a new random
polarity each time the variable is branched upon instead of selecting one
initially and then always taking this choice.

optional double random_polarity_ratio = 45 [default = 0];

Returns

Whether the randomPolarityRatio field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 18376 of file SatParameters.java.

hasRandomSeed()

boolean com.google.ortools.sat.SatParameters.Builder.hasRandomSeed

(

)

At the beginning of each solve, the random number generator used in some
part of the solver is reinitialized to this seed. If you change the random
seed, the solver may make different choices during the solving process.

For some problems, the running time may vary a lot depending on small
change in the solving algorithm. Running the solver with different seeds
enables to have more robust benchmarks when evaluating new features.

optional int32 random_seed = 31 [default = 1];

Returns

Whether the randomSeed field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 20904 of file SatParameters.java.

hasRelativeGapLimit()

boolean com.google.ortools.sat.SatParameters.Builder.hasRelativeGapLimit

(

)

optional double relative_gap_limit = 160 [default = 0];

Returns

Whether the relativeGapLimit field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 20854 of file SatParameters.java.

hasRepairHint()

boolean com.google.ortools.sat.SatParameters.Builder.hasRepairHint

(

)

If true, the solver tries to repair the solution given in the hint. This
search terminates after the 'hint_conflict_limit' is reached and the solver
switches to regular search. If false, then  we do a FIXED_SEARCH using the
hint until the hint_conflict_limit is reached.

optional bool repair_hint = 167 [default = false];

Returns

Whether the repairHint field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 27520 of file SatParameters.java.

hasRestartDlAverageRatio()

boolean com.google.ortools.sat.SatParameters.Builder.hasRestartDlAverageRatio

(

)

In the moving average restart algorithms, a restart is triggered if the
window average times this ratio is greater that the global average.

optional double restart_dl_average_ratio = 63 [default = 1];

Returns

Whether the restartDlAverageRatio field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 20027 of file SatParameters.java.

hasRestartLbdAverageRatio()

boolean com.google.ortools.sat.SatParameters.Builder.hasRestartLbdAverageRatio

(

)

optional double restart_lbd_average_ratio = 71 [default = 1];

Returns

Whether the restartLbdAverageRatio field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 20082 of file SatParameters.java.

hasRestartPeriod()

boolean com.google.ortools.sat.SatParameters.Builder.hasRestartPeriod

(

)

Restart period for the FIXED_RESTART strategy. This is also the multiplier
used by the LUBY_RESTART strategy.

optional int32 restart_period = 30 [default = 50];

Returns

Whether the restartPeriod field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19911 of file SatParameters.java.

hasRestartRunningWindowSize()

boolean com.google.ortools.sat.SatParameters.Builder.hasRestartRunningWindowSize

(

)

Size of the window for the moving average restarts.

optional int32 restart_running_window_size = 62 [default = 50];

Returns

Whether the restartRunningWindowSize field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19970 of file SatParameters.java.

hasRootLpIterations()

boolean com.google.ortools.sat.SatParameters.Builder.hasRootLpIterations

(

)

Even at the root node, we do not want to spend too much time on the LP if
it is "difficult". So we solve it in "chunks" of that many iterations. The
solve will be continued down in the tree or the next time we go back to the
root node.

optional int32 root_lp_iterations = 227 [default = 2000];

Returns

Whether the rootLpIterations field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 33032 of file SatParameters.java.

hasSaveLpBasisInLbTreeSearch()

boolean com.google.ortools.sat.SatParameters.Builder.hasSaveLpBasisInLbTreeSearch

(

)

Experimental. Save the current LP basis at each node of the search tree so
that when we jump around, we can load it and reduce the number of LP
iterations needed.

It currently works okay if we do not change the lp with cuts or
simplification... More work is needed to make it robust in all cases.

optional bool save_lp_basis_in_lb_tree_search = 284 [default = false];

Returns

Whether the saveLpBasisInLbTreeSearch field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 28398 of file SatParameters.java.

hasSearchBranching()

boolean com.google.ortools.sat.SatParameters.Builder.hasSearchBranching

(

)

optional .operations_research.sat.SatParameters.SearchBranching search_branching = 82 [default = AUTOMATIC_SEARCH];

Returns

Whether the searchBranching field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 27414 of file SatParameters.java.

hasSearchRandomVariablePoolSize()

boolean com.google.ortools.sat.SatParameters.Builder.hasSearchRandomVariablePoolSize

(

)

Search randomization will collect the top
'search_random_variable_pool_size' valued variables, and pick one randomly.
The value of the variable is specific to each strategy.

optional int64 search_random_variable_pool_size = 104 [default = 0];

Returns

Whether the searchRandomVariablePoolSize field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 31015 of file SatParameters.java.

hasShareBinaryClauses()

boolean com.google.ortools.sat.SatParameters.Builder.hasShareBinaryClauses

(

)

Allows sharing of new learned binary clause between workers.

optional bool share_binary_clauses = 203 [default = true];

Returns

Whether the shareBinaryClauses field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 25463 of file SatParameters.java.

hasSharedTreeMaxNodesPerWorker()

boolean com.google.ortools.sat.SatParameters.Builder.hasSharedTreeMaxNodesPerWorker

(

)

In order to limit total shared memory and communication overhead, limit the
total number of nodes that may be generated in the shared tree. If the
shared tree runs out of unassigned leaves, workers act as portfolio
workers. Note: this limit includes interior nodes, not just leaves.

optional int32 shared_tree_max_nodes_per_worker = 238 [default = 100000];

Returns

Whether the sharedTreeMaxNodesPerWorker field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 29780 of file SatParameters.java.

hasSharedTreeNumWorkers()

boolean com.google.ortools.sat.SatParameters.Builder.hasSharedTreeNumWorkers

(

)

Enables experimental workstealing-like shared tree search.
If non-zero, start this many complete worker threads to explore a shared
search tree. These workers communicate objective bounds and simple decision
nogoods relating to the shared prefix of the tree, and will avoid exploring
the same subtrees as one another.

optional int32 shared_tree_num_workers = 235 [default = 0];

Returns

Whether the sharedTreeNumWorkers field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 29405 of file SatParameters.java.

hasSharedTreeOpenLeavesPerWorker()

boolean com.google.ortools.sat.SatParameters.Builder.hasSharedTreeOpenLeavesPerWorker

(

)

How many open leaf nodes should the shared tree maintain per worker.

optional double shared_tree_open_leaves_per_worker = 281 [default = 2];

Returns

Whether the sharedTreeOpenLeavesPerWorker field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 29721 of file SatParameters.java.

hasSharedTreeSplitStrategy()

boolean com.google.ortools.sat.SatParameters.Builder.hasSharedTreeSplitStrategy

(

)

optional .operations_research.sat.SatParameters.SharedTreeSplitStrategy shared_tree_split_strategy = 239 [default = SPLIT_STRATEGY_AUTO];

Returns

Whether the sharedTreeSplitStrategy field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 29840 of file SatParameters.java.

hasSharedTreeWorkerEnableTrailSharing()

boolean com.google.ortools.sat.SatParameters.Builder.hasSharedTreeWorkerEnableTrailSharing

(

)

If true, workers share more of the information from their local trail.
Specifically, literals implied by the shared tree decisions and
the longest conflict-free assignment from the last restart (to enable
cross-worker phase-saving).

optional bool shared_tree_worker_enable_trail_sharing = 295 [default = true];

Returns

Whether the sharedTreeWorkerEnableTrailSharing field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 29656 of file SatParameters.java.

hasSharedTreeWorkerMinRestartsPerSubtree()

boolean com.google.ortools.sat.SatParameters.Builder.hasSharedTreeWorkerMinRestartsPerSubtree

(

)

Minimum number of restarts before a worker will replace a subtree
that looks "bad" based on the average LBD of learned clauses.

optional int32 shared_tree_worker_min_restarts_per_subtree = 282 [default = 1];

Returns

Whether the sharedTreeWorkerMinRestartsPerSubtree field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 29594 of file SatParameters.java.

hasSharedTreeWorkerObjectiveSplitProbability()

boolean com.google.ortools.sat.SatParameters.Builder.hasSharedTreeWorkerObjectiveSplitProbability

(

)

After their assigned prefix, shared tree workers will branch on the
objective with this probability. Higher numbers cause the shared tree
search to focus on improving the lower bound over finding primal solutions.

optional double shared_tree_worker_objective_split_probability = 237 [default = 0.5];

Returns

Whether the sharedTreeWorkerObjectiveSplitProbability field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 29531 of file SatParameters.java.

hasShareGlueClauses()

boolean com.google.ortools.sat.SatParameters.Builder.hasShareGlueClauses

(

)

Allows sharing of short glue clauses between workers.
Implicitly disabled if share_binary_clauses is false.

optional bool share_glue_clauses = 285 [default = false];

Returns

Whether the shareGlueClauses field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 25520 of file SatParameters.java.

hasShareLevelZeroBounds()

boolean com.google.ortools.sat.SatParameters.Builder.hasShareLevelZeroBounds

(

)

Allows sharing of the bounds of modified variables at level 0.

optional bool share_level_zero_bounds = 114 [default = true];

Returns

Whether the shareLevelZeroBounds field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 25407 of file SatParameters.java.

hasShareObjectiveBounds()

boolean com.google.ortools.sat.SatParameters.Builder.hasShareObjectiveBounds

(

)

Allows objective sharing between workers.

optional bool share_objective_bounds = 113 [default = true];

Returns

Whether the shareObjectiveBounds field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 25351 of file SatParameters.java.

hasShavingSearchDeterministicTime()

boolean com.google.ortools.sat.SatParameters.Builder.hasShavingSearchDeterministicTime

(

)

Specifies the amount of deterministic time spent of each try at shaving a
bound in the shaving search.

optional double shaving_search_deterministic_time = 205 [default = 0.001];

Returns

Whether the shavingSearchDeterministicTime field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 27882 of file SatParameters.java.

hasShavingSearchThreshold()

boolean com.google.ortools.sat.SatParameters.Builder.hasShavingSearchThreshold

(

)

Specifies the threshold between two modes in the shaving procedure.
If the range of the variable/objective is less than this threshold, then
the shaving procedure will try to remove values one by one. Otherwise, it
will try to remove one range at a time.

optional int64 shaving_search_threshold = 290 [default = 64];

Returns

Whether the shavingSearchThreshold field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 27944 of file SatParameters.java.

hasSolutionPoolSize()

boolean com.google.ortools.sat.SatParameters.Builder.hasSolutionPoolSize

(

)

Size of the top-n different solutions kept by the solver.
This parameter must be > 0.
Currently this only impact the "base" solution chosen for a LNS fragment.

optional int32 solution_pool_size = 193 [default = 3];

Returns

Whether the solutionPoolSize field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 30621 of file SatParameters.java.

hasStopAfterFirstSolution()

boolean com.google.ortools.sat.SatParameters.Builder.hasStopAfterFirstSolution

(

)

For an optimization problem, stop the solver as soon as we have a solution.

optional bool stop_after_first_solution = 98 [default = false];

Returns

Whether the stopAfterFirstSolution field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 30351 of file SatParameters.java.

hasStopAfterPresolve()

boolean com.google.ortools.sat.SatParameters.Builder.hasStopAfterPresolve

(

)

Mainly used when improving the presolver. When true, stops the solver after
the presolve is complete (or after loading and root level propagation).

optional bool stop_after_presolve = 149 [default = false];

Returns

Whether the stopAfterPresolve field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 30408 of file SatParameters.java.

hasStopAfterRootPropagation()

boolean com.google.ortools.sat.SatParameters.Builder.hasStopAfterRootPropagation

(

)

optional bool stop_after_root_propagation = 252 [default = false];

Returns

Whether the stopAfterRootPropagation field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 30463 of file SatParameters.java.

hasStrategyChangeIncreaseRatio()

boolean com.google.ortools.sat.SatParameters.Builder.hasStrategyChangeIncreaseRatio

(

)

The parameter num_conflicts_before_strategy_changes is increased by that
much after each strategy change.

optional double strategy_change_increase_ratio = 69 [default = 0];

Returns

Whether the strategyChangeIncreaseRatio field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 20335 of file SatParameters.java.

hasSubsumptionDuringConflictAnalysis()

boolean com.google.ortools.sat.SatParameters.Builder.hasSubsumptionDuringConflictAnalysis

(

)

At a really low cost, during the 1-UIP conflict computation, it is easy to
detect if some of the involved reasons are subsumed by the current
conflict. When this is true, such clauses are detached and later removed
from the problem.

optional bool subsumption_during_conflict_analysis = 56 [default = true];

Returns

Whether the subsumptionDuringConflictAnalysis field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 18803 of file SatParameters.java.

hasSymmetryLevel()

boolean com.google.ortools.sat.SatParameters.Builder.hasSymmetryLevel

(

)

Whether we try to automatically detect the symmetries in a model and
exploit them. Currently, at level 1 we detect them in presolve and try
to fix Booleans. At level 2, we also do some form of dynamic symmetry
breaking during search. At level 3, we also detect symmetries for very
large models, which can be slow. At level 4, we try to break as much
symmetry as possible in presolve.

optional int32 symmetry_level = 183 [default = 2];

Returns

Whether the symmetryLevel field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 31782 of file SatParameters.java.

hasTableCompressionLevel()

boolean com.google.ortools.sat.SatParameters.Builder.hasTableCompressionLevel

(

)

How much we try to "compress" a table constraint. Compressing more leads to
less Booleans and faster propagation but can reduced the quality of the lp
relaxation. Values goes from 0 to 3 where we always try to fully compress a
table. At 2, we try to automatically decide if it is worth it.

optional int32 table_compression_level = 217 [default = 2];

Returns

Whether the tableCompressionLevel field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 22429 of file SatParameters.java.

hasUseAbslRandom()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseAbslRandom

(

)

optional bool use_absl_random = 180 [default = false];

Returns

Whether the useAbslRandom field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 21082 of file SatParameters.java.

hasUseAreaEnergeticReasoningInNoOverlap2D()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseAreaEnergeticReasoningInNoOverlap2D

(

)

When this is true, the no_overlap_2d constraint is reinforced with
an energetic reasoning that uses an area-based energy. This can be combined
with the two other overlap heuristics above.

optional bool use_area_energetic_reasoning_in_no_overlap_2d = 271 [default = false];

Returns

Whether the useAreaEnergeticReasoningInNoOverlap2d field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 27229 of file SatParameters.java.

hasUseBlockingRestart()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseBlockingRestart

(

)

Block a moving restart algorithm if the trail size of the current conflict
is greater than the multiplier times the moving average of the trail size
at the previous conflicts.

optional bool use_blocking_restart = 64 [default = false];

Returns

Whether the useBlockingRestart field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 20128 of file SatParameters.java.

hasUseCombinedNoOverlap()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseCombinedNoOverlap

(

)

This can be beneficial if there is a lot of no-overlap constraints but a
relatively low number of different intervals in the problem. Like 1000
intervals, but 1M intervals in the no-overlap constraints covering them.

optional bool use_combined_no_overlap = 133 [default = false];

Returns

Whether the useCombinedNoOverlap field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 31283 of file SatParameters.java.

hasUseConservativeScaleOverloadChecker()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseConservativeScaleOverloadChecker

(

)

Enable a heuristic to solve cumulative constraints using a modified energy
constraint. We modify the usual energy definition by applying a
super-additive function (also called "conservative scale" or "dual-feasible
function") to the demand and the durations of the tasks.

This heuristic is fast but for most problems it does not help much to find
a solution.

optional bool use_conservative_scale_overload_checker = 286 [default = false];

Returns

Whether the useConservativeScaleOverloadChecker field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 26669 of file SatParameters.java.

hasUseDisjunctiveConstraintInCumulative()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseDisjunctiveConstraintInCumulative

(

)

When this is true, the cumulative constraint is reinforced with propagators
from the disjunctive constraint to improve the inference on a set of tasks
that are disjunctive at the root of the problem. This additional level
supplements the default level of reasoning.

Propagators of the cumulative constraint will not be used at all if all the
tasks are disjunctive at root node.

This always result in better propagation, but it is usually slow, so
depending on the problem, turning this off may lead to a faster solution.

optional bool use_disjunctive_constraint_in_cumulative = 80 [default = true];

Returns

Whether the useDisjunctiveConstraintInCumulative field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 27008 of file SatParameters.java.

hasUseDualSchedulingHeuristics()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseDualSchedulingHeuristics

(

)

When set, it activates a few scheduling parameters to improve the lower
bound of scheduling problems. This is only effective with multiple workers
as it modifies the reduced_cost, lb_tree_search, and probing workers.

optional bool use_dual_scheduling_heuristics = 214 [default = true];

Returns

Whether the useDualSchedulingHeuristics field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 27357 of file SatParameters.java.

hasUseDynamicPrecedenceInCumulative()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseDynamicPrecedenceInCumulative

(

)

optional bool use_dynamic_precedence_in_cumulative = 268 [default = false];

Returns

Whether the useDynamicPrecedenceInCumulative field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 26539 of file SatParameters.java.

hasUseDynamicPrecedenceInDisjunctive()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseDynamicPrecedenceInDisjunctive

(

)

Whether we try to branch on decision "interval A before interval B" rather
than on intervals bounds. This usually works better, but slow down a bit
the time to find the first solution.

These parameters are still EXPERIMENTAL, the result should be correct, but
it some corner cases, they can cause some failing CHECK in the solver.

optional bool use_dynamic_precedence_in_disjunctive = 263 [default = false];

Returns

Whether the useDynamicPrecedenceInDisjunctive field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 26472 of file SatParameters.java.

hasUseEnergeticReasoningInNoOverlap2D()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseEnergeticReasoningInNoOverlap2D

(

)

When this is true, the no_overlap_2d constraint is reinforced with
energetic reasoning. This additional level supplements the default level of
reasoning.

optional bool use_energetic_reasoning_in_no_overlap_2d = 213 [default = false];

Returns

Whether the useEnergeticReasoningInNoOverlap2d field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 27165 of file SatParameters.java.

hasUseErwaHeuristic()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseErwaHeuristic

(

)

Whether we use the ERWA (Exponential Recency Weighted Average) heuristic as
described in "Learning Rate Based Branching Heuristic for SAT solvers",
J.H.Liang, V. Ganesh, P. Poupart, K.Czarnecki, SAT 2016.

optional bool use_erwa_heuristic = 75 [default = false];

Returns

Whether the useErwaHeuristic field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 18510 of file SatParameters.java.

hasUseExactLpReason()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseExactLpReason

(

)

The solver usually exploit the LP relaxation of a model. If this option is
true, then whatever is infered by the LP will be used like an heuristic to
compute EXACT propagation on the IP. So with this option, there is no
numerical imprecision issues.

optional bool use_exact_lp_reason = 109 [default = true];

Returns

Whether the useExactLpReason field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 31216 of file SatParameters.java.

hasUseExtendedProbing()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseExtendedProbing

(

)

Use extended probing (probe bool_or, at_most_one, exactly_one).

optional bool use_extended_probing = 269 [default = true];

Returns

Whether the useExtendedProbing field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 27709 of file SatParameters.java.

hasUseFeasibilityJump()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseFeasibilityJump

(

)

Parameters for an heuristic similar to the one described in the paper:
"Feasibility Jump: an LP-free Lagrangian MIP heuristic", Bjørnar
Luteberget, Giorgio Sartor, 2023, Mathematical Programming Computation.

optional bool use_feasibility_jump = 265 [default = true];

Returns

Whether the useFeasibilityJump field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 28615 of file SatParameters.java.

hasUseFeasibilityPump()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseFeasibilityPump

(

)

Adds a feasibility pump subsolver along with lns subsolvers.

optional bool use_feasibility_pump = 164 [default = true];

Returns

Whether the useFeasibilityPump field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 30739 of file SatParameters.java.

hasUseHardPrecedencesInCumulative()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseHardPrecedencesInCumulative

(

)

If true, detect and create constraint for integer variable that are "after"
a set of intervals in the same cumulative constraint.

Experimental: by default we just use "direct" precedences. If
exploit_all_precedences is true, we explore the full precedence graph. This
assumes we have a DAG otherwise it fails.

optional bool use_hard_precedences_in_cumulative = 215 [default = false];

Returns

Whether the useHardPrecedencesInCumulative field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 26888 of file SatParameters.java.

hasUseImpliedBounds()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseImpliedBounds

(

)

Stores and exploits "implied-bounds" in the solver. That is, relations of
the form literal => (var >= bound). This is currently used to derive
stronger cuts.

optional bool use_implied_bounds = 144 [default = true];

Returns

Whether the useImpliedBounds field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 31471 of file SatParameters.java.

hasUseLbRelaxLns()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseLbRelaxLns

(

)

Turns on neighborhood generator based on local branching LP. Based on Huang
et al., "Local Branching Relaxation Heuristics for Integer Linear
Programs", 2023.

optional bool use_lb_relax_lns = 255 [default = false];

Returns

Whether the useLbRelaxLns field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 30797 of file SatParameters.java.

hasUseLns()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseLns

(

)

Testing parameters used to disable all lns workers.

optional bool use_lns = 283 [default = true];

Returns

Whether the useLns field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 30507 of file SatParameters.java.

hasUseLnsOnly()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseLnsOnly

(

)

Experimental parameters to disable everything but lns.

optional bool use_lns_only = 101 [default = false];

Returns

Whether the useLnsOnly field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 30563 of file SatParameters.java.

hasUseLsOnly()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseLsOnly

(

)

Disable every other type of subsolver, setting this turns CP-SAT into a
pure local-search solver.

optional bool use_ls_only = 240 [default = false];

Returns

Whether the useLsOnly field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 28678 of file SatParameters.java.

hasUseObjectiveLbSearch()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseObjectiveLbSearch

(

)

If true, search will search in ascending max objective value (when
minimizing) starting from the lower bound of the objective.

optional bool use_objective_lb_search = 228 [default = false];

Returns

Whether the useObjectiveLbSearch field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 28010 of file SatParameters.java.

hasUseObjectiveShavingSearch()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseObjectiveShavingSearch

(

)

This search differs from the previous search as it will not use assumptions
to bound the objective, and it will recreate a full model with the
hardcoded objective value.

optional bool use_objective_shaving_search = 253 [default = false];

Returns

Whether the useObjectiveShavingSearch field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 28071 of file SatParameters.java.

hasUseOptimizationHints()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseOptimizationHints

(

)

For an optimization problem, whether we follow some hints in order to find
a better first solution. For a variable with hint, the solver will always
try to follow the hint. It will revert to the variable_branching default
otherwise.

optional bool use_optimization_hints = 35 [default = true];

Returns

Whether the useOptimizationHints field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 25762 of file SatParameters.java.

hasUseOptionalVariables()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseOptionalVariables

(

)

If true, we automatically detect variables whose constraint are always
enforced by the same literal and we mark them as optional. This allows
to propagate them as if they were present in some situation.

TODO(user): This is experimental and seems to lead to wrong optimal in
some situation. It should however gives correct solutions. Fix.

optional bool use_optional_variables = 108 [default = false];

Returns

Whether the useOptionalVariables field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 31142 of file SatParameters.java.

hasUseOverloadCheckerInCumulative()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseOverloadCheckerInCumulative

(

)

When this is true, the cumulative constraint is reinforced with overload
checking, i.e., an additional level of reasoning based on energy. This
additional level supplements the default level of reasoning as well as
timetable edge finding.

This always result in better propagation, but it is usually slow, so
depending on the problem, turning this off may lead to a faster solution.

optional bool use_overload_checker_in_cumulative = 78 [default = false];

Returns

Whether the useOverloadCheckerInCumulative field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 26589 of file SatParameters.java.

hasUsePbResolution()

boolean com.google.ortools.sat.SatParameters.Builder.hasUsePbResolution

(

)

Whether to use pseudo-Boolean resolution to analyze a conflict. Note that
this option only make sense if your problem is modelized using
pseudo-Boolean constraints. If you only have clauses, this shouldn't change
anything (except slow the solver down).

optional bool use_pb_resolution = 43 [default = false];

Returns

Whether the usePbResolution field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 21477 of file SatParameters.java.

hasUsePhaseSaving()

boolean com.google.ortools.sat.SatParameters.Builder.hasUsePhaseSaving

(

)

If this is true, then the polarity of a variable will be the last value it
was assigned to, or its default polarity if it was never assigned since the
call to ResetDecisionHeuristic().

Actually, we use a newer version where we follow the last value in the
longest non-conflicting partial assignment in the current phase.

This is called 'literal phase saving'. For details see 'A Lightweight
Component Caching Scheme for Satisfiability Solvers' K. Pipatsrisawat and
A.Darwiche, In 10th International Conference on Theory and Applications of
Satisfiability Testing, 2007.

optional bool use_phase_saving = 44 [default = true];

Returns

Whether the usePhaseSaving field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 18222 of file SatParameters.java.

hasUsePrecedencesInDisjunctiveConstraint()

boolean com.google.ortools.sat.SatParameters.Builder.hasUsePrecedencesInDisjunctiveConstraint

(

)

When this is true, then a disjunctive constraint will try to use the
precedence relations between time intervals to propagate their bounds
further. For instance if task A and B are both before C and task A and B
are in disjunction, then we can deduce that task C must start after
duration(A) + duration(B) instead of simply max(duration(A), duration(B)),
provided that the start time for all task was currently zero.

This always result in better propagation, but it is usually slow, so
depending on the problem, turning this off may lead to a faster solution.

optional bool use_precedences_in_disjunctive_constraint = 74 [default = true];

Returns

Whether the usePrecedencesInDisjunctiveConstraint field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 26259 of file SatParameters.java.

hasUseProbingSearch()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseProbingSearch

(

)

If true, search will continuously probe Boolean variables, and integer
variable bounds. This parameter is set to true in parallel on the probing
worker.

optional bool use_probing_search = 176 [default = false];

Returns

Whether the useProbingSearch field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 27647 of file SatParameters.java.

hasUseRinsLns()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseRinsLns

(

)

Turns on relaxation induced neighborhood generator.

optional bool use_rins_lns = 129 [default = true];

Returns

Whether the useRinsLns field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 30683 of file SatParameters.java.

hasUseSatInprocessing()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseSatInprocessing

(

)

Enable or disable "inprocessing" which is some SAT presolving done at
each restart to the root level.

optional bool use_sat_inprocessing = 163 [default = true];

Returns

Whether the useSatInprocessing field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 23515 of file SatParameters.java.

hasUseSharedTreeSearch()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseSharedTreeSearch

(

)

Set on shared subtree workers. Users should not set this directly.

optional bool use_shared_tree_search = 236 [default = false];

Returns

Whether the useSharedTreeSearch field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 29473 of file SatParameters.java.

hasUseShavingInProbingSearch()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseShavingInProbingSearch

(

)

Add a shaving phase (where the solver tries to prove that the lower or
upper bound of a variable are infeasible) to the probing search.

optional bool use_shaving_in_probing_search = 204 [default = true];

Returns

Whether the useShavingInProbingSearch field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 27822 of file SatParameters.java.

hasUseStrongPropagationInDisjunctive()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseStrongPropagationInDisjunctive

(

)

Enable stronger and more expensive propagation on no_overlap constraint.

optional bool use_strong_propagation_in_disjunctive = 230 [default = false];

Returns

Whether the useStrongPropagationInDisjunctive field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 26411 of file SatParameters.java.

hasUseTimetableEdgeFindingInCumulative()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseTimetableEdgeFindingInCumulative

(

)

When this is true, the cumulative constraint is reinforced with timetable
edge finding, i.e., an additional level of reasoning based on the
conjunction of energy and mandatory parts. This additional level
supplements the default level of reasoning as well as overload_checker.

This always result in better propagation, but it is usually slow, so
depending on the problem, turning this off may lead to a faster solution.

optional bool use_timetable_edge_finding_in_cumulative = 79 [default = false];

Returns

Whether the useTimetableEdgeFindingInCumulative field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 26749 of file SatParameters.java.

hasUseTimetablingInNoOverlap2D()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseTimetablingInNoOverlap2D

(

)

When this is true, the no_overlap_2d constraint is reinforced with
propagators from the cumulative constraints. It consists of ignoring the
position of rectangles in one position and projecting the no_overlap_2d on
the other dimension to create a cumulative constraint. This is done on both
axis. This additional level supplements the default level of reasoning.

optional bool use_timetabling_in_no_overlap_2d = 200 [default = false];

Returns

Whether the useTimetablingInNoOverlap2d field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 27095 of file SatParameters.java.

hasUseVariablesShavingSearch()

boolean com.google.ortools.sat.SatParameters.Builder.hasUseVariablesShavingSearch

(

)

This search takes all Boolean or integer variables, and maximize or
minimize them in order to reduce their domain.

optional bool use_variables_shaving_search = 289 [default = false];

Returns

Whether the useVariablesShavingSearch field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 28134 of file SatParameters.java.

hasVariableActivityDecay()

boolean com.google.ortools.sat.SatParameters.Builder.hasVariableActivityDecay

(

)

Each time a conflict is found, the activities of some variables are
increased by one. Then, the activity of all variables are multiplied by
variable_activity_decay.

To implement this efficiently, the activity of all the variables is not
decayed at each conflict. Instead, the activity increment is multiplied by
1 / decay. When an activity reach max_variable_activity_value, all the
activity are multiplied by 1 / max_variable_activity_value.

optional double variable_activity_decay = 15 [default = 0.8];

Returns

Whether the variableActivityDecay field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 19295 of file SatParameters.java.

hasViolationLsCompoundMoveProbability()

boolean com.google.ortools.sat.SatParameters.Builder.hasViolationLsCompoundMoveProbability

(

)

Probability of using compound move search each restart.
TODO(user): Add reference to paper when published.

optional double violation_ls_compound_move_probability = 259 [default = 0.5];

Returns

Whether the violationLsCompoundMoveProbability field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 29342 of file SatParameters.java.

hasViolationLsPerturbationPeriod()

boolean com.google.ortools.sat.SatParameters.Builder.hasViolationLsPerturbationPeriod

(

)

How long violation_ls should wait before perturbating a solution.

optional int32 violation_ls_perturbation_period = 249 [default = 100];

Returns

Whether the violationLsPerturbationPeriod field is set.

Implements com.google.ortools.sat.SatParametersOrBuilder.

Definition at line 29285 of file SatParameters.java.

internalGetFieldAccessorTable()

com.google.protobuf.GeneratedMessage.FieldAccessorTable com.google.ortools.sat.SatParameters.Builder.internalGetFieldAccessorTable ( )

protected

Definition at line 14397 of file SatParameters.java.

isInitialized()

final boolean com.google.ortools.sat.SatParameters.Builder.isInitialized

(

)

Definition at line 16611 of file SatParameters.java.

mergeFrom() [1/3]

Builder com.google.ortools.sat.SatParameters.Builder.mergeFrom

(

com.google.ortools.sat.SatParameters

other

)

Definition at line 15795 of file SatParameters.java.

mergeFrom() [2/3]

Builder com.google.ortools.sat.SatParameters.Builder.mergeFrom	(	com.google.protobuf.CodedInputStream	input,
		com.google.protobuf.ExtensionRegistryLite	extensionRegistry ) throws java.io.IOException

Definition at line 16616 of file SatParameters.java.

mergeFrom() [3/3]

Builder com.google.ortools.sat.SatParameters.Builder.mergeFrom

(

com.google.protobuf.Message

other

)

Definition at line 15786 of file SatParameters.java.

removeSubsolverParams()

Builder com.google.ortools.sat.SatParameters.Builder.removeSubsolverParams

(

int

index

)

It is possible to specify additional subsolver configuration. These can be
referred by their params.name() in the fields above. Note that only the
specified field will "overwrite" the ones of the base parameter. If a
subsolver_params has the name of an existing subsolver configuration, the
named parameters will be merged into the subsolver configuration.

repeated .operations_research.sat.SatParameters subsolver_params = 210;

Definition at line 25102 of file SatParameters.java.

setAbsoluteGapLimit()

Builder com.google.ortools.sat.SatParameters.Builder.setAbsoluteGapLimit

(

double

value

)

Stop the search when the gap between the best feasible objective (O) and
our best objective bound (B) is smaller than a limit.
The exact definition is:
- Absolute: abs(O - B)
- Relative: abs(O - B) / max(1, abs(O)).

Important: The relative gap depends on the objective offset! If you
artificially shift the objective, you will get widely different value of
the relative gap.

Note that if the gap is reached, the search status will be OPTIMAL. But
one can check the best objective bound to see the actual gap.

If the objective is integer, then any absolute gap < 1 will lead to a true
optimal. If the objective is floating point, a gap of zero make little
sense so is is why we use a non-zero default value. At the end of the
search, we will display a warning if OPTIMAL is reported yet the gap is
greater than this absolute gap.

optional double absolute_gap_limit = 159 [default = 0.0001];

Parameters

value

The absoluteGapLimit to set.

Returns

This builder for chaining.

Definition at line 20809 of file SatParameters.java.

setAddCgCuts()

Builder com.google.ortools.sat.SatParameters.Builder.setAddCgCuts

(

boolean

value

)

Whether we generate and add Chvatal-Gomory cuts to the LP at root node.
Note that for now, this is not heavily tuned.

optional bool add_cg_cuts = 117 [default = true];

Parameters

value

The addCgCuts to set.

Returns

This builder for chaining.

Definition at line 32472 of file SatParameters.java.

setAddCliqueCuts()

Builder com.google.ortools.sat.SatParameters.Builder.setAddCliqueCuts

(

boolean

value

)

Whether we generate clique cuts from the binary implication graph. Note
that as the search goes on, this graph will contains new binary clauses
learned by the SAT engine.

optional bool add_clique_cuts = 172 [default = true];

Parameters

value

The addCliqueCuts to set.

Returns

This builder for chaining.

Definition at line 32655 of file SatParameters.java.

setAddLinMaxCuts()

Builder com.google.ortools.sat.SatParameters.Builder.setAddLinMaxCuts

(

boolean

value

)

For the lin max constraints, generates the cuts described in "Strong
mixed-integer programming formulations for trained neural networks" by Ross
Anderson et. (https://arxiv.org/pdf/1811.01988.pdf)

optional bool add_lin_max_cuts = 152 [default = true];

Parameters

value

The addLinMaxCuts to set.

Returns

This builder for chaining.

Definition at line 32843 of file SatParameters.java.

setAddLpConstraintsLazily()

Builder com.google.ortools.sat.SatParameters.Builder.setAddLpConstraintsLazily

(

boolean

value

)

If true, we start by an empty LP, and only add constraints not satisfied
by the current LP solution batch by batch. A constraint that is only added
like this is known as a "lazy" constraint in the literature, except that we
currently consider all constraints as lazy here.

optional bool add_lp_constraints_lazily = 112 [default = true];

Parameters

value

The addLpConstraintsLazily to set.

Returns

This builder for chaining.

Definition at line 32994 of file SatParameters.java.

setAddMirCuts()

Builder com.google.ortools.sat.SatParameters.Builder.setAddMirCuts

(

boolean

value

)

Whether we generate MIR cuts at root node.
Note that for now, this is not heavily tuned.

optional bool add_mir_cuts = 120 [default = true];

Parameters

value

The addMirCuts to set.

Returns

This builder for chaining.

Definition at line 32532 of file SatParameters.java.

setAddObjectiveCut()

Builder com.google.ortools.sat.SatParameters.Builder.setAddObjectiveCut

(

boolean

value

)

When the LP objective is fractional, do we add the cut that forces the
linear objective expression to be greater or equal to this fractional value
rounded up? We can always do that since our objective is integer, and
combined with MIR heuristic to reduce the coefficient of such cut, it can
help.

optional bool add_objective_cut = 197 [default = false];

Parameters

value

The addObjectiveCut to set.

Returns

This builder for chaining.

Definition at line 32409 of file SatParameters.java.

setAddRltCuts()

Builder com.google.ortools.sat.SatParameters.Builder.setAddRltCuts

(

boolean

value

)

Whether we generate RLT cuts. This is still experimental but can help on
binary problem with a lot of clauses of size 3.

optional bool add_rlt_cuts = 279 [default = true];

Parameters

value

The addRltCuts to set.

Returns

This builder for chaining.

Definition at line 32716 of file SatParameters.java.

setAddZeroHalfCuts()

Builder com.google.ortools.sat.SatParameters.Builder.setAddZeroHalfCuts

(

boolean

value

)

Whether we generate Zero-Half cuts at root node.
Note that for now, this is not heavily tuned.

optional bool add_zero_half_cuts = 169 [default = true];

Parameters

value

The addZeroHalfCuts to set.

Returns

This builder for chaining.

Definition at line 32592 of file SatParameters.java.

setAlsoBumpVariablesInConflictReasons()

Builder com.google.ortools.sat.SatParameters.Builder.setAlsoBumpVariablesInConflictReasons

(

boolean

value

)

When this is true, then the variables that appear in any of the reason of
the variables in a conflict have their activity bumped. This is addition to
the variables in the conflict, and the one that were used during conflict
resolution.

optional bool also_bump_variables_in_conflict_reasons = 77 [default = false];

Parameters

value

The alsoBumpVariablesInConflictReasons to set.

Returns

This builder for chaining.

Definition at line 18681 of file SatParameters.java.

setAtMostOneMaxExpansionSize()

Builder com.google.ortools.sat.SatParameters.Builder.setAtMostOneMaxExpansionSize

(

int

value

)

All at_most_one constraints with a size <= param will be replaced by a
quadratic number of binary implications.

optional int32 at_most_one_max_expansion_size = 270 [default = 3];

Parameters

value

The atMostOneMaxExpansionSize to set.

Returns

This builder for chaining.

Definition at line 31372 of file SatParameters.java.

setAutoDetectGreaterThanAtLeastOneOf()

Builder com.google.ortools.sat.SatParameters.Builder.setAutoDetectGreaterThanAtLeastOneOf

(

boolean

value

)

If true, then the precedences propagator try to detect for each variable if
it has a set of "optional incoming arc" for which at least one of them is
present. This is usually useful to have but can be slow on model with a lot
of precedence.

optional bool auto_detect_greater_than_at_least_one_of = 95 [default = true];

Parameters

value

The autoDetectGreaterThanAtLeastOneOf to set.

Returns

This builder for chaining.

Definition at line 30316 of file SatParameters.java.

setBinaryMinimizationAlgorithm()

Builder com.google.ortools.sat.SatParameters.Builder.setBinaryMinimizationAlgorithm

(

com.google.ortools.sat.SatParameters.BinaryMinizationAlgorithm

value

)

optional .operations_research.sat.SatParameters.BinaryMinizationAlgorithm binary_minimization_algorithm = 34 [default = BINARY_MINIMIZATION_FIRST];

Parameters

value

The binaryMinimizationAlgorithm to set.

Returns

This builder for chaining.

Definition at line 18770 of file SatParameters.java.

setBinarySearchNumConflicts()

Builder com.google.ortools.sat.SatParameters.Builder.setBinarySearchNumConflicts

(

int

value

)

If non-negative, perform a binary search on the objective variable in order
to find an [min, max] interval outside of which the solver proved unsat/sat
under this amount of conflict. This can quickly reduce the objective domain
on some problems.

optional int32 binary_search_num_conflicts = 99 [default = -1];

Parameters

value

The binarySearchNumConflicts to set.

Returns

This builder for chaining.

Definition at line 28502 of file SatParameters.java.

setBlockingRestartMultiplier()

Builder com.google.ortools.sat.SatParameters.Builder.setBlockingRestartMultiplier

(

double

value

)

optional double blocking_restart_multiplier = 66 [default = 1.4];

Parameters

value

The blockingRestartMultiplier to set.

Returns

This builder for chaining.

Definition at line 20242 of file SatParameters.java.

setBlockingRestartWindowSize()

Builder com.google.ortools.sat.SatParameters.Builder.setBlockingRestartWindowSize

(

int

value

)

optional int32 blocking_restart_window_size = 65 [default = 5000];

Parameters

value

The blockingRestartWindowSize to set.

Returns

This builder for chaining.

Definition at line 20202 of file SatParameters.java.

setBooleanEncodingLevel()

Builder com.google.ortools.sat.SatParameters.Builder.setBooleanEncodingLevel

(

int

value

)

A non-negative level indicating how much we should try to fully encode
Integer variables as Boolean.

optional int32 boolean_encoding_level = 107 [default = 1];

Parameters

value

The booleanEncodingLevel to set.

Returns

This builder for chaining.

Definition at line 32076 of file SatParameters.java.

setCatchSigintSignal()

Builder com.google.ortools.sat.SatParameters.Builder.setCatchSigintSignal

(

boolean

value

)

Indicates if the CP-SAT layer should catch Control-C (SIGINT) signals
when calling solve. If set, catching the SIGINT signal will terminate the
search gracefully, as if a time limit was reached.

optional bool catch_sigint_signal = 135 [default = true];

Parameters

value

The catchSigintSignal to set.

Returns

This builder for chaining.

Definition at line 31435 of file SatParameters.java.

setClauseActivityDecay()

Builder com.google.ortools.sat.SatParameters.Builder.setClauseActivityDecay

(

double

value

)

Clause activity parameters (same effect as the one on the variables).

optional double clause_activity_decay = 17 [default = 0.999];

Parameters

value

The clauseActivityDecay to set.

Returns

This builder for chaining.

Definition at line 19588 of file SatParameters.java.

setClauseCleanupLbdBound()

Builder com.google.ortools.sat.SatParameters.Builder.setClauseCleanupLbdBound

(

int

value

)

All the clauses with a LBD (literal blocks distance) lower or equal to this
parameters will always be kept.

optional int32 clause_cleanup_lbd_bound = 59 [default = 5];

Parameters

value

The clauseCleanupLbdBound to set.

Returns

This builder for chaining.

Definition at line 19117 of file SatParameters.java.

setClauseCleanupOrdering()

Builder com.google.ortools.sat.SatParameters.Builder.setClauseCleanupOrdering

(

com.google.ortools.sat.SatParameters.ClauseOrdering

value

)

optional .operations_research.sat.SatParameters.ClauseOrdering clause_cleanup_ordering = 60 [default = CLAUSE_ACTIVITY];

Parameters

value

The clauseCleanupOrdering to set.

Returns

This builder for chaining.

Definition at line 19162 of file SatParameters.java.

setClauseCleanupPeriod()

Builder com.google.ortools.sat.SatParameters.Builder.setClauseCleanupPeriod

(

int

value

)

Trigger a cleanup when this number of "deletable" clauses is learned.

optional int32 clause_cleanup_period = 11 [default = 10000];

Parameters

value

The clauseCleanupPeriod to set.

Returns

This builder for chaining.

Definition at line 18892 of file SatParameters.java.

setClauseCleanupProtection()

Builder com.google.ortools.sat.SatParameters.Builder.setClauseCleanupProtection

(

com.google.ortools.sat.SatParameters.ClauseProtection

value

)

optional .operations_research.sat.SatParameters.ClauseProtection clause_cleanup_protection = 58 [default = PROTECTION_NONE];

Parameters

value

The clauseCleanupProtection to set.

Returns

This builder for chaining.

Definition at line 19060 of file SatParameters.java.

setClauseCleanupRatio()

Builder com.google.ortools.sat.SatParameters.Builder.setClauseCleanupRatio

(

double

value

)

During a cleanup, if clause_cleanup_target is 0, we will delete the
clause_cleanup_ratio of "deletable" clauses instead of aiming for a fixed
target of clauses to keep.

optional double clause_cleanup_ratio = 190 [default = 0.5];

Parameters

value

The clauseCleanupRatio to set.

Returns

This builder for chaining.

Definition at line 19014 of file SatParameters.java.

setClauseCleanupTarget()

Builder com.google.ortools.sat.SatParameters.Builder.setClauseCleanupTarget

(

int

value

)

During a cleanup, we will always keep that number of "deletable" clauses.
Note that this doesn't include the "protected" clauses.

optional int32 clause_cleanup_target = 13 [default = 0];

Parameters

value

The clauseCleanupTarget to set.

Returns

This builder for chaining.

Definition at line 18951 of file SatParameters.java.

setConvertIntervals()

Builder com.google.ortools.sat.SatParameters.Builder.setConvertIntervals

(

boolean

value

)

Temporary flag util the feature is more mature. This convert intervals to
the newer proto format that support affine start/var/end instead of just
variables.

optional bool convert_intervals = 177 [default = true];

Parameters

value

The convertIntervals to set.

Returns

This builder for chaining.

Definition at line 31743 of file SatParameters.java.

setCoreMinimizationLevel()

Builder com.google.ortools.sat.SatParameters.Builder.setCoreMinimizationLevel

(

int

value

)

If positive, we spend some effort on each core:
- At level 1, we use a simple heuristic to try to minimize an UNSAT core.
- At level 2, we use propagation to minimize the core but also identify
literal in at most one relationship in this core.

optional int32 core_minimization_level = 50 [default = 2];

Parameters

value

The coreMinimizationLevel to set.

Returns

This builder for chaining.

Definition at line 25860 of file SatParameters.java.

setCountAssumptionLevelsInLbd()

Builder com.google.ortools.sat.SatParameters.Builder.setCountAssumptionLevelsInLbd

(

boolean

value

)

Whether or not the assumption levels are taken into account during the LBD
computation. According to the reference below, not counting them improves
the solver in some situation. Note that this only impact solves under
assumptions.

Gilles Audemard, Jean-Marie Lagniez, Laurent Simon, "Improving Glucose for
Incremental SAT Solving with Assumptions: Application to MUS Extraction"
Theory and Applications of Satisfiability Testing - SAT 2013, Lecture Notes
in Computer Science Volume 7962, 2013, pp 309-317.

optional bool count_assumption_levels_in_lbd = 49 [default = true];

Parameters

value

The countAssumptionLevelsInLbd to set.

Returns

This builder for chaining.

Definition at line 21658 of file SatParameters.java.

setCoverOptimization()

Builder com.google.ortools.sat.SatParameters.Builder.setCoverOptimization

(

boolean

value

)

If true, when the max-sat algo find a core, we compute the minimal number
of literals in the core that needs to be true to have a feasible solution.
This is also called core exhaustion in more recent max-SAT papers.

optional bool cover_optimization = 89 [default = true];

Parameters

value

The coverOptimization to set.

Returns

This builder for chaining.

Definition at line 25985 of file SatParameters.java.

setCpModelPresolve()

Builder com.google.ortools.sat.SatParameters.Builder.setCpModelPresolve

(

boolean

value

)

Whether we presolve the cp_model before solving it.

optional bool cp_model_presolve = 86 [default = true];

Parameters

value

The cpModelPresolve to set.

Returns

This builder for chaining.

Definition at line 22206 of file SatParameters.java.

setCpModelProbingLevel()

Builder com.google.ortools.sat.SatParameters.Builder.setCpModelProbingLevel

(

int

value

)

How much effort do we spend on probing. 0 disables it completely.

optional int32 cp_model_probing_level = 110 [default = 2];

Parameters

value

The cpModelProbingLevel to set.

Returns

This builder for chaining.

Definition at line 22262 of file SatParameters.java.

setCpModelUseSatPresolve()

Builder com.google.ortools.sat.SatParameters.Builder.setCpModelUseSatPresolve

(

boolean

value

)

Whether we also use the sat presolve when cp_model_presolve is true.

optional bool cp_model_use_sat_presolve = 93 [default = true];

Parameters

value

The cpModelUseSatPresolve to set.

Returns

This builder for chaining.

Definition at line 22318 of file SatParameters.java.

setCutActiveCountDecay()

Builder com.google.ortools.sat.SatParameters.Builder.setCutActiveCountDecay

(

double

value

)

optional double cut_active_count_decay = 156 [default = 0.8];

Parameters

value

The cutActiveCountDecay to set.

Returns

This builder for chaining.

Definition at line 33365 of file SatParameters.java.

setCutCleanupTarget()

Builder com.google.ortools.sat.SatParameters.Builder.setCutCleanupTarget

(

int

value

)

Target number of constraints to remove during cleanup.

optional int32 cut_cleanup_target = 157 [default = 1000];

Parameters

value

The cutCleanupTarget to set.

Returns

This builder for chaining.

Definition at line 33417 of file SatParameters.java.

setCutLevel()

Builder com.google.ortools.sat.SatParameters.Builder.setCutLevel

(

int

value

)

Control the global cut effort. Zero will turn off all cut. For now we just
have one level. Note also that most cuts are only used at linearization
level >= 2.

optional int32 cut_level = 196 [default = 1];

Parameters

value

The cutLevel to set.

Returns

This builder for chaining.

Definition at line 32279 of file SatParameters.java.

setCutMaxActiveCountValue()

Builder com.google.ortools.sat.SatParameters.Builder.setCutMaxActiveCountValue

(

double

value

)

These parameters are similar to sat clause management activity parameters.
They are effective only if the number of generated cuts exceed the storage
limit. Default values are based on a few experiments on miplib instances.

optional double cut_max_active_count_value = 155 [default = 10000000000];

Parameters

value

The cutMaxActiveCountValue to set.

Returns

This builder for chaining.

Definition at line 33319 of file SatParameters.java.

setDebugCrashOnBadHint()

Builder com.google.ortools.sat.SatParameters.Builder.setDebugCrashOnBadHint

(

boolean

value

)

Crash if we do not manage to complete the hint into a full solution.

optional bool debug_crash_on_bad_hint = 195 [default = false];

Parameters

value

The debugCrashOnBadHint to set.

Returns

This builder for chaining.

Definition at line 25727 of file SatParameters.java.

setDebugMaxNumPresolveOperations()

Builder com.google.ortools.sat.SatParameters.Builder.setDebugMaxNumPresolveOperations

(

int

value

)

If positive, try to stop just after that many presolve rules have been
applied. This is mainly useful for debugging presolve.

optional int32 debug_max_num_presolve_operations = 151 [default = 0];

Parameters

value

The debugMaxNumPresolveOperations to set.

Returns

This builder for chaining.

Definition at line 25670 of file SatParameters.java.

setDebugPostsolveWithFullSolver()

Builder com.google.ortools.sat.SatParameters.Builder.setDebugPostsolveWithFullSolver

(

boolean

value

)

We have two different postsolve code. The default one should be better and
it allows for a more powerful presolve, but it can be useful to postsolve
using the full solver instead.

optional bool debug_postsolve_with_full_solver = 162 [default = false];

Parameters

value

The debugPostsolveWithFullSolver to set.

Returns

This builder for chaining.

Definition at line 25609 of file SatParameters.java.

setDefaultRestartAlgorithms()

Builder com.google.ortools.sat.SatParameters.Builder.setDefaultRestartAlgorithms

(

java.lang.String

value

)

optional string default_restart_algorithms = 70 [default = "LUBY_RESTART,LBD_MOVING_AVERAGE_RESTART,DL_MOVING_AVERAGE_RESTART"];

Parameters

value

The defaultRestartAlgorithms to set.

Returns

This builder for chaining.

Definition at line 19868 of file SatParameters.java.

setDefaultRestartAlgorithmsBytes()

Builder com.google.ortools.sat.SatParameters.Builder.setDefaultRestartAlgorithmsBytes

(

com.google.protobuf.ByteString

value

)

optional string default_restart_algorithms = 70 [default = "LUBY_RESTART,LBD_MOVING_AVERAGE_RESTART,DL_MOVING_AVERAGE_RESTART"];

Parameters

value

The bytes for defaultRestartAlgorithms to set.

Returns

This builder for chaining.

Definition at line 19891 of file SatParameters.java.

setDetectLinearizedProduct()

Builder com.google.ortools.sat.SatParameters.Builder.setDetectLinearizedProduct

(

boolean

value

)

Infer products of Boolean or of Boolean time IntegerVariable from the
linear constrainst in the problem. This can be used in some cuts, altough
for now we don't really exploit it.

optional bool detect_linearized_product = 277 [default = false];

Parameters

value

The detectLinearizedProduct to set.

Returns

This builder for chaining.

Definition at line 33851 of file SatParameters.java.

setDetectTableWithCost()

Builder com.google.ortools.sat.SatParameters.Builder.setDetectTableWithCost

(

boolean

value

)

If true, we detect variable that are unique to a table constraint and only
there to encode a cost on each tuple. This is usually the case when a WCSP
(weighted constraint program) is encoded into CP-SAT format.

This can lead to a dramatic speed-up for such problems but is still
experimental at this point.

optional bool detect_table_with_cost = 216 [default = false];

Parameters

value

The detectTableWithCost to set.

Returns

This builder for chaining.

Definition at line 22389 of file SatParameters.java.

setDisableConstraintExpansion()

Builder com.google.ortools.sat.SatParameters.Builder.setDisableConstraintExpansion

(

boolean

value

)

If true, it disable all constraint expansion.
This should only be used to test the presolve of expanded constraints.

optional bool disable_constraint_expansion = 181 [default = false];

Parameters

value

The disableConstraintExpansion to set.

Returns

This builder for chaining.

Definition at line 22877 of file SatParameters.java.

setDiversifyLnsParams()

Builder com.google.ortools.sat.SatParameters.Builder.setDiversifyLnsParams

(

boolean

value

)

If true, registers more lns subsolvers with different parameters.

optional bool diversify_lns_params = 137 [default = false];

Parameters

value

The diversifyLnsParams to set.

Returns

This builder for chaining.

Definition at line 30925 of file SatParameters.java.

setEncodeComplexLinearConstraintWithInteger()

Builder com.google.ortools.sat.SatParameters.Builder.setEncodeComplexLinearConstraintWithInteger

(

boolean

value

)

Linear constraint with a complex right hand side (more than a single
interval) need to be expanded, there is a couple of way to do that.

optional bool encode_complex_linear_constraint_with_integer = 223 [default = false];

Parameters

value

The encodeComplexLinearConstraintWithInteger to set.

Returns

This builder for chaining.

Definition at line 22937 of file SatParameters.java.

setEncodeCumulativeAsReservoir()

Builder com.google.ortools.sat.SatParameters.Builder.setEncodeCumulativeAsReservoir

(

boolean

value

)

Encore cumulative with fixed demands and capacity as a reservoir
constraint. The only reason you might want to do that is to test the
reservoir propagation code!

optional bool encode_cumulative_as_reservoir = 287 [default = false];

Parameters

value

The encodeCumulativeAsReservoir to set.

Returns

This builder for chaining.

Definition at line 22744 of file SatParameters.java.

setEnumerateAllSolutions()

Builder com.google.ortools.sat.SatParameters.Builder.setEnumerateAllSolutions

(

boolean

value

)

Whether we enumerate all solutions of a problem without objective. Note
that setting this to true automatically disable some presolve reduction
that can remove feasible solution. That is it has the same effect as
setting keep_all_feasible_solutions_in_presolve.

TODO(user): Do not do that and let the user choose what behavior is best by
setting keep_all_feasible_solutions_in_presolve ?

optional bool enumerate_all_solutions = 87 [default = false];

Parameters

value

The enumerateAllSolutions to set.

Returns

This builder for chaining.

Definition at line 29929 of file SatParameters.java.

setExpandAlldiffConstraints()

Builder com.google.ortools.sat.SatParameters.Builder.setExpandAlldiffConstraints

(

boolean

value

)

If true, expand all_different constraints that are not permutations.
Permutations (#Variables = #Values) are always expanded.

optional bool expand_alldiff_constraints = 170 [default = false];

Parameters

value

The expandAlldiffConstraints to set.

Returns

This builder for chaining.

Definition at line 22521 of file SatParameters.java.

setExpandReservoirConstraints()

Builder com.google.ortools.sat.SatParameters.Builder.setExpandReservoirConstraints

(

boolean

value

)

If true, expand the reservoir constraints by creating booleans for all
possible precedences between event and encoding the constraint.

optional bool expand_reservoir_constraints = 182 [default = true];

Parameters

value

The expandReservoirConstraints to set.

Returns

This builder for chaining.

Definition at line 22581 of file SatParameters.java.

setExpandReservoirUsingCircuit()

Builder com.google.ortools.sat.SatParameters.Builder.setExpandReservoirUsingCircuit

(

boolean

value

)

Mainly useful for testing.

If this and expand_reservoir_constraints is true, we use a different
encoding of the reservoir constraint using circuit instead of precedences.
Note that this is usually slower, but can exercise different part of the
solver. Note that contrary to the precedence encoding, this easily support
variable demands.

WARNING: with this encoding, the constraint take a slighlty different
meaning. The level must be within the reservoir for any permutation of the
events. So we cannot have +100 and -100 at the same time if the maximum
level is 10 (as autorized by the reservoir constraint).

optional bool expand_reservoir_using_circuit = 288 [default = false];

Parameters

value

The expandReservoirUsingCircuit to set.

Returns

This builder for chaining.

Definition at line 22671 of file SatParameters.java.

setExploitAllLpSolution()

Builder com.google.ortools.sat.SatParameters.Builder.setExploitAllLpSolution

(

boolean

value

)

If true and the Lp relaxation of the problem has a solution, try to exploit
it. This is same as above except in this case the lp solution might not be
an integer solution.

optional bool exploit_all_lp_solution = 116 [default = true];

Parameters

value

The exploitAllLpSolution to set.

Returns

This builder for chaining.

Definition at line 33607 of file SatParameters.java.

setExploitAllPrecedences()

Builder com.google.ortools.sat.SatParameters.Builder.setExploitAllPrecedences

(

boolean

value

)

optional bool exploit_all_precedences = 220 [default = false];

Parameters

value

The exploitAllPrecedences to set.

Returns

This builder for chaining.

Definition at line 26971 of file SatParameters.java.

setExploitBestSolution()

Builder com.google.ortools.sat.SatParameters.Builder.setExploitBestSolution

(

boolean

value

)

When branching on a variable, follow the last best solution value.

optional bool exploit_best_solution = 130 [default = false];

Parameters

value

The exploitBestSolution to set.

Returns

This builder for chaining.

Definition at line 33665 of file SatParameters.java.

setExploitIntegerLpSolution()

Builder com.google.ortools.sat.SatParameters.Builder.setExploitIntegerLpSolution

(

boolean

value

)

If true and the Lp relaxation of the problem has an integer optimal
solution, try to exploit it. Note that since the LP relaxation may not
contain all the constraints, such a solution is not necessarily a solution
of the full problem.

optional bool exploit_integer_lp_solution = 94 [default = true];

Parameters

value

The exploitIntegerLpSolution to set.

Returns

This builder for chaining.

Definition at line 33542 of file SatParameters.java.

setExploitObjective()

Builder com.google.ortools.sat.SatParameters.Builder.setExploitObjective

(

boolean

value

)

When branching an a variable that directly affect the objective,
branch on the value that lead to the best objective first.

optional bool exploit_objective = 131 [default = true];

Parameters

value

The exploitObjective to set.

Returns

This builder for chaining.

Definition at line 33788 of file SatParameters.java.

setExploitRelaxationSolution()

Builder com.google.ortools.sat.SatParameters.Builder.setExploitRelaxationSolution

(

boolean

value

)

When branching on a variable, follow the last best relaxation solution
value. We use the relaxation with the tightest bound on the objective as
the best relaxation solution.

optional bool exploit_relaxation_solution = 161 [default = false];

Parameters

value

The exploitRelaxationSolution to set.

Returns

This builder for chaining.

Definition at line 33727 of file SatParameters.java.

setExtraSubsolvers()

Builder com.google.ortools.sat.SatParameters.Builder.setExtraSubsolvers	(	int	index,
		java.lang.String	value )

A convenient way to add more workers types.
These will be added at the beginning of the list.

repeated string extra_subsolvers = 219;

Parameters

index	The index to set the value at.
value	The extraSubsolvers to set.

Returns

This builder for chaining.

Definition at line 24430 of file SatParameters.java.

setFeasibilityJumpBatchDtime()

Builder com.google.ortools.sat.SatParameters.Builder.setFeasibilityJumpBatchDtime

(

double

value

)

How much dtime for each LS batch.

optional double feasibility_jump_batch_dtime = 292 [default = 0.1];

Parameters

value

The feasibilityJumpBatchDtime to set.

Returns

This builder for chaining.

Definition at line 28937 of file SatParameters.java.

setFeasibilityJumpDecay()

Builder com.google.ortools.sat.SatParameters.Builder.setFeasibilityJumpDecay

(

double

value

)

On each restart, we randomly choose if we use decay (with this parameter)
or no decay.

optional double feasibility_jump_decay = 242 [default = 0.95];

Parameters

value

The feasibilityJumpDecay to set.

Returns

This builder for chaining.

Definition at line 28764 of file SatParameters.java.

setFeasibilityJumpEnableRestarts()

Builder com.google.ortools.sat.SatParameters.Builder.setFeasibilityJumpEnableRestarts

(

boolean

value

)

When stagnating, feasibility jump will either restart from a default
solution (with some possible randomization), or randomly pertubate the
current solution. This parameter selects the first option.

optional bool feasibility_jump_enable_restarts = 250 [default = true];

Parameters

value

The feasibilityJumpEnableRestarts to set.

Returns

This builder for chaining.

Definition at line 29119 of file SatParameters.java.

setFeasibilityJumpLinearizationLevel()

Builder com.google.ortools.sat.SatParameters.Builder.setFeasibilityJumpLinearizationLevel

(

int

value

)

How much do we linearize the problem in the local search code.

optional int32 feasibility_jump_linearization_level = 257 [default = 2];

Parameters

value

The feasibilityJumpLinearizationLevel to set.

Returns

This builder for chaining.

Definition at line 28821 of file SatParameters.java.

setFeasibilityJumpMaxExpandedConstraintSize()

Builder com.google.ortools.sat.SatParameters.Builder.setFeasibilityJumpMaxExpandedConstraintSize

(

int

value

)

Maximum size of no_overlap or no_overlap_2d constraint for a quadratic
expansion. This might look a lot, but by expanding such constraint, we get
a linear time evaluation per single variable moves instead of a slow O(n
log n) one.

optional int32 feasibility_jump_max_expanded_constraint_size = 264 [default = 500];

Parameters

value

The feasibilityJumpMaxExpandedConstraintSize to set.

Returns

This builder for chaining.

Definition at line 29186 of file SatParameters.java.

setFeasibilityJumpRestartFactor()

Builder com.google.ortools.sat.SatParameters.Builder.setFeasibilityJumpRestartFactor

(

int

value

)

This is a factor that directly influence the work before each restart.
Increasing it leads to longer restart.

optional int32 feasibility_jump_restart_factor = 258 [default = 1];

Parameters

value

The feasibilityJumpRestartFactor to set.

Returns

This builder for chaining.

Definition at line 28880 of file SatParameters.java.

setFeasibilityJumpVarPerburbationRangeRatio()

Builder com.google.ortools.sat.SatParameters.Builder.setFeasibilityJumpVarPerburbationRangeRatio

(

double

value

)

Max distance between the default value and the pertubated value relative to
the range of the domain of the variable.

optional double feasibility_jump_var_perburbation_range_ratio = 248 [default = 0.2];

Parameters

value

The feasibilityJumpVarPerburbationRangeRatio to set.

Returns

This builder for chaining.

Definition at line 29056 of file SatParameters.java.

setFeasibilityJumpVarRandomizationProbability()

Builder com.google.ortools.sat.SatParameters.Builder.setFeasibilityJumpVarRandomizationProbability

(

double

value

)

Probability for a variable to have a non default value upon restarts or
perturbations.

optional double feasibility_jump_var_randomization_probability = 247 [default = 0.05];

Parameters

value

The feasibilityJumpVarRandomizationProbability to set.

Returns

This builder for chaining.

Definition at line 28996 of file SatParameters.java.

setFillAdditionalSolutionsInResponse()

Builder com.google.ortools.sat.SatParameters.Builder.setFillAdditionalSolutionsInResponse

(

boolean

value

)

If true, the final response addition_solutions field will be filled with
all solutions from our solutions pool.

Note that if both this field and enumerate_all_solutions is true, we will
copy to the pool all of the solution found. So if solution_pool_size is big
enough, you can get all solutions this way instead of using the solution
callback.

Note that this only affect the "final" solution, not the one passed to the
solution callbacks.

optional bool fill_additional_solutions_in_response = 194 [default = false];

Parameters

value

The fillAdditionalSolutionsInResponse to set.

Returns

This builder for chaining.

Definition at line 30174 of file SatParameters.java.

setFillTightenedDomainsInResponse()

Builder com.google.ortools.sat.SatParameters.Builder.setFillTightenedDomainsInResponse

(

boolean

value

)

If true, add information about the derived variable domains to the
CpSolverResponse. It is an option because it makes the response slighly
bigger and there is a bit more work involved during the postsolve to
construct it, but it should still have a low overhead. See the
tightened_variables field in CpSolverResponse for more details.

optional bool fill_tightened_domains_in_response = 132 [default = false];

Parameters

value

The fillTightenedDomainsInResponse to set.

Returns

This builder for chaining.

Definition at line 30087 of file SatParameters.java.

setFilterSubsolvers()

Builder com.google.ortools.sat.SatParameters.Builder.setFilterSubsolvers	(	int	index,
		java.lang.String	value )

repeated string filter_subsolvers = 293;

Parameters

index	The index to set the value at.
value	The filterSubsolvers to set.

Returns

This builder for chaining.

Definition at line 24778 of file SatParameters.java.

setFindBigLinearOverlap()

Builder com.google.ortools.sat.SatParameters.Builder.setFindBigLinearOverlap

(

boolean

value

)

Try to find large "rectangle" in the linear constraint matrix with
identical lines. If such rectangle is big enough, we can introduce a new
integer variable corresponding to the common expression and greatly reduce
the number of non-zero.

optional bool find_big_linear_overlap = 234 [default = true];

Parameters

value

The findBigLinearOverlap to set.

Returns

This builder for chaining.

Definition at line 23479 of file SatParameters.java.

setFindMultipleCores()

Builder com.google.ortools.sat.SatParameters.Builder.setFindMultipleCores

(

boolean

value

)

Whether we try to find more independent cores for a given set of
assumptions in the core based max-SAT algorithms.

optional bool find_multiple_cores = 84 [default = true];

Parameters

value

The findMultipleCores to set.

Returns

This builder for chaining.

Definition at line 25922 of file SatParameters.java.

setFixVariablesToTheirHintedValue()

Builder com.google.ortools.sat.SatParameters.Builder.setFixVariablesToTheirHintedValue

(

boolean

value

)

If true, variables appearing in the solution hints will be fixed to their
hinted value.

optional bool fix_variables_to_their_hinted_value = 192 [default = false];

Parameters

value

The fixVariablesToTheirHintedValue to set.

Returns

This builder for chaining.

Definition at line 27612 of file SatParameters.java.

setFpRounding()

Builder com.google.ortools.sat.SatParameters.Builder.setFpRounding

(

com.google.ortools.sat.SatParameters.FPRoundingMethod

value

)

optional .operations_research.sat.SatParameters.FPRoundingMethod fp_rounding = 165 [default = PROPAGATION_ASSISTED];

Parameters

value

The fpRounding to set.

Returns

This builder for chaining.

Definition at line 30871 of file SatParameters.java.

setGlucoseDecayIncrement()

Builder com.google.ortools.sat.SatParameters.Builder.setGlucoseDecayIncrement

(

double

value

)

optional double glucose_decay_increment = 23 [default = 0.01];

Parameters

value

The glucoseDecayIncrement to set.

Returns

This builder for chaining.

Definition at line 19496 of file SatParameters.java.

setGlucoseDecayIncrementPeriod()

Builder com.google.ortools.sat.SatParameters.Builder.setGlucoseDecayIncrementPeriod

(

int

value

)

optional int32 glucose_decay_increment_period = 24 [default = 5000];

Parameters

value

The glucoseDecayIncrementPeriod to set.

Returns

This builder for chaining.

Definition at line 19536 of file SatParameters.java.

setGlucoseMaxDecay()

Builder com.google.ortools.sat.SatParameters.Builder.setGlucoseMaxDecay

(

double

value

)

The activity starts at 0.8 and increment by 0.01 every 5000 conflicts until
0.95. This "hack" seems to work well and comes from:

Glucose 2.3 in the SAT 2013 Competition - SAT Competition 2013
http://edacc4.informatik.uni-ulm.de/SC13/solver-description-download/136

optional double glucose_max_decay = 22 [default = 0.95];

Parameters

value

The glucoseMaxDecay to set.

Returns

This builder for chaining.

Definition at line 19448 of file SatParameters.java.

setHintConflictLimit()

Builder com.google.ortools.sat.SatParameters.Builder.setHintConflictLimit

(

int

value

)

Conflict limit used in the phase that exploit the solution hint.

optional int32 hint_conflict_limit = 153 [default = 10];

Parameters

value

The hintConflictLimit to set.

Returns

This builder for chaining.

Definition at line 27485 of file SatParameters.java.

setIgnoreNames()

Builder com.google.ortools.sat.SatParameters.Builder.setIgnoreNames

(

boolean

value

)

If true, we don't keep names in our internal copy of the user given model.

optional bool ignore_names = 202 [default = true];

Parameters

value

The ignoreNames to set.

Returns

This builder for chaining.

Definition at line 23330 of file SatParameters.java.

setIgnoreSubsolvers()

Builder com.google.ortools.sat.SatParameters.Builder.setIgnoreSubsolvers	(	int	index,
		java.lang.String	value )

Rather than fully specifying subsolvers, it is often convenient to just
remove the ones that are not useful on a given problem or only keep
specific ones for testing. Each string is interpreted as a "glob", so we
support '*' and '?'.

The way this work is that we will only accept a name that match a filter
pattern (if non-empty) and do not match an ignore pattern. Note also that
these fields work on LNS or LS names even if these are currently not
specified via the subsolvers field.

repeated string ignore_subsolvers = 209;

Parameters

index	The index to set the value at.
value	The ignoreSubsolvers to set.

Returns

This builder for chaining.

Definition at line 24620 of file SatParameters.java.

setInferAllDiffs()

Builder com.google.ortools.sat.SatParameters.Builder.setInferAllDiffs

(

boolean

value

)

Run a max-clique code amongst all the x != y we can find and try to infer
set of variables that are all different. This allows to close neos16.mps
for instance. Note that we only run this code if there is no all_diff
already in the model so that if a user want to add some all_diff, we assume
it is well done and do not try to add more.

This will also detect and add no_overlap constraints, if all the relations
x != y have "offsets" between them. I.e. x > y + offset.

optional bool infer_all_diffs = 233 [default = true];

Parameters

value

The inferAllDiffs to set.

Returns

This builder for chaining.

Definition at line 23407 of file SatParameters.java.

setInitialPolarity()

Builder com.google.ortools.sat.SatParameters.Builder.setInitialPolarity

(

com.google.ortools.sat.SatParameters.Polarity

value

)

optional .operations_research.sat.SatParameters.Polarity initial_polarity = 2 [default = POLARITY_FALSE];

Parameters

value

The initialPolarity to set.

Returns

This builder for chaining.

Definition at line 18182 of file SatParameters.java.

setInitialVariablesActivity()

Builder com.google.ortools.sat.SatParameters.Builder.setInitialVariablesActivity

(

double

value

)

The initial value of the variables activity. A non-zero value only make
sense when use_erwa_heuristic is true. Experiments with a value of 1e-2
together with the ERWA heuristic showed slighthly better result than simply
using zero. The idea is that when the "learning rate" of a variable becomes
lower than this value, then we prefer to branch on never explored before
variables. This is not in the ERWA paper.

optional double initial_variables_activity = 76 [default = 0];

Parameters

value

The initialVariablesActivity to set.

Returns

This builder for chaining.

Definition at line 18611 of file SatParameters.java.

setInprocessingDtimeRatio()

Builder com.google.ortools.sat.SatParameters.Builder.setInprocessingDtimeRatio

(

double

value

)

Proportion of deterministic time we should spend on inprocessing.
At each "restart", if the proportion is below this ratio, we will do some
inprocessing, otherwise, we skip it for this restart.

optional double inprocessing_dtime_ratio = 273 [default = 0.2];

Parameters

value

The inprocessingDtimeRatio to set.

Returns

This builder for chaining.

Definition at line 23604 of file SatParameters.java.

setInprocessingMinimizationDtime()

Builder com.google.ortools.sat.SatParameters.Builder.setInprocessingMinimizationDtime

(

double

value

)

Parameters for an heuristic similar to the one described in "An effective
learnt clause minimization approach for CDCL Sat Solvers",
https://www.ijcai.org/proceedings/2017/0098.pdf

This is the amount of dtime we should spend on this technique during each
inprocessing phase.

The minimization technique is the same as the one used to minimize core in
max-sat. We also minimize problem clauses and not just the learned clause
that we keep forever like in the paper.

optional double inprocessing_minimization_dtime = 275 [default = 1];

Parameters

value

The inprocessingMinimizationDtime to set.

Returns

This builder for chaining.

Definition at line 23745 of file SatParameters.java.

setInprocessingProbingDtime()

Builder com.google.ortools.sat.SatParameters.Builder.setInprocessingProbingDtime

(

double

value

)

The amount of dtime we should spend on probing for each inprocessing round.

optional double inprocessing_probing_dtime = 274 [default = 1];

Parameters

value

The inprocessingProbingDtime to set.

Returns

This builder for chaining.

Definition at line 23662 of file SatParameters.java.

setInstantiateAllVariables()

Builder com.google.ortools.sat.SatParameters.Builder.setInstantiateAllVariables

(

boolean

value

)

If true, the solver will add a default integer branching strategy to the
already defined search strategy. If not, some variable might still not be
fixed at the end of the search. For now we assume these variable can just
be set to their lower bound.

optional bool instantiate_all_variables = 106 [default = true];

Parameters

value

The instantiateAllVariables to set.

Returns

This builder for chaining.

Definition at line 30248 of file SatParameters.java.

setInterleaveBatchSize()

Builder com.google.ortools.sat.SatParameters.Builder.setInterleaveBatchSize

(

int

value

)

optional int32 interleave_batch_size = 134 [default = 0];

Parameters

value

The interleaveBatchSize to set.

Returns

This builder for chaining.

Definition at line 25323 of file SatParameters.java.

setInterleaveSearch()

Builder com.google.ortools.sat.SatParameters.Builder.setInterleaveSearch

(

boolean

value

)

Experimental. If this is true, then we interleave all our major search
strategy and distribute the work amongst num_workers.

The search is deterministic (independently of num_workers!), and we
schedule and wait for interleave_batch_size task to be completed before
synchronizing and scheduling the next batch of tasks.

optional bool interleave_search = 136 [default = false];

Parameters

value

The interleaveSearch to set.

Returns

This builder for chaining.

Definition at line 25274 of file SatParameters.java.

setKeepAllFeasibleSolutionsInPresolve()

Builder com.google.ortools.sat.SatParameters.Builder.setKeepAllFeasibleSolutionsInPresolve

(

boolean

value

)

If true, we disable the presolve reductions that remove feasible solutions
from the search space. Such solution are usually dominated by a "better"
solution that is kept, but depending on the situation, we might want to
keep all solutions.

A trivial example is when a variable is unused. If this is true, then the
presolve will not fix it to an arbitrary value and it will stay in the
search space.

optional bool keep_all_feasible_solutions_in_presolve = 173 [default = false];

Parameters

value

The keepAllFeasibleSolutionsInPresolve to set.

Returns

This builder for chaining.

Definition at line 30012 of file SatParameters.java.

setLinearizationLevel()

Builder com.google.ortools.sat.SatParameters.Builder.setLinearizationLevel

(

int

value

)

A non-negative level indicating the type of constraints we consider in the
LP relaxation. At level zero, no LP relaxation is used. At level 1, only
the linear constraint and full encoding are added. At level 2, we also add
all the Boolean constraints.

optional int32 linearization_level = 90 [default = 1];

Parameters

value

The linearizationLevel to set.

Returns

This builder for chaining.

Definition at line 32014 of file SatParameters.java.

setLinearSplitSize()

Builder com.google.ortools.sat.SatParameters.Builder.setLinearSplitSize

(

int

value

)

Linear constraints that are not pseudo-Boolean and that are longer than
this size will be split into sqrt(size) intermediate sums in order to have
faster propation in the CP engine.

optional int32 linear_split_size = 256 [default = 100];

Parameters

value

The linearSplitSize to set.

Returns

This builder for chaining.

Definition at line 31947 of file SatParameters.java.

setLogPrefix()

Builder com.google.ortools.sat.SatParameters.Builder.setLogPrefix

(

java.lang.String

value

)

Add a prefix to all logs.

optional string log_prefix = 185 [default = ""];

Parameters

value

The logPrefix to set.

Returns

This builder for chaining.

Definition at line 21312 of file SatParameters.java.

setLogPrefixBytes()

Builder com.google.ortools.sat.SatParameters.Builder.setLogPrefixBytes

(

com.google.protobuf.ByteString

value

)

Add a prefix to all logs.

optional string log_prefix = 185 [default = ""];

Parameters

value

The bytes for logPrefix to set.

Returns

This builder for chaining.

Definition at line 21343 of file SatParameters.java.

setLogSearchProgress()

Builder com.google.ortools.sat.SatParameters.Builder.setLogSearchProgress

(

boolean

value

)

Whether the solver should log the search progress. This is the maing
logging parameter and if this is false, none of the logging (callbacks,
log_to_stdout, log_to_response, ...) will do anything.

optional bool log_search_progress = 41 [default = false];

Parameters

value

The logSearchProgress to set.

Returns

This builder for chaining.

Definition at line 21156 of file SatParameters.java.

setLogSubsolverStatistics()

Builder com.google.ortools.sat.SatParameters.Builder.setLogSubsolverStatistics

(

boolean

value

)

Whether the solver should display per sub-solver search statistics.
This is only useful is log_search_progress is set to true, and if the
number of search workers is > 1. Note that in all case we display a bit
of stats with one line per subsolver.

optional bool log_subsolver_statistics = 189 [default = false];

Parameters

value

The logSubsolverStatistics to set.

Returns

This builder for chaining.

Definition at line 21223 of file SatParameters.java.

setLogToResponse()

Builder com.google.ortools.sat.SatParameters.Builder.setLogToResponse

(

boolean

value

)

Log to response proto.

optional bool log_to_response = 187 [default = false];

Parameters

value

The logToResponse to set.

Returns

This builder for chaining.

Definition at line 21442 of file SatParameters.java.

setLogToStdout()

Builder com.google.ortools.sat.SatParameters.Builder.setLogToStdout

(

boolean

value

)

Log to stdout.

optional bool log_to_stdout = 186 [default = true];

Parameters

value

The logToStdout to set.

Returns

This builder for chaining.

Definition at line 21386 of file SatParameters.java.

setLpDualTolerance()

Builder com.google.ortools.sat.SatParameters.Builder.setLpDualTolerance

(

double

value

)

optional double lp_dual_tolerance = 267 [default = 1e-07];

Parameters

value

The lpDualTolerance to set.

Returns

This builder for chaining.

Definition at line 31685 of file SatParameters.java.

setLpPrimalTolerance()

Builder com.google.ortools.sat.SatParameters.Builder.setLpPrimalTolerance

(

double

value

)

The internal LP tolerances used by CP-SAT. These applies to the internal
and scaled problem. If the domains of your variables are large it might be
good to use lower tolerances. If your problem is binary with low
coefficients, it might be good to use higher ones to speed-up the lp
solves.

optional double lp_primal_tolerance = 266 [default = 1e-07];

Parameters

value

The lpPrimalTolerance to set.

Returns

This builder for chaining.

Definition at line 31637 of file SatParameters.java.

setMaxAllDiffCutSize()

Builder com.google.ortools.sat.SatParameters.Builder.setMaxAllDiffCutSize

(

int

value

)

Cut generator for all diffs can add too many cuts for large all_diff
constraints. This parameter restricts the large all_diff constraints to
have a cut generator.

optional int32 max_all_diff_cut_size = 148 [default = 64];

Parameters

value

The maxAllDiffCutSize to set.

Returns

This builder for chaining.

Definition at line 32779 of file SatParameters.java.

setMaxClauseActivityValue()

Builder com.google.ortools.sat.SatParameters.Builder.setMaxClauseActivityValue

(

double

value

)

optional double max_clause_activity_value = 18 [default = 1e+20];

Parameters

value

The maxClauseActivityValue to set.

Returns

This builder for chaining.

Definition at line 19632 of file SatParameters.java.

setMaxConsecutiveInactiveCount()

Builder com.google.ortools.sat.SatParameters.Builder.setMaxConsecutiveInactiveCount

(

int

value

)

If a constraint/cut in LP is not active for that many consecutive OPTIMAL
solves, remove it from the LP. Note that it might be added again later if
it become violated by the current LP solution.

optional int32 max_consecutive_inactive_count = 121 [default = 100];

Parameters

value

The maxConsecutiveInactiveCount to set.

Returns

This builder for chaining.

Definition at line 33255 of file SatParameters.java.

setMaxCutRoundsAtLevelZero()

Builder com.google.ortools.sat.SatParameters.Builder.setMaxCutRoundsAtLevelZero

(

int

value

)

Max number of time we perform cut generation and resolve the LP at level 0.

optional int32 max_cut_rounds_at_level_zero = 154 [default = 1];

Parameters

value

The maxCutRoundsAtLevelZero to set.

Returns

This builder for chaining.

Definition at line 33193 of file SatParameters.java.

setMaxDeterministicTime()

Builder com.google.ortools.sat.SatParameters.Builder.setMaxDeterministicTime

(

double

value

)

Maximum time allowed in deterministic time to solve a problem.
The deterministic time should be correlated with the real time used by the
solver, the time unit being as close as possible to a second.

optional double max_deterministic_time = 67 [default = inf];

Parameters

value

The maxDeterministicTime to set.

Returns

This builder for chaining.

Definition at line 20484 of file SatParameters.java.

setMaxDomainSizeWhenEncodingEqNeqConstraints()

Builder com.google.ortools.sat.SatParameters.Builder.setMaxDomainSizeWhenEncodingEqNeqConstraints

(

int

value

)

When loading a*x + b*y ==/!= c when x and y are both fully encoded.
The solver may decide to replace the linear equation by a set of clauses.
This is triggered if the sizes of the domains of x and y are below the
threshold.

optional int32 max_domain_size_when_encoding_eq_neq_constraints = 191 [default = 16];

Parameters

value

The maxDomainSizeWhenEncodingEqNeqConstraints to set.

Returns

This builder for chaining.

Definition at line 32142 of file SatParameters.java.

setMaxIntegerRoundingScaling()

Builder com.google.ortools.sat.SatParameters.Builder.setMaxIntegerRoundingScaling

(

int

value

)

In the integer rounding procedure used for MIR and Gomory cut, the maximum
"scaling" we use (must be positive). The lower this is, the lower the
integer coefficients of the cut will be. Note that cut generated by lower
values are not necessarily worse than cut generated by larger value. There
is no strict dominance relationship.

Setting this to 2 result in the "strong fractional rouding" of Letchford
and Lodi.

optional int32 max_integer_rounding_scaling = 119 [default = 600];

Parameters

value

The maxIntegerRoundingScaling to set.

Returns

This builder for chaining.

Definition at line 32922 of file SatParameters.java.

setMaxLinMaxSizeForExpansion()

Builder com.google.ortools.sat.SatParameters.Builder.setMaxLinMaxSizeForExpansion

(

int

value

)

If the number of expressions in the lin_max is less that the max size
parameter, model expansion replaces target = max(xi) by linear constraint
with the introduction of new booleans bi such that bi => target == xi.

This is mainly for experimenting compared to a custom lin_max propagator.

optional int32 max_lin_max_size_for_expansion = 280 [default = 0];

Parameters

value

The maxLinMaxSizeForExpansion to set.

Returns

This builder for chaining.

Definition at line 22814 of file SatParameters.java.

setMaxMemoryInMb()

Builder com.google.ortools.sat.SatParameters.Builder.setMaxMemoryInMb

(

long

value

)

Maximum memory allowed for the whole thread containing the solver. The
solver will abort as soon as it detects that this limit is crossed. As a
result, this limit is approximative, but usually the solver will not go too
much over.

TODO(user): This is only used by the pure SAT solver, generalize to CP-SAT.

optional int64 max_memory_in_mb = 40 [default = 10000];

Parameters

value

The maxMemoryInMb to set.

Returns

This builder for chaining.

Definition at line 20697 of file SatParameters.java.

setMaxNumberOfConflicts()

Builder com.google.ortools.sat.SatParameters.Builder.setMaxNumberOfConflicts

(

long

value

)

Maximum number of conflicts allowed to solve a problem.

TODO(user): Maybe change the way the conflict limit is enforced?
currently it is enforced on each independent internal SAT solve, rather
than on the overall number of conflicts across all solves. So in the
context of an optimization problem, this is not really usable directly by a
client.

optional int64 max_number_of_conflicts = 37 [default = 9223372036854775807];

Parameters

value

The maxNumberOfConflicts to set.

Returns

This builder for chaining.

Definition at line 20620 of file SatParameters.java.

setMaxNumCuts()

Builder com.google.ortools.sat.SatParameters.Builder.setMaxNumCuts

(

int

value

)

The limit on the number of cuts in our cut pool. When this is reached we do
not generate cuts anymore.

TODO(user): We should probably remove this parameters, and just always
generate cuts but only keep the best n or something.

optional int32 max_num_cuts = 91 [default = 10000];

Parameters

value

The maxNumCuts to set.

Returns

This builder for chaining.

Definition at line 32213 of file SatParameters.java.

setMaxNumDeterministicBatches()

Builder com.google.ortools.sat.SatParameters.Builder.setMaxNumDeterministicBatches

(

int

value

)

Stops after that number of batches has been scheduled. This only make sense
when interleave_search is true.

optional int32 max_num_deterministic_batches = 291 [default = 0];

Parameters

value

The maxNumDeterministicBatches to set.

Returns

This builder for chaining.

Definition at line 20545 of file SatParameters.java.

setMaxNumIntervalsForTimetableEdgeFinding()

Builder com.google.ortools.sat.SatParameters.Builder.setMaxNumIntervalsForTimetableEdgeFinding

(

int

value

)

Max number of intervals for the timetable_edge_finding algorithm to
propagate. A value of 0 disables the constraint.

optional int32 max_num_intervals_for_timetable_edge_finding = 260 [default = 100];

Parameters

value

The maxNumIntervalsForTimetableEdgeFinding to set.

Returns

This builder for chaining.

Definition at line 26850 of file SatParameters.java.

setMaxPairsPairwiseReasoningInNoOverlap2D()

Builder com.google.ortools.sat.SatParameters.Builder.setMaxPairsPairwiseReasoningInNoOverlap2D

(

int

value

)

If the number of pairs to look is below this threshold, do an extra step of
propagation in the no_overlap_2d constraint by looking at all pairs of
intervals.

optional int32 max_pairs_pairwise_reasoning_in_no_overlap_2d = 276 [default = 1250];

Parameters

value

The maxPairsPairwiseReasoningInNoOverlap2d to set.

Returns

This builder for chaining.

Definition at line 27321 of file SatParameters.java.

setMaxPresolveIterations()

Builder com.google.ortools.sat.SatParameters.Builder.setMaxPresolveIterations

(

int

value

)

In case of large reduction in a presolve iteration, we perform multiple
presolve iterations. This parameter controls the maximum number of such
presolve iterations.

optional int32 max_presolve_iterations = 138 [default = 3];

Parameters

value

The maxPresolveIterations to set.

Returns

This builder for chaining.

Definition at line 22148 of file SatParameters.java.

setMaxSatAssumptionOrder()

Builder com.google.ortools.sat.SatParameters.Builder.setMaxSatAssumptionOrder

(

com.google.ortools.sat.SatParameters.MaxSatAssumptionOrder

value

)

optional .operations_research.sat.SatParameters.MaxSatAssumptionOrder max_sat_assumption_order = 51 [default = DEFAULT_ASSUMPTION_ORDER];

Parameters

value

The maxSatAssumptionOrder to set.

Returns

This builder for chaining.

Definition at line 26031 of file SatParameters.java.

setMaxSatReverseAssumptionOrder()

Builder com.google.ortools.sat.SatParameters.Builder.setMaxSatReverseAssumptionOrder

(

boolean

value

)

If true, adds the assumption in the reverse order of the one defined by
max_sat_assumption_order.

optional bool max_sat_reverse_assumption_order = 52 [default = false];

Parameters

value

The maxSatReverseAssumptionOrder to set.

Returns

This builder for chaining.

Definition at line 26088 of file SatParameters.java.

setMaxSatStratification()

Builder com.google.ortools.sat.SatParameters.Builder.setMaxSatStratification

(

com.google.ortools.sat.SatParameters.MaxSatStratificationAlgorithm

value

)

optional .operations_research.sat.SatParameters.MaxSatStratificationAlgorithm max_sat_stratification = 53 [default = STRATIFICATION_DESCENT];

Parameters

value

The maxSatStratification to set.

Returns

This builder for chaining.

Definition at line 26133 of file SatParameters.java.

setMaxSizeToCreatePrecedenceLiteralsInDisjunctive()

Builder com.google.ortools.sat.SatParameters.Builder.setMaxSizeToCreatePrecedenceLiteralsInDisjunctive

(

int

value

)

Create one literal for each disjunction of two pairs of tasks. This slows
down the solve time, but improves the lower bound of the objective in the
makespan case. This will be triggered if the number of intervals is less or
equal than the parameter and if use_strong_propagation_in_disjunctive is
true.

optional int32 max_size_to_create_precedence_literals_in_disjunctive = 229 [default = 60];

Parameters

value

The maxSizeToCreatePrecedenceLiteralsInDisjunctive to set.

Returns

This builder for chaining.

Definition at line 26375 of file SatParameters.java.

setMaxTimeInSeconds()

Builder com.google.ortools.sat.SatParameters.Builder.setMaxTimeInSeconds

(

double

value

)

Maximum time allowed in seconds to solve a problem.
The counter will starts at the beginning of the Solve() call.

optional double max_time_in_seconds = 36 [default = inf];

Parameters

value

The maxTimeInSeconds to set.

Returns

This builder for chaining.

Definition at line 20421 of file SatParameters.java.

setMaxVariableActivityValue()

Builder com.google.ortools.sat.SatParameters.Builder.setMaxVariableActivityValue

(

double

value

)

optional double max_variable_activity_value = 16 [default = 1e+100];

Parameters

value

The maxVariableActivityValue to set.

Returns

This builder for chaining.

Definition at line 19384 of file SatParameters.java.

setMergeAtMostOneWorkLimit()

Builder com.google.ortools.sat.SatParameters.Builder.setMergeAtMostOneWorkLimit

(

double

value

)

optional double merge_at_most_one_work_limit = 146 [default = 100000000];

Parameters

value

The mergeAtMostOneWorkLimit to set.

Returns

This builder for chaining.

Definition at line 23054 of file SatParameters.java.

setMergeNoOverlapWorkLimit()

Builder com.google.ortools.sat.SatParameters.Builder.setMergeNoOverlapWorkLimit

(

double

value

)

During presolve, we use a maximum clique heuristic to merge together
no-overlap constraints or at most one constraints. This code can be slow,
so we have a limit in place on the number of explored nodes in the
underlying graph. The internal limit is an int64, but we use double here to
simplify manual input.

optional double merge_no_overlap_work_limit = 145 [default = 1000000000000];

Parameters

value

The mergeNoOverlapWorkLimit to set.

Returns

This builder for chaining.

Definition at line 23006 of file SatParameters.java.

setMinimizationAlgorithm()

Builder com.google.ortools.sat.SatParameters.Builder.setMinimizationAlgorithm

(

com.google.ortools.sat.SatParameters.ConflictMinimizationAlgorithm

value

)

optional .operations_research.sat.SatParameters.ConflictMinimizationAlgorithm minimization_algorithm = 4 [default = RECURSIVE];

Parameters

value

The minimizationAlgorithm to set.

Returns

This builder for chaining.

Definition at line 18728 of file SatParameters.java.

setMinimizeReductionDuringPbResolution()

Builder com.google.ortools.sat.SatParameters.Builder.setMinimizeReductionDuringPbResolution

(

boolean

value

)

A different algorithm during PB resolution. It minimizes the number of
calls to ReduceCoefficients() which can be time consuming. However, the
search space will be different and if the coefficients are large, this may
lead to integer overflows that could otherwise be prevented.

optional bool minimize_reduction_during_pb_resolution = 48 [default = false];

Parameters

value

The minimizeReductionDuringPbResolution to set.

Returns

This builder for chaining.

Definition at line 21575 of file SatParameters.java.

setMinOrthogonalityForLpConstraints()

Builder com.google.ortools.sat.SatParameters.Builder.setMinOrthogonalityForLpConstraints

(

double

value

)

While adding constraints, skip the constraints which have orthogonality
less than 'min_orthogonality_for_lp_constraints' with already added
constraints during current call. Orthogonality is defined as 1 -
cosine(vector angle between constraints). A value of zero disable this
feature.

optional double min_orthogonality_for_lp_constraints = 115 [default = 0.05];

Parameters

value

The minOrthogonalityForLpConstraints to set.

Returns

This builder for chaining.

Definition at line 33133 of file SatParameters.java.

setMipAutomaticallyScaleVariables()

Builder com.google.ortools.sat.SatParameters.Builder.setMipAutomaticallyScaleVariables

(

boolean

value

)

If true, some continuous variable might be automatically scaled. For now,
this is only the case where we detect that a variable is actually an
integer multiple of a constant. For instance, variables of the form k * 0.5
are quite frequent, and if we detect this, we will scale such variable
domain by 2 to make it implied integer.

optional bool mip_automatically_scale_variables = 166 [default = true];

Parameters

value

The mipAutomaticallyScaleVariables to set.

Returns

This builder for chaining.

Definition at line 34113 of file SatParameters.java.

setMipCheckPrecision()

Builder com.google.ortools.sat.SatParameters.Builder.setMipCheckPrecision

(

double

value

)

As explained in mip_precision and mip_max_activity_exponent, we cannot
always reach the wanted precision during scaling. We use this threshold to
enphasize in the logs when the precision seems bad.

optional double mip_check_precision = 128 [default = 0.0001];

Parameters

value

The mipCheckPrecision to set.

Returns

This builder for chaining.

Definition at line 34483 of file SatParameters.java.

setMipComputeTrueObjectiveBound()

Builder com.google.ortools.sat.SatParameters.Builder.setMipComputeTrueObjectiveBound

(

boolean

value

)

Even if we make big error when scaling the objective, we can always derive
a correct lower bound on the original objective by using the exact lower
bound on the scaled integer version of the objective. This should be fast,
but if you don't care about having a precise lower bound, you can turn it
off.

optional bool mip_compute_true_objective_bound = 198 [default = true];

Parameters

value

The mipComputeTrueObjectiveBound to set.

Returns

This builder for chaining.

Definition at line 34553 of file SatParameters.java.

setMipDropTolerance()

Builder com.google.ortools.sat.SatParameters.Builder.setMipDropTolerance

(

double

value

)

Any value in the input mip with a magnitude lower than this will be set to
zero. This is to avoid some issue in LP presolving.

optional double mip_drop_tolerance = 232 [default = 1e-16];

Parameters

value

The mipDropTolerance to set.

Returns

This builder for chaining.

Definition at line 34764 of file SatParameters.java.

setMipMaxActivityExponent()

Builder com.google.ortools.sat.SatParameters.Builder.setMipMaxActivityExponent

(

int

value

)

To avoid integer overflow, we always force the maximum possible constraint
activity (and objective value) according to the initial variable domain to
be smaller than 2 to this given power. Because of this, we cannot always
reach the "mip_wanted_precision" parameter above.

This can go as high as 62, but some internal algo currently abort early if
they might run into integer overflow, so it is better to keep it a bit
lower than this.

optional int32 mip_max_activity_exponent = 127 [default = 53];

Parameters

value

The mipMaxActivityExponent to set.

Returns

This builder for chaining.

Definition at line 34414 of file SatParameters.java.

setMipMaxBound()

Builder com.google.ortools.sat.SatParameters.Builder.setMipMaxBound

(

double

value

)

We need to bound the maximum magnitude of the variables for CP-SAT, and
that is the bound we use. If the MIP model expect larger variable value in
the solution, then the converted model will likely not be relevant.

optional double mip_max_bound = 124 [default = 10000000];

Parameters

value

The mipMaxBound to set.

Returns

This builder for chaining.

Definition at line 33915 of file SatParameters.java.

setMipMaxValidMagnitude()

Builder com.google.ortools.sat.SatParameters.Builder.setMipMaxValidMagnitude

(

double

value

)

Any finite values in the input MIP must be below this threshold, otherwise
the model will be reported invalid. This is needed to avoid floating point
overflow when evaluating bounds * coeff for instance. We are a bit more
defensive, but in practice, users shouldn't use super large values in a
MIP.

optional double mip_max_valid_magnitude = 199 [default = 1e+20];

Parameters

value

The mipMaxValidMagnitude to set.

Returns

This builder for chaining.

Definition at line 34625 of file SatParameters.java.

setMipPresolveLevel()

Builder com.google.ortools.sat.SatParameters.Builder.setMipPresolveLevel

(

int

value

)

When solving a MIP, we do some basic floating point presolving before
scaling the problem to integer to be handled by CP-SAT. This control how
much of that presolve we do. It can help to better scale floating point
model, but it is not always behaving nicely.

optional int32 mip_presolve_level = 261 [default = 2];

Parameters

value

The mipPresolveLevel to set.

Returns

This builder for chaining.

Definition at line 34830 of file SatParameters.java.

setMipScaleLargeDomain()

Builder com.google.ortools.sat.SatParameters.Builder.setMipScaleLargeDomain

(

boolean

value

)

If this is false, then mip_var_scaling is only applied to variables with
"small" domain. If it is true, we scale all floating point variable
independenlty of their domain.

optional bool mip_scale_large_domain = 225 [default = false];

Parameters

value

The mipScaleLargeDomain to set.

Returns

This builder for chaining.

Definition at line 34043 of file SatParameters.java.

setMipTreatHighMagnitudeBoundsAsInfinity()

Builder com.google.ortools.sat.SatParameters.Builder.setMipTreatHighMagnitudeBoundsAsInfinity

(

boolean

value

)

By default, any variable/constraint bound with a finite value and a
magnitude greater than the mip_max_valid_magnitude will result with a
invalid model. This flags change the behavior such that such bounds are
silently transformed to +∞ or -∞.

It is recommended to keep it at false, and create valid bounds.

optional bool mip_treat_high_magnitude_bounds_as_infinity = 278 [default = false];

Parameters

value

The mipTreatHighMagnitudeBoundsAsInfinity to set.

Returns

This builder for chaining.

Definition at line 34700 of file SatParameters.java.

setMipVarScaling()

Builder com.google.ortools.sat.SatParameters.Builder.setMipVarScaling

(

double

value

)

All continuous variable of the problem will be multiplied by this factor.
By default, we don't do any variable scaling and rely on the MIP model to
specify continuous variable domain with the wanted precision.

optional double mip_var_scaling = 125 [default = 1];

Parameters

value

The mipVarScaling to set.

Returns

This builder for chaining.

Definition at line 33979 of file SatParameters.java.

setMipWantedPrecision()

Builder com.google.ortools.sat.SatParameters.Builder.setMipWantedPrecision

(

double

value

)

When scaling constraint with double coefficients to integer coefficients,
we will multiply by a power of 2 and round the coefficients. We will choose
the lowest power such that we have no potential overflow (see
mip_max_activity_exponent) and the worst case constraint activity error
does not exceed this threshold.

Note that we also detect constraint with rational coefficients and scale
them accordingly when it seems better instead of using a power of 2.

We also relax all constraint bounds by this absolute value. For pure
integer constraint, if this value if lower than one, this will not change
anything. However it is needed when scaling MIP problems.

If we manage to scale a constraint correctly, the maximum error we can make
will be twice this value (once for the scaling error and once for the
relaxed bounds). If we are not able to scale that well, we will display
that fact but still scale as best as we can.

optional double mip_wanted_precision = 126 [default = 1e-06];

Parameters

value

The mipWantedPrecision to set.

Returns

This builder for chaining.

Definition at line 34321 of file SatParameters.java.

setName()

Builder com.google.ortools.sat.SatParameters.Builder.setName

(

java.lang.String

value

)

In some context, like in a portfolio of search, it makes sense to name a
given parameters set for logging purpose.

optional string name = 171 [default = ""];

Parameters

value

The name to set.

Returns

This builder for chaining.

Definition at line 18076 of file SatParameters.java.

setNameBytes()

Builder com.google.ortools.sat.SatParameters.Builder.setNameBytes

(

com.google.protobuf.ByteString

value

)

In some context, like in a portfolio of search, it makes sense to name a
given parameters set for logging purpose.

optional string name = 171 [default = ""];

Parameters

value

The bytes for name to set.

Returns

This builder for chaining.

Definition at line 18109 of file SatParameters.java.

setNewConstraintsBatchSize()

Builder com.google.ortools.sat.SatParameters.Builder.setNewConstraintsBatchSize

(

int

value

)

Add that many lazy constraints (or cuts) at once in the LP. Note that at
the beginning of the solve, we do add more than this.

optional int32 new_constraints_batch_size = 122 [default = 50];

Parameters

value

The newConstraintsBatchSize to set.

Returns

This builder for chaining.

Definition at line 33476 of file SatParameters.java.

setNewLinearPropagation()

Builder com.google.ortools.sat.SatParameters.Builder.setNewLinearPropagation

(

boolean

value

)

The new linear propagation code treat all constraints at once and use
an adaptation of Bellman-Ford-Tarjan to propagate constraint in a smarter
order and potentially detect propagation cycle earlier.

optional bool new_linear_propagation = 224 [default = true];

Parameters

value

The newLinearPropagation to set.

Returns

This builder for chaining.

Definition at line 31883 of file SatParameters.java.

setNumConflictsBeforeStrategyChanges()

Builder com.google.ortools.sat.SatParameters.Builder.setNumConflictsBeforeStrategyChanges

(

int

value

)

After each restart, if the number of conflict since the last strategy
change is greater that this, then we increment a "strategy_counter" that
can be use to change the search strategy used by the following restarts.

optional int32 num_conflicts_before_strategy_changes = 68 [default = 0];

Parameters

value

The numConflictsBeforeStrategyChanges to set.

Returns

This builder for chaining.

Definition at line 20300 of file SatParameters.java.

setNumFullSubsolvers()

Builder com.google.ortools.sat.SatParameters.Builder.setNumFullSubsolvers

(

int

value

)

We distinguish subsolvers that consume a full thread, and the ones that are
always interleaved. If left at zero, we will fix this with a default
formula that depends on num_workers. But if you start modifying what runs,
you might want to fix that to a given value depending on the num_workers
you use.

optional int32 num_full_subsolvers = 294 [default = 0];

Parameters

value

The numFullSubsolvers to set.

Returns

This builder for chaining.

Definition at line 23970 of file SatParameters.java.

setNumSearchWorkers()

Builder com.google.ortools.sat.SatParameters.Builder.setNumSearchWorkers

(

int

value

)

optional int32 num_search_workers = 100 [default = 0];

Parameters

value

The numSearchWorkers to set.

Returns

This builder for chaining.

Definition at line 23906 of file SatParameters.java.

setNumViolationLs()

Builder com.google.ortools.sat.SatParameters.Builder.setNumViolationLs

(

int

value

)

This will create incomplete subsolvers (that are not LNS subsolvers)
that use the feasibility jump code to find improving solution, treating
the objective improvement as a hard constraint.

optional int32 num_violation_ls = 244 [default = 0];

Parameters

value

The numViolationLs to set.

Returns

This builder for chaining.

Definition at line 29251 of file SatParameters.java.

setNumWorkers()

Builder com.google.ortools.sat.SatParameters.Builder.setNumWorkers

(

int

value

)

Specify the number of parallel workers (i.e. threads) to use during search.
This should usually be lower than your number of available cpus +
hyperthread in your machine.

A value of 0 means the solver will try to use all cores on the machine.
A number of 1 means no parallelism.

Note that 'num_workers' is the preferred name, but if it is set to zero,
we will still read the deprecated 'num_search_workers'.

As of 2020-04-10, if you're using SAT via MPSolver (to solve integer
programs) this field is overridden with a value of 8, if the field is not
set *explicitly*. Thus, always set this field explicitly or via
MPSolver::SetNumThreads().

optional int32 num_workers = 206 [default = 0];

Parameters

value

The numWorkers to set.

Returns

This builder for chaining.

Definition at line 23849 of file SatParameters.java.

setOnlyAddCutsAtLevelZero()

Builder com.google.ortools.sat.SatParameters.Builder.setOnlyAddCutsAtLevelZero

(

boolean

value

)

For the cut that can be generated at any level, this control if we only
try to generate them at the root node.

optional bool only_add_cuts_at_level_zero = 92 [default = false];

Parameters

value

The onlyAddCutsAtLevelZero to set.

Returns

This builder for chaining.

Definition at line 32340 of file SatParameters.java.

setOnlySolveIp()

Builder com.google.ortools.sat.SatParameters.Builder.setOnlySolveIp

(

boolean

value

)

If one try to solve a MIP model with CP-SAT, because we assume all variable
to be integer after scaling, we will not necessarily have the correct
optimal. Note however that all feasible solutions are valid since we will
just solve a more restricted version of the original problem.

This parameters is here to prevent user to think the solution is optimal
when it might not be. One will need to manually set this to false to solve
a MIP model where the optimal might be different.

Note that this is tested after some MIP presolve steps, so even if not
all original variable are integer, we might end up with a pure IP after
presolve and after implied integer detection.

optional bool only_solve_ip = 222 [default = false];

Parameters

value

The onlySolveIp to set.

Returns

This builder for chaining.

Definition at line 34206 of file SatParameters.java.

setOptimizeWithCore()

Builder com.google.ortools.sat.SatParameters.Builder.setOptimizeWithCore

(

boolean

value

)

The default optimization method is a simple "linear scan", each time trying
to find a better solution than the previous one. If this is true, then we
use a core-based approach (like in max-SAT) when we try to increase the
lower bound instead.

optional bool optimize_with_core = 83 [default = false];

Parameters

value

The optimizeWithCore to set.

Returns

This builder for chaining.

Definition at line 28286 of file SatParameters.java.

setOptimizeWithLbTreeSearch()

Builder com.google.ortools.sat.SatParameters.Builder.setOptimizeWithLbTreeSearch

(

boolean

value

)

Do a more conventional tree search (by opposition to SAT based one) where
we keep all the explored node in a tree. This is meant to be used in a
portfolio and focus on improving the objective lower bound. Keeping the
whole tree allow us to report a better objective lower bound coming from
the worst open node in the tree.

optional bool optimize_with_lb_tree_search = 188 [default = false];

Parameters

value

The optimizeWithLbTreeSearch to set.

Returns

This builder for chaining.

Definition at line 28357 of file SatParameters.java.

setOptimizeWithMaxHs()

Builder com.google.ortools.sat.SatParameters.Builder.setOptimizeWithMaxHs

(

boolean

value

)

This has no effect if optimize_with_core is false. If true, use a different
core-based algorithm similar to the max-HS algo for max-SAT. This is a
hybrid MIP/CP approach and it uses a MIP solver in addition to the CP/SAT
one. This is also related to the PhD work of tobyodavies@
"Automatic Logic-Based Benders Decomposition with MiniZinc"
http://aaai.org/ocs/index.php/AAAI/AAAI17/paper/view/14489

optional bool optimize_with_max_hs = 85 [default = false];

Parameters

value

The optimizeWithMaxHs to set.

Returns

This builder for chaining.

Definition at line 28576 of file SatParameters.java.

setPbCleanupIncrement()

Builder com.google.ortools.sat.SatParameters.Builder.setPbCleanupIncrement

(

int

value

)

Same as for the clauses, but for the learned pseudo-Boolean constraints.

optional int32 pb_cleanup_increment = 46 [default = 200];

Parameters

value

The pbCleanupIncrement to set.

Returns

This builder for chaining.

Definition at line 19216 of file SatParameters.java.

setPbCleanupRatio()

Builder com.google.ortools.sat.SatParameters.Builder.setPbCleanupRatio

(

double

value

)

optional double pb_cleanup_ratio = 47 [default = 0.5];

Parameters

value

The pbCleanupRatio to set.

Returns

This builder for chaining.

Definition at line 19260 of file SatParameters.java.

setPermutePresolveConstraintOrder()

Builder com.google.ortools.sat.SatParameters.Builder.setPermutePresolveConstraintOrder

(

boolean

value

)

optional bool permute_presolve_constraint_order = 179 [default = false];

Parameters

value

The permutePresolveConstraintOrder to set.

Returns

This builder for chaining.

Definition at line 21058 of file SatParameters.java.

setPermuteVariableRandomly()

Builder com.google.ortools.sat.SatParameters.Builder.setPermuteVariableRandomly

(

boolean

value

)

This is mainly here to test the solver variability. Note that in tests, if
not explicitly set to false, all 3 options will be set to true so that
clients do not rely on the solver returning a specific solution if they are
many equivalent optimal solutions.

optional bool permute_variable_randomly = 178 [default = false];

Parameters

value

The permuteVariableRandomly to set.

Returns

This builder for chaining.

Definition at line 21011 of file SatParameters.java.

setPolarityRephaseIncrement()

Builder com.google.ortools.sat.SatParameters.Builder.setPolarityRephaseIncrement

(

int

value

)

If non-zero, then we change the polarity heuristic after that many number
of conflicts in an arithmetically increasing fashion. So x the first time,
2 * x the second time, etc...

optional int32 polarity_rephase_increment = 168 [default = 1000];

Parameters

value

The polarityRephaseIncrement to set.

Returns

This builder for chaining.

Definition at line 18338 of file SatParameters.java.

setPolishLpSolution()

Builder com.google.ortools.sat.SatParameters.Builder.setPolishLpSolution

(

boolean

value

)

Whether we try to do a few degenerate iteration at the end of an LP solve
to minimize the fractionality of the integer variable in the basis. This
helps on some problems, but not so much on others. It also cost of bit of
time to do such polish step.

optional bool polish_lp_solution = 175 [default = false];

Parameters

value

The polishLpSolution to set.

Returns

This builder for chaining.

Definition at line 31566 of file SatParameters.java.

setPreferredVariableOrder()

Builder com.google.ortools.sat.SatParameters.Builder.setPreferredVariableOrder

(

com.google.ortools.sat.SatParameters.VariableOrder

value

)

optional .operations_research.sat.SatParameters.VariableOrder preferred_variable_order = 1 [default = IN_ORDER];

Parameters

value

The preferredVariableOrder to set.

Returns

This builder for chaining.

Definition at line 18140 of file SatParameters.java.

setPresolveBlockedClause()

Builder com.google.ortools.sat.SatParameters.Builder.setPresolveBlockedClause

(

boolean

value

)

Whether we use an heuristic to detect some basic case of blocked clause
in the SAT presolve.

optional bool presolve_blocked_clause = 88 [default = true];

Parameters

value

The presolveBlockedClause to set.

Returns

This builder for chaining.

Definition at line 21961 of file SatParameters.java.

setPresolveBvaThreshold()

Builder com.google.ortools.sat.SatParameters.Builder.setPresolveBvaThreshold

(

int

value

)

Apply Bounded Variable Addition (BVA) if the number of clauses is reduced
by stricly more than this threshold. The algorithm described in the paper
uses 0, but quick experiments showed that 1 is a good value. It may not be
worth it to add a new variable just to remove one clause.

optional int32 presolve_bva_threshold = 73 [default = 1];

Parameters

value

The presolveBvaThreshold to set.

Returns

This builder for chaining.

Definition at line 22083 of file SatParameters.java.

setPresolveBveClauseWeight()

Builder com.google.ortools.sat.SatParameters.Builder.setPresolveBveClauseWeight

(

int

value

)

During presolve, we apply BVE only if this weight times the number of
clauses plus the number of clause literals is not increased.

optional int32 presolve_bve_clause_weight = 55 [default = 3];

Parameters

value

The presolveBveClauseWeight to set.

Returns

This builder for chaining.

Definition at line 21789 of file SatParameters.java.

setPresolveBveThreshold()

Builder com.google.ortools.sat.SatParameters.Builder.setPresolveBveThreshold

(

int

value

)

During presolve, only try to perform the bounded variable elimination (BVE)
of a variable x if the number of occurrences of x times the number of
occurrences of not(x) is not greater than this parameter.

optional int32 presolve_bve_threshold = 54 [default = 500];

Parameters

value

The presolveBveThreshold to set.

Returns

This builder for chaining.

Definition at line 21728 of file SatParameters.java.

setPresolveExtractIntegerEnforcement()

Builder com.google.ortools.sat.SatParameters.Builder.setPresolveExtractIntegerEnforcement

(

boolean

value

)

If true, we will extract from linear constraints, enforcement literals of
the form "integer variable at bound => simplified constraint". This should
always be beneficial except that we don't always handle them as efficiently
as we could for now. This causes problem on manna81.mps (LP relaxation not
as tight it seems) and on neos-3354841-apure.mps.gz (too many literals
created this way).

optional bool presolve_extract_integer_enforcement = 174 [default = false];

Parameters

value

The presolveExtractIntegerEnforcement to set.

Returns

This builder for chaining.

Definition at line 23189 of file SatParameters.java.

setPresolveInclusionWorkLimit()

Builder com.google.ortools.sat.SatParameters.Builder.setPresolveInclusionWorkLimit

(

long

value

)

A few presolve operations involve detecting constraints included in other
constraint. Since there can be a quadratic number of such pairs, and
processing them usually involve scanning them, the complexity of these
operations can be big. This enforce a local deterministic limit on the
number of entries scanned. Default is 1e8.

A value of zero will disable these presolve rules completely.

optional int64 presolve_inclusion_work_limit = 201 [default = 100000000];

Parameters

value

The presolveInclusionWorkLimit to set.

Returns

This builder for chaining.

Definition at line 23268 of file SatParameters.java.

setPresolveProbingDeterministicTimeLimit()

Builder com.google.ortools.sat.SatParameters.Builder.setPresolveProbingDeterministicTimeLimit

(

double

value

)

optional double presolve_probing_deterministic_time_limit = 57 [default = 30];

Parameters

value

The presolveProbingDeterministicTimeLimit to set.

Returns

This builder for chaining.

Definition at line 21906 of file SatParameters.java.

setPresolveSubstitutionLevel()

Builder com.google.ortools.sat.SatParameters.Builder.setPresolveSubstitutionLevel

(

int

value

)

How much substitution (also called free variable aggregation in MIP
litterature) should we perform at presolve. This currently only concerns
variable appearing only in linear constraints. For now the value 0 turns it
off and any positive value performs substitution.

optional int32 presolve_substitution_level = 147 [default = 1];

Parameters

value

The presolveSubstitutionLevel to set.

Returns

This builder for chaining.

Definition at line 23115 of file SatParameters.java.

setPresolveUseBva()

Builder com.google.ortools.sat.SatParameters.Builder.setPresolveUseBva

(

boolean

value

)

Whether or not we use Bounded Variable Addition (BVA) in the presolve.

optional bool presolve_use_bva = 72 [default = true];

Parameters

value

The presolveUseBva to set.

Returns

This builder for chaining.

Definition at line 22018 of file SatParameters.java.

setProbingDeterministicTimeLimit()

Builder com.google.ortools.sat.SatParameters.Builder.setProbingDeterministicTimeLimit

(

double

value

)

The maximum "deterministic" time limit to spend in probing. A value of
zero will disable the probing.

TODO(user): Clean up. The first one is used in CP-SAT, the other in pure
SAT presolve.

optional double probing_deterministic_time_limit = 226 [default = 1];

Parameters

value

The probingDeterministicTimeLimit to set.

Returns

This builder for chaining.

Definition at line 21858 of file SatParameters.java.

setProbingNumCombinationsLimit()

Builder com.google.ortools.sat.SatParameters.Builder.setProbingNumCombinationsLimit

(

int

value

)

How many combinations of pairs or triplets of variables we want to scan.

optional int32 probing_num_combinations_limit = 272 [default = 20000];

Parameters

value

The probingNumCombinationsLimit to set.

Returns

This builder for chaining.

Definition at line 27789 of file SatParameters.java.

setPropagationLoopDetectionFactor()

Builder com.google.ortools.sat.SatParameters.Builder.setPropagationLoopDetectionFactor

(

double

value

)

Some search decisions might cause a really large number of propagations to
happen when integer variables with large domains are only reduced by 1 at
each step. If we propagate more than the number of variable times this
parameters we try to take counter-measure. Setting this to 0.0 disable this
feature.

TODO(user): Setting this to something like 10 helps in most cases, but the
code is currently buggy and can cause the solve to enter a bad state where
no progress is made.

optional double propagation_loop_detection_factor = 221 [default = 10];

Parameters

value

The propagationLoopDetectionFactor to set.

Returns

This builder for chaining.

Definition at line 26211 of file SatParameters.java.

setPseudoCostReliabilityThreshold()

Builder com.google.ortools.sat.SatParameters.Builder.setPseudoCostReliabilityThreshold

(

long

value

)

The solver ignores the pseudo costs of variables with number of recordings
less than this threshold.

optional int64 pseudo_cost_reliability_threshold = 123 [default = 100];

Parameters

value

The pseudoCostReliabilityThreshold to set.

Returns

This builder for chaining.

Definition at line 28220 of file SatParameters.java.

setPushAllTasksTowardStart()

Builder com.google.ortools.sat.SatParameters.Builder.setPushAllTasksTowardStart

(

boolean

value

)

Experimental code: specify if the objective pushes all tasks toward the
start of the schedule.

optional bool push_all_tasks_toward_start = 262 [default = false];

Parameters

value

The pushAllTasksTowardStart to set.

Returns

This builder for chaining.

Definition at line 31104 of file SatParameters.java.

setRandomBranchesRatio()

Builder com.google.ortools.sat.SatParameters.Builder.setRandomBranchesRatio

(

double

value

)

A number between 0 and 1 that indicates the proportion of branching
variables that are selected randomly instead of choosing the first variable
from the given variable_ordering strategy.

optional double random_branches_ratio = 32 [default = 0];

Parameters

value

The randomBranchesRatio to set.

Returns

This builder for chaining.

Definition at line 18474 of file SatParameters.java.

setRandomizeSearch()

Builder com.google.ortools.sat.SatParameters.Builder.setRandomizeSearch

(

boolean

value

)

Randomize fixed search.

optional bool randomize_search = 103 [default = false];

Parameters

value

The randomizeSearch to set.

Returns

This builder for chaining.

Definition at line 30981 of file SatParameters.java.

setRandomPolarityRatio()

Builder com.google.ortools.sat.SatParameters.Builder.setRandomPolarityRatio

(

double

value

)

The proportion of polarity chosen at random. Note that this take
precedence over the phase saving heuristic. This is different from
initial_polarity:POLARITY_RANDOM because it will select a new random
polarity each time the variable is branched upon instead of selecting one
initially and then always taking this choice.

optional double random_polarity_ratio = 45 [default = 0];

Parameters

value

The randomPolarityRatio to set.

Returns

This builder for chaining.

Definition at line 18408 of file SatParameters.java.

setRandomSeed()

Builder com.google.ortools.sat.SatParameters.Builder.setRandomSeed

(

int

value

)

At the beginning of each solve, the random number generator used in some
part of the solver is reinitialized to this seed. If you change the random
seed, the solver may make different choices during the solving process.

For some problems, the running time may vary a lot depending on small
change in the solving algorithm. Running the solver with different seeds
enables to have more robust benchmarks when evaluating new features.

optional int32 random_seed = 31 [default = 1];

Parameters

value

The randomSeed to set.

Returns

This builder for chaining.

Definition at line 20940 of file SatParameters.java.

setRelativeGapLimit()

Builder com.google.ortools.sat.SatParameters.Builder.setRelativeGapLimit

(

double

value

)

optional double relative_gap_limit = 160 [default = 0];

Parameters

value

The relativeGapLimit to set.

Returns

This builder for chaining.

Definition at line 20870 of file SatParameters.java.

setRepairHint()

Builder com.google.ortools.sat.SatParameters.Builder.setRepairHint

(

boolean

value

)

If true, the solver tries to repair the solution given in the hint. This
search terminates after the 'hint_conflict_limit' is reached and the solver
switches to regular search. If false, then  we do a FIXED_SEARCH using the
hint until the hint_conflict_limit is reached.

optional bool repair_hint = 167 [default = false];

Parameters

value

The repairHint to set.

Returns

This builder for chaining.

Definition at line 27550 of file SatParameters.java.

setRestartAlgorithms()

Builder com.google.ortools.sat.SatParameters.Builder.setRestartAlgorithms	(	int	index,
		com.google.ortools.sat.SatParameters.RestartAlgorithm	value )

The restart strategies will change each time the strategy_counter is
increased. The current strategy will simply be the one at index
strategy_counter modulo the number of strategy. Note that if this list
includes a NO_RESTART, nothing will change when it is reached because the
strategy_counter will only increment after a restart.

The idea of switching of search strategy tailored for SAT/UNSAT comes from
Chanseok Oh with his COMiniSatPS solver, see http://cs.nyu.edu/~chanseok/.
But more generally, it seems REALLY beneficial to try different strategy.

repeated .operations_research.sat.SatParameters.RestartAlgorithm restart_algorithms = 61;

Parameters

index	The index to set the value at.
value	The restartAlgorithms to set.

Returns

This builder for chaining.

Definition at line 19735 of file SatParameters.java.

setRestartDlAverageRatio()

Builder com.google.ortools.sat.SatParameters.Builder.setRestartDlAverageRatio

(

double

value

)

In the moving average restart algorithms, a restart is triggered if the
window average times this ratio is greater that the global average.

optional double restart_dl_average_ratio = 63 [default = 1];

Parameters

value

The restartDlAverageRatio to set.

Returns

This builder for chaining.

Definition at line 20053 of file SatParameters.java.

setRestartLbdAverageRatio()

Builder com.google.ortools.sat.SatParameters.Builder.setRestartLbdAverageRatio

(

double

value

)

optional double restart_lbd_average_ratio = 71 [default = 1];

Parameters

value

The restartLbdAverageRatio to set.

Returns

This builder for chaining.

Definition at line 20098 of file SatParameters.java.

setRestartPeriod()

Builder com.google.ortools.sat.SatParameters.Builder.setRestartPeriod

(

int

value

)

Restart period for the FIXED_RESTART strategy. This is also the multiplier
used by the LUBY_RESTART strategy.

optional int32 restart_period = 30 [default = 50];

Parameters

value

The restartPeriod to set.

Returns

This builder for chaining.

Definition at line 19937 of file SatParameters.java.

setRestartRunningWindowSize()

Builder com.google.ortools.sat.SatParameters.Builder.setRestartRunningWindowSize

(

int

value

)

Size of the window for the moving average restarts.

optional int32 restart_running_window_size = 62 [default = 50];

Parameters

value

The restartRunningWindowSize to set.

Returns

This builder for chaining.

Definition at line 19994 of file SatParameters.java.

setRootLpIterations()

Builder com.google.ortools.sat.SatParameters.Builder.setRootLpIterations

(

int

value

)

Even at the root node, we do not want to spend too much time on the LP if
it is "difficult". So we solve it in "chunks" of that many iterations. The
solve will be continued down in the tree or the next time we go back to the
root node.

optional int32 root_lp_iterations = 227 [default = 2000];

Parameters

value

The rootLpIterations to set.

Returns

This builder for chaining.

Definition at line 33062 of file SatParameters.java.

setSaveLpBasisInLbTreeSearch()

Builder com.google.ortools.sat.SatParameters.Builder.setSaveLpBasisInLbTreeSearch

(

boolean

value

)

Experimental. Save the current LP basis at each node of the search tree so
that when we jump around, we can load it and reduce the number of LP
iterations needed.

It currently works okay if we do not change the lp with cuts or
simplification... More work is needed to make it robust in all cases.

optional bool save_lp_basis_in_lb_tree_search = 284 [default = false];

Parameters

value

The saveLpBasisInLbTreeSearch to set.

Returns

This builder for chaining.

Definition at line 28432 of file SatParameters.java.

setSearchBranching()

Builder com.google.ortools.sat.SatParameters.Builder.setSearchBranching

(

com.google.ortools.sat.SatParameters.SearchBranching

value

)

optional .operations_research.sat.SatParameters.SearchBranching search_branching = 82 [default = AUTOMATIC_SEARCH];

Parameters

value

The searchBranching to set.

Returns

This builder for chaining.

Definition at line 27431 of file SatParameters.java.

setSearchRandomVariablePoolSize()

Builder com.google.ortools.sat.SatParameters.Builder.setSearchRandomVariablePoolSize

(

long

value

)

Search randomization will collect the top
'search_random_variable_pool_size' valued variables, and pick one randomly.
The value of the variable is specific to each strategy.

optional int64 search_random_variable_pool_size = 104 [default = 0];

Parameters

value

The searchRandomVariablePoolSize to set.

Returns

This builder for chaining.

Definition at line 31043 of file SatParameters.java.

setShareBinaryClauses()

Builder com.google.ortools.sat.SatParameters.Builder.setShareBinaryClauses

(

boolean

value

)

Allows sharing of new learned binary clause between workers.

optional bool share_binary_clauses = 203 [default = true];

Parameters

value

The shareBinaryClauses to set.

Returns

This builder for chaining.

Definition at line 25487 of file SatParameters.java.

setSharedTreeMaxNodesPerWorker()

Builder com.google.ortools.sat.SatParameters.Builder.setSharedTreeMaxNodesPerWorker

(

int

value

)

In order to limit total shared memory and communication overhead, limit the
total number of nodes that may be generated in the shared tree. If the
shared tree runs out of unassigned leaves, workers act as portfolio
workers. Note: this limit includes interior nodes, not just leaves.

optional int32 shared_tree_max_nodes_per_worker = 238 [default = 100000];

Parameters

value

The sharedTreeMaxNodesPerWorker to set.

Returns

This builder for chaining.

Definition at line 29810 of file SatParameters.java.

setSharedTreeNumWorkers()

Builder com.google.ortools.sat.SatParameters.Builder.setSharedTreeNumWorkers

(

int

value

)

Enables experimental workstealing-like shared tree search.
If non-zero, start this many complete worker threads to explore a shared
search tree. These workers communicate objective bounds and simple decision
nogoods relating to the shared prefix of the tree, and will avoid exploring
the same subtrees as one another.

optional int32 shared_tree_num_workers = 235 [default = 0];

Parameters

value

The sharedTreeNumWorkers to set.

Returns

This builder for chaining.

Definition at line 29437 of file SatParameters.java.

setSharedTreeOpenLeavesPerWorker()

Builder com.google.ortools.sat.SatParameters.Builder.setSharedTreeOpenLeavesPerWorker

(

double

value

)

How many open leaf nodes should the shared tree maintain per worker.

optional double shared_tree_open_leaves_per_worker = 281 [default = 2];

Parameters

value

The sharedTreeOpenLeavesPerWorker to set.

Returns

This builder for chaining.

Definition at line 29745 of file SatParameters.java.

setSharedTreeSplitStrategy()

Builder com.google.ortools.sat.SatParameters.Builder.setSharedTreeSplitStrategy

(

com.google.ortools.sat.SatParameters.SharedTreeSplitStrategy

value

)

optional .operations_research.sat.SatParameters.SharedTreeSplitStrategy shared_tree_split_strategy = 239 [default = SPLIT_STRATEGY_AUTO];

Parameters

value

The sharedTreeSplitStrategy to set.

Returns

This builder for chaining.

Definition at line 29857 of file SatParameters.java.

setSharedTreeWorkerEnableTrailSharing()

Builder com.google.ortools.sat.SatParameters.Builder.setSharedTreeWorkerEnableTrailSharing

(

boolean

value

)

If true, workers share more of the information from their local trail.
Specifically, literals implied by the shared tree decisions and
the longest conflict-free assignment from the last restart (to enable
cross-worker phase-saving).

optional bool shared_tree_worker_enable_trail_sharing = 295 [default = true];

Parameters

value

The sharedTreeWorkerEnableTrailSharing to set.

Returns

This builder for chaining.

Definition at line 29686 of file SatParameters.java.

setSharedTreeWorkerMinRestartsPerSubtree()

Builder com.google.ortools.sat.SatParameters.Builder.setSharedTreeWorkerMinRestartsPerSubtree

(

int

value

)

Minimum number of restarts before a worker will replace a subtree
that looks "bad" based on the average LBD of learned clauses.

optional int32 shared_tree_worker_min_restarts_per_subtree = 282 [default = 1];

Parameters

value

The sharedTreeWorkerMinRestartsPerSubtree to set.

Returns

This builder for chaining.

Definition at line 29620 of file SatParameters.java.

setSharedTreeWorkerObjectiveSplitProbability()

Builder com.google.ortools.sat.SatParameters.Builder.setSharedTreeWorkerObjectiveSplitProbability

(

double

value

)

After their assigned prefix, shared tree workers will branch on the
objective with this probability. Higher numbers cause the shared tree
search to focus on improving the lower bound over finding primal solutions.

optional double shared_tree_worker_objective_split_probability = 237 [default = 0.5];

Parameters

value

The sharedTreeWorkerObjectiveSplitProbability to set.

Returns

This builder for chaining.

Definition at line 29559 of file SatParameters.java.

setShareGlueClauses()

Builder com.google.ortools.sat.SatParameters.Builder.setShareGlueClauses

(

boolean

value

)

Allows sharing of short glue clauses between workers.
Implicitly disabled if share_binary_clauses is false.

optional bool share_glue_clauses = 285 [default = false];

Parameters

value

The shareGlueClauses to set.

Returns

This builder for chaining.

Definition at line 25546 of file SatParameters.java.

setShareLevelZeroBounds()

Builder com.google.ortools.sat.SatParameters.Builder.setShareLevelZeroBounds

(

boolean

value

)

Allows sharing of the bounds of modified variables at level 0.

optional bool share_level_zero_bounds = 114 [default = true];

Parameters

value

The shareLevelZeroBounds to set.

Returns

This builder for chaining.

Definition at line 25431 of file SatParameters.java.

setShareObjectiveBounds()

Builder com.google.ortools.sat.SatParameters.Builder.setShareObjectiveBounds

(

boolean

value

)

Allows objective sharing between workers.

optional bool share_objective_bounds = 113 [default = true];

Parameters

value

The shareObjectiveBounds to set.

Returns

This builder for chaining.

Definition at line 25375 of file SatParameters.java.

setShavingSearchDeterministicTime()

Builder com.google.ortools.sat.SatParameters.Builder.setShavingSearchDeterministicTime

(

double

value

)

Specifies the amount of deterministic time spent of each try at shaving a
bound in the shaving search.

optional double shaving_search_deterministic_time = 205 [default = 0.001];

Parameters

value

The shavingSearchDeterministicTime to set.

Returns

This builder for chaining.

Definition at line 27908 of file SatParameters.java.

setShavingSearchThreshold()

Builder com.google.ortools.sat.SatParameters.Builder.setShavingSearchThreshold

(

long

value

)

Specifies the threshold between two modes in the shaving procedure.
If the range of the variable/objective is less than this threshold, then
the shaving procedure will try to remove values one by one. Otherwise, it
will try to remove one range at a time.

optional int64 shaving_search_threshold = 290 [default = 64];

Parameters

value

The shavingSearchThreshold to set.

Returns

This builder for chaining.

Definition at line 27974 of file SatParameters.java.

setSolutionPoolSize()

Builder com.google.ortools.sat.SatParameters.Builder.setSolutionPoolSize

(

int

value

)

Size of the top-n different solutions kept by the solver.
This parameter must be > 0.
Currently this only impact the "base" solution chosen for a LNS fragment.

optional int32 solution_pool_size = 193 [default = 3];

Parameters

value

The solutionPoolSize to set.

Returns

This builder for chaining.

Definition at line 30649 of file SatParameters.java.

setStopAfterFirstSolution()

Builder com.google.ortools.sat.SatParameters.Builder.setStopAfterFirstSolution

(

boolean

value

)

For an optimization problem, stop the solver as soon as we have a solution.

optional bool stop_after_first_solution = 98 [default = false];

Parameters

value

The stopAfterFirstSolution to set.

Returns

This builder for chaining.

Definition at line 30375 of file SatParameters.java.

setStopAfterPresolve()

Builder com.google.ortools.sat.SatParameters.Builder.setStopAfterPresolve

(

boolean

value

)

Mainly used when improving the presolver. When true, stops the solver after
the presolve is complete (or after loading and root level propagation).

optional bool stop_after_presolve = 149 [default = false];

Parameters

value

The stopAfterPresolve to set.

Returns

This builder for chaining.

Definition at line 30434 of file SatParameters.java.

setStopAfterRootPropagation()

Builder com.google.ortools.sat.SatParameters.Builder.setStopAfterRootPropagation

(

boolean

value

)

optional bool stop_after_root_propagation = 252 [default = false];

Parameters

value

The stopAfterRootPropagation to set.

Returns

This builder for chaining.

Definition at line 30479 of file SatParameters.java.

setStrategyChangeIncreaseRatio()

Builder com.google.ortools.sat.SatParameters.Builder.setStrategyChangeIncreaseRatio

(

double

value

)

The parameter num_conflicts_before_strategy_changes is increased by that
much after each strategy change.

optional double strategy_change_increase_ratio = 69 [default = 0];

Parameters

value

The strategyChangeIncreaseRatio to set.

Returns

This builder for chaining.

Definition at line 20361 of file SatParameters.java.

setSubsolverParams() [1/2]

Builder com.google.ortools.sat.SatParameters.Builder.setSubsolverParams	(	int	index,
		com.google.ortools.sat.SatParameters	value )

It is possible to specify additional subsolver configuration. These can be
referred by their params.name() in the fields above. Note that only the
specified field will "overwrite" the ones of the base parameter. If a
subsolver_params has the name of an existing subsolver configuration, the
named parameters will be merged into the subsolver configuration.

repeated .operations_research.sat.SatParameters subsolver_params = 210;

Definition at line 24918 of file SatParameters.java.

setSubsolverParams() [2/2]

Builder com.google.ortools.sat.SatParameters.Builder.setSubsolverParams	(	int	index,
		com.google.ortools.sat.SatParameters.Builder	builderForValue )

It is possible to specify additional subsolver configuration. These can be
referred by their params.name() in the fields above. Note that only the
specified field will "overwrite" the ones of the base parameter. If a
subsolver_params has the name of an existing subsolver configuration, the
named parameters will be merged into the subsolver configuration.

repeated .operations_research.sat.SatParameters subsolver_params = 210;

Definition at line 24943 of file SatParameters.java.

setSubsolvers()

Builder com.google.ortools.sat.SatParameters.Builder.setSubsolvers	(	int	index,
		java.lang.String	value )

In multi-thread, the solver can be mainly seen as a portfolio of solvers
with different parameters. This field indicates the names of the parameters
that are used in multithread. This only applies to "full" subsolvers.

See cp_model_search.cc to see a list of the names and the default value (if
left empty) that looks like:
- default_lp           (linearization_level:1)
- fixed                (only if fixed search specified or scheduling)
- no_lp                (linearization_level:0)
- max_lp               (linearization_level:2)
- pseudo_costs         (only if objective, change search heuristic)
- reduced_costs        (only if objective, change search heuristic)
- quick_restart        (kind of probing)
- quick_restart_no_lp  (kind of probing with linearization_level:0)
- lb_tree_search       (to improve lower bound, MIP like tree search)
- probing              (continuous probing and shaving)

Also, note that some set of parameters will be ignored if they do not make
sense. For instance if there is no objective, pseudo_cost or reduced_cost
search will be ignored. Core based search will only work if the objective
has many terms. If there is no fixed strategy fixed will be ignored. And so
on.

The order is important, as only the first num_full_subsolvers will be
scheduled. You can see in the log which one are selected for a given run.

repeated string subsolvers = 207;

Parameters

index	The index to set the value at.
value	The subsolvers to set.

Returns

This builder for chaining.

Definition at line 24183 of file SatParameters.java.

setSubsumptionDuringConflictAnalysis()

Builder com.google.ortools.sat.SatParameters.Builder.setSubsumptionDuringConflictAnalysis

(

boolean

value

)

At a really low cost, during the 1-UIP conflict computation, it is easy to
detect if some of the involved reasons are subsumed by the current
conflict. When this is true, such clauses are detached and later removed
from the problem.

optional bool subsumption_during_conflict_analysis = 56 [default = true];

Parameters

value

The subsumptionDuringConflictAnalysis to set.

Returns

This builder for chaining.

Definition at line 18833 of file SatParameters.java.

setSymmetryLevel()

Builder com.google.ortools.sat.SatParameters.Builder.setSymmetryLevel

(

int

value

)

Whether we try to automatically detect the symmetries in a model and
exploit them. Currently, at level 1 we detect them in presolve and try
to fix Booleans. At level 2, we also do some form of dynamic symmetry
breaking during search. At level 3, we also detect symmetries for very
large models, which can be slow. At level 4, we try to break as much
symmetry as possible in presolve.

optional int32 symmetry_level = 183 [default = 2];

Parameters

value

The symmetryLevel to set.

Returns

This builder for chaining.

Definition at line 31816 of file SatParameters.java.

setTableCompressionLevel()

Builder com.google.ortools.sat.SatParameters.Builder.setTableCompressionLevel

(

int

value

)

How much we try to "compress" a table constraint. Compressing more leads to
less Booleans and faster propagation but can reduced the quality of the lp
relaxation. Values goes from 0 to 3 where we always try to fully compress a
table. At 2, we try to automatically decide if it is worth it.

optional int32 table_compression_level = 217 [default = 2];

Parameters

value

The tableCompressionLevel to set.

Returns

This builder for chaining.

Definition at line 22459 of file SatParameters.java.

setUseAbslRandom()

Builder com.google.ortools.sat.SatParameters.Builder.setUseAbslRandom

(

boolean

value

)

optional bool use_absl_random = 180 [default = false];

Parameters

value

The useAbslRandom to set.

Returns

This builder for chaining.

Definition at line 21098 of file SatParameters.java.

setUseAreaEnergeticReasoningInNoOverlap2D()

Builder com.google.ortools.sat.SatParameters.Builder.setUseAreaEnergeticReasoningInNoOverlap2D

(

boolean

value

)

When this is true, the no_overlap_2d constraint is reinforced with
an energetic reasoning that uses an area-based energy. This can be combined
with the two other overlap heuristics above.

optional bool use_area_energetic_reasoning_in_no_overlap_2d = 271 [default = false];

Parameters

value

The useAreaEnergeticReasoningInNoOverlap2d to set.

Returns

This builder for chaining.

Definition at line 27257 of file SatParameters.java.

setUseBlockingRestart()

Builder com.google.ortools.sat.SatParameters.Builder.setUseBlockingRestart

(

boolean

value

)

Block a moving restart algorithm if the trail size of the current conflict
is greater than the multiplier times the moving average of the trail size
at the previous conflicts.

optional bool use_blocking_restart = 64 [default = false];

Parameters

value

The useBlockingRestart to set.

Returns

This builder for chaining.

Definition at line 20156 of file SatParameters.java.

setUseCombinedNoOverlap()

Builder com.google.ortools.sat.SatParameters.Builder.setUseCombinedNoOverlap

(

boolean

value

)

This can be beneficial if there is a lot of no-overlap constraints but a
relatively low number of different intervals in the problem. Like 1000
intervals, but 1M intervals in the no-overlap constraints covering them.

optional bool use_combined_no_overlap = 133 [default = false];

Parameters

value

The useCombinedNoOverlap to set.

Returns

This builder for chaining.

Definition at line 31311 of file SatParameters.java.

setUseConservativeScaleOverloadChecker()

Builder com.google.ortools.sat.SatParameters.Builder.setUseConservativeScaleOverloadChecker

(

boolean

value

)

Enable a heuristic to solve cumulative constraints using a modified energy
constraint. We modify the usual energy definition by applying a
super-additive function (also called "conservative scale" or "dual-feasible
function") to the demand and the durations of the tasks.

This heuristic is fast but for most problems it does not help much to find
a solution.

optional bool use_conservative_scale_overload_checker = 286 [default = false];

Parameters

value

The useConservativeScaleOverloadChecker to set.

Returns

This builder for chaining.

Definition at line 26705 of file SatParameters.java.

setUseDisjunctiveConstraintInCumulative()

Builder com.google.ortools.sat.SatParameters.Builder.setUseDisjunctiveConstraintInCumulative

(

boolean

value

)

When this is true, the cumulative constraint is reinforced with propagators
from the disjunctive constraint to improve the inference on a set of tasks
that are disjunctive at the root of the problem. This additional level
supplements the default level of reasoning.

Propagators of the cumulative constraint will not be used at all if all the
tasks are disjunctive at root node.

This always result in better propagation, but it is usually slow, so
depending on the problem, turning this off may lead to a faster solution.

optional bool use_disjunctive_constraint_in_cumulative = 80 [default = true];

Parameters

value

The useDisjunctiveConstraintInCumulative to set.

Returns

This builder for chaining.

Definition at line 27050 of file SatParameters.java.

setUseDualSchedulingHeuristics()

Builder com.google.ortools.sat.SatParameters.Builder.setUseDualSchedulingHeuristics

(

boolean

value

)

When set, it activates a few scheduling parameters to improve the lower
bound of scheduling problems. This is only effective with multiple workers
as it modifies the reduced_cost, lb_tree_search, and probing workers.

optional bool use_dual_scheduling_heuristics = 214 [default = true];

Parameters

value

The useDualSchedulingHeuristics to set.

Returns

This builder for chaining.

Definition at line 27385 of file SatParameters.java.

setUseDynamicPrecedenceInCumulative()

Builder com.google.ortools.sat.SatParameters.Builder.setUseDynamicPrecedenceInCumulative

(

boolean

value

)

optional bool use_dynamic_precedence_in_cumulative = 268 [default = false];

Parameters

value

The useDynamicPrecedenceInCumulative to set.

Returns

This builder for chaining.

Definition at line 26555 of file SatParameters.java.

setUseDynamicPrecedenceInDisjunctive()

Builder com.google.ortools.sat.SatParameters.Builder.setUseDynamicPrecedenceInDisjunctive

(

boolean

value

)

Whether we try to branch on decision "interval A before interval B" rather
than on intervals bounds. This usually works better, but slow down a bit
the time to find the first solution.

These parameters are still EXPERIMENTAL, the result should be correct, but
it some corner cases, they can cause some failing CHECK in the solver.

optional bool use_dynamic_precedence_in_disjunctive = 263 [default = false];

Parameters

value

The useDynamicPrecedenceInDisjunctive to set.

Returns

This builder for chaining.

Definition at line 26506 of file SatParameters.java.

setUseEnergeticReasoningInNoOverlap2D()

Builder com.google.ortools.sat.SatParameters.Builder.setUseEnergeticReasoningInNoOverlap2D

(

boolean

value

)

When this is true, the no_overlap_2d constraint is reinforced with
energetic reasoning. This additional level supplements the default level of
reasoning.

optional bool use_energetic_reasoning_in_no_overlap_2d = 213 [default = false];

Parameters

value

The useEnergeticReasoningInNoOverlap2d to set.

Returns

This builder for chaining.

Definition at line 27193 of file SatParameters.java.

setUseErwaHeuristic()

Builder com.google.ortools.sat.SatParameters.Builder.setUseErwaHeuristic

(

boolean

value

)

Whether we use the ERWA (Exponential Recency Weighted Average) heuristic as
described in "Learning Rate Based Branching Heuristic for SAT solvers",
J.H.Liang, V. Ganesh, P. Poupart, K.Czarnecki, SAT 2016.

optional bool use_erwa_heuristic = 75 [default = false];

Parameters

value

The useErwaHeuristic to set.

Returns

This builder for chaining.

Definition at line 18538 of file SatParameters.java.

setUseExactLpReason()

Builder com.google.ortools.sat.SatParameters.Builder.setUseExactLpReason

(

boolean

value

)

The solver usually exploit the LP relaxation of a model. If this option is
true, then whatever is infered by the LP will be used like an heuristic to
compute EXACT propagation on the IP. So with this option, there is no
numerical imprecision issues.

optional bool use_exact_lp_reason = 109 [default = true];

Parameters

value

The useExactLpReason to set.

Returns

This builder for chaining.

Definition at line 31246 of file SatParameters.java.

setUseExtendedProbing()

Builder com.google.ortools.sat.SatParameters.Builder.setUseExtendedProbing

(

boolean

value

)

Use extended probing (probe bool_or, at_most_one, exactly_one).

optional bool use_extended_probing = 269 [default = true];

Parameters

value

The useExtendedProbing to set.

Returns

This builder for chaining.

Definition at line 27733 of file SatParameters.java.

setUseFeasibilityJump()

Builder com.google.ortools.sat.SatParameters.Builder.setUseFeasibilityJump

(

boolean

value

)

Parameters for an heuristic similar to the one described in the paper:
"Feasibility Jump: an LP-free Lagrangian MIP heuristic", Bjørnar
Luteberget, Giorgio Sartor, 2023, Mathematical Programming Computation.

optional bool use_feasibility_jump = 265 [default = true];

Parameters

value

The useFeasibilityJump to set.

Returns

This builder for chaining.

Definition at line 28643 of file SatParameters.java.

setUseFeasibilityPump()

Builder com.google.ortools.sat.SatParameters.Builder.setUseFeasibilityPump

(

boolean

value

)

Adds a feasibility pump subsolver along with lns subsolvers.

optional bool use_feasibility_pump = 164 [default = true];

Parameters

value

The useFeasibilityPump to set.

Returns

This builder for chaining.

Definition at line 30763 of file SatParameters.java.

setUseHardPrecedencesInCumulative()

Builder com.google.ortools.sat.SatParameters.Builder.setUseHardPrecedencesInCumulative

(

boolean

value

)

If true, detect and create constraint for integer variable that are "after"
a set of intervals in the same cumulative constraint.

Experimental: by default we just use "direct" precedences. If
exploit_all_precedences is true, we explore the full precedence graph. This
assumes we have a DAG otherwise it fails.

optional bool use_hard_precedences_in_cumulative = 215 [default = false];

Parameters

value

The useHardPrecedencesInCumulative to set.

Returns

This builder for chaining.

Definition at line 26922 of file SatParameters.java.

setUseImpliedBounds()

Builder com.google.ortools.sat.SatParameters.Builder.setUseImpliedBounds

(

boolean

value

)

Stores and exploits "implied-bounds" in the solver. That is, relations of
the form literal => (var >= bound). This is currently used to derive
stronger cuts.

optional bool use_implied_bounds = 144 [default = true];

Parameters

value

The useImpliedBounds to set.

Returns

This builder for chaining.

Definition at line 31499 of file SatParameters.java.

setUseLbRelaxLns()

Builder com.google.ortools.sat.SatParameters.Builder.setUseLbRelaxLns

(

boolean

value

)

Turns on neighborhood generator based on local branching LP. Based on Huang
et al., "Local Branching Relaxation Heuristics for Integer Linear
Programs", 2023.

optional bool use_lb_relax_lns = 255 [default = false];

Parameters

value

The useLbRelaxLns to set.

Returns

This builder for chaining.

Definition at line 30825 of file SatParameters.java.

setUseLns()

Builder com.google.ortools.sat.SatParameters.Builder.setUseLns

(

boolean

value

)

Testing parameters used to disable all lns workers.

optional bool use_lns = 283 [default = true];

Parameters

value

The useLns to set.

Returns

This builder for chaining.

Definition at line 30531 of file SatParameters.java.

setUseLnsOnly()

Builder com.google.ortools.sat.SatParameters.Builder.setUseLnsOnly

(

boolean

value

)

Experimental parameters to disable everything but lns.

optional bool use_lns_only = 101 [default = false];

Parameters

value

The useLnsOnly to set.

Returns

This builder for chaining.

Definition at line 30587 of file SatParameters.java.

setUseLsOnly()

Builder com.google.ortools.sat.SatParameters.Builder.setUseLsOnly

(

boolean

value

)

Disable every other type of subsolver, setting this turns CP-SAT into a
pure local-search solver.

optional bool use_ls_only = 240 [default = false];

Parameters

value

The useLsOnly to set.

Returns

This builder for chaining.

Definition at line 28704 of file SatParameters.java.

setUseObjectiveLbSearch()

Builder com.google.ortools.sat.SatParameters.Builder.setUseObjectiveLbSearch

(

boolean

value

)

If true, search will search in ascending max objective value (when
minimizing) starting from the lower bound of the objective.

optional bool use_objective_lb_search = 228 [default = false];

Parameters

value

The useObjectiveLbSearch to set.

Returns

This builder for chaining.

Definition at line 28036 of file SatParameters.java.

setUseObjectiveShavingSearch()

Builder com.google.ortools.sat.SatParameters.Builder.setUseObjectiveShavingSearch

(

boolean

value

)

This search differs from the previous search as it will not use assumptions
to bound the objective, and it will recreate a full model with the
hardcoded objective value.

optional bool use_objective_shaving_search = 253 [default = false];

Parameters

value

The useObjectiveShavingSearch to set.

Returns

This builder for chaining.

Definition at line 28099 of file SatParameters.java.

setUseOptimizationHints()

Builder com.google.ortools.sat.SatParameters.Builder.setUseOptimizationHints

(

boolean

value

)

For an optimization problem, whether we follow some hints in order to find
a better first solution. For a variable with hint, the solver will always
try to follow the hint. It will revert to the variable_branching default
otherwise.

optional bool use_optimization_hints = 35 [default = true];

Parameters

value

The useOptimizationHints to set.

Returns

This builder for chaining.

Definition at line 25792 of file SatParameters.java.

setUseOptionalVariables()

Builder com.google.ortools.sat.SatParameters.Builder.setUseOptionalVariables

(

boolean

value

)

If true, we automatically detect variables whose constraint are always
enforced by the same literal and we mark them as optional. This allows
to propagate them as if they were present in some situation.

TODO(user): This is experimental and seems to lead to wrong optimal in
some situation. It should however gives correct solutions. Fix.

optional bool use_optional_variables = 108 [default = false];

Parameters

value

The useOptionalVariables to set.

Returns

This builder for chaining.

Definition at line 31176 of file SatParameters.java.

setUseOverloadCheckerInCumulative()

Builder com.google.ortools.sat.SatParameters.Builder.setUseOverloadCheckerInCumulative

(

boolean

value

)

When this is true, the cumulative constraint is reinforced with overload
checking, i.e., an additional level of reasoning based on energy. This
additional level supplements the default level of reasoning as well as
timetable edge finding.

This always result in better propagation, but it is usually slow, so
depending on the problem, turning this off may lead to a faster solution.

optional bool use_overload_checker_in_cumulative = 78 [default = false];

Parameters

value

The useOverloadCheckerInCumulative to set.

Returns

This builder for chaining.

Definition at line 26625 of file SatParameters.java.

setUsePbResolution()

Builder com.google.ortools.sat.SatParameters.Builder.setUsePbResolution

(

boolean

value

)

Whether to use pseudo-Boolean resolution to analyze a conflict. Note that
this option only make sense if your problem is modelized using
pseudo-Boolean constraints. If you only have clauses, this shouldn't change
anything (except slow the solver down).

optional bool use_pb_resolution = 43 [default = false];

Parameters

value

The usePbResolution to set.

Returns

This builder for chaining.

Definition at line 21507 of file SatParameters.java.

setUsePhaseSaving()

Builder com.google.ortools.sat.SatParameters.Builder.setUsePhaseSaving

(

boolean

value

)

If this is true, then the polarity of a variable will be the last value it
was assigned to, or its default polarity if it was never assigned since the
call to ResetDecisionHeuristic().

Actually, we use a newer version where we follow the last value in the
longest non-conflicting partial assignment in the current phase.

This is called 'literal phase saving'. For details see 'A Lightweight
Component Caching Scheme for Satisfiability Solvers' K. Pipatsrisawat and
A.Darwiche, In 10th International Conference on Theory and Applications of
Satisfiability Testing, 2007.

optional bool use_phase_saving = 44 [default = true];

Parameters

value

The usePhaseSaving to set.

Returns

This builder for chaining.

Definition at line 18266 of file SatParameters.java.

setUsePrecedencesInDisjunctiveConstraint()

Builder com.google.ortools.sat.SatParameters.Builder.setUsePrecedencesInDisjunctiveConstraint

(

boolean

value

)

When this is true, then a disjunctive constraint will try to use the
precedence relations between time intervals to propagate their bounds
further. For instance if task A and B are both before C and task A and B
are in disjunction, then we can deduce that task C must start after
duration(A) + duration(B) instead of simply max(duration(A), duration(B)),
provided that the start time for all task was currently zero.

This always result in better propagation, but it is usually slow, so
depending on the problem, turning this off may lead to a faster solution.

optional bool use_precedences_in_disjunctive_constraint = 74 [default = true];

Parameters

value

The usePrecedencesInDisjunctiveConstraint to set.

Returns

This builder for chaining.

Definition at line 26299 of file SatParameters.java.

setUseProbingSearch()

Builder com.google.ortools.sat.SatParameters.Builder.setUseProbingSearch

(

boolean

value

)

If true, search will continuously probe Boolean variables, and integer
variable bounds. This parameter is set to true in parallel on the probing
worker.

optional bool use_probing_search = 176 [default = false];

Parameters

value

The useProbingSearch to set.

Returns

This builder for chaining.

Definition at line 27675 of file SatParameters.java.

setUseRinsLns()

Builder com.google.ortools.sat.SatParameters.Builder.setUseRinsLns

(

boolean

value

)

Turns on relaxation induced neighborhood generator.

optional bool use_rins_lns = 129 [default = true];

Parameters

value

The useRinsLns to set.

Returns

This builder for chaining.

Definition at line 30707 of file SatParameters.java.

setUseSatInprocessing()

Builder com.google.ortools.sat.SatParameters.Builder.setUseSatInprocessing

(

boolean

value

)

Enable or disable "inprocessing" which is some SAT presolving done at
each restart to the root level.

optional bool use_sat_inprocessing = 163 [default = true];

Parameters

value

The useSatInprocessing to set.

Returns

This builder for chaining.

Definition at line 23541 of file SatParameters.java.

setUseSharedTreeSearch()

Builder com.google.ortools.sat.SatParameters.Builder.setUseSharedTreeSearch

(

boolean

value

)

Set on shared subtree workers. Users should not set this directly.

optional bool use_shared_tree_search = 236 [default = false];

Parameters

value

The useSharedTreeSearch to set.

Returns

This builder for chaining.

Definition at line 29497 of file SatParameters.java.

setUseShavingInProbingSearch()

Builder com.google.ortools.sat.SatParameters.Builder.setUseShavingInProbingSearch

(

boolean

value

)

Add a shaving phase (where the solver tries to prove that the lower or
upper bound of a variable are infeasible) to the probing search.

optional bool use_shaving_in_probing_search = 204 [default = true];

Parameters

value

The useShavingInProbingSearch to set.

Returns

This builder for chaining.

Definition at line 27848 of file SatParameters.java.

setUseStrongPropagationInDisjunctive()

Builder com.google.ortools.sat.SatParameters.Builder.setUseStrongPropagationInDisjunctive

(

boolean

value

)

Enable stronger and more expensive propagation on no_overlap constraint.

optional bool use_strong_propagation_in_disjunctive = 230 [default = false];

Parameters

value

The useStrongPropagationInDisjunctive to set.

Returns

This builder for chaining.

Definition at line 26435 of file SatParameters.java.

setUseTimetableEdgeFindingInCumulative()

Builder com.google.ortools.sat.SatParameters.Builder.setUseTimetableEdgeFindingInCumulative

(

boolean

value

)

When this is true, the cumulative constraint is reinforced with timetable
edge finding, i.e., an additional level of reasoning based on the
conjunction of energy and mandatory parts. This additional level
supplements the default level of reasoning as well as overload_checker.

This always result in better propagation, but it is usually slow, so
depending on the problem, turning this off may lead to a faster solution.

optional bool use_timetable_edge_finding_in_cumulative = 79 [default = false];

Parameters

value

The useTimetableEdgeFindingInCumulative to set.

Returns

This builder for chaining.

Definition at line 26785 of file SatParameters.java.

setUseTimetablingInNoOverlap2D()

Builder com.google.ortools.sat.SatParameters.Builder.setUseTimetablingInNoOverlap2D

(

boolean

value

)

When this is true, the no_overlap_2d constraint is reinforced with
propagators from the cumulative constraints. It consists of ignoring the
position of rectangles in one position and projecting the no_overlap_2d on
the other dimension to create a cumulative constraint. This is done on both
axis. This additional level supplements the default level of reasoning.

optional bool use_timetabling_in_no_overlap_2d = 200 [default = false];

Parameters

value

The useTimetablingInNoOverlap2d to set.

Returns

This builder for chaining.

Definition at line 27127 of file SatParameters.java.

setUseVariablesShavingSearch()

Builder com.google.ortools.sat.SatParameters.Builder.setUseVariablesShavingSearch

(

boolean

value

)

This search takes all Boolean or integer variables, and maximize or
minimize them in order to reduce their domain.

optional bool use_variables_shaving_search = 289 [default = false];

Parameters

value

The useVariablesShavingSearch to set.

Returns

This builder for chaining.

Definition at line 28160 of file SatParameters.java.

setVariableActivityDecay()

Builder com.google.ortools.sat.SatParameters.Builder.setVariableActivityDecay

(

double

value

)

Each time a conflict is found, the activities of some variables are
increased by one. Then, the activity of all variables are multiplied by
variable_activity_decay.

To implement this efficiently, the activity of all the variables is not
decayed at each conflict. Instead, the activity increment is multiplied by
1 / decay. When an activity reach max_variable_activity_value, all the
activity are multiplied by 1 / max_variable_activity_value.

optional double variable_activity_decay = 15 [default = 0.8];

Parameters

value

The variableActivityDecay to set.

Returns

This builder for chaining.

Definition at line 19333 of file SatParameters.java.

setViolationLsCompoundMoveProbability()

Builder com.google.ortools.sat.SatParameters.Builder.setViolationLsCompoundMoveProbability

(

double

value

)

Probability of using compound move search each restart.
TODO(user): Add reference to paper when published.

optional double violation_ls_compound_move_probability = 259 [default = 0.5];

Parameters

value

The violationLsCompoundMoveProbability to set.

Returns

This builder for chaining.

Definition at line 29368 of file SatParameters.java.

setViolationLsPerturbationPeriod()

Builder com.google.ortools.sat.SatParameters.Builder.setViolationLsPerturbationPeriod

(

int

value

)

How long violation_ls should wait before perturbating a solution.

optional int32 violation_ls_perturbation_period = 249 [default = 100];

Parameters

value

The violationLsPerturbationPeriod to set.

Returns

This builder for chaining.

Definition at line 29309 of file SatParameters.java.

---

The documentation for this class was generated from the following file:

• build/java/ortools-java/src/main/java/com/google/ortools/sat/SatParameters.java