 |
Google OR-Tools v9.15
a fast and portable software suite for combinatorial optimization
|
|
Google OR-Tools v9.15
a fast and portable software suite for combinatorial optimization
|
Contains the definitions for all the sat algorithm parameters and their default values. NEXT TAG: 356
Protobuf type operations_research.sat.SatParameters
Definition at line 19 of file SatParameters.java.
Classes | |
| enum | VariableOrder |
| enum | Polarity |
| enum | ConflictMinimizationAlgorithm |
| enum | BinaryMinizationAlgorithm |
| enum | ClauseOrdering |
| enum | RestartAlgorithm |
| enum | MaxSatAssumptionOrder |
| enum | MaxSatStratificationAlgorithm |
| enum | SearchBranching |
| enum | SharedTreeSplitStrategy |
| enum | FPRoundingMethod |
| class | Builder |
Static Public Member Functions | |
| static final com.google.protobuf.Descriptors.Descriptor | getDescriptor () |
| static com.google.ortools.sat.SatParameters | parseFrom (java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException |
| static com.google.ortools.sat.SatParameters | parseFrom (java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException |
| static com.google.ortools.sat.SatParameters | parseFrom (com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException |
| static com.google.ortools.sat.SatParameters | parseFrom (com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException |
| static com.google.ortools.sat.SatParameters | parseFrom (byte[] data) throws com.google.protobuf.InvalidProtocolBufferException |
| static com.google.ortools.sat.SatParameters | parseFrom (byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException |
| static com.google.ortools.sat.SatParameters | parseFrom (java.io.InputStream input) throws java.io.IOException |
| static com.google.ortools.sat.SatParameters | parseFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException |
| static com.google.ortools.sat.SatParameters | parseDelimitedFrom (java.io.InputStream input) throws java.io.IOException |
| static com.google.ortools.sat.SatParameters | parseDelimitedFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException |
| static com.google.ortools.sat.SatParameters | parseFrom (com.google.protobuf.CodedInputStream input) throws java.io.IOException |
| static com.google.ortools.sat.SatParameters | parseFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException |
| static Builder | newBuilder () |
| static Builder | newBuilder (com.google.ortools.sat.SatParameters prototype) |
| static com.google.ortools.sat.SatParameters | getDefaultInstance () |
| static com.google.protobuf.Parser< SatParameters > | parser () |
Protected Member Functions | |
| com.google.protobuf.GeneratedMessage.FieldAccessorTable | internalGetFieldAccessorTable () |
| Builder | newBuilderForType (com.google.protobuf.GeneratedMessage.BuilderParent parent) |
| boolean com.google.ortools.sat.SatParameters.equals | ( | final java.lang.Object | obj | ) |
Definition at line 13876 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3643 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10501 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10590 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10681 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10755 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10530 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10472 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10619 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10559 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2321 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getAlternativePoolSize | ( | ) |
In order to not get stuck in local optima, when this is non-zero, we try to also work on "older" solutions with a worse objective value so we get a chance to follow a different LS/LNS trajectory.
optional int32 alternative_pool_size = 325 [default = 1];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9499 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9873 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9229 of file SatParameters.java.
| com.google.ortools.sat.SatParameters.BinaryMinizationAlgorithm com.google.ortools.sat.SatParameters.getBinaryMinimizationAlgorithm | ( | ) |
optional .operations_research.sat.SatParameters.BinaryMinizationAlgorithm binary_minimization_algorithm = 34 [default = BINARY_MINIMIZATION_FROM_UIP_AND_DECISIONS];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2356 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8280 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.getBlockingRestartMultiplier | ( | ) |
optional double blocking_restart_multiplier = 66 [default = 1.4];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3357 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getBlockingRestartWindowSize | ( | ) |
optional int32 blocking_restart_window_size = 65 [default = 5000];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3338 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10309 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9904 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getCheckDratProof | ( | ) |
If true, and if the problem is UNSAT, a DRAT proof of this UNSAT property is checked after the solver has finished. As of November 2025, this only works for pure SAT problems, with - num_workers = 1, - cp_model_presolve = false, - linearization_level <= 1, - symmetry_level <= 1.
optional bool check_drat_proof = 346 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6317 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getCheckLratProof | ( | ) |
If true, inferred clauses are checked with an LRAT checker as they are learned, in presolve (reduced to trivial simplifications if cp_model_presolve is false), and in each worker. As of December 2025, this only works with pure SAT problems, with - cp_model_presolve = false, - linearization_level <= 1, - symmetry_level <= 1.
optional bool check_lrat_proof = 344 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6202 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getCheckMergedLratProof | ( | ) |
If true, and if output_lrat_proof is true and the problem is UNSAT, check that the merged proof file is valid, i.e., that clause sharing between workers is correct. This checks each inferred clause, so you might want to disable check_lrat_proof to avoid redundant work. As of November 2025, this only works for pure SAT problems, with num_workers = 1.
optional bool check_merged_lrat_proof = 352 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6237 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getChronologicalBacktrackMinConflicts | ( | ) |
If chronological backtracking is enabled, this is the minimum number of conflicts before we will consider backjumping.
optional int32 chronological_backtrack_min_conflicts = 332 [default = 1000];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2599 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.getClauseActivityDecay | ( | ) |
Clause activity parameters (same effect as the one on the variables).
optional double clause_activity_decay = 17 [default = 0.999];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3040 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getClauseCleanupLbdBound | ( | ) |
All the clauses with a LBD (literal blocks distance) lower or equal to this parameters will always be kept. Note that the LBD of a clause that just propagated is 1 + number of different decision levels of its literals. So that the "classic" LBD of a learned conflict is the same as its LBD when we backjump and then propagate it.
optional int32 clause_cleanup_lbd_bound = 59 [default = 5];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2752 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getClauseCleanupLbdTier1 | ( | ) |
All the clause with a LBD lower or equal to this will be kept except if its activity hasn't been bumped in the last 32 cleanup phase. Note that this has no effect if it is <= clause_cleanup_lbd_bound.
optional int32 clause_cleanup_lbd_tier1 = 349 [default = 0];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2783 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getClauseCleanupLbdTier2 | ( | ) |
All the clause with a LBD lower or equal to this will be kept except if its activity hasn't been bumped since the previous cleanup phase. Note that this has no effect if it is <= clause_cleanup_lbd_bound or <= clause_cleanup_lbd_tier1.
optional int32 clause_cleanup_lbd_tier2 = 350 [default = 0];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2816 of file SatParameters.java.
| com.google.ortools.sat.SatParameters.ClauseOrdering com.google.ortools.sat.SatParameters.getClauseCleanupOrdering | ( | ) |
optional .operations_research.sat.SatParameters.ClauseOrdering clause_cleanup_ordering = 60 [default = CLAUSE_ACTIVITY];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2833 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getClauseCleanupPeriod | ( | ) |
Trigger a cleanup when this number of "deletable" clauses is learned.
optional int32 clause_cleanup_period = 11 [default = 10000];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2626 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getClauseCleanupPeriodIncrement | ( | ) |
Increase clause_cleanup_period by this amount after each cleanup.
optional int32 clause_cleanup_period_increment = 337 [default = 0];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2653 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2713 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2682 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10053 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6592 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4074 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6652 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getCpModelPresolve | ( | ) |
Whether we presolve the cp_model before solving it.
optional bool cp_model_presolve = 86 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4374 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getCpModelProbingLevel | ( | ) |
How much effort do we spend on probing. 0 disables it completely.
optional int32 cp_model_probing_level = 110 [default = 2];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4401 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getCpModelUseSatPresolve | ( | ) |
Whether we also use the sat presolve when cp_model_presolve is true.
optional bool cp_model_use_sat_presolve = 93 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4428 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getCreate1UipBooleanDuringIcr | ( | ) |
If true, and during integer conflict resolution (icr) the 1-UIP is an integer literal for which we do not have an associated Boolean. Create one.
optional bool create_1uip_boolean_during_icr = 341 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11227 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.getCutActiveCountDecay | ( | ) |
optional double cut_active_count_decay = 156 [default = 0.8];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10931 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getCutCleanupTarget | ( | ) |
Target number of constraints to remove during cleanup.
optional int32 cut_cleanup_target = 157 [default = 1000];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10958 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10408 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10912 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getDebugCrashIfLratCheckFails | ( | ) |
Crash if the LRAT UNSAT proof is invalid.
optional bool debug_crash_if_lrat_check_fails = 339 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6526 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getDebugCrashIfPresolveBreaksHint | ( | ) |
Crash if presolve breaks a feasible hint.
optional bool debug_crash_if_presolve_breaks_hint = 306 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6499 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6472 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6445 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6416 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getDecisionSubsumptionDuringConflictAnalysis | ( | ) |
Try even more subsumption options during conflict analysis.
optional bool decision_subsumption_during_conflict_analysis = 353 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2448 of file SatParameters.java.
|
static |
Definition at line 41809 of file SatParameters.java.
| com.google.ortools.sat.SatParameters com.google.ortools.sat.SatParameters.getDefaultInstanceForType | ( | ) |
Definition at line 41845 of file SatParameters.java.
| java.lang.String com.google.ortools.sat.SatParameters.getDefaultRestartAlgorithms | ( | ) |
optional string default_restart_algorithms = 70 [default = "LUBY_RESTART,LBD_MOVING_AVERAGE_RESTART,DL_MOVING_AVERAGE_RESTART"];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3155 of file SatParameters.java.
| com.google.protobuf.ByteString com.google.ortools.sat.SatParameters.getDefaultRestartAlgorithmsBytes | ( | ) |
optional string default_restart_algorithms = 70 [default = "LUBY_RESTART,LBD_MOVING_AVERAGE_RESTART,DL_MOVING_AVERAGE_RESTART"];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3175 of file SatParameters.java.
|
static |
Definition at line 241 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11169 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4535 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4828 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getDiversifyLnsParams | ( | ) |
If true, registers more lns subsolvers with different parameters.
optional bool diversify_lns_params = 137 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9656 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getEagerlySubsumeLastNConflicts | ( | ) |
If >=0, each time we have a conflict, we try to subsume the last n learned clause with it.
optional int32 eagerly_subsume_last_n_conflicts = 343 [default = 4];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2477 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4857 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4764 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getEnumerateAllSolutions | ( | ) |
Whether we enumerate all solutions of a problem without objective. WARNING: - This can be used with num_workers > 1 but then each solutions can be found more than once, so it is up to the client to deduplicate them. - If keep_all_feasible_solutions_in_presolve is unset, we will set it to true as otherwise, many feasible solution can just be removed by the presolve. It is still possible to manually set this to false if one only wants to enumerate all solutions of the presolved model.
optional bool enumerate_all_solutions = 87 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9042 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4597 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4653 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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 takes a slightly different meaning. There must exist a permutation of the events occurring at the same time such that the level is within the reservoir after each of these events (in this permuted order). So we cannot have +100 and -100 at the same time if the level must be between 0 and 10 (as authorized by the reservoir constraint).
optional bool expand_reservoir_using_circuit = 288 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4733 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11051 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getExploitAllPrecedences | ( | ) |
optional bool exploit_all_precedences = 220 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7154 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getExploitBestSolution | ( | ) |
When branching on a variable, follow the last best solution value.
optional bool exploit_best_solution = 130 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11078 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11020 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11138 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11109 of file SatParameters.java.
| java.lang.String com.google.ortools.sat.SatParameters.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;
| index | The index of the element to return. |
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5689 of file SatParameters.java.
| com.google.protobuf.ByteString com.google.ortools.sat.SatParameters.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;
| index | The index of the value to return. |
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5703 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getExtraSubsolversCount | ( | ) |
A convenient way to add more workers types. These will be added at the beginning of the list.
repeated string extra_subsolvers = 219;
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5676 of file SatParameters.java.
| com.google.protobuf.ProtocolStringList com.google.ortools.sat.SatParameters.getExtraSubsolversList | ( | ) |
A convenient way to add more workers types. These will be added at the beginning of the list.
repeated string extra_subsolvers = 219;
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5664 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getExtraSubsumptionDuringConflictAnalysis | ( | ) |
It is possible that "intermediate" clauses during conflict resolution subsumes some of the clauses that propagated. This is quite cheap to detect and result in more subsumption/strengthening of clauses.
optional bool extra_subsumption_during_conflict_analysis = 351 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2421 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.getFeasibilityJumpBatchDtime | ( | ) |
How much dtime for each LS batch.
optional double feasibility_jump_batch_dtime = 292 [default = 0.1];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8489 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8406 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8578 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getFeasibilityJumpLinearizationLevel | ( | ) |
How much do we linearize the problem in the local search code.
optional int32 feasibility_jump_linearization_level = 257 [default = 2];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8433 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8611 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8462 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8547 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8518 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9163 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9118 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getFilterSatPostsolveClauses | ( | ) |
Internal parameter. During BVE, if we eliminate a variable x, by default we will push all clauses containing x and all clauses containing not(x) to the postsolve. However, it is possible to write the postsolve code so that only one such set is needed. The idea is that, if we push the set containing a literal l, is to set l to false except if it is needed to satisfy one of the clause in the set. This is always beneficial, but for historical reason, not all our postsolve algorithm support this.
optional bool filter_sat_postsolve_clauses = 324 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4144 of file SatParameters.java.
| java.lang.String com.google.ortools.sat.SatParameters.getFilterSubsolvers | ( | int | index | ) |
repeated string filter_subsolvers = 293;
| index | The index of the element to return. |
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5816 of file SatParameters.java.
| com.google.protobuf.ByteString com.google.ortools.sat.SatParameters.getFilterSubsolversBytes | ( | int | index | ) |
repeated string filter_subsolvers = 293;
| index | The index of the value to return. |
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5825 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getFilterSubsolversCount | ( | ) |
repeated string filter_subsolvers = 293;
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5808 of file SatParameters.java.
| com.google.protobuf.ProtocolStringList com.google.ortools.sat.SatParameters.getFilterSubsolversList | ( | ) |
repeated string filter_subsolvers = 293;
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5801 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5121 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getFindClausesThatAreExactlyOne | ( | ) |
By propagating (or just using binary clauses), one can detect that all literal of a clause are actually in at most one relationship. Thus this constraint can be promoted to an exactly one constraints. This should help as it convey more structure. Note that this is expensive, so we have a deterministic limit in place.
optional bool find_clauses_that_are_exactly_one = 333 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5156 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6621 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7844 of file SatParameters.java.
| com.google.ortools.sat.SatParameters.FPRoundingMethod com.google.ortools.sat.SatParameters.getFpRounding | ( | ) |
optional .operations_research.sat.SatParameters.FPRoundingMethod fp_rounding = 165 [default = PROPAGATION_ASSISTED];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9628 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.getGlucoseDecayIncrement | ( | ) |
optional double glucose_decay_increment = 23 [default = 0.01];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2994 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getGlucoseDecayIncrementPeriod | ( | ) |
optional int32 glucose_decay_increment_period = 24 [default = 5000];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3013 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2975 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getHintConflictLimit | ( | ) |
Conflict limit used in the phase that exploit the solution hint.
optional int32 hint_conflict_limit = 153 [default = 10];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7782 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getIgnoreNames | ( | ) |
If true, we don't keep names in our internal copy of the user given model.
optional bool ignore_names = 202 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5047 of file SatParameters.java.
| java.lang.String com.google.ortools.sat.SatParameters.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;
| index | The index of the element to return. |
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5767 of file SatParameters.java.
| com.google.protobuf.ByteString com.google.ortools.sat.SatParameters.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;
| index | The index of the value to return. |
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5788 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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;
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5747 of file SatParameters.java.
| com.google.protobuf.ProtocolStringList com.google.ortools.sat.SatParameters.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;
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5728 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5088 of file SatParameters.java.
| com.google.ortools.sat.SatParameters.Polarity com.google.ortools.sat.SatParameters.getInitialPolarity | ( | ) |
optional .operations_research.sat.SatParameters.Polarity initial_polarity = 2 [default = POLARITY_FALSE];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2046 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2288 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5216 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5288 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getInprocessingMinimizationUseAllOrderings | ( | ) |
optional bool inprocessing_minimization_use_all_orderings = 298 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5326 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getInprocessingMinimizationUseConflictAnalysis | ( | ) |
optional bool inprocessing_minimization_use_conflict_analysis = 297 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5307 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.getInprocessingProbingDtime | ( | ) |
The amount of dtime we should spend on probing for each inprocessing round.
optional double inprocessing_probing_dtime = 274 [default = 1];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5243 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getInprocessingUseCongruenceClosure | ( | ) |
Whether we use the algorithm described in "Clausal Congruence closure", Armin Biere, Katalin Fazekas, Mathias Fleury, Nils Froleyks, 2024. Note that we only have a basic version currently.
optional bool inprocessing_use_congruence_closure = 342 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5359 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getInprocessingUseSatSweeping | ( | ) |
Whether we use the SAT sweeping algorithm described in "Clausal Equivalence Sweeping", Armin Biere, Katalin Fazekas, Mathias Fleury, Nils Froleyks, 2025.
optional bool inprocessing_use_sat_sweeping = 354 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5390 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9196 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getInterleaveBatchSize | ( | ) |
optional int32 interleave_batch_size = 134 [default = 0];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5962 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5943 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9083 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getKeepSymmetryInPresolve | ( | ) |
Experimental. This will compute the symmetry of the problem once and for all. All presolve operations we do should keep the symmetry group intact or modify it properly. For now we have really little support for this. We will disable a bunch of presolve operations that could be supported.
optional bool keep_symmetry_in_presolve = 303 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10158 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getLbRelaxNumWorkersThreshold | ( | ) |
Only use lb-relax if we have at least that many workers.
optional int32 lb_relax_num_workers_threshold = 296 [default = 16];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9611 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10280 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10247 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.getLnsInitialDeterministicLimit | ( | ) |
optional double lns_initial_deterministic_limit = 308 [default = 0.1];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9350 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.getLnsInitialDifficulty | ( | ) |
Initial parameters for neighborhood generation.
optional double lns_initial_difficulty = 307 [default = 0.5];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9331 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getLoadAtMostOnesInSatPresolve | ( | ) |
If we try to load at most ones and exactly ones constraints when running the pure SAT presolve. Or if we just ignore them. If one detects at_most_one via merge_at_most_one_work_limit or exactly one with find_clauses_that_are_exactly_one, it might be good to also set this to true.
optional bool load_at_most_ones_in_sat_presolve = 335 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4465 of file SatParameters.java.
| java.lang.String com.google.ortools.sat.SatParameters.getLogPrefix | ( | ) |
Add a prefix to all logs.
optional string log_prefix = 185 [default = ""];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3864 of file SatParameters.java.
| com.google.protobuf.ByteString com.google.ortools.sat.SatParameters.getLogPrefixBytes | ( | ) |
Add a prefix to all logs.
optional string log_prefix = 185 [default = ""];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3888 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3803 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3836 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getLogToResponse | ( | ) |
Log to response proto.
optional bool log_to_response = 187 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3951 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getLogToStdout | ( | ) |
Log to stdout.
optional bool log_to_stdout = 186 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3924 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.getLpDualTolerance | ( | ) |
optional double lp_dual_tolerance = 267 [default = 1e-07];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10022 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10003 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10650 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getMaxAlldiffDomainSize | ( | ) |
Max domain size for all_different constraints to be expanded.
optional int32 max_alldiff_domain_size = 320 [default = 256];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4624 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getMaxBackjumpLevels | ( | ) |
If chronological backtracking is enabled, this is the maximum number of levels we will backjump over, otherwise we will backtrack.
optional int32 max_backjump_levels = 331 [default = 50];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2570 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.getMaxClauseActivityValue | ( | ) |
optional double max_clause_activity_value = 18 [default = 1e+20];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3059 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10881 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10850 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3477 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getMaxDomainSizeForLinear2Expansion | ( | ) |
Max domain size for expanding linear2 constraints (ax + by ==/!= c).
optional int32 max_domain_size_for_linear2_expansion = 340 [default = 8];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4680 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10342 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.getMaxDratTimeInSeconds | ( | ) |
The maximum time allowed to check the DRAT proof (this can take more time than the solve itself). Only used if check_drat_proof is true.
optional double max_drat_time_in_seconds = 348 [default = inf];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6385 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getMaximumRegionsToSplitInDisconnectedNoOverlap2D | ( | ) |
Detects when the space where items of a no_overlap_2d constraint can placed is disjoint (ie., fixed boxes split the domain). When it is the case, we can introduce a boolean for each pair <item, component> encoding whether the item is in the component or not. Then we replace the original no_overlap_2d constraint by one no_overlap_2d constraint for each component, with the new booleans as the enforcement_literal of the intervals. This is equivalent to expanding the original no_overlap_2d constraint into a bin packing problem with each connected component being a bin. This heuristic is only done when the number of regions to split is less than this parameter and <= 1 disables it.
optional int32 maximum_regions_to_split_in_disconnected_no_overlap_2d = 315 [default = 0];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7442 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10722 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4799 of file SatParameters.java.
| long com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3582 of file SatParameters.java.
| long com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3545 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10377 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3506 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7098 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7397 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4347 of file SatParameters.java.
| com.google.ortools.sat.SatParameters.MaxSatAssumptionOrder com.google.ortools.sat.SatParameters.getMaxSatAssumptionOrder | ( | ) |
optional .operations_research.sat.SatParameters.MaxSatAssumptionOrder max_sat_assumption_order = 51 [default = DEFAULT_ASSUMPTION_ORDER];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6669 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6699 of file SatParameters.java.
| com.google.ortools.sat.SatParameters.MaxSatStratificationAlgorithm com.google.ortools.sat.SatParameters.getMaxSatStratification | ( | ) |
optional .operations_research.sat.SatParameters.MaxSatStratificationAlgorithm max_sat_stratification = 53 [default = STRATIFICATION_DESCENT];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6716 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6869 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3446 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.getMaxVariableActivityValue | ( | ) |
optional double max_variable_activity_value = 16 [default = 1e+100];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2940 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.getMergeAtMostOneWorkLimit | ( | ) |
optional double merge_at_most_one_work_limit = 146 [default = 100000000];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4911 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4892 of file SatParameters.java.
| com.google.ortools.sat.SatParameters.ConflictMinimizationAlgorithm com.google.ortools.sat.SatParameters.getMinimizationAlgorithm | ( | ) |
optional .operations_research.sat.SatParameters.ConflictMinimizationAlgorithm minimization_algorithm = 4 [default = RECURSIVE];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2338 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4031 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getMinimizeSharedClauses | ( | ) |
Minimize and detect subsumption of shared clauses immediately after they are imported.
optional bool minimize_shared_clauses = 300 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6136 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10823 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11355 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11535 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11570 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11671 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11504 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11258 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11605 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11704 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11320 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11642 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11289 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11463 of file SatParameters.java.
| java.lang.String com.google.ortools.sat.SatParameters.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 = ""];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 1977 of file SatParameters.java.
| com.google.protobuf.ByteString com.google.ortools.sat.SatParameters.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 = ""];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2002 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10987 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10216 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getNoOverlap2DBooleanRelationsLimit | ( | ) |
If less than this number of boxes are present in a no-overlap 2d, we create 4 Booleans per pair of boxes: - Box 2 is after Box 1 on x. - Box 1 is after Box 2 on x. - Box 2 is after Box 1 on y. - Box 1 is after Box 2 on y. Note that at least one of them must be true, and at most one on x and one on y can be true. This can significantly help in closing small problem. The SAT reasoning can be a lot more powerful when we take decision on such positional relations.
optional int32 no_overlap_2d_boolean_relations_limit = 321 [default = 10];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7250 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3388 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5497 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getNumSearchWorkers | ( | ) |
optional int32 num_search_workers = 100 [default = 0];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5462 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8642 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5443 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10437 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11404 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8175 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8210 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8317 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getOutputDratProof | ( | ) |
If true, a DRAT proof that all the clauses inferred by the solver are valid is output to a file. As of December 2025, this only works for pure SAT problems, with - num_workers = 1, - cp_model_presolve = false, - linearization_level <= 1, - symmetry_level <= 1.
optional bool output_drat_proof = 347 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6356 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getOutputLratProof | ( | ) |
If true, an LRAT proof that all the clauses inferred by the solver are valid is output to several files (one for presolve -- reduced to trivial simplifications if cp_model_presolve is false, one per worker, and one for the merged proof). As of December 2025, this only works for pure SAT problems, with - cp_model_presolve = false, - linearization_level <= 1, - symmetry_level <= 1.
optional bool output_lrat_proof = 345 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6278 of file SatParameters.java.
| com.google.protobuf.Parser< SatParameters > com.google.ortools.sat.SatParameters.getParserForType | ( | ) |
Definition at line 41840 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getPbCleanupIncrement | ( | ) |
Same as for the clauses, but for the learned pseudo-Boolean constraints.
optional int32 pb_cleanup_increment = 46 [default = 200];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2861 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.getPbCleanupRatio | ( | ) |
optional double pb_cleanup_ratio = 47 [default = 0.5];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2880 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getPermutePresolveConstraintOrder | ( | ) |
optional bool permute_presolve_constraint_order = 179 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3753 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3734 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getPolarityExploitLsHints | ( | ) |
If true and we have first solution LS workers, tries in some phase to follow a LS solutions that violates has litle constraints as possible.
optional bool polarity_exploit_ls_hints = 309 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2154 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2125 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9968 of file SatParameters.java.
| com.google.ortools.sat.SatParameters.VariableOrder com.google.ortools.sat.SatParameters.getPreferredVariableOrder | ( | ) |
optional .operations_research.sat.SatParameters.VariableOrder preferred_variable_order = 1 [default = IN_ORDER];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2028 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4256 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4316 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4173 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4105 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4981 of file SatParameters.java.
| long com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5020 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.getPresolveProbingDeterministicTimeLimit | ( | ) |
optional double presolve_probing_deterministic_time_limit = 57 [default = 30];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4227 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4944 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getPresolveUseBva | ( | ) |
Whether or not we use Bounded Variable Addition (BVA) in the presolve.
optional bool presolve_use_bva = 72 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4283 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4208 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getProbingNumCombinationsLimit | ( | ) |
How many combinations of pairs or triplets of variables we want to scan.
optional int32 probing_num_combinations_limit = 272 [default = 20000];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7929 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6760 of file SatParameters.java.
| long com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8142 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9743 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2220 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getRandomizeSearch | ( | ) |
Randomize fixed search.
optional bool randomize_search = 103 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9683 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2189 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3701 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.getRelativeGapLimit | ( | ) |
optional double relative_gap_limit = 160 [default = 0];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3662 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getRemoveFixedVariablesEarly | ( | ) |
If cp_model_presolve is true and there is a large proportion of fixed variable after the first model copy, remap all the model to a dense set of variable before the full presolve even starts. This should help for LNS on large models.
optional bool remove_fixed_variables_early = 310 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4498 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7815 of file SatParameters.java.
| com.google.ortools.sat.SatParameters.RestartAlgorithm com.google.ortools.sat.SatParameters.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;
| index | The index of the element to return. |
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3135 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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;
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3114 of file SatParameters.java.
| java.util.List< com.google.ortools.sat.SatParameters.RestartAlgorithm > com.google.ortools.sat.SatParameters.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;
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3093 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3269 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.getRestartLbdAverageRatio | ( | ) |
optional double restart_lbd_average_ratio = 71 [default = 1];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3288 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3213 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getRestartRunningWindowSize | ( | ) |
Size of the window for the moving average restarts.
optional int32 restart_running_window_size = 62 [default = 50];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3240 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10788 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.getRoutingCutDpEffort | ( | ) |
The amount of "effort" to spend in dynamic programming for computing routing cuts. This is in term of basic operations needed by the algorithm in the worst case, so a value like 1e8 should take less than a second to compute.
optional double routing_cut_dp_effort = 314 [default = 10000000];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7708 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getRoutingCutMaxInfeasiblePathLength | ( | ) |
If the length of an infeasible path is less than this value, a cut will be added to exclude it.
optional int32 routing_cut_max_infeasible_path_length = 317 [default = 6];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7737 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getRoutingCutSubsetSizeForBinaryRelationBound | ( | ) |
If the size of a subset of nodes of a RoutesConstraint is less than this value, use linear constraints of size 1 and 2 (such as capacity and time window constraints) enforced by the arc literals to compute cuts for this subset (unless the subset size is less than routing_cut_subset_size_for_tight_binary_relation_bound, in which case the corresponding algorithm is used instead). The algorithm for these cuts has a O(n^3) complexity, where n is the subset size. Hence the value of this parameter should not be too large (e.g. 10 or 20).
optional int32 routing_cut_subset_size_for_binary_relation_bound = 312 [default = 0];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7580 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getRoutingCutSubsetSizeForExactBinaryRelationBound | ( | ) |
Similar to above, but with an even stronger algorithm in O(n!). We try to be defensive and abort early or not run that often. Still the value of that parameter shouldn't really be much more than 10.
optional int32 routing_cut_subset_size_for_exact_binary_relation_bound = 316 [default = 8];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7642 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getRoutingCutSubsetSizeForShortestPathsBound | ( | ) |
Similar to routing_cut_subset_size_for_exact_binary_relation_bound but use a bound based on shortest path distances (which respect triangular inequality). This allows to derive bounds that are valid for any superset of a given subset. This is slow, so it shouldn't really be larger than 10.
optional int32 routing_cut_subset_size_for_shortest_paths_bound = 318 [default = 8];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7675 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getRoutingCutSubsetSizeForTightBinaryRelationBound | ( | ) |
Similar to above, but with a different algorithm producing better cuts, at the price of a higher O(2^n) complexity, where n is the subset size. Hence the value of this parameter should be small (e.g. less than 10).
optional int32 routing_cut_subset_size_for_tight_binary_relation_bound = 313 [default = 0];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7611 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8247 of file SatParameters.java.
| com.google.ortools.sat.SatParameters.SearchBranching com.google.ortools.sat.SatParameters.getSearchBranching | ( | ) |
optional .operations_research.sat.SatParameters.SearchBranching search_branching = 82 [default = AUTOMATIC_SEARCH];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7754 of file SatParameters.java.
| long com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9714 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getSerializedSize | ( | ) |
Definition at line 12635 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getShareBinaryClauses | ( | ) |
Allows sharing of new learned binary clause between workers.
optional bool share_binary_clauses = 203 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6078 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getSharedTreeBalanceTolerance | ( | ) |
How much deeper compared to the ideal max depth of the tree is considered "balanced" enough to still accept a split. Without such a tolerance, sometimes the tree can only be split by a single worker, and they may not generate a split for some time. In contrast, with a tolerance of 1, at least half of all workers should be able to split the tree as soon as a split becomes required. This only has an effect on SPLIT_STRATEGY_BALANCED_TREE and SPLIT_STRATEGY_DISCREPANCY.
optional int32 shared_tree_balance_tolerance = 305 [default = 1];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8968 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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 = 10000];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8911 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getSharedTreeNumWorkers | ( | ) |
Enables shared tree search. If positive, 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. Specifying a negative number uses a heuristic to select an appropriate number of shared tree workeres based on the total number of workers.
optional int32 shared_tree_num_workers = 235 [default = -1];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8737 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.getSharedTreeOpenLeavesPerWorker | ( | ) |
How many open leaf nodes should the shared tree maintain per worker.
optional double shared_tree_open_leaves_per_worker = 281 [default = 2];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8878 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.getSharedTreeSplitMinDtime | ( | ) |
How much dtime a worker will wait between proposing splits. This limits the contention in splitting the shared tree, and also reduces the number of too-easy subtrees that are generates.
optional double shared_tree_split_min_dtime = 328 [default = 0.1];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8999 of file SatParameters.java.
| com.google.ortools.sat.SatParameters.SharedTreeSplitStrategy com.google.ortools.sat.SatParameters.getSharedTreeSplitStrategy | ( | ) |
optional .operations_research.sat.SatParameters.SharedTreeSplitStrategy shared_tree_split_strategy = 239 [default = SPLIT_STRATEGY_AUTO];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8928 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getSharedTreeWorkerEnablePhaseSharing | ( | ) |
If true, shared tree workers share their target phase when returning an assigned subtree for the next worker to use.
optional bool shared_tree_worker_enable_phase_sharing = 304 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8851 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getSharedTreeWorkerEnableTrailSharing | ( | ) |
If true, workers share more of the information from their local trail. Specifically, literals implied by the shared tree decisions.
optional bool shared_tree_worker_enable_trail_sharing = 295 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8822 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getSharedTreeWorkerMinRestartsPerSubtree | ( | ) |
Minimum 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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8793 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getShareGlueClauses | ( | ) |
Allows sharing of short glue clauses between workers. Implicitly disabled if share_binary_clauses is false.
optional bool share_glue_clauses = 285 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6107 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.getShareGlueClausesDtime | ( | ) |
The amount of dtime between each export of shared glue clauses.
optional double share_glue_clauses_dtime = 322 [default = 1];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6163 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getShareLevelZeroBounds | ( | ) |
Allows sharing of the bounds of modified variables at level 0.
optional bool share_level_zero_bounds = 114 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6016 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getShareLinear2Bounds | ( | ) |
Allows sharing of the bounds on linear2 discovered at level 0. This is mainly interesting on scheduling type of problems when we branch on precedences. Warning: This currently non-deterministic.
optional bool share_linear2_bounds = 326 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6051 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getShareObjectiveBounds | ( | ) |
Allows objective sharing between workers.
optional bool share_objective_bounds = 113 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5989 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.getShavingDeterministicTimeInProbingSearch | ( | ) |
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. (<= 0 disables it).
optional double shaving_deterministic_time_in_probing_search = 204 [default = 0.001];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7960 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.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.1];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7989 of file SatParameters.java.
| long com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8022 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getSolutionPoolDiversityLimit | ( | ) |
If solution_pool_size is <= this, we will use DP to keep a "diverse" set of solutions (the one further apart via hamming distance) in the pool. Setting this to large value might be slow, especially if your solution are large.
optional int32 solution_pool_diversity_limit = 329 [default = 10];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9468 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getSolutionPoolSize | ( | ) |
Size of the top-n different solutions kept by the solver. This parameter must be > 0. Currently, having this larger than one mainly impact the "base" solution chosen for a LNS/LS fragment.
optional int32 solution_pool_size = 193 [default = 3];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9435 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getStopAfterFirstSolution | ( | ) |
For an optimization problem, stop the solver as soon as we have a solution.
optional bool stop_after_first_solution = 98 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9256 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9285 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getStopAfterRootPropagation | ( | ) |
optional bool stop_after_root_propagation = 252 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9304 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3417 of file SatParameters.java.
| com.google.ortools.sat.SatParameters com.google.ortools.sat.SatParameters.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 5890 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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 5875 of file SatParameters.java.
| java.util.List< com.google.ortools.sat.SatParameters > com.google.ortools.sat.SatParameters.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 5844 of file SatParameters.java.
| com.google.ortools.sat.SatParametersOrBuilder com.google.ortools.sat.SatParameters.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 5905 of file SatParameters.java.
| java.util.List<? extends com.google.ortools.sat.SatParametersOrBuilder > com.google.ortools.sat.SatParameters.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 5860 of file SatParameters.java.
| java.lang.String com.google.ortools.sat.SatParameters.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;
| index | The index of the element to return. |
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5609 of file SatParameters.java.
| com.google.protobuf.ByteString com.google.ortools.sat.SatParameters.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;
| index | The index of the value to return. |
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5646 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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;
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5573 of file SatParameters.java.
| com.google.protobuf.ProtocolStringList com.google.ortools.sat.SatParameters.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;
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5538 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getSubsumeDuringVivification | ( | ) |
If we remove clause that we now are "implied" by others. Note that this might not always be good as we might loose some propagation power.
optional bool subsume_during_vivification = 355 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2506 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2390 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.getSymmetryDetectionDeterministicTimeLimit | ( | ) |
Deterministic time limit for symmetry detection.
optional double symmetry_detection_deterministic_time_limit = 302 [default = 1];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10185 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10090 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4568 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getTransitivePrecedencesWorkLimit | ( | ) |
At root level, we might compute the transitive closure of "precedences" relations so that we can exploit that in scheduling problems. Setting this to zero disable the feature.
optional int32 transitive_precedences_work_limit = 327 [default = 1000000];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6834 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getUseAbslRandom | ( | ) |
optional bool use_absl_random = 180 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3772 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getUseAllDifferentForCircuit | ( | ) |
Turn on extra propagation for the circuit constraint. This can be quite slow.
optional bool use_all_different_for_circuit = 311 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7539 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7347 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3319 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getUseChronologicalBacktracking | ( | ) |
If true, try to backtrack as little as possible on conflict and re-imply the clauses later. This means we discard less propagation than traditional backjumping, but requites additional bookkeeping to handle reimplication. See: https://doi.org/10.1007/978-3-319-94144-8_7
optional bool use_chronological_backtracking = 330 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2541 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9844 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7030 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7199 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7510 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getUseDynamicPrecedenceInCumulative | ( | ) |
optional bool use_dynamic_precedence_in_cumulative = 268 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6952 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6933 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7316 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2251 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9813 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getUseExtendedProbing | ( | ) |
Use extended probing (probe bool_or, at_most_one, exactly_one).
optional bool use_extended_probing = 269 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7902 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8348 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getUseFeasibilityPump | ( | ) |
Adds a feasibility pump subsolver along with lns subsolvers.
optional bool use_feasibility_pump = 164 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9553 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7135 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9935 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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 = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9584 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getUseLinear3ForNoOverlap2DPrecedences | ( | ) |
When set, this activates a propagator for the no_overlap_2d constraint that
uses any eventual linear constraints of the model in the form
`{start interval 1} - {end interval 2} + c*w <= ub` to detect that two
intervals must overlap in one dimension for some values of `w`. This is
particularly useful for problems where the distance between two boxes is
part of the model.
optional bool use_linear3_for_no_overlap_2d_precedences = 323 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7479 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getUseLns | ( | ) |
Testing parameters used to disable all lns workers.
optional bool use_lns = 283 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9377 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getUseLnsOnly | ( | ) |
Experimental parameters to disable everything but lns.
optional bool use_lns_only = 101 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9404 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8377 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getUseNewIntegerConflictResolution | ( | ) |
This should be better on integer problems. But it is still work in progress.
optional bool use_new_integer_conflict_resolution = 336 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11198 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8051 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8082 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6559 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9780 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6991 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getUsePbResolution | ( | ) |
Experimental. This is an old experiment, it might cause crashes in multi-thread and you should double check the solver result. It can still be used if you only care about feasible solutions (these are checked) and it gives good result on your problem. We might revive it at some point. 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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3998 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2094 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6803 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7875 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getUseRinsLns | ( | ) |
Turns on relaxation induced neighborhood generator.
optional bool use_rins_lns = 129 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9526 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5185 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getUseSharedTreeSearch | ( | ) |
Set on shared subtree workers. Users should not set this directly.
optional bool use_shared_tree_search = 236 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8764 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getUseStrongPropagationInDisjunctive | ( | ) |
Enable stronger and more expensive propagation on no_overlap constraint.
optional bool use_strong_propagation_in_disjunctive = 230 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6896 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getUseSymmetryInLp | ( | ) |
When we have symmetry, it is possible to "fold" all variables from the same orbit into a single variable, while having the same power of LP relaxation. This can help significantly on symmetric problem. However there is currently a bit of overhead as the rest of the solver need to do some translation between the folded LP and the rest of the problem.
optional bool use_symmetry_in_lp = 301 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10125 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7069 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7285 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.getUseTryEdgeReasoningInNoOverlap2D | ( | ) |
optional bool use_try_edge_reasoning_in_no_overlap_2d = 299 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7366 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2921 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getVariablesShavingLevel | ( | ) |
This search takes all Boolean or integer variables, and maximize or minimize them in order to reduce their domain. -1 is automatic, otherwise value 0 disables it, and 1, 2, or 3 changes something.
optional int32 variables_shaving_level = 289 [default = -1];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8113 of file SatParameters.java.
| double com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8698 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.getViolationLsPerturbationPeriod | ( | ) |
How long violation_ls should wait before perturbating a solution.
optional int32 violation_ls_perturbation_period = 249 [default = 100];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8669 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3614 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10488 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10576 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10667 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10740 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10517 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10456 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10606 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10546 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2306 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasAlternativePoolSize | ( | ) |
In order to not get stuck in local optima, when this is non-zero, we try to also work on "older" solutions with a worse objective value so we get a chance to follow a different LS/LNS trajectory.
optional int32 alternative_pool_size = 325 [default = 1];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9485 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9860 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9214 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasBinaryMinimizationAlgorithm | ( | ) |
optional .operations_research.sat.SatParameters.BinaryMinizationAlgorithm binary_minimization_algorithm = 34 [default = BINARY_MINIMIZATION_FROM_UIP_AND_DECISIONS];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2349 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8265 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasBlockingRestartMultiplier | ( | ) |
optional double blocking_restart_multiplier = 66 [default = 1.4];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3349 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasBlockingRestartWindowSize | ( | ) |
optional int32 blocking_restart_window_size = 65 [default = 5000];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3330 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10296 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9890 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasCheckDratProof | ( | ) |
If true, and if the problem is UNSAT, a DRAT proof of this UNSAT property is checked after the solver has finished. As of November 2025, this only works for pure SAT problems, with - num_workers = 1, - cp_model_presolve = false, - linearization_level <= 1, - symmetry_level <= 1.
optional bool check_drat_proof = 346 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6299 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasCheckLratProof | ( | ) |
If true, inferred clauses are checked with an LRAT checker as they are learned, in presolve (reduced to trivial simplifications if cp_model_presolve is false), and in each worker. As of December 2025, this only works with pure SAT problems, with - cp_model_presolve = false, - linearization_level <= 1, - symmetry_level <= 1.
optional bool check_lrat_proof = 344 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6184 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasCheckMergedLratProof | ( | ) |
If true, and if output_lrat_proof is true and the problem is UNSAT, check that the merged proof file is valid, i.e., that clause sharing between workers is correct. This checks each inferred clause, so you might want to disable check_lrat_proof to avoid redundant work. As of November 2025, this only works for pure SAT problems, with num_workers = 1.
optional bool check_merged_lrat_proof = 352 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6221 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasChronologicalBacktrackMinConflicts | ( | ) |
If chronological backtracking is enabled, this is the minimum number of conflicts before we will consider backjumping.
optional int32 chronological_backtrack_min_conflicts = 332 [default = 1000];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2586 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasClauseActivityDecay | ( | ) |
Clause activity parameters (same effect as the one on the variables).
optional double clause_activity_decay = 17 [default = 0.999];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3028 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasClauseCleanupLbdBound | ( | ) |
All the clauses with a LBD (literal blocks distance) lower or equal to this parameters will always be kept. Note that the LBD of a clause that just propagated is 1 + number of different decision levels of its literals. So that the "classic" LBD of a learned conflict is the same as its LBD when we backjump and then propagate it.
optional int32 clause_cleanup_lbd_bound = 59 [default = 5];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2734 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasClauseCleanupLbdTier1 | ( | ) |
All the clause with a LBD lower or equal to this will be kept except if its activity hasn't been bumped in the last 32 cleanup phase. Note that this has no effect if it is <= clause_cleanup_lbd_bound.
optional int32 clause_cleanup_lbd_tier1 = 349 [default = 0];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2769 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasClauseCleanupLbdTier2 | ( | ) |
All the clause with a LBD lower or equal to this will be kept except if its activity hasn't been bumped since the previous cleanup phase. Note that this has no effect if it is <= clause_cleanup_lbd_bound or <= clause_cleanup_lbd_tier1.
optional int32 clause_cleanup_lbd_tier2 = 350 [default = 0];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2801 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasClauseCleanupOrdering | ( | ) |
optional .operations_research.sat.SatParameters.ClauseOrdering clause_cleanup_ordering = 60 [default = CLAUSE_ACTIVITY];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2826 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasClauseCleanupPeriod | ( | ) |
Trigger a cleanup when this number of "deletable" clauses is learned.
optional int32 clause_cleanup_period = 11 [default = 10000];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2614 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasClauseCleanupPeriodIncrement | ( | ) |
Increase clause_cleanup_period by this amount after each cleanup.
optional int32 clause_cleanup_period_increment = 337 [default = 0];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2641 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2699 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2669 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10039 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6577 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4054 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6638 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasCpModelPresolve | ( | ) |
Whether we presolve the cp_model before solving it.
optional bool cp_model_presolve = 86 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4362 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasCpModelProbingLevel | ( | ) |
How much effort do we spend on probing. 0 disables it completely.
optional int32 cp_model_probing_level = 110 [default = 2];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4389 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasCpModelUseSatPresolve | ( | ) |
Whether we also use the sat presolve when cp_model_presolve is true.
optional bool cp_model_use_sat_presolve = 93 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4416 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasCreate1UipBooleanDuringIcr | ( | ) |
If true, and during integer conflict resolution (icr) the 1-UIP is an integer literal for which we do not have an associated Boolean. Create one.
optional bool create_1uip_boolean_during_icr = 341 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11214 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasCutActiveCountDecay | ( | ) |
optional double cut_active_count_decay = 156 [default = 0.8];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10923 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasCutCleanupTarget | ( | ) |
Target number of constraints to remove during cleanup.
optional int32 cut_cleanup_target = 157 [default = 1000];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10946 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10394 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10898 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasDebugCrashIfLratCheckFails | ( | ) |
Crash if the LRAT UNSAT proof is invalid.
optional bool debug_crash_if_lrat_check_fails = 339 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6514 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasDebugCrashIfPresolveBreaksHint | ( | ) |
Crash if presolve breaks a feasible hint.
optional bool debug_crash_if_presolve_breaks_hint = 306 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6487 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6460 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6432 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6402 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasDecisionSubsumptionDuringConflictAnalysis | ( | ) |
Try even more subsumption options during conflict analysis.
optional bool decision_subsumption_during_conflict_analysis = 353 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2436 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasDefaultRestartAlgorithms | ( | ) |
optional string default_restart_algorithms = 70 [default = "LUBY_RESTART,LBD_MOVING_AVERAGE_RESTART,DL_MOVING_AVERAGE_RESTART"];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3147 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11155 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4518 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4815 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasDiversifyLnsParams | ( | ) |
If true, registers more lns subsolvers with different parameters.
optional bool diversify_lns_params = 137 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9644 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasEagerlySubsumeLastNConflicts | ( | ) |
If >=0, each time we have a conflict, we try to subsume the last n learned clause with it.
optional int32 eagerly_subsume_last_n_conflicts = 343 [default = 4];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2464 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4844 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4750 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasEnumerateAllSolutions | ( | ) |
Whether we enumerate all solutions of a problem without objective. WARNING: - This can be used with num_workers > 1 but then each solutions can be found more than once, so it is up to the client to deduplicate them. - If keep_all_feasible_solutions_in_presolve is unset, we will set it to true as otherwise, many feasible solution can just be removed by the presolve. It is still possible to manually set this to false if one only wants to enumerate all solutions of the presolved model.
optional bool enumerate_all_solutions = 87 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9022 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4584 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4640 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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 takes a slightly different meaning. There must exist a permutation of the events occurring at the same time such that the level is within the reservoir after each of these events (in this permuted order). So we cannot have +100 and -100 at the same time if the level must be between 0 and 10 (as authorized by the reservoir constraint).
optional bool expand_reservoir_using_circuit = 288 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4708 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11037 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasExploitAllPrecedences | ( | ) |
optional bool exploit_all_precedences = 220 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7146 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasExploitBestSolution | ( | ) |
When branching on a variable, follow the last best solution value.
optional bool exploit_best_solution = 130 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11066 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11005 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11125 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11095 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasExtraSubsumptionDuringConflictAnalysis | ( | ) |
It is possible that "intermediate" clauses during conflict resolution subsumes some of the clauses that propagated. This is quite cheap to detect and result in more subsumption/strengthening of clauses.
optional bool extra_subsumption_during_conflict_analysis = 351 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2407 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasFeasibilityJumpBatchDtime | ( | ) |
How much dtime for each LS batch.
optional double feasibility_jump_batch_dtime = 292 [default = 0.1];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8477 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8393 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8564 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasFeasibilityJumpLinearizationLevel | ( | ) |
How much do we linearize the problem in the local search code.
optional int32 feasibility_jump_linearization_level = 257 [default = 2];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8421 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8596 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8449 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8534 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8505 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9142 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9102 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasFilterSatPostsolveClauses | ( | ) |
Internal parameter. During BVE, if we eliminate a variable x, by default we will push all clauses containing x and all clauses containing not(x) to the postsolve. However, it is possible to write the postsolve code so that only one such set is needed. The idea is that, if we push the set containing a literal l, is to set l to false except if it is needed to satisfy one of the clause in the set. This is always beneficial, but for historical reason, not all our postsolve algorithm support this.
optional bool filter_sat_postsolve_clauses = 324 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4126 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5106 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasFindClausesThatAreExactlyOne | ( | ) |
By propagating (or just using binary clauses), one can detect that all literal of a clause are actually in at most one relationship. Thus this constraint can be promoted to an exactly one constraints. This should help as it convey more structure. Note that this is expensive, so we have a deterministic limit in place.
optional bool find_clauses_that_are_exactly_one = 333 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5140 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6608 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7831 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasFpRounding | ( | ) |
optional .operations_research.sat.SatParameters.FPRoundingMethod fp_rounding = 165 [default = PROPAGATION_ASSISTED];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9621 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasGlucoseDecayIncrement | ( | ) |
optional double glucose_decay_increment = 23 [default = 0.01];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2986 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasGlucoseDecayIncrementPeriod | ( | ) |
optional int32 glucose_decay_increment_period = 24 [default = 5000];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3005 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2959 of file SatParameters.java.
| int com.google.ortools.sat.SatParameters.hashCode | ( | ) |
Definition at line 15429 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasHintConflictLimit | ( | ) |
Conflict limit used in the phase that exploit the solution hint.
optional int32 hint_conflict_limit = 153 [default = 10];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7770 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasIgnoreNames | ( | ) |
If true, we don't keep names in our internal copy of the user given model.
optional bool ignore_names = 202 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5035 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5069 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasInitialPolarity | ( | ) |
optional .operations_research.sat.SatParameters.Polarity initial_polarity = 2 [default = POLARITY_FALSE];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2039 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2271 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5202 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5267 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasInprocessingMinimizationUseAllOrderings | ( | ) |
optional bool inprocessing_minimization_use_all_orderings = 298 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5318 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasInprocessingMinimizationUseConflictAnalysis | ( | ) |
optional bool inprocessing_minimization_use_conflict_analysis = 297 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5299 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasInprocessingProbingDtime | ( | ) |
The amount of dtime we should spend on probing for each inprocessing round.
optional double inprocessing_probing_dtime = 274 [default = 1];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5231 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasInprocessingUseCongruenceClosure | ( | ) |
Whether we use the algorithm described in "Clausal Congruence closure", Armin Biere, Katalin Fazekas, Mathias Fleury, Nils Froleyks, 2024. Note that we only have a basic version currently.
optional bool inprocessing_use_congruence_closure = 342 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5344 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasInprocessingUseSatSweeping | ( | ) |
Whether we use the SAT sweeping algorithm described in "Clausal Equivalence Sweeping", Armin Biere, Katalin Fazekas, Mathias Fleury, Nils Froleyks, 2025.
optional bool inprocessing_use_sat_sweeping = 354 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5376 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9181 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasInterleaveBatchSize | ( | ) |
optional int32 interleave_batch_size = 134 [default = 0];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5954 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5926 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9064 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasKeepSymmetryInPresolve | ( | ) |
Experimental. This will compute the symmetry of the problem once and for all. All presolve operations we do should keep the symmetry group intact or modify it properly. For now we have really little support for this. We will disable a bunch of presolve operations that could be supported.
optional bool keep_symmetry_in_presolve = 303 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10143 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasLbRelaxNumWorkersThreshold | ( | ) |
Only use lb-relax if we have at least that many workers.
optional int32 lb_relax_num_workers_threshold = 296 [default = 16];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9599 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10265 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10233 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasLnsInitialDeterministicLimit | ( | ) |
optional double lns_initial_deterministic_limit = 308 [default = 0.1];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9342 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasLnsInitialDifficulty | ( | ) |
Initial parameters for neighborhood generation.
optional double lns_initial_difficulty = 307 [default = 0.5];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9319 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasLoadAtMostOnesInSatPresolve | ( | ) |
If we try to load at most ones and exactly ones constraints when running the pure SAT presolve. Or if we just ignore them. If one detects at_most_one via merge_at_most_one_work_limit or exactly one with find_clauses_that_are_exactly_one, it might be good to also set this to true.
optional bool load_at_most_ones_in_sat_presolve = 335 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4448 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasLogPrefix | ( | ) |
Add a prefix to all logs.
optional string log_prefix = 185 [default = ""];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3852 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3789 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3821 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasLogToResponse | ( | ) |
Log to response proto.
optional bool log_to_response = 187 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3939 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasLogToStdout | ( | ) |
Log to stdout.
optional bool log_to_stdout = 186 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3912 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasLpDualTolerance | ( | ) |
optional double lp_dual_tolerance = 267 [default = 1e-07];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10014 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9987 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10636 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasMaxAlldiffDomainSize | ( | ) |
Max domain size for all_different constraints to be expanded.
optional int32 max_alldiff_domain_size = 320 [default = 256];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4612 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasMaxBackjumpLevels | ( | ) |
If chronological backtracking is enabled, this is the maximum number of levels we will backjump over, otherwise we will backtrack.
optional int32 max_backjump_levels = 331 [default = 50];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2557 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasMaxClauseActivityValue | ( | ) |
optional double max_clause_activity_value = 18 [default = 1e+20];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3051 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10867 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10838 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3463 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasMaxDomainSizeForLinear2Expansion | ( | ) |
Max domain size for expanding linear2 constraints (ax + by ==/!= c).
optional int32 max_domain_size_for_linear2_expansion = 340 [default = 8];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4668 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10327 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasMaxDratTimeInSeconds | ( | ) |
The maximum time allowed to check the DRAT proof (this can take more time than the solve itself). Only used if check_drat_proof is true.
optional double max_drat_time_in_seconds = 348 [default = inf];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6372 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasMaximumRegionsToSplitInDisconnectedNoOverlap2D | ( | ) |
Detects when the space where items of a no_overlap_2d constraint can placed is disjoint (ie., fixed boxes split the domain). When it is the case, we can introduce a boolean for each pair <item, component> encoding whether the item is in the component or not. Then we replace the original no_overlap_2d constraint by one no_overlap_2d constraint for each component, with the new booleans as the enforcement_literal of the intervals. This is equivalent to expanding the original no_overlap_2d constraint into a bin packing problem with each connected component being a bin. This heuristic is only done when the number of regions to split is less than this parameter and <= 1 disables it.
optional int32 maximum_regions_to_split_in_disconnected_no_overlap_2d = 315 [default = 0];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7421 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10703 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4783 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3565 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3527 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10361 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3493 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7085 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7383 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4333 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasMaxSatAssumptionOrder | ( | ) |
optional .operations_research.sat.SatParameters.MaxSatAssumptionOrder max_sat_assumption_order = 51 [default = DEFAULT_ASSUMPTION_ORDER];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6662 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6686 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasMaxSatStratification | ( | ) |
optional .operations_research.sat.SatParameters.MaxSatStratificationAlgorithm max_sat_stratification = 53 [default = STRATIFICATION_DESCENT];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6709 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6853 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3433 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasMaxVariableActivityValue | ( | ) |
optional double max_variable_activity_value = 16 [default = 1e+100];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2932 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasMergeAtMostOneWorkLimit | ( | ) |
optional double merge_at_most_one_work_limit = 146 [default = 100000000];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4903 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4876 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasMinimizationAlgorithm | ( | ) |
optional .operations_research.sat.SatParameters.ConflictMinimizationAlgorithm minimization_algorithm = 4 [default = RECURSIVE];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2331 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4016 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasMinimizeSharedClauses | ( | ) |
Minimize and detect subsumption of shared clauses immediately after they are imported.
optional bool minimize_shared_clauses = 300 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6123 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10807 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11339 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11521 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11554 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11658 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11485 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11244 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11589 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11689 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11306 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11625 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11275 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11435 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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 = ""];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 1964 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10974 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10202 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasNoOverlap2DBooleanRelationsLimit | ( | ) |
If less than this number of boxes are present in a no-overlap 2d, we create 4 Booleans per pair of boxes: - Box 2 is after Box 1 on x. - Box 1 is after Box 2 on x. - Box 2 is after Box 1 on y. - Box 1 is after Box 2 on y. Note that at least one of them must be true, and at most one on x and one on y can be true. This can significantly help in closing small problem. The SAT reasoning can be a lot more powerful when we take decision on such positional relations.
optional int32 no_overlap_2d_boolean_relations_limit = 321 [default = 10];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7226 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3374 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5481 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasNumSearchWorkers | ( | ) |
optional int32 num_search_workers = 100 [default = 0];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5454 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8628 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5418 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10424 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11381 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8160 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8194 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8300 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasOutputDratProof | ( | ) |
If true, a DRAT proof that all the clauses inferred by the solver are valid is output to a file. As of December 2025, this only works for pure SAT problems, with - num_workers = 1, - cp_model_presolve = false, - linearization_level <= 1, - symmetry_level <= 1.
optional bool output_drat_proof = 347 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6338 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasOutputLratProof | ( | ) |
If true, an LRAT proof that all the clauses inferred by the solver are valid is output to several files (one for presolve -- reduced to trivial simplifications if cp_model_presolve is false, one per worker, and one for the merged proof). As of December 2025, this only works for pure SAT problems, with - cp_model_presolve = false, - linearization_level <= 1, - symmetry_level <= 1.
optional bool output_lrat_proof = 345 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6259 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasPbCleanupIncrement | ( | ) |
Same as for the clauses, but for the learned pseudo-Boolean constraints.
optional int32 pb_cleanup_increment = 46 [default = 200];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2849 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasPbCleanupRatio | ( | ) |
optional double pb_cleanup_ratio = 47 [default = 0.5];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2872 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasPermutePresolveConstraintOrder | ( | ) |
optional bool permute_presolve_constraint_order = 179 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3745 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3719 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasPolarityExploitLsHints | ( | ) |
If true and we have first solution LS workers, tries in some phase to follow a LS solutions that violates has litle constraints as possible.
optional bool polarity_exploit_ls_hints = 309 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2141 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2111 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9953 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasPreferredVariableOrder | ( | ) |
optional .operations_research.sat.SatParameters.VariableOrder preferred_variable_order = 1 [default = IN_ORDER];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2021 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4243 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4301 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4160 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4091 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4964 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5002 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasPresolveProbingDeterministicTimeLimit | ( | ) |
optional double presolve_probing_deterministic_time_limit = 57 [default = 30];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4219 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4929 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasPresolveUseBva | ( | ) |
Whether or not we use Bounded Variable Addition (BVA) in the presolve.
optional bool presolve_use_bva = 72 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4271 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4192 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasProbingNumCombinationsLimit | ( | ) |
How many combinations of pairs or triplets of variables we want to scan.
optional int32 probing_num_combinations_limit = 272 [default = 20000];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7917 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6740 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8129 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9730 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2206 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasRandomizeSearch | ( | ) |
Randomize fixed search.
optional bool randomize_search = 103 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9671 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2173 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3683 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasRelativeGapLimit | ( | ) |
optional double relative_gap_limit = 160 [default = 0];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3654 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasRemoveFixedVariablesEarly | ( | ) |
If cp_model_presolve is true and there is a large proportion of fixed variable after the first model copy, remap all the model to a dense set of variable before the full presolve even starts. This should help for LNS on large models.
optional bool remove_fixed_variables_early = 310 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4483 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7800 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3256 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasRestartLbdAverageRatio | ( | ) |
optional double restart_lbd_average_ratio = 71 [default = 1];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3280 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3200 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasRestartRunningWindowSize | ( | ) |
Size of the window for the moving average restarts.
optional int32 restart_running_window_size = 62 [default = 50];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3228 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10773 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasRoutingCutDpEffort | ( | ) |
The amount of "effort" to spend in dynamic programming for computing routing cuts. This is in term of basic operations needed by the algorithm in the worst case, so a value like 1e8 should take less than a second to compute.
optional double routing_cut_dp_effort = 314 [default = 10000000];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7693 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasRoutingCutMaxInfeasiblePathLength | ( | ) |
If the length of an infeasible path is less than this value, a cut will be added to exclude it.
optional int32 routing_cut_max_infeasible_path_length = 317 [default = 6];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7724 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasRoutingCutSubsetSizeForBinaryRelationBound | ( | ) |
If the size of a subset of nodes of a RoutesConstraint is less than this value, use linear constraints of size 1 and 2 (such as capacity and time window constraints) enforced by the arc literals to compute cuts for this subset (unless the subset size is less than routing_cut_subset_size_for_tight_binary_relation_bound, in which case the corresponding algorithm is used instead). The algorithm for these cuts has a O(n^3) complexity, where n is the subset size. Hence the value of this parameter should not be too large (e.g. 10 or 20).
optional int32 routing_cut_subset_size_for_binary_relation_bound = 312 [default = 0];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7561 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasRoutingCutSubsetSizeForExactBinaryRelationBound | ( | ) |
Similar to above, but with an even stronger algorithm in O(n!). We try to be defensive and abort early or not run that often. Still the value of that parameter shouldn't really be much more than 10.
optional int32 routing_cut_subset_size_for_exact_binary_relation_bound = 316 [default = 8];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7628 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasRoutingCutSubsetSizeForShortestPathsBound | ( | ) |
Similar to routing_cut_subset_size_for_exact_binary_relation_bound but use a bound based on shortest path distances (which respect triangular inequality). This allows to derive bounds that are valid for any superset of a given subset. This is slow, so it shouldn't really be larger than 10.
optional int32 routing_cut_subset_size_for_shortest_paths_bound = 318 [default = 8];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7660 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasRoutingCutSubsetSizeForTightBinaryRelationBound | ( | ) |
Similar to above, but with a different algorithm producing better cuts, at the price of a higher O(2^n) complexity, where n is the subset size. Hence the value of this parameter should be small (e.g. less than 10).
optional int32 routing_cut_subset_size_for_tight_binary_relation_bound = 313 [default = 0];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7597 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8230 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasSearchBranching | ( | ) |
optional .operations_research.sat.SatParameters.SearchBranching search_branching = 82 [default = AUTOMATIC_SEARCH];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7747 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9700 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasShareBinaryClauses | ( | ) |
Allows sharing of new learned binary clause between workers.
optional bool share_binary_clauses = 203 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6066 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasSharedTreeBalanceTolerance | ( | ) |
How much deeper compared to the ideal max depth of the tree is considered "balanced" enough to still accept a split. Without such a tolerance, sometimes the tree can only be split by a single worker, and they may not generate a split for some time. In contrast, with a tolerance of 1, at least half of all workers should be able to split the tree as soon as a split becomes required. This only has an effect on SPLIT_STRATEGY_BALANCED_TREE and SPLIT_STRATEGY_DISCREPANCY.
optional int32 shared_tree_balance_tolerance = 305 [default = 1];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8950 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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 = 10000];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8896 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasSharedTreeNumWorkers | ( | ) |
Enables shared tree search. If positive, 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. Specifying a negative number uses a heuristic to select an appropriate number of shared tree workeres based on the total number of workers.
optional int32 shared_tree_num_workers = 235 [default = -1];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8719 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasSharedTreeOpenLeavesPerWorker | ( | ) |
How many open leaf nodes should the shared tree maintain per worker.
optional double shared_tree_open_leaves_per_worker = 281 [default = 2];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8866 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasSharedTreeSplitMinDtime | ( | ) |
How much dtime a worker will wait between proposing splits. This limits the contention in splitting the shared tree, and also reduces the number of too-easy subtrees that are generates.
optional double shared_tree_split_min_dtime = 328 [default = 0.1];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8985 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasSharedTreeSplitStrategy | ( | ) |
optional .operations_research.sat.SatParameters.SharedTreeSplitStrategy shared_tree_split_strategy = 239 [default = SPLIT_STRATEGY_AUTO];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8921 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasSharedTreeWorkerEnablePhaseSharing | ( | ) |
If true, shared tree workers share their target phase when returning an assigned subtree for the next worker to use.
optional bool shared_tree_worker_enable_phase_sharing = 304 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8838 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasSharedTreeWorkerEnableTrailSharing | ( | ) |
If true, workers share more of the information from their local trail. Specifically, literals implied by the shared tree decisions.
optional bool shared_tree_worker_enable_trail_sharing = 295 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8809 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasSharedTreeWorkerMinRestartsPerSubtree | ( | ) |
Minimum 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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8780 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasShareGlueClauses | ( | ) |
Allows sharing of short glue clauses between workers. Implicitly disabled if share_binary_clauses is false.
optional bool share_glue_clauses = 285 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6094 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasShareGlueClausesDtime | ( | ) |
The amount of dtime between each export of shared glue clauses.
optional double share_glue_clauses_dtime = 322 [default = 1];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6151 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasShareLevelZeroBounds | ( | ) |
Allows sharing of the bounds of modified variables at level 0.
optional bool share_level_zero_bounds = 114 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6004 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasShareLinear2Bounds | ( | ) |
Allows sharing of the bounds on linear2 discovered at level 0. This is mainly interesting on scheduling type of problems when we branch on precedences. Warning: This currently non-deterministic.
optional bool share_linear2_bounds = 326 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6035 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasShareObjectiveBounds | ( | ) |
Allows objective sharing between workers.
optional bool share_objective_bounds = 113 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5977 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasShavingDeterministicTimeInProbingSearch | ( | ) |
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. (<= 0 disables it).
optional double shaving_deterministic_time_in_probing_search = 204 [default = 0.001];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7946 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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.1];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7976 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8007 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasSolutionPoolDiversityLimit | ( | ) |
If solution_pool_size is <= this, we will use DP to keep a "diverse" set of solutions (the one further apart via hamming distance) in the pool. Setting this to large value might be slow, especially if your solution are large.
optional int32 solution_pool_diversity_limit = 329 [default = 10];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9453 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasSolutionPoolSize | ( | ) |
Size of the top-n different solutions kept by the solver. This parameter must be > 0. Currently, having this larger than one mainly impact the "base" solution chosen for a LNS/LS fragment.
optional int32 solution_pool_size = 193 [default = 3];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9421 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasStopAfterFirstSolution | ( | ) |
For an optimization problem, stop the solver as soon as we have a solution.
optional bool stop_after_first_solution = 98 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9244 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9272 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasStopAfterRootPropagation | ( | ) |
optional bool stop_after_root_propagation = 252 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9296 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3404 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasSubsumeDuringVivification | ( | ) |
If we remove clause that we now are "implied" by others. Note that this might not always be good as we might loose some propagation power.
optional bool subsume_during_vivification = 355 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2493 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2375 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasSymmetryDetectionDeterministicTimeLimit | ( | ) |
Deterministic time limit for symmetry detection.
optional double symmetry_detection_deterministic_time_limit = 302 [default = 1];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10173 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10073 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 4553 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasTransitivePrecedencesWorkLimit | ( | ) |
At root level, we might compute the transitive closure of "precedences" relations so that we can exploit that in scheduling problems. Setting this to zero disable the feature.
optional int32 transitive_precedences_work_limit = 327 [default = 1000000];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6820 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasUseAbslRandom | ( | ) |
optional bool use_absl_random = 180 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3764 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasUseAllDifferentForCircuit | ( | ) |
Turn on extra propagation for the circuit constraint. This can be quite slow.
optional bool use_all_different_for_circuit = 311 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7526 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7333 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3305 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasUseChronologicalBacktracking | ( | ) |
If true, try to backtrack as little as possible on conflict and re-imply the clauses later. This means we discard less propagation than traditional backjumping, but requites additional bookkeeping to handle reimplication. See: https://doi.org/10.1007/978-3-319-94144-8_7
optional bool use_chronological_backtracking = 330 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2525 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9830 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7012 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7178 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7496 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasUseDynamicPrecedenceInCumulative | ( | ) |
optional bool use_dynamic_precedence_in_cumulative = 268 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6944 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6916 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7302 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2237 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9798 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasUseExtendedProbing | ( | ) |
Use extended probing (probe bool_or, at_most_one, exactly_one).
optional bool use_extended_probing = 269 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7890 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8334 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasUseFeasibilityPump | ( | ) |
Adds a feasibility pump subsolver along with lns subsolvers.
optional bool use_feasibility_pump = 164 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9541 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7118 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9921 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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 = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9570 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasUseLinear3ForNoOverlap2DPrecedences | ( | ) |
When set, this activates a propagator for the no_overlap_2d constraint that
uses any eventual linear constraints of the model in the form
`{start interval 1} - {end interval 2} + c*w <= ub` to detect that two
intervals must overlap in one dimension for some values of `w`. This is
particularly useful for problems where the distance between two boxes is
part of the model.
optional bool use_linear3_for_no_overlap_2d_precedences = 323 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7462 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasUseLns | ( | ) |
Testing parameters used to disable all lns workers.
optional bool use_lns = 283 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9365 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasUseLnsOnly | ( | ) |
Experimental parameters to disable everything but lns.
optional bool use_lns_only = 101 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9392 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8364 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasUseNewIntegerConflictResolution | ( | ) |
This should be better on integer problems. But it is still work in progress.
optional bool use_new_integer_conflict_resolution = 336 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 11185 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8038 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8068 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6544 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9763 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6973 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasUsePbResolution | ( | ) |
Experimental. This is an old experiment, it might cause crashes in multi-thread and you should double check the solver result. It can still be used if you only care about feasible solutions (these are checked) and it gives good result on your problem. We might revive it at some point. 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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 3976 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2072 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6783 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7861 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasUseRinsLns | ( | ) |
Turns on relaxation induced neighborhood generator.
optional bool use_rins_lns = 129 [default = true];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 9514 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 5172 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasUseSharedTreeSearch | ( | ) |
Set on shared subtree workers. Users should not set this directly.
optional bool use_shared_tree_search = 236 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8752 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasUseStrongPropagationInDisjunctive | ( | ) |
Enable stronger and more expensive propagation on no_overlap constraint.
optional bool use_strong_propagation_in_disjunctive = 230 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 6884 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasUseSymmetryInLp | ( | ) |
When we have symmetry, it is possible to "fold" all variables from the same orbit into a single variable, while having the same power of LP relaxation. This can help significantly on symmetric problem. However there is currently a bit of overhead as the rest of the solver need to do some translation between the folded LP and the rest of the problem.
optional bool use_symmetry_in_lp = 301 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 10109 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7051 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7269 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasUseTryEdgeReasoningInNoOverlap2D | ( | ) |
optional bool use_try_edge_reasoning_in_no_overlap_2d = 299 [default = false];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 7358 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 2902 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasVariablesShavingLevel | ( | ) |
This search takes all Boolean or integer variables, and maximize or minimize them in order to reduce their domain. -1 is automatic, otherwise value 0 disables it, and 1, 2, or 3 changes something.
optional int32 variables_shaving_level = 289 [default = -1];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8099 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.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];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8685 of file SatParameters.java.
| boolean com.google.ortools.sat.SatParameters.hasViolationLsPerturbationPeriod | ( | ) |
How long violation_ls should wait before perturbating a solution.
optional int32 violation_ls_perturbation_period = 249 [default = 100];
Implements com.google.ortools.sat.SatParametersOrBuilder.
Definition at line 8657 of file SatParameters.java.
|
protected |
Definition at line 247 of file SatParameters.java.
| final boolean com.google.ortools.sat.SatParameters.isInitialized | ( | ) |
Definition at line 11710 of file SatParameters.java.
|
static |
Definition at line 16931 of file SatParameters.java.
|
static |
Definition at line 16934 of file SatParameters.java.
| Builder com.google.ortools.sat.SatParameters.newBuilderForType | ( | ) |
Definition at line 16930 of file SatParameters.java.
|
protected |
Definition at line 16944 of file SatParameters.java.
|
static |
Definition at line 16902 of file SatParameters.java.
|
static |
Definition at line 16908 of file SatParameters.java.
|
static |
Definition at line 16879 of file SatParameters.java.
|
static |
Definition at line 16883 of file SatParameters.java.
|
static |
Definition at line 16868 of file SatParameters.java.
|
static |
Definition at line 16873 of file SatParameters.java.
|
static |
Definition at line 16915 of file SatParameters.java.
|
static |
Definition at line 16921 of file SatParameters.java.
|
static |
Definition at line 16889 of file SatParameters.java.
|
static |
Definition at line 16894 of file SatParameters.java.
|
static |
Definition at line 16857 of file SatParameters.java.
|
static |
Definition at line 16862 of file SatParameters.java.
|
static |
Definition at line 41835 of file SatParameters.java.
| Builder com.google.ortools.sat.SatParameters.toBuilder | ( | ) |
Definition at line 16938 of file SatParameters.java.
| void com.google.ortools.sat.SatParameters.writeTo | ( | com.google.protobuf.CodedOutputStream | output | ) | throws java.io.IOException |
Definition at line 11720 of file SatParameters.java.
|
static |
Definition at line 3586 of file SatParameters.java.
|
static |
Definition at line 10476 of file SatParameters.java.
|
static |
Definition at line 10563 of file SatParameters.java.
|
static |
Definition at line 10654 of file SatParameters.java.
|
static |
Definition at line 10726 of file SatParameters.java.
|
static |
Definition at line 10505 of file SatParameters.java.
|
static |
Definition at line 10441 of file SatParameters.java.
|
static |
Definition at line 10594 of file SatParameters.java.
|
static |
Definition at line 10534 of file SatParameters.java.
|
static |
Definition at line 2292 of file SatParameters.java.
|
static |
Definition at line 9472 of file SatParameters.java.
|
static |
Definition at line 9848 of file SatParameters.java.
|
static |
Definition at line 9200 of file SatParameters.java.
|
static |
Definition at line 2343 of file SatParameters.java.
|
static |
Definition at line 8251 of file SatParameters.java.
|
static |
Definition at line 3342 of file SatParameters.java.
|
static |
Definition at line 3323 of file SatParameters.java.
|
static |
Definition at line 10284 of file SatParameters.java.
|
static |
Definition at line 9877 of file SatParameters.java.
|
static |
Definition at line 6282 of file SatParameters.java.
|
static |
Definition at line 6167 of file SatParameters.java.
|
static |
Definition at line 6206 of file SatParameters.java.
|
static |
Definition at line 2574 of file SatParameters.java.
|
static |
Definition at line 3017 of file SatParameters.java.
|
static |
Definition at line 2717 of file SatParameters.java.
|
static |
Definition at line 2756 of file SatParameters.java.
|
static |
Definition at line 2787 of file SatParameters.java.
|
static |
Definition at line 2820 of file SatParameters.java.
|
static |
Definition at line 2603 of file SatParameters.java.
|
static |
Definition at line 2630 of file SatParameters.java.
|
static |
Definition at line 2686 of file SatParameters.java.
|
static |
Definition at line 2657 of file SatParameters.java.
|
static |
Definition at line 10026 of file SatParameters.java.
|
static |
Definition at line 6563 of file SatParameters.java.
|
static |
Definition at line 4035 of file SatParameters.java.
|
static |
Definition at line 6625 of file SatParameters.java.
|
static |
Definition at line 4351 of file SatParameters.java.
|
static |
Definition at line 4378 of file SatParameters.java.
|
static |
Definition at line 4405 of file SatParameters.java.
|
static |
Definition at line 11202 of file SatParameters.java.
|
static |
Definition at line 10916 of file SatParameters.java.
|
static |
Definition at line 10935 of file SatParameters.java.
|
static |
Definition at line 10381 of file SatParameters.java.
|
static |
Definition at line 10885 of file SatParameters.java.
|
static |
Definition at line 6503 of file SatParameters.java.
|
static |
Definition at line 6476 of file SatParameters.java.
|
static |
Definition at line 6449 of file SatParameters.java.
|
static |
Definition at line 6420 of file SatParameters.java.
|
static |
Definition at line 6389 of file SatParameters.java.
|
static |
Definition at line 2425 of file SatParameters.java.
|
static |
Definition at line 3139 of file SatParameters.java.
|
static |
Definition at line 11142 of file SatParameters.java.
|
static |
Definition at line 4502 of file SatParameters.java.
|
static |
Definition at line 4803 of file SatParameters.java.
|
static |
Definition at line 9633 of file SatParameters.java.
|
static |
Definition at line 2452 of file SatParameters.java.
|
static |
Definition at line 4832 of file SatParameters.java.
|
static |
Definition at line 4737 of file SatParameters.java.
|
static |
Definition at line 9003 of file SatParameters.java.
|
static |
Definition at line 4572 of file SatParameters.java.
|
static |
Definition at line 4628 of file SatParameters.java.
|
static |
Definition at line 4684 of file SatParameters.java.
|
static |
Definition at line 11024 of file SatParameters.java.
|
static |
Definition at line 7139 of file SatParameters.java.
|
static |
Definition at line 11055 of file SatParameters.java.
|
static |
Definition at line 10991 of file SatParameters.java.
|
static |
Definition at line 11113 of file SatParameters.java.
|
static |
Definition at line 11082 of file SatParameters.java.
|
static |
Definition at line 5650 of file SatParameters.java.
|
static |
Definition at line 2394 of file SatParameters.java.
|
static |
Definition at line 8466 of file SatParameters.java.
|
static |
Definition at line 8381 of file SatParameters.java.
|
static |
Definition at line 8551 of file SatParameters.java.
|
static |
Definition at line 8410 of file SatParameters.java.
|
static |
Definition at line 8582 of file SatParameters.java.
|
static |
Definition at line 8437 of file SatParameters.java.
|
static |
Definition at line 8522 of file SatParameters.java.
|
static |
Definition at line 8493 of file SatParameters.java.
|
static |
Definition at line 9122 of file SatParameters.java.
|
static |
Definition at line 9087 of file SatParameters.java.
|
static |
Definition at line 4109 of file SatParameters.java.
|
static |
Definition at line 5792 of file SatParameters.java.
|
static |
Definition at line 5092 of file SatParameters.java.
|
static |
Definition at line 5125 of file SatParameters.java.
|
static |
Definition at line 6596 of file SatParameters.java.
|
static |
Definition at line 7819 of file SatParameters.java.
|
static |
Definition at line 9615 of file SatParameters.java.
|
static |
Definition at line 2979 of file SatParameters.java.
|
static |
Definition at line 2998 of file SatParameters.java.
|
static |
Definition at line 2944 of file SatParameters.java.
|
static |
Definition at line 7759 of file SatParameters.java.
|
static |
Definition at line 5024 of file SatParameters.java.
|
static |
Definition at line 5707 of file SatParameters.java.
|
static |
Definition at line 5051 of file SatParameters.java.
|
static |
Definition at line 2033 of file SatParameters.java.
|
static |
Definition at line 2255 of file SatParameters.java.
|
static |
Definition at line 5189 of file SatParameters.java.
|
static |
Definition at line 5247 of file SatParameters.java.
|
static |
Definition at line 5311 of file SatParameters.java.
|
static |
Definition at line 5292 of file SatParameters.java.
|
static |
Definition at line 5220 of file SatParameters.java.
|
static |
Definition at line 5330 of file SatParameters.java.
|
static |
Definition at line 5363 of file SatParameters.java.
|
static |
Definition at line 9167 of file SatParameters.java.
|
static |
Definition at line 5947 of file SatParameters.java.
|
static |
Definition at line 5910 of file SatParameters.java.
|
static |
Definition at line 9046 of file SatParameters.java.
|
static |
Definition at line 10129 of file SatParameters.java.
|
static |
Definition at line 9588 of file SatParameters.java.
|
static |
Definition at line 10220 of file SatParameters.java.
|
static |
Definition at line 10251 of file SatParameters.java.
|
static |
Definition at line 9335 of file SatParameters.java.
|
static |
Definition at line 9308 of file SatParameters.java.
|
static |
Definition at line 4432 of file SatParameters.java.
|
static |
Definition at line 3840 of file SatParameters.java.
|
static |
Definition at line 3776 of file SatParameters.java.
|
static |
Definition at line 3807 of file SatParameters.java.
|
static |
Definition at line 3928 of file SatParameters.java.
|
static |
Definition at line 3901 of file SatParameters.java.
|
static |
Definition at line 10007 of file SatParameters.java.
|
static |
Definition at line 9972 of file SatParameters.java.
|
static |
Definition at line 10623 of file SatParameters.java.
|
static |
Definition at line 4601 of file SatParameters.java.
|
static |
Definition at line 2545 of file SatParameters.java.
|
static |
Definition at line 3044 of file SatParameters.java.
|
static |
Definition at line 10854 of file SatParameters.java.
|
static |
Definition at line 10827 of file SatParameters.java.
|
static |
Definition at line 3450 of file SatParameters.java.
|
static |
Definition at line 4657 of file SatParameters.java.
|
static |
Definition at line 10313 of file SatParameters.java.
|
static |
Definition at line 6360 of file SatParameters.java.
|
static |
Definition at line 10685 of file SatParameters.java.
|
static |
Definition at line 4768 of file SatParameters.java.
|
static |
Definition at line 3549 of file SatParameters.java.
|
static |
Definition at line 10346 of file SatParameters.java.
|
static |
Definition at line 3481 of file SatParameters.java.
|
static |
Definition at line 7073 of file SatParameters.java.
|
static |
Definition at line 3510 of file SatParameters.java.
|
static |
Definition at line 7370 of file SatParameters.java.
|
static |
Definition at line 4320 of file SatParameters.java.
|
static |
Definition at line 6656 of file SatParameters.java.
|
static |
Definition at line 6674 of file SatParameters.java.
|
static |
Definition at line 6703 of file SatParameters.java.
|
static |
Definition at line 6838 of file SatParameters.java.
|
static |
Definition at line 3421 of file SatParameters.java.
|
static |
Definition at line 2925 of file SatParameters.java.
|
static |
Definition at line 7401 of file SatParameters.java.
|
static |
Definition at line 4896 of file SatParameters.java.
|
static |
Definition at line 4861 of file SatParameters.java.
|
static |
Definition at line 10792 of file SatParameters.java.
|
static |
Definition at line 2325 of file SatParameters.java.
|
static |
Definition at line 4002 of file SatParameters.java.
|
static |
Definition at line 6111 of file SatParameters.java.
|
static |
Definition at line 11324 of file SatParameters.java.
|
static |
Definition at line 11508 of file SatParameters.java.
|
static |
Definition at line 11539 of file SatParameters.java.
|
static |
Definition at line 11646 of file SatParameters.java.
|
static |
Definition at line 11467 of file SatParameters.java.
|
static |
Definition at line 11231 of file SatParameters.java.
|
static |
Definition at line 11574 of file SatParameters.java.
|
static |
Definition at line 11675 of file SatParameters.java.
|
static |
Definition at line 11293 of file SatParameters.java.
|
static |
Definition at line 11609 of file SatParameters.java.
|
static |
Definition at line 11262 of file SatParameters.java.
|
static |
Definition at line 11408 of file SatParameters.java.
|
static |
Definition at line 1951 of file SatParameters.java.
|
static |
Definition at line 10962 of file SatParameters.java.
|
static |
Definition at line 10189 of file SatParameters.java.
|
static |
Definition at line 7203 of file SatParameters.java.
|
static |
Definition at line 3361 of file SatParameters.java.
|
static |
Definition at line 5466 of file SatParameters.java.
|
static |
Definition at line 5447 of file SatParameters.java.
|
static |
Definition at line 8615 of file SatParameters.java.
|
static |
Definition at line 5394 of file SatParameters.java.
|
static |
Definition at line 10412 of file SatParameters.java.
|
static |
Definition at line 11359 of file SatParameters.java.
|
static |
Definition at line 8146 of file SatParameters.java.
|
static |
Definition at line 8179 of file SatParameters.java.
|
static |
Definition at line 8284 of file SatParameters.java.
|
static |
Definition at line 6321 of file SatParameters.java.
|
static |
Definition at line 6241 of file SatParameters.java.
|
static |
Definition at line 2838 of file SatParameters.java.
|
static |
Definition at line 2865 of file SatParameters.java.
|
static |
Definition at line 3738 of file SatParameters.java.
|
static |
Definition at line 3705 of file SatParameters.java.
|
static |
Definition at line 2129 of file SatParameters.java.
|
static |
Definition at line 2098 of file SatParameters.java.
|
static |
Definition at line 9939 of file SatParameters.java.
|
static |
Definition at line 2015 of file SatParameters.java.
|
static |
Definition at line 4231 of file SatParameters.java.
|
static |
Definition at line 4287 of file SatParameters.java.
|
static |
Definition at line 4148 of file SatParameters.java.
|
static |
Definition at line 4078 of file SatParameters.java.
|
static |
Definition at line 4948 of file SatParameters.java.
|
static |
Definition at line 4985 of file SatParameters.java.
|
static |
Definition at line 4212 of file SatParameters.java.
|
static |
Definition at line 4915 of file SatParameters.java.
|
static |
Definition at line 4260 of file SatParameters.java.
|
static |
Definition at line 4177 of file SatParameters.java.
|
static |
Definition at line 7906 of file SatParameters.java.
|
static |
Definition at line 6721 of file SatParameters.java.
|
static |
Definition at line 8117 of file SatParameters.java.
|
static |
Definition at line 9718 of file SatParameters.java.
|
static |
Definition at line 2193 of file SatParameters.java.
|
static |
Definition at line 2158 of file SatParameters.java.
|
static |
Definition at line 3666 of file SatParameters.java.
|
static |
Definition at line 9660 of file SatParameters.java.
|
static |
Definition at line 3647 of file SatParameters.java.
|
static |
Definition at line 4469 of file SatParameters.java.
|
static |
Definition at line 7786 of file SatParameters.java.
|
static |
Definition at line 3063 of file SatParameters.java.
|
static |
Definition at line 3244 of file SatParameters.java.
|
static |
Definition at line 3273 of file SatParameters.java.
|
static |
Definition at line 3188 of file SatParameters.java.
|
static |
Definition at line 3217 of file SatParameters.java.
|
static |
Definition at line 10759 of file SatParameters.java.
|
static |
Definition at line 7679 of file SatParameters.java.
|
static |
Definition at line 7712 of file SatParameters.java.
|
static |
Definition at line 7543 of file SatParameters.java.
|
static |
Definition at line 7615 of file SatParameters.java.
|
static |
Definition at line 7646 of file SatParameters.java.
|
static |
Definition at line 7584 of file SatParameters.java.
|
static |
Definition at line 8214 of file SatParameters.java.
|
static |
Definition at line 7741 of file SatParameters.java.
|
static |
Definition at line 9687 of file SatParameters.java.
|
static |
Definition at line 6055 of file SatParameters.java.
|
static |
Definition at line 6140 of file SatParameters.java.
|
static |
Definition at line 6082 of file SatParameters.java.
|
static |
Definition at line 5993 of file SatParameters.java.
|
static |
Definition at line 6020 of file SatParameters.java.
|
static |
Definition at line 5966 of file SatParameters.java.
|
static |
Definition at line 8933 of file SatParameters.java.
|
static |
Definition at line 8882 of file SatParameters.java.
|
static |
Definition at line 8702 of file SatParameters.java.
|
static |
Definition at line 8855 of file SatParameters.java.
|
static |
Definition at line 8972 of file SatParameters.java.
|
static |
Definition at line 8915 of file SatParameters.java.
|
static |
Definition at line 8826 of file SatParameters.java.
|
static |
Definition at line 8797 of file SatParameters.java.
|
static |
Definition at line 8768 of file SatParameters.java.
|
static |
Definition at line 7933 of file SatParameters.java.
|
static |
Definition at line 7964 of file SatParameters.java.
|
static |
Definition at line 7993 of file SatParameters.java.
|
static |
Definition at line 9439 of file SatParameters.java.
|
static |
Definition at line 9408 of file SatParameters.java.
|
static |
Definition at line 9233 of file SatParameters.java.
|
static |
Definition at line 9260 of file SatParameters.java.
|
static |
Definition at line 9289 of file SatParameters.java.
|
static |
Definition at line 3392 of file SatParameters.java.
|
static |
Definition at line 5829 of file SatParameters.java.
|
static |
Definition at line 5501 of file SatParameters.java.
|
static |
Definition at line 2481 of file SatParameters.java.
|
static |
Definition at line 2361 of file SatParameters.java.
|
static |
Definition at line 10162 of file SatParameters.java.
|
static |
Definition at line 10057 of file SatParameters.java.
|
static |
Definition at line 4539 of file SatParameters.java.
|
static |
Definition at line 6807 of file SatParameters.java.
|
static |
Definition at line 3757 of file SatParameters.java.
|
static |
Definition at line 7514 of file SatParameters.java.
|
static |
Definition at line 7320 of file SatParameters.java.
|
static |
Definition at line 3292 of file SatParameters.java.
|
static |
Definition at line 2510 of file SatParameters.java.
|
static |
Definition at line 9817 of file SatParameters.java.
|
static |
Definition at line 6995 of file SatParameters.java.
|
static |
Definition at line 7158 of file SatParameters.java.
|
static |
Definition at line 7483 of file SatParameters.java.
|
static |
Definition at line 6937 of file SatParameters.java.
|
static |
Definition at line 6900 of file SatParameters.java.
|
static |
Definition at line 7289 of file SatParameters.java.
|
static |
Definition at line 2224 of file SatParameters.java.
|
static |
Definition at line 9784 of file SatParameters.java.
|
static |
Definition at line 7879 of file SatParameters.java.
|
static |
Definition at line 8321 of file SatParameters.java.
|
static |
Definition at line 9530 of file SatParameters.java.
|
static |
Definition at line 7102 of file SatParameters.java.
|
static |
Definition at line 9908 of file SatParameters.java.
|
static |
Definition at line 9557 of file SatParameters.java.
|
static |
Definition at line 7446 of file SatParameters.java.
|
static |
Definition at line 9354 of file SatParameters.java.
|
static |
Definition at line 9381 of file SatParameters.java.
|
static |
Definition at line 8352 of file SatParameters.java.
|
static |
Definition at line 11173 of file SatParameters.java.
|
static |
Definition at line 8026 of file SatParameters.java.
|
static |
Definition at line 8055 of file SatParameters.java.
|
static |
Definition at line 6530 of file SatParameters.java.
|
static |
Definition at line 9747 of file SatParameters.java.
|
static |
Definition at line 6956 of file SatParameters.java.
|
static |
Definition at line 3955 of file SatParameters.java.
|
static |
Definition at line 2051 of file SatParameters.java.
|
static |
Definition at line 6764 of file SatParameters.java.
|
static |
Definition at line 7848 of file SatParameters.java.
|
static |
Definition at line 9503 of file SatParameters.java.
|
static |
Definition at line 5160 of file SatParameters.java.
|
static |
Definition at line 8741 of file SatParameters.java.
|
static |
Definition at line 6873 of file SatParameters.java.
|
static |
Definition at line 10094 of file SatParameters.java.
|
static |
Definition at line 7034 of file SatParameters.java.
|
static |
Definition at line 7254 of file SatParameters.java.
|
static |
Definition at line 7351 of file SatParameters.java.
|
static |
Definition at line 2884 of file SatParameters.java.
|
static |
Definition at line 8086 of file SatParameters.java.
|
static |
Definition at line 8673 of file SatParameters.java.
|
static |
Definition at line 8646 of file SatParameters.java.
1.15.0