Interface SatParametersOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SatParameters, SatParameters.Builder

public interface SatParametersOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Summary

    Modifier and Type
    Method
    Description
    double
    Stop the search when the gap between the best feasible objective (O) and our best objective bound (B) is smaller than a limit.
    boolean
    Whether we generate and add Chvatal-Gomory cuts to the LP at root node.
    boolean
    Whether we generate clique cuts from the binary implication graph.
    boolean
    For the lin max constraints, generates the cuts described in "Strong mixed-integer programming formulations for trained neural networks" by Ross Anderson et.
    boolean
    If true, we start by an empty LP, and only add constraints not satisfied by the current LP solution batch by batch.
    boolean
    Whether we generate MIR cuts at root node.
    boolean
    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.
    boolean
    Whether we generate Zero-Half cuts at root node.
    boolean
    When this is true, then the variables that appear in any of the reason of the variables in a conflict have their activity bumped.
    boolean
    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.
    optional .operations_research.sat.SatParameters.BinaryMinizationAlgorithm binary_minimization_algorithm = 34 [default = BINARY_MINIMIZATION_FIRST];
    int
    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.
    double
    optional double blocking_restart_multiplier = 66 [default = 1.4];
    int
    optional int32 blocking_restart_window_size = 65 [default = 5000];
    int
    A non-negative level indicating how much we should try to fully encode Integer variables as Boolean.
    boolean
    Indicates if the CP-SAT layer should catch Control-C (SIGINT) signals when calling solve.
    double
    Clause activity parameters (same effect as the one on the variables).
    int
    All the clauses with a LBD (literal blocks distance) lower or equal to this parameters will always be kept.
    optional .operations_research.sat.SatParameters.ClauseOrdering clause_cleanup_ordering = 60 [default = CLAUSE_ACTIVITY];
    int
    Trigger a cleanup when this number of "deletable" clauses is learned.
    optional .operations_research.sat.SatParameters.ClauseProtection clause_cleanup_protection = 58 [default = PROTECTION_NONE];
    double
    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.
    int
    During a cleanup, we will always keep that number of "deletable" clauses.
    boolean
    Temporary flag util the feature is more mature.
    boolean
    Whether or not the assumption levels are taken into account during the LBD computation.
    boolean
    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.
    boolean
    Whether we presolve the cp_model before solving it.
    int
    How much effort do we spend on probing.
    boolean
    Whether we also use the sat presolve when cp_model_presolve is true.
    double
    optional double cut_active_count_decay = 156 [default = 0.8];
    int
    Target number of constraints to remove during cleanup.
    int
    Control the global cut effort.
    double
    These parameters are similar to sat clause management activity parameters.
    boolean
    Crash if we do not manage to complete the hint into a full solution.
    int
    If positive, try to stop just after that many presolve rules have been applied.
    boolean
    We have two different postsolve code.
    optional string default_restart_algorithms = 70 [default = "LUBY_RESTART,LBD_MOVING_AVERAGE_RESTART,DL_MOVING_AVERAGE_RESTART"];
    com.google.protobuf.ByteString
    optional string default_restart_algorithms = 70 [default = "LUBY_RESTART,LBD_MOVING_AVERAGE_RESTART,DL_MOVING_AVERAGE_RESTART"];
    boolean
    If true, we detect variable that are unique to a table constraint and only there to encode a cost on each tuple.
    boolean
    If true, it disable all constraint expansion.
    boolean
    If true, registers more lns subsolvers with different parameters.
    boolean
    Whether we enumerate all solutions of a problem without objective.
    boolean
    If true, expand all_different constraints that are not permutations.
    boolean
    If true and the Lp relaxation of the problem has a solution, try to exploit it.
    boolean
    optional bool exploit_all_precedences = 220 [default = false];
    boolean
    When branching on a variable, follow the last best solution value.
    boolean
    If true and the Lp relaxation of the problem has an integer optimal solution, try to exploit it.
    boolean
    When branching an a variable that directly affect the objective, branch on the value that lead to the best objective first.
    boolean
    When branching on a variable, follow the last best relaxation solution value.
    getExtraSubsolvers(int index)
    A convenient way to add more workers types.
    com.google.protobuf.ByteString
    A convenient way to add more workers types.
    int
    A convenient way to add more workers types.
    A convenient way to add more workers types.
    boolean
    If true, the final response addition_solutions field will be filled with all solutions from our solutions pool.
    boolean
    If true, add information about the derived variable domains to the CpSolverResponse.
    boolean
    Whether we try to find more independent cores for a given set of assumptions in the core based max-SAT algorithms.
    boolean
    If true, variables appearing in the solution hints will be fixed to their hinted value.
    optional .operations_research.sat.SatParameters.FPRoundingMethod fp_rounding = 165 [default = PROPAGATION_ASSISTED];
    double
    optional double glucose_decay_increment = 23 [default = 0.01];
    int
    optional int32 glucose_decay_increment_period = 24 [default = 5000];
    double
    The activity starts at 0.8 and increment by 0.01 every 5000 conflicts until 0.95.
    int
    Conflict limit used in the phase that exploit the solution hint.
    boolean
    If true, we don't keep names in our internal copy of the user given model.
    Rather than fully specifying subsolvers, it is often convenient to just remove the ones that are not useful on a given problem.
    com.google.protobuf.ByteString
    Rather than fully specifying subsolvers, it is often convenient to just remove the ones that are not useful on a given problem.
    int
    Rather than fully specifying subsolvers, it is often convenient to just remove the ones that are not useful on a given problem.
    Rather than fully specifying subsolvers, it is often convenient to just remove the ones that are not useful on a given problem.
    optional .operations_research.sat.SatParameters.Polarity initial_polarity = 2 [default = POLARITY_FALSE];
    double
    The initial value of the variables activity.
    boolean
    If true, the solver will add a default integer branching strategy to the already defined search strategy.
    int
    optional int32 interleave_batch_size = 134 [default = 1];
    boolean
    Experimental.
    boolean
    If true, we disable the presolve reductions that remove feasible solutions from the search space.
    int
    A non-negative level indicating the type of constraints we consider in the LP relaxation.
    double
    Indicates how much logging should wait before logging periodic search information from specialized workers (lb_tree_search, probing).
    Add a prefix to all logs.
    com.google.protobuf.ByteString
    Add a prefix to all logs.
    boolean
    Whether the solver should log the search progress.
    boolean
    Whether the solver should display per sub-solver search statistics.
    boolean
    Log to response proto.
    boolean
    Log to stdout.
    int
    Cut generator for all diffs can add too many cuts for large all_diff constraints.
    double
    optional double max_clause_activity_value = 18 [default = 1e+20];
    int
    If a constraint/cut in LP is not active for that many consecutive OPTIMAL solves, remove it from the LP.
    int
    Max number of time we perform cut generation and resolve the LP at level 0.
    double
    Maximum time allowed in deterministic time to solve a problem.
    int
    When loading a*x + b*y ==/!= c when x and y are both fully encoded.
    int
    In the integer rounding procedure used for MIR and Gomory cut, the maximum "scaling" we use (must be positive).
    long
    Maximum memory allowed for the whole thread containing the solver.
    long
    Maximum number of conflicts allowed to solve a problem.
    int
    The limit on the number of cuts in our cut pool.
    int
    In case of large reduction in a presolve iteration, we perform multiple presolve iterations.
    optional .operations_research.sat.SatParameters.MaxSatAssumptionOrder max_sat_assumption_order = 51 [default = DEFAULT_ASSUMPTION_ORDER];
    boolean
    If true, adds the assumption in the reverse order of the one defined by max_sat_assumption_order.
    optional .operations_research.sat.SatParameters.MaxSatStratificationAlgorithm max_sat_stratification = 53 [default = STRATIFICATION_DESCENT];
    double
    Maximum time allowed in seconds to solve a problem.
    double
    optional double max_variable_activity_value = 16 [default = 1e+100];
    double
    optional double merge_at_most_one_work_limit = 146 [default = 100000000];
    double
    During presolve, we use a maximum clique heuristic to merge together no-overlap constraints or at most one constraints.
    optional .operations_research.sat.SatParameters.ConflictMinimizationAlgorithm minimization_algorithm = 4 [default = RECURSIVE];
    boolean
    Whether we use a simple heuristic to try to minimize an UNSAT core.
    boolean
    A different algorithm during PB resolution.
    int
    optional int32 minimize_with_propagation_num_decisions = 97 [default = 1000];
    int
    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 For now, we have a somewhat simpler implementation where every x restart we spend y decisions on clause minimization.
    int
    If there is an objective and we are not in interleave mode, we will reserve at least this number of worker for LNS thread.
    double
    While adding constraints, skip the constraints which have orthogonality less than 'min_orthogonality_for_lp_constraints' with already added constraints during current call.
    boolean
    If true, some continuous variable might be automatically scaled.
    double
    As explained in mip_precision and mip_max_activity_exponent, we cannot always reach the wanted precision during scaling.
    boolean
    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.
    int
    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.
    double
    We need to bound the maximum magnitude of the variables for CP-SAT, and that is the bound we use.
    double
    Any finite values in the input MIP must be below this threshold, otherwise the model will be reported invalid.
    double
    All continuous variable of the problem will be multiplied by this factor.
    double
    When scaling constraint with double coefficients to integer coefficients, we will multiply by a power of 2 and round the coefficients.
    double
    optional double model_reduction_log_frequency_in_seconds = 218 [default = 5];
    In some context, like in a portfolio of search, it makes sense to name a given parameters set for logging purpose.
    com.google.protobuf.ByteString
    In some context, like in a portfolio of search, it makes sense to name a given parameters set for logging purpose.
    int
    Add that many lazy constraints (or cuts) at once in the LP.
    int
    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.
    int
    optional int32 num_search_workers = 100 [default = 0];
    int
    Specify the number of parallel workers (i.e.
    boolean
    For the cut that can be generated at any level, this control if we only try to generate them at the root node.
    boolean
    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.
    boolean
    The default optimization method is a simple "linear scan", each time trying to find a better solution than the previous one.
    boolean
    Do a more conventional tree search (by opposition to SAT based one) where we keep all the explored node in a tree.
    boolean
    This has no effect if optimize_with_core is false.
    int
    Same as for the clauses, but for the learned pseudo-Boolean constraints.
    double
    optional double pb_cleanup_ratio = 47 [default = 0.5];
    boolean
    optional bool permute_presolve_constraint_order = 179 [default = false];
    boolean
    This is mainly here to test the solver variability.
    int
    If non-zero, then we change the polarity heuristic after that many number of conflicts in an arithmetically increasing fashion.
    boolean
    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.
    optional .operations_research.sat.SatParameters.VariableOrder preferred_variable_order = 1 [default = IN_ORDER];
    boolean
    Whether we use an heuristic to detect some basic case of blocked clause in the SAT presolve.
    int
    Apply Bounded Variable Addition (BVA) if the number of clauses is reduced by stricly more than this threshold.
    int
    During presolve, we apply BVE only if this weight times the number of clauses plus the number of clause literals is not increased.
    int
    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.
    boolean
    If true, we will extract from linear constraints, enforcement literals of the form "integer variable at bound => simplified constraint".
    long
    A few presolve operations involve detecting constraints included in other constraint.
    double
    The maximum "deterministic" time limit to spend in probing.
    int
    How much substitution (also called free variable aggregation in MIP litterature) should we perform at presolve.
    boolean
    Whether or not we use Bounded Variable Addition (BVA) in the presolve.
    long
    If set at zero (the default), it is disabled.
    double
    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.
    long
    The solver ignores the pseudo costs of variables with number of recordings less than this threshold.
    double
    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.
    boolean
    Randomize fixed search.
    double
    The proportion of polarity chosen at random.
    int
    At the beginning of each solve, the random number generator used in some part of the solver is reinitialized to this seed.
    double
    optional double relative_gap_limit = 160 [default = 0];
    boolean
    If true, the solver tries to repair the solution given in the hint.
    The restart strategies will change each time the strategy_counter is increased.
    int
    The restart strategies will change each time the strategy_counter is increased.
    The restart strategies will change each time the strategy_counter is increased.
    double
    In the moving average restart algorithms, a restart is triggered if the window average times this ratio is greater that the global average.
    double
    optional double restart_lbd_average_ratio = 71 [default = 1];
    int
    Restart period for the FIXED_RESTART strategy.
    int
    Size of the window for the moving average restarts.
    optional .operations_research.sat.SatParameters.SearchBranching search_branching = 82 [default = AUTOMATIC_SEARCH];
    long
    Search randomization will collect equivalent 'max valued' variables, and pick one randomly.
    boolean
    Allows sharing of new learned binary clause between workers.
    boolean
    Allows sharing of the bounds of modified variables at level 0.
    boolean
    Allows objective sharing between workers.
    double
    Specifies the amount of deterministic time spent of each try at shaving a bound in the shaving search.
    int
    Size of the top-n different solutions kept by the solver.
    boolean
    For an optimization problem, stop the solver as soon as we have a solution.
    boolean
    Mainly used when improving the presolver.
    double
    The parameter num_conflicts_before_strategy_changes is increased by that much after each strategy change.
    getSubsolverParams(int index)
    It is possible to specify additional subsolver configuration.
    int
    It is possible to specify additional subsolver configuration.
    It is possible to specify additional subsolver configuration.
    It is possible to specify additional subsolver configuration.
    It is possible to specify additional subsolver configuration.
    getSubsolvers(int index)
    In multi-thread, the solver can be mainly seen as a portfolio of solvers with different parameters.
    com.google.protobuf.ByteString
    getSubsolversBytes(int index)
    In multi-thread, the solver can be mainly seen as a portfolio of solvers with different parameters.
    int
    In multi-thread, the solver can be mainly seen as a portfolio of solvers with different parameters.
    In multi-thread, the solver can be mainly seen as a portfolio of solvers with different parameters.
    boolean
    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.
    int
    Whether we try to automatically detect the symmetries in a model and exploit them.
    int
    How much we try to "compress" a table constraint.
    boolean
    optional bool use_absl_random = 180 [default = false];
    boolean
    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.
    boolean
    If true, the solver attemts to generate more info inside lp propagator by branching on some variables if certain criteria are met during the search tree exploration.
    boolean
    This can be beneficial if there is a lot of no-overlap constraints but a relatively low number of different intervals in the problem.
    boolean
    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.
    boolean
    When set, it activates a few scheduling parameters to improve the lower bound of scheduling problems.
    boolean
    When this is true, the no_overlap_2d constraint is reinforced with energetic reasoning.
    boolean
    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.
    boolean
    The solver usually exploit the LP relaxation of a model.
    boolean
    Adds a feasibility pump subsolver along with lns subsolvers.
    boolean
    If true, detect and create constraint for integer variable that are "after" a set of intervals in the same cumulative constraint.
    boolean
    Stores and exploits "implied-bounds" in the solver.
    boolean
    LNS parameters.
    boolean
    For an optimization problem, whether we follow some hints in order to find a better first solution.
    boolean
    If true, we automatically detect variables whose constraint are always enforced by the same literal and we mark them as optional.
    boolean
    When this is true, the cumulative constraint is reinforced with overload checking, i.e., an additional level of reasoning based on energy.
    boolean
    Whether to use pseudo-Boolean resolution to analyze a conflict.
    boolean
    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().
    boolean
    When this is true, then a disjunctive constraint will try to use the precedence relations between time intervals to propagate their bounds further.
    boolean
    If true, search will continuously probe Boolean variables, and integer variable bounds.
    boolean
    Turns on a lns worker which solves relaxed version of the original problem by removing constraints from the problem in order to get better bounds.
    boolean
    Turns on relaxation induced neighborhood generator.
    boolean
    optional bool use_sat_inprocessing = 163 [default = false];
    boolean
    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.
    boolean
    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.
    boolean
    When this is true, the no_overlap_2d constraint is reinforced with propagators from the cumulative constraints.
    double
    Each time a conflict is found, the activities of some variables are increased by one.
    boolean
    Stop the search when the gap between the best feasible objective (O) and our best objective bound (B) is smaller than a limit.
    boolean
    Whether we generate and add Chvatal-Gomory cuts to the LP at root node.
    boolean
    Whether we generate clique cuts from the binary implication graph.
    boolean
    For the lin max constraints, generates the cuts described in "Strong mixed-integer programming formulations for trained neural networks" by Ross Anderson et.
    boolean
    If true, we start by an empty LP, and only add constraints not satisfied by the current LP solution batch by batch.
    boolean
    Whether we generate MIR cuts at root node.
    boolean
    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.
    boolean
    Whether we generate Zero-Half cuts at root node.
    boolean
    When this is true, then the variables that appear in any of the reason of the variables in a conflict have their activity bumped.
    boolean
    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.
    boolean
    optional .operations_research.sat.SatParameters.BinaryMinizationAlgorithm binary_minimization_algorithm = 34 [default = BINARY_MINIMIZATION_FIRST];
    boolean
    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.
    boolean
    optional double blocking_restart_multiplier = 66 [default = 1.4];
    boolean
    optional int32 blocking_restart_window_size = 65 [default = 5000];
    boolean
    A non-negative level indicating how much we should try to fully encode Integer variables as Boolean.
    boolean
    Indicates if the CP-SAT layer should catch Control-C (SIGINT) signals when calling solve.
    boolean
    Clause activity parameters (same effect as the one on the variables).
    boolean
    All the clauses with a LBD (literal blocks distance) lower or equal to this parameters will always be kept.
    boolean
    optional .operations_research.sat.SatParameters.ClauseOrdering clause_cleanup_ordering = 60 [default = CLAUSE_ACTIVITY];
    boolean
    Trigger a cleanup when this number of "deletable" clauses is learned.
    boolean
    optional .operations_research.sat.SatParameters.ClauseProtection clause_cleanup_protection = 58 [default = PROTECTION_NONE];
    boolean
    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.
    boolean
    During a cleanup, we will always keep that number of "deletable" clauses.
    boolean
    Temporary flag util the feature is more mature.
    boolean
    Whether or not the assumption levels are taken into account during the LBD computation.
    boolean
    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.
    boolean
    Whether we presolve the cp_model before solving it.
    boolean
    How much effort do we spend on probing.
    boolean
    Whether we also use the sat presolve when cp_model_presolve is true.
    boolean
    optional double cut_active_count_decay = 156 [default = 0.8];
    boolean
    Target number of constraints to remove during cleanup.
    boolean
    Control the global cut effort.
    boolean
    These parameters are similar to sat clause management activity parameters.
    boolean
    Crash if we do not manage to complete the hint into a full solution.
    boolean
    If positive, try to stop just after that many presolve rules have been applied.
    boolean
    We have two different postsolve code.
    boolean
    optional string default_restart_algorithms = 70 [default = "LUBY_RESTART,LBD_MOVING_AVERAGE_RESTART,DL_MOVING_AVERAGE_RESTART"];
    boolean
    If true, we detect variable that are unique to a table constraint and only there to encode a cost on each tuple.
    boolean
    If true, it disable all constraint expansion.
    boolean
    If true, registers more lns subsolvers with different parameters.
    boolean
    Whether we enumerate all solutions of a problem without objective.
    boolean
    If true, expand all_different constraints that are not permutations.
    boolean
    If true and the Lp relaxation of the problem has a solution, try to exploit it.
    boolean
    optional bool exploit_all_precedences = 220 [default = false];
    boolean
    When branching on a variable, follow the last best solution value.
    boolean
    If true and the Lp relaxation of the problem has an integer optimal solution, try to exploit it.
    boolean
    When branching an a variable that directly affect the objective, branch on the value that lead to the best objective first.
    boolean
    When branching on a variable, follow the last best relaxation solution value.
    boolean
    If true, the final response addition_solutions field will be filled with all solutions from our solutions pool.
    boolean
    If true, add information about the derived variable domains to the CpSolverResponse.
    boolean
    Whether we try to find more independent cores for a given set of assumptions in the core based max-SAT algorithms.
    boolean
    If true, variables appearing in the solution hints will be fixed to their hinted value.
    boolean
    optional .operations_research.sat.SatParameters.FPRoundingMethod fp_rounding = 165 [default = PROPAGATION_ASSISTED];
    boolean
    optional double glucose_decay_increment = 23 [default = 0.01];
    boolean
    optional int32 glucose_decay_increment_period = 24 [default = 5000];
    boolean
    The activity starts at 0.8 and increment by 0.01 every 5000 conflicts until 0.95.
    boolean
    Conflict limit used in the phase that exploit the solution hint.
    boolean
    If true, we don't keep names in our internal copy of the user given model.
    boolean
    optional .operations_research.sat.SatParameters.Polarity initial_polarity = 2 [default = POLARITY_FALSE];
    boolean
    The initial value of the variables activity.
    boolean
    If true, the solver will add a default integer branching strategy to the already defined search strategy.
    boolean
    optional int32 interleave_batch_size = 134 [default = 1];
    boolean
    Experimental.
    boolean
    If true, we disable the presolve reductions that remove feasible solutions from the search space.
    boolean
    A non-negative level indicating the type of constraints we consider in the LP relaxation.
    boolean
    Indicates how much logging should wait before logging periodic search information from specialized workers (lb_tree_search, probing).
    boolean
    Add a prefix to all logs.
    boolean
    Whether the solver should log the search progress.
    boolean
    Whether the solver should display per sub-solver search statistics.
    boolean
    Log to response proto.
    boolean
    Log to stdout.
    boolean
    Cut generator for all diffs can add too many cuts for large all_diff constraints.
    boolean
    optional double max_clause_activity_value = 18 [default = 1e+20];
    boolean
    If a constraint/cut in LP is not active for that many consecutive OPTIMAL solves, remove it from the LP.
    boolean
    Max number of time we perform cut generation and resolve the LP at level 0.
    boolean
    Maximum time allowed in deterministic time to solve a problem.
    boolean
    When loading a*x + b*y ==/!= c when x and y are both fully encoded.
    boolean
    In the integer rounding procedure used for MIR and Gomory cut, the maximum "scaling" we use (must be positive).
    boolean
    Maximum memory allowed for the whole thread containing the solver.
    boolean
    Maximum number of conflicts allowed to solve a problem.
    boolean
    The limit on the number of cuts in our cut pool.
    boolean
    In case of large reduction in a presolve iteration, we perform multiple presolve iterations.
    boolean
    optional .operations_research.sat.SatParameters.MaxSatAssumptionOrder max_sat_assumption_order = 51 [default = DEFAULT_ASSUMPTION_ORDER];
    boolean
    If true, adds the assumption in the reverse order of the one defined by max_sat_assumption_order.
    boolean
    optional .operations_research.sat.SatParameters.MaxSatStratificationAlgorithm max_sat_stratification = 53 [default = STRATIFICATION_DESCENT];
    boolean
    Maximum time allowed in seconds to solve a problem.
    boolean
    optional double max_variable_activity_value = 16 [default = 1e+100];
    boolean
    optional double merge_at_most_one_work_limit = 146 [default = 100000000];
    boolean
    During presolve, we use a maximum clique heuristic to merge together no-overlap constraints or at most one constraints.
    boolean
    optional .operations_research.sat.SatParameters.ConflictMinimizationAlgorithm minimization_algorithm = 4 [default = RECURSIVE];
    boolean
    Whether we use a simple heuristic to try to minimize an UNSAT core.
    boolean
    A different algorithm during PB resolution.
    boolean
    optional int32 minimize_with_propagation_num_decisions = 97 [default = 1000];
    boolean
    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 For now, we have a somewhat simpler implementation where every x restart we spend y decisions on clause minimization.
    boolean
    If there is an objective and we are not in interleave mode, we will reserve at least this number of worker for LNS thread.
    boolean
    While adding constraints, skip the constraints which have orthogonality less than 'min_orthogonality_for_lp_constraints' with already added constraints during current call.
    boolean
    If true, some continuous variable might be automatically scaled.
    boolean
    As explained in mip_precision and mip_max_activity_exponent, we cannot always reach the wanted precision during scaling.
    boolean
    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.
    boolean
    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.
    boolean
    We need to bound the maximum magnitude of the variables for CP-SAT, and that is the bound we use.
    boolean
    Any finite values in the input MIP must be below this threshold, otherwise the model will be reported invalid.
    boolean
    All continuous variable of the problem will be multiplied by this factor.
    boolean
    When scaling constraint with double coefficients to integer coefficients, we will multiply by a power of 2 and round the coefficients.
    boolean
    optional double model_reduction_log_frequency_in_seconds = 218 [default = 5];
    boolean
    In some context, like in a portfolio of search, it makes sense to name a given parameters set for logging purpose.
    boolean
    Add that many lazy constraints (or cuts) at once in the LP.
    boolean
    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.
    boolean
    optional int32 num_search_workers = 100 [default = 0];
    boolean
    Specify the number of parallel workers (i.e.
    boolean
    For the cut that can be generated at any level, this control if we only try to generate them at the root node.
    boolean
    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.
    boolean
    The default optimization method is a simple "linear scan", each time trying to find a better solution than the previous one.
    boolean
    Do a more conventional tree search (by opposition to SAT based one) where we keep all the explored node in a tree.
    boolean
    This has no effect if optimize_with_core is false.
    boolean
    Same as for the clauses, but for the learned pseudo-Boolean constraints.
    boolean
    optional double pb_cleanup_ratio = 47 [default = 0.5];
    boolean
    optional bool permute_presolve_constraint_order = 179 [default = false];
    boolean
    This is mainly here to test the solver variability.
    boolean
    If non-zero, then we change the polarity heuristic after that many number of conflicts in an arithmetically increasing fashion.
    boolean
    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.
    boolean
    optional .operations_research.sat.SatParameters.VariableOrder preferred_variable_order = 1 [default = IN_ORDER];
    boolean
    Whether we use an heuristic to detect some basic case of blocked clause in the SAT presolve.
    boolean
    Apply Bounded Variable Addition (BVA) if the number of clauses is reduced by stricly more than this threshold.
    boolean
    During presolve, we apply BVE only if this weight times the number of clauses plus the number of clause literals is not increased.
    boolean
    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.
    boolean
    If true, we will extract from linear constraints, enforcement literals of the form "integer variable at bound => simplified constraint".
    boolean
    A few presolve operations involve detecting constraints included in other constraint.
    boolean
    The maximum "deterministic" time limit to spend in probing.
    boolean
    How much substitution (also called free variable aggregation in MIP litterature) should we perform at presolve.
    boolean
    Whether or not we use Bounded Variable Addition (BVA) in the presolve.
    boolean
    If set at zero (the default), it is disabled.
    boolean
    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.
    boolean
    The solver ignores the pseudo costs of variables with number of recordings less than this threshold.
    boolean
    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.
    boolean
    Randomize fixed search.
    boolean
    The proportion of polarity chosen at random.
    boolean
    At the beginning of each solve, the random number generator used in some part of the solver is reinitialized to this seed.
    boolean
    optional double relative_gap_limit = 160 [default = 0];
    boolean
    If true, the solver tries to repair the solution given in the hint.
    boolean
    In the moving average restart algorithms, a restart is triggered if the window average times this ratio is greater that the global average.
    boolean
    optional double restart_lbd_average_ratio = 71 [default = 1];
    boolean
    Restart period for the FIXED_RESTART strategy.
    boolean
    Size of the window for the moving average restarts.
    boolean
    optional .operations_research.sat.SatParameters.SearchBranching search_branching = 82 [default = AUTOMATIC_SEARCH];
    boolean
    Search randomization will collect equivalent 'max valued' variables, and pick one randomly.
    boolean
    Allows sharing of new learned binary clause between workers.
    boolean
    Allows sharing of the bounds of modified variables at level 0.
    boolean
    Allows objective sharing between workers.
    boolean
    Specifies the amount of deterministic time spent of each try at shaving a bound in the shaving search.
    boolean
    Size of the top-n different solutions kept by the solver.
    boolean
    For an optimization problem, stop the solver as soon as we have a solution.
    boolean
    Mainly used when improving the presolver.
    boolean
    The parameter num_conflicts_before_strategy_changes is increased by that much after each strategy change.
    boolean
    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.
    boolean
    Whether we try to automatically detect the symmetries in a model and exploit them.
    boolean
    How much we try to "compress" a table constraint.
    boolean
    optional bool use_absl_random = 180 [default = false];
    boolean
    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.
    boolean
    If true, the solver attemts to generate more info inside lp propagator by branching on some variables if certain criteria are met during the search tree exploration.
    boolean
    This can be beneficial if there is a lot of no-overlap constraints but a relatively low number of different intervals in the problem.
    boolean
    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.
    boolean
    When set, it activates a few scheduling parameters to improve the lower bound of scheduling problems.
    boolean
    When this is true, the no_overlap_2d constraint is reinforced with energetic reasoning.
    boolean
    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.
    boolean
    The solver usually exploit the LP relaxation of a model.
    boolean
    Adds a feasibility pump subsolver along with lns subsolvers.
    boolean
    If true, detect and create constraint for integer variable that are "after" a set of intervals in the same cumulative constraint.
    boolean
    Stores and exploits "implied-bounds" in the solver.
    boolean
    LNS parameters.
    boolean
    For an optimization problem, whether we follow some hints in order to find a better first solution.
    boolean
    If true, we automatically detect variables whose constraint are always enforced by the same literal and we mark them as optional.
    boolean
    When this is true, the cumulative constraint is reinforced with overload checking, i.e., an additional level of reasoning based on energy.
    boolean
    Whether to use pseudo-Boolean resolution to analyze a conflict.
    boolean
    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().
    boolean
    When this is true, then a disjunctive constraint will try to use the precedence relations between time intervals to propagate their bounds further.
    boolean
    If true, search will continuously probe Boolean variables, and integer variable bounds.
    boolean
    Turns on a lns worker which solves relaxed version of the original problem by removing constraints from the problem in order to get better bounds.
    boolean
    Turns on relaxation induced neighborhood generator.
    boolean
    optional bool use_sat_inprocessing = 163 [default = false];
    boolean
    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.
    boolean
    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.
    boolean
    When this is true, the no_overlap_2d constraint is reinforced with propagators from the cumulative constraints.
    boolean
    Each time a conflict is found, the activities of some variables are increased by one.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
  • Method Details

    • hasName

      boolean hasName()
       In some context, like in a portfolio of search, it makes sense to name a
       given parameters set for logging purpose.
       
      optional string name = 171 [default = ""];
      Returns:
      Whether the name field is set.
    • getName

      String getName()
       In some context, like in a portfolio of search, it makes sense to name a
       given parameters set for logging purpose.
       
      optional string name = 171 [default = ""];
      Returns:
      The name.
    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       In some context, like in a portfolio of search, it makes sense to name a
       given parameters set for logging purpose.
       
      optional string name = 171 [default = ""];
      Returns:
      The bytes for name.
    • hasPreferredVariableOrder

      boolean hasPreferredVariableOrder()
      optional .operations_research.sat.SatParameters.VariableOrder preferred_variable_order = 1 [default = IN_ORDER];
      Returns:
      Whether the preferredVariableOrder field is set.
    • getPreferredVariableOrder

      SatParameters.VariableOrder getPreferredVariableOrder()
      optional .operations_research.sat.SatParameters.VariableOrder preferred_variable_order = 1 [default = IN_ORDER];
      Returns:
      The preferredVariableOrder.
    • hasInitialPolarity

      boolean hasInitialPolarity()
      optional .operations_research.sat.SatParameters.Polarity initial_polarity = 2 [default = POLARITY_FALSE];
      Returns:
      Whether the initialPolarity field is set.
    • getInitialPolarity

      SatParameters.Polarity getInitialPolarity()
      optional .operations_research.sat.SatParameters.Polarity initial_polarity = 2 [default = POLARITY_FALSE];
      Returns:
      The initialPolarity.
    • hasUsePhaseSaving

      boolean hasUsePhaseSaving()
       If this is true, then the polarity of a variable will be the last value it
       was assigned to, or its default polarity if it was never assigned since the
       call to ResetDecisionHeuristic().
       Actually, we use a newer version where we follow the last value in the
       longest non-conflicting partial assignment in the current phase.
       This is called 'literal phase saving'. For details see 'A Lightweight
       Component Caching Scheme for Satisfiability Solvers' K. Pipatsrisawat and
       A.Darwiche, In 10th International Conference on Theory and Applications of
       Satisfiability Testing, 2007.
       
      optional bool use_phase_saving = 44 [default = true];
      Returns:
      Whether the usePhaseSaving field is set.
    • getUsePhaseSaving

      boolean getUsePhaseSaving()
       If this is true, then the polarity of a variable will be the last value it
       was assigned to, or its default polarity if it was never assigned since the
       call to ResetDecisionHeuristic().
       Actually, we use a newer version where we follow the last value in the
       longest non-conflicting partial assignment in the current phase.
       This is called 'literal phase saving'. For details see 'A Lightweight
       Component Caching Scheme for Satisfiability Solvers' K. Pipatsrisawat and
       A.Darwiche, In 10th International Conference on Theory and Applications of
       Satisfiability Testing, 2007.
       
      optional bool use_phase_saving = 44 [default = true];
      Returns:
      The usePhaseSaving.
    • hasPolarityRephaseIncrement

      boolean hasPolarityRephaseIncrement()
       If non-zero, then we change the polarity heuristic after that many number
       of conflicts in an arithmetically increasing fashion. So x the first time,
       2 * x the second time, etc...
       
      optional int32 polarity_rephase_increment = 168 [default = 1000];
      Returns:
      Whether the polarityRephaseIncrement field is set.
    • getPolarityRephaseIncrement

      int getPolarityRephaseIncrement()
       If non-zero, then we change the polarity heuristic after that many number
       of conflicts in an arithmetically increasing fashion. So x the first time,
       2 * x the second time, etc...
       
      optional int32 polarity_rephase_increment = 168 [default = 1000];
      Returns:
      The polarityRephaseIncrement.
    • hasRandomPolarityRatio

      boolean hasRandomPolarityRatio()
       The proportion of polarity chosen at random. Note that this take
       precedence over the phase saving heuristic. This is different from
       initial_polarity:POLARITY_RANDOM because it will select a new random
       polarity each time the variable is branched upon instead of selecting one
       initially and then always taking this choice.
       
      optional double random_polarity_ratio = 45 [default = 0];
      Returns:
      Whether the randomPolarityRatio field is set.
    • getRandomPolarityRatio

      double getRandomPolarityRatio()
       The proportion of polarity chosen at random. Note that this take
       precedence over the phase saving heuristic. This is different from
       initial_polarity:POLARITY_RANDOM because it will select a new random
       polarity each time the variable is branched upon instead of selecting one
       initially and then always taking this choice.
       
      optional double random_polarity_ratio = 45 [default = 0];
      Returns:
      The randomPolarityRatio.
    • hasRandomBranchesRatio

      boolean hasRandomBranchesRatio()
       A number between 0 and 1 that indicates the proportion of branching
       variables that are selected randomly instead of choosing the first variable
       from the given variable_ordering strategy.
       
      optional double random_branches_ratio = 32 [default = 0];
      Returns:
      Whether the randomBranchesRatio field is set.
    • getRandomBranchesRatio

      double getRandomBranchesRatio()
       A number between 0 and 1 that indicates the proportion of branching
       variables that are selected randomly instead of choosing the first variable
       from the given variable_ordering strategy.
       
      optional double random_branches_ratio = 32 [default = 0];
      Returns:
      The randomBranchesRatio.
    • hasUseErwaHeuristic

      boolean hasUseErwaHeuristic()
       Whether we use the ERWA (Exponential Recency Weighted Average) heuristic as
       described in "Learning Rate Based Branching Heuristic for SAT solvers",
       J.H.Liang, V. Ganesh, P. Poupart, K.Czarnecki, SAT 2016.
       
      optional bool use_erwa_heuristic = 75 [default = false];
      Returns:
      Whether the useErwaHeuristic field is set.
    • getUseErwaHeuristic

      boolean getUseErwaHeuristic()
       Whether we use the ERWA (Exponential Recency Weighted Average) heuristic as
       described in "Learning Rate Based Branching Heuristic for SAT solvers",
       J.H.Liang, V. Ganesh, P. Poupart, K.Czarnecki, SAT 2016.
       
      optional bool use_erwa_heuristic = 75 [default = false];
      Returns:
      The useErwaHeuristic.
    • hasInitialVariablesActivity

      boolean hasInitialVariablesActivity()
       The initial value of the variables activity. A non-zero value only make
       sense when use_erwa_heuristic is true. Experiments with a value of 1e-2
       together with the ERWA heuristic showed slighthly better result than simply
       using zero. The idea is that when the "learning rate" of a variable becomes
       lower than this value, then we prefer to branch on never explored before
       variables. This is not in the ERWA paper.
       
      optional double initial_variables_activity = 76 [default = 0];
      Returns:
      Whether the initialVariablesActivity field is set.
    • getInitialVariablesActivity

      double getInitialVariablesActivity()
       The initial value of the variables activity. A non-zero value only make
       sense when use_erwa_heuristic is true. Experiments with a value of 1e-2
       together with the ERWA heuristic showed slighthly better result than simply
       using zero. The idea is that when the "learning rate" of a variable becomes
       lower than this value, then we prefer to branch on never explored before
       variables. This is not in the ERWA paper.
       
      optional double initial_variables_activity = 76 [default = 0];
      Returns:
      The initialVariablesActivity.
    • hasAlsoBumpVariablesInConflictReasons

      boolean hasAlsoBumpVariablesInConflictReasons()
       When this is true, then the variables that appear in any of the reason of
       the variables in a conflict have their activity bumped. This is addition to
       the variables in the conflict, and the one that were used during conflict
       resolution.
       
      optional bool also_bump_variables_in_conflict_reasons = 77 [default = false];
      Returns:
      Whether the alsoBumpVariablesInConflictReasons field is set.
    • getAlsoBumpVariablesInConflictReasons

      boolean getAlsoBumpVariablesInConflictReasons()
       When this is true, then the variables that appear in any of the reason of
       the variables in a conflict have their activity bumped. This is addition to
       the variables in the conflict, and the one that were used during conflict
       resolution.
       
      optional bool also_bump_variables_in_conflict_reasons = 77 [default = false];
      Returns:
      The alsoBumpVariablesInConflictReasons.
    • hasMinimizationAlgorithm

      boolean hasMinimizationAlgorithm()
      optional .operations_research.sat.SatParameters.ConflictMinimizationAlgorithm minimization_algorithm = 4 [default = RECURSIVE];
      Returns:
      Whether the minimizationAlgorithm field is set.
    • getMinimizationAlgorithm

      optional .operations_research.sat.SatParameters.ConflictMinimizationAlgorithm minimization_algorithm = 4 [default = RECURSIVE];
      Returns:
      The minimizationAlgorithm.
    • hasBinaryMinimizationAlgorithm

      boolean hasBinaryMinimizationAlgorithm()
      optional .operations_research.sat.SatParameters.BinaryMinizationAlgorithm binary_minimization_algorithm = 34 [default = BINARY_MINIMIZATION_FIRST];
      Returns:
      Whether the binaryMinimizationAlgorithm field is set.
    • getBinaryMinimizationAlgorithm

      SatParameters.BinaryMinizationAlgorithm getBinaryMinimizationAlgorithm()
      optional .operations_research.sat.SatParameters.BinaryMinizationAlgorithm binary_minimization_algorithm = 34 [default = BINARY_MINIMIZATION_FIRST];
      Returns:
      The binaryMinimizationAlgorithm.
    • hasSubsumptionDuringConflictAnalysis

      boolean hasSubsumptionDuringConflictAnalysis()
       At a really low cost, during the 1-UIP conflict computation, it is easy to
       detect if some of the involved reasons are subsumed by the current
       conflict. When this is true, such clauses are detached and later removed
       from the problem.
       
      optional bool subsumption_during_conflict_analysis = 56 [default = true];
      Returns:
      Whether the subsumptionDuringConflictAnalysis field is set.
    • getSubsumptionDuringConflictAnalysis

      boolean getSubsumptionDuringConflictAnalysis()
       At a really low cost, during the 1-UIP conflict computation, it is easy to
       detect if some of the involved reasons are subsumed by the current
       conflict. When this is true, such clauses are detached and later removed
       from the problem.
       
      optional bool subsumption_during_conflict_analysis = 56 [default = true];
      Returns:
      The subsumptionDuringConflictAnalysis.
    • hasClauseCleanupPeriod

      boolean hasClauseCleanupPeriod()
       Trigger a cleanup when this number of "deletable" clauses is learned.
       
      optional int32 clause_cleanup_period = 11 [default = 10000];
      Returns:
      Whether the clauseCleanupPeriod field is set.
    • getClauseCleanupPeriod

      int getClauseCleanupPeriod()
       Trigger a cleanup when this number of "deletable" clauses is learned.
       
      optional int32 clause_cleanup_period = 11 [default = 10000];
      Returns:
      The clauseCleanupPeriod.
    • hasClauseCleanupTarget

      boolean hasClauseCleanupTarget()
       During a cleanup, we will always keep that number of "deletable" clauses.
       Note that this doesn't include the "protected" clauses.
       
      optional int32 clause_cleanup_target = 13 [default = 0];
      Returns:
      Whether the clauseCleanupTarget field is set.
    • getClauseCleanupTarget

      int getClauseCleanupTarget()
       During a cleanup, we will always keep that number of "deletable" clauses.
       Note that this doesn't include the "protected" clauses.
       
      optional int32 clause_cleanup_target = 13 [default = 0];
      Returns:
      The clauseCleanupTarget.
    • hasClauseCleanupRatio

      boolean hasClauseCleanupRatio()
       During a cleanup, if clause_cleanup_target is 0, we will delete the
       clause_cleanup_ratio of "deletable" clauses instead of aiming for a fixed
       target of clauses to keep.
       
      optional double clause_cleanup_ratio = 190 [default = 0.5];
      Returns:
      Whether the clauseCleanupRatio field is set.
    • getClauseCleanupRatio

      double getClauseCleanupRatio()
       During a cleanup, if clause_cleanup_target is 0, we will delete the
       clause_cleanup_ratio of "deletable" clauses instead of aiming for a fixed
       target of clauses to keep.
       
      optional double clause_cleanup_ratio = 190 [default = 0.5];
      Returns:
      The clauseCleanupRatio.
    • hasClauseCleanupProtection

      boolean hasClauseCleanupProtection()
      optional .operations_research.sat.SatParameters.ClauseProtection clause_cleanup_protection = 58 [default = PROTECTION_NONE];
      Returns:
      Whether the clauseCleanupProtection field is set.
    • getClauseCleanupProtection

      SatParameters.ClauseProtection getClauseCleanupProtection()
      optional .operations_research.sat.SatParameters.ClauseProtection clause_cleanup_protection = 58 [default = PROTECTION_NONE];
      Returns:
      The clauseCleanupProtection.
    • hasClauseCleanupLbdBound

      boolean hasClauseCleanupLbdBound()
       All the clauses with a LBD (literal blocks distance) lower or equal to this
       parameters will always be kept.
       
      optional int32 clause_cleanup_lbd_bound = 59 [default = 5];
      Returns:
      Whether the clauseCleanupLbdBound field is set.
    • getClauseCleanupLbdBound

      int getClauseCleanupLbdBound()
       All the clauses with a LBD (literal blocks distance) lower or equal to this
       parameters will always be kept.
       
      optional int32 clause_cleanup_lbd_bound = 59 [default = 5];
      Returns:
      The clauseCleanupLbdBound.
    • hasClauseCleanupOrdering

      boolean hasClauseCleanupOrdering()
      optional .operations_research.sat.SatParameters.ClauseOrdering clause_cleanup_ordering = 60 [default = CLAUSE_ACTIVITY];
      Returns:
      Whether the clauseCleanupOrdering field is set.
    • getClauseCleanupOrdering

      SatParameters.ClauseOrdering getClauseCleanupOrdering()
      optional .operations_research.sat.SatParameters.ClauseOrdering clause_cleanup_ordering = 60 [default = CLAUSE_ACTIVITY];
      Returns:
      The clauseCleanupOrdering.
    • hasPbCleanupIncrement

      boolean hasPbCleanupIncrement()
       Same as for the clauses, but for the learned pseudo-Boolean constraints.
       
      optional int32 pb_cleanup_increment = 46 [default = 200];
      Returns:
      Whether the pbCleanupIncrement field is set.
    • getPbCleanupIncrement

      int getPbCleanupIncrement()
       Same as for the clauses, but for the learned pseudo-Boolean constraints.
       
      optional int32 pb_cleanup_increment = 46 [default = 200];
      Returns:
      The pbCleanupIncrement.
    • hasPbCleanupRatio

      boolean hasPbCleanupRatio()
      optional double pb_cleanup_ratio = 47 [default = 0.5];
      Returns:
      Whether the pbCleanupRatio field is set.
    • getPbCleanupRatio

      double getPbCleanupRatio()
      optional double pb_cleanup_ratio = 47 [default = 0.5];
      Returns:
      The pbCleanupRatio.
    • hasMinimizeWithPropagationRestartPeriod

      boolean hasMinimizeWithPropagationRestartPeriod()
       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
       For now, we have a somewhat simpler implementation where every x restart we
       spend y decisions on clause minimization. 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.
       Changing these parameters or the kind of clause we minimize seems to have
       a big impact on the overall perf on our benchmarks. So this technique seems
       definitely useful, but it is hard to tune properly.
       
      optional int32 minimize_with_propagation_restart_period = 96 [default = 10];
      Returns:
      Whether the minimizeWithPropagationRestartPeriod field is set.
    • getMinimizeWithPropagationRestartPeriod

      int getMinimizeWithPropagationRestartPeriod()
       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
       For now, we have a somewhat simpler implementation where every x restart we
       spend y decisions on clause minimization. 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.
       Changing these parameters or the kind of clause we minimize seems to have
       a big impact on the overall perf on our benchmarks. So this technique seems
       definitely useful, but it is hard to tune properly.
       
      optional int32 minimize_with_propagation_restart_period = 96 [default = 10];
      Returns:
      The minimizeWithPropagationRestartPeriod.
    • hasMinimizeWithPropagationNumDecisions

      boolean hasMinimizeWithPropagationNumDecisions()
      optional int32 minimize_with_propagation_num_decisions = 97 [default = 1000];
      Returns:
      Whether the minimizeWithPropagationNumDecisions field is set.
    • getMinimizeWithPropagationNumDecisions

      int getMinimizeWithPropagationNumDecisions()
      optional int32 minimize_with_propagation_num_decisions = 97 [default = 1000];
      Returns:
      The minimizeWithPropagationNumDecisions.
    • hasVariableActivityDecay

      boolean hasVariableActivityDecay()
       Each time a conflict is found, the activities of some variables are
       increased by one. Then, the activity of all variables are multiplied by
       variable_activity_decay.
       To implement this efficiently, the activity of all the variables is not
       decayed at each conflict. Instead, the activity increment is multiplied by
       1 / decay. When an activity reach max_variable_activity_value, all the
       activity are multiplied by 1 / max_variable_activity_value.
       
      optional double variable_activity_decay = 15 [default = 0.8];
      Returns:
      Whether the variableActivityDecay field is set.
    • getVariableActivityDecay

      double getVariableActivityDecay()
       Each time a conflict is found, the activities of some variables are
       increased by one. Then, the activity of all variables are multiplied by
       variable_activity_decay.
       To implement this efficiently, the activity of all the variables is not
       decayed at each conflict. Instead, the activity increment is multiplied by
       1 / decay. When an activity reach max_variable_activity_value, all the
       activity are multiplied by 1 / max_variable_activity_value.
       
      optional double variable_activity_decay = 15 [default = 0.8];
      Returns:
      The variableActivityDecay.
    • hasMaxVariableActivityValue

      boolean hasMaxVariableActivityValue()
      optional double max_variable_activity_value = 16 [default = 1e+100];
      Returns:
      Whether the maxVariableActivityValue field is set.
    • getMaxVariableActivityValue

      double getMaxVariableActivityValue()
      optional double max_variable_activity_value = 16 [default = 1e+100];
      Returns:
      The maxVariableActivityValue.
    • hasGlucoseMaxDecay

      boolean hasGlucoseMaxDecay()
       The activity starts at 0.8 and increment by 0.01 every 5000 conflicts until
       0.95. This "hack" seems to work well and comes from:
       Glucose 2.3 in the SAT 2013 Competition - SAT Competition 2013
       http://edacc4.informatik.uni-ulm.de/SC13/solver-description-download/136
       
      optional double glucose_max_decay = 22 [default = 0.95];
      Returns:
      Whether the glucoseMaxDecay field is set.
    • getGlucoseMaxDecay

      double getGlucoseMaxDecay()
       The activity starts at 0.8 and increment by 0.01 every 5000 conflicts until
       0.95. This "hack" seems to work well and comes from:
       Glucose 2.3 in the SAT 2013 Competition - SAT Competition 2013
       http://edacc4.informatik.uni-ulm.de/SC13/solver-description-download/136
       
      optional double glucose_max_decay = 22 [default = 0.95];
      Returns:
      The glucoseMaxDecay.
    • hasGlucoseDecayIncrement

      boolean hasGlucoseDecayIncrement()
      optional double glucose_decay_increment = 23 [default = 0.01];
      Returns:
      Whether the glucoseDecayIncrement field is set.
    • getGlucoseDecayIncrement

      double getGlucoseDecayIncrement()
      optional double glucose_decay_increment = 23 [default = 0.01];
      Returns:
      The glucoseDecayIncrement.
    • hasGlucoseDecayIncrementPeriod

      boolean hasGlucoseDecayIncrementPeriod()
      optional int32 glucose_decay_increment_period = 24 [default = 5000];
      Returns:
      Whether the glucoseDecayIncrementPeriod field is set.
    • getGlucoseDecayIncrementPeriod

      int getGlucoseDecayIncrementPeriod()
      optional int32 glucose_decay_increment_period = 24 [default = 5000];
      Returns:
      The glucoseDecayIncrementPeriod.
    • hasClauseActivityDecay

      boolean hasClauseActivityDecay()
       Clause activity parameters (same effect as the one on the variables).
       
      optional double clause_activity_decay = 17 [default = 0.999];
      Returns:
      Whether the clauseActivityDecay field is set.
    • getClauseActivityDecay

      double getClauseActivityDecay()
       Clause activity parameters (same effect as the one on the variables).
       
      optional double clause_activity_decay = 17 [default = 0.999];
      Returns:
      The clauseActivityDecay.
    • hasMaxClauseActivityValue

      boolean hasMaxClauseActivityValue()
      optional double max_clause_activity_value = 18 [default = 1e+20];
      Returns:
      Whether the maxClauseActivityValue field is set.
    • getMaxClauseActivityValue

      double getMaxClauseActivityValue()
      optional double max_clause_activity_value = 18 [default = 1e+20];
      Returns:
      The maxClauseActivityValue.
    • getRestartAlgorithmsList

      List<SatParameters.RestartAlgorithm> getRestartAlgorithmsList()
       The restart strategies will change each time the strategy_counter is
       increased. The current strategy will simply be the one at index
       strategy_counter modulo the number of strategy. Note that if this list
       includes a NO_RESTART, nothing will change when it is reached because the
       strategy_counter will only increment after a restart.
       The idea of switching of search strategy tailored for SAT/UNSAT comes from
       Chanseok Oh with his COMiniSatPS solver, see http://cs.nyu.edu/~chanseok/.
       But more generally, it seems REALLY beneficial to try different strategy.
       
      repeated .operations_research.sat.SatParameters.RestartAlgorithm restart_algorithms = 61;
      Returns:
      A list containing the restartAlgorithms.
    • getRestartAlgorithmsCount

      int getRestartAlgorithmsCount()
       The restart strategies will change each time the strategy_counter is
       increased. The current strategy will simply be the one at index
       strategy_counter modulo the number of strategy. Note that if this list
       includes a NO_RESTART, nothing will change when it is reached because the
       strategy_counter will only increment after a restart.
       The idea of switching of search strategy tailored for SAT/UNSAT comes from
       Chanseok Oh with his COMiniSatPS solver, see http://cs.nyu.edu/~chanseok/.
       But more generally, it seems REALLY beneficial to try different strategy.
       
      repeated .operations_research.sat.SatParameters.RestartAlgorithm restart_algorithms = 61;
      Returns:
      The count of restartAlgorithms.
    • getRestartAlgorithms

      SatParameters.RestartAlgorithm getRestartAlgorithms(int index)
       The restart strategies will change each time the strategy_counter is
       increased. The current strategy will simply be the one at index
       strategy_counter modulo the number of strategy. Note that if this list
       includes a NO_RESTART, nothing will change when it is reached because the
       strategy_counter will only increment after a restart.
       The idea of switching of search strategy tailored for SAT/UNSAT comes from
       Chanseok Oh with his COMiniSatPS solver, see http://cs.nyu.edu/~chanseok/.
       But more generally, it seems REALLY beneficial to try different strategy.
       
      repeated .operations_research.sat.SatParameters.RestartAlgorithm restart_algorithms = 61;
      Parameters:
      index - The index of the element to return.
      Returns:
      The restartAlgorithms at the given index.
    • hasDefaultRestartAlgorithms

      boolean hasDefaultRestartAlgorithms()
      optional string default_restart_algorithms = 70 [default = "LUBY_RESTART,LBD_MOVING_AVERAGE_RESTART,DL_MOVING_AVERAGE_RESTART"];
      Returns:
      Whether the defaultRestartAlgorithms field is set.
    • getDefaultRestartAlgorithms

      String getDefaultRestartAlgorithms()
      optional string default_restart_algorithms = 70 [default = "LUBY_RESTART,LBD_MOVING_AVERAGE_RESTART,DL_MOVING_AVERAGE_RESTART"];
      Returns:
      The defaultRestartAlgorithms.
    • getDefaultRestartAlgorithmsBytes

      com.google.protobuf.ByteString getDefaultRestartAlgorithmsBytes()
      optional string default_restart_algorithms = 70 [default = "LUBY_RESTART,LBD_MOVING_AVERAGE_RESTART,DL_MOVING_AVERAGE_RESTART"];
      Returns:
      The bytes for defaultRestartAlgorithms.
    • hasRestartPeriod

      boolean hasRestartPeriod()
       Restart period for the FIXED_RESTART strategy. This is also the multiplier
       used by the LUBY_RESTART strategy.
       
      optional int32 restart_period = 30 [default = 50];
      Returns:
      Whether the restartPeriod field is set.
    • getRestartPeriod

      int getRestartPeriod()
       Restart period for the FIXED_RESTART strategy. This is also the multiplier
       used by the LUBY_RESTART strategy.
       
      optional int32 restart_period = 30 [default = 50];
      Returns:
      The restartPeriod.
    • hasRestartRunningWindowSize

      boolean hasRestartRunningWindowSize()
       Size of the window for the moving average restarts.
       
      optional int32 restart_running_window_size = 62 [default = 50];
      Returns:
      Whether the restartRunningWindowSize field is set.
    • getRestartRunningWindowSize

      int getRestartRunningWindowSize()
       Size of the window for the moving average restarts.
       
      optional int32 restart_running_window_size = 62 [default = 50];
      Returns:
      The restartRunningWindowSize.
    • hasRestartDlAverageRatio

      boolean hasRestartDlAverageRatio()
       In the moving average restart algorithms, a restart is triggered if the
       window average times this ratio is greater that the global average.
       
      optional double restart_dl_average_ratio = 63 [default = 1];
      Returns:
      Whether the restartDlAverageRatio field is set.
    • getRestartDlAverageRatio

      double getRestartDlAverageRatio()
       In the moving average restart algorithms, a restart is triggered if the
       window average times this ratio is greater that the global average.
       
      optional double restart_dl_average_ratio = 63 [default = 1];
      Returns:
      The restartDlAverageRatio.
    • hasRestartLbdAverageRatio

      boolean hasRestartLbdAverageRatio()
      optional double restart_lbd_average_ratio = 71 [default = 1];
      Returns:
      Whether the restartLbdAverageRatio field is set.
    • getRestartLbdAverageRatio

      double getRestartLbdAverageRatio()
      optional double restart_lbd_average_ratio = 71 [default = 1];
      Returns:
      The restartLbdAverageRatio.
    • hasUseBlockingRestart

      boolean hasUseBlockingRestart()
       Block a moving restart algorithm if the trail size of the current conflict
       is greater than the multiplier times the moving average of the trail size
       at the previous conflicts.
       
      optional bool use_blocking_restart = 64 [default = false];
      Returns:
      Whether the useBlockingRestart field is set.
    • getUseBlockingRestart

      boolean getUseBlockingRestart()
       Block a moving restart algorithm if the trail size of the current conflict
       is greater than the multiplier times the moving average of the trail size
       at the previous conflicts.
       
      optional bool use_blocking_restart = 64 [default = false];
      Returns:
      The useBlockingRestart.
    • hasBlockingRestartWindowSize

      boolean hasBlockingRestartWindowSize()
      optional int32 blocking_restart_window_size = 65 [default = 5000];
      Returns:
      Whether the blockingRestartWindowSize field is set.
    • getBlockingRestartWindowSize

      int getBlockingRestartWindowSize()
      optional int32 blocking_restart_window_size = 65 [default = 5000];
      Returns:
      The blockingRestartWindowSize.
    • hasBlockingRestartMultiplier

      boolean hasBlockingRestartMultiplier()
      optional double blocking_restart_multiplier = 66 [default = 1.4];
      Returns:
      Whether the blockingRestartMultiplier field is set.
    • getBlockingRestartMultiplier

      double getBlockingRestartMultiplier()
      optional double blocking_restart_multiplier = 66 [default = 1.4];
      Returns:
      The blockingRestartMultiplier.
    • hasNumConflictsBeforeStrategyChanges

      boolean hasNumConflictsBeforeStrategyChanges()
       After each restart, if the number of conflict since the last strategy
       change is greater that this, then we increment a "strategy_counter" that
       can be use to change the search strategy used by the following restarts.
       
      optional int32 num_conflicts_before_strategy_changes = 68 [default = 0];
      Returns:
      Whether the numConflictsBeforeStrategyChanges field is set.
    • getNumConflictsBeforeStrategyChanges

      int getNumConflictsBeforeStrategyChanges()
       After each restart, if the number of conflict since the last strategy
       change is greater that this, then we increment a "strategy_counter" that
       can be use to change the search strategy used by the following restarts.
       
      optional int32 num_conflicts_before_strategy_changes = 68 [default = 0];
      Returns:
      The numConflictsBeforeStrategyChanges.
    • hasStrategyChangeIncreaseRatio

      boolean hasStrategyChangeIncreaseRatio()
       The parameter num_conflicts_before_strategy_changes is increased by that
       much after each strategy change.
       
      optional double strategy_change_increase_ratio = 69 [default = 0];
      Returns:
      Whether the strategyChangeIncreaseRatio field is set.
    • getStrategyChangeIncreaseRatio

      double getStrategyChangeIncreaseRatio()
       The parameter num_conflicts_before_strategy_changes is increased by that
       much after each strategy change.
       
      optional double strategy_change_increase_ratio = 69 [default = 0];
      Returns:
      The strategyChangeIncreaseRatio.
    • hasMaxTimeInSeconds

      boolean hasMaxTimeInSeconds()
       Maximum time allowed in seconds to solve a problem.
       The counter will starts at the beginning of the Solve() call.
       
      optional double max_time_in_seconds = 36 [default = inf];
      Returns:
      Whether the maxTimeInSeconds field is set.
    • getMaxTimeInSeconds

      double getMaxTimeInSeconds()
       Maximum time allowed in seconds to solve a problem.
       The counter will starts at the beginning of the Solve() call.
       
      optional double max_time_in_seconds = 36 [default = inf];
      Returns:
      The maxTimeInSeconds.
    • hasMaxDeterministicTime

      boolean hasMaxDeterministicTime()
       Maximum time allowed in deterministic time to solve a problem.
       The deterministic time should be correlated with the real time used by the
       solver, the time unit being as close as possible to a second.
       
      optional double max_deterministic_time = 67 [default = inf];
      Returns:
      Whether the maxDeterministicTime field is set.
    • getMaxDeterministicTime

      double getMaxDeterministicTime()
       Maximum time allowed in deterministic time to solve a problem.
       The deterministic time should be correlated with the real time used by the
       solver, the time unit being as close as possible to a second.
       
      optional double max_deterministic_time = 67 [default = inf];
      Returns:
      The maxDeterministicTime.
    • hasMaxNumberOfConflicts

      boolean hasMaxNumberOfConflicts()
       Maximum number of conflicts allowed to solve a problem.
       TODO(user,user): Maybe change the way the conflict limit is enforced?
       currently it is enforced on each independent internal SAT solve, rather
       than on the overall number of conflicts across all solves. So in the
       context of an optimization problem, this is not really usable directly by a
       client.
       
      optional int64 max_number_of_conflicts = 37 [default = 9223372036854775807];
      Returns:
      Whether the maxNumberOfConflicts field is set.
    • getMaxNumberOfConflicts

      long getMaxNumberOfConflicts()
       Maximum number of conflicts allowed to solve a problem.
       TODO(user,user): Maybe change the way the conflict limit is enforced?
       currently it is enforced on each independent internal SAT solve, rather
       than on the overall number of conflicts across all solves. So in the
       context of an optimization problem, this is not really usable directly by a
       client.
       
      optional int64 max_number_of_conflicts = 37 [default = 9223372036854775807];
      Returns:
      The maxNumberOfConflicts.
    • hasMaxMemoryInMb

      boolean hasMaxMemoryInMb()
       Maximum memory allowed for the whole thread containing the solver. The
       solver will abort as soon as it detects that this limit is crossed. As a
       result, this limit is approximative, but usually the solver will not go too
       much over.
       TODO(user): This is only used by the pure SAT solver, generalize to CP-SAT.
       
      optional int64 max_memory_in_mb = 40 [default = 10000];
      Returns:
      Whether the maxMemoryInMb field is set.
    • getMaxMemoryInMb

      long getMaxMemoryInMb()
       Maximum memory allowed for the whole thread containing the solver. The
       solver will abort as soon as it detects that this limit is crossed. As a
       result, this limit is approximative, but usually the solver will not go too
       much over.
       TODO(user): This is only used by the pure SAT solver, generalize to CP-SAT.
       
      optional int64 max_memory_in_mb = 40 [default = 10000];
      Returns:
      The maxMemoryInMb.
    • hasAbsoluteGapLimit

      boolean hasAbsoluteGapLimit()
       Stop the search when the gap between the best feasible objective (O) and
       our best objective bound (B) is smaller than a limit.
       The exact definition is:
       - Absolute: abs(O - B)
       - Relative: abs(O - B) / max(1, abs(O)).
       Important: The relative gap depends on the objective offset! If you
       artificially shift the objective, you will get widely different value of
       the relative gap.
       Note that if the gap is reached, the search status will be OPTIMAL. But
       one can check the best objective bound to see the actual gap.
       If the objective is integer, then any absolute gap < 1 will lead to a true
       optimal. If the objective is floating point, a gap of zero make little
       sense so is is why we use a non-zero default value. At the end of the
       search, we will display a warning if OPTIMAL is reported yet the gap is
       greater than this absolute gap.
       
      optional double absolute_gap_limit = 159 [default = 0.0001];
      Returns:
      Whether the absoluteGapLimit field is set.
    • getAbsoluteGapLimit

      double getAbsoluteGapLimit()
       Stop the search when the gap between the best feasible objective (O) and
       our best objective bound (B) is smaller than a limit.
       The exact definition is:
       - Absolute: abs(O - B)
       - Relative: abs(O - B) / max(1, abs(O)).
       Important: The relative gap depends on the objective offset! If you
       artificially shift the objective, you will get widely different value of
       the relative gap.
       Note that if the gap is reached, the search status will be OPTIMAL. But
       one can check the best objective bound to see the actual gap.
       If the objective is integer, then any absolute gap < 1 will lead to a true
       optimal. If the objective is floating point, a gap of zero make little
       sense so is is why we use a non-zero default value. At the end of the
       search, we will display a warning if OPTIMAL is reported yet the gap is
       greater than this absolute gap.
       
      optional double absolute_gap_limit = 159 [default = 0.0001];
      Returns:
      The absoluteGapLimit.
    • hasRelativeGapLimit

      boolean hasRelativeGapLimit()
      optional double relative_gap_limit = 160 [default = 0];
      Returns:
      Whether the relativeGapLimit field is set.
    • getRelativeGapLimit

      double getRelativeGapLimit()
      optional double relative_gap_limit = 160 [default = 0];
      Returns:
      The relativeGapLimit.
    • hasRandomSeed

      boolean hasRandomSeed()
       At the beginning of each solve, the random number generator used in some
       part of the solver is reinitialized to this seed. If you change the random
       seed, the solver may make different choices during the solving process.
       For some problems, the running time may vary a lot depending on small
       change in the solving algorithm. Running the solver with different seeds
       enables to have more robust benchmarks when evaluating new features.
       
      optional int32 random_seed = 31 [default = 1];
      Returns:
      Whether the randomSeed field is set.
    • getRandomSeed

      int getRandomSeed()
       At the beginning of each solve, the random number generator used in some
       part of the solver is reinitialized to this seed. If you change the random
       seed, the solver may make different choices during the solving process.
       For some problems, the running time may vary a lot depending on small
       change in the solving algorithm. Running the solver with different seeds
       enables to have more robust benchmarks when evaluating new features.
       
      optional int32 random_seed = 31 [default = 1];
      Returns:
      The randomSeed.
    • hasPermuteVariableRandomly

      boolean hasPermuteVariableRandomly()
       This is mainly here to test the solver variability. Note that in tests, if
       not explicitly set to false, all 3 options will be set to true so that
       clients do not rely on the solver returning a specific solution if they are
       many equivalent optimal solutions.
       
      optional bool permute_variable_randomly = 178 [default = false];
      Returns:
      Whether the permuteVariableRandomly field is set.
    • getPermuteVariableRandomly

      boolean getPermuteVariableRandomly()
       This is mainly here to test the solver variability. Note that in tests, if
       not explicitly set to false, all 3 options will be set to true so that
       clients do not rely on the solver returning a specific solution if they are
       many equivalent optimal solutions.
       
      optional bool permute_variable_randomly = 178 [default = false];
      Returns:
      The permuteVariableRandomly.
    • hasPermutePresolveConstraintOrder

      boolean hasPermutePresolveConstraintOrder()
      optional bool permute_presolve_constraint_order = 179 [default = false];
      Returns:
      Whether the permutePresolveConstraintOrder field is set.
    • getPermutePresolveConstraintOrder

      boolean getPermutePresolveConstraintOrder()
      optional bool permute_presolve_constraint_order = 179 [default = false];
      Returns:
      The permutePresolveConstraintOrder.
    • hasUseAbslRandom

      boolean hasUseAbslRandom()
      optional bool use_absl_random = 180 [default = false];
      Returns:
      Whether the useAbslRandom field is set.
    • getUseAbslRandom

      boolean getUseAbslRandom()
      optional bool use_absl_random = 180 [default = false];
      Returns:
      The useAbslRandom.
    • hasLogSearchProgress

      boolean hasLogSearchProgress()
       Whether the solver should log the search progress. By default, it logs to
       LOG(INFO). This can be overwritten by the log_destination parameter.
       
      optional bool log_search_progress = 41 [default = false];
      Returns:
      Whether the logSearchProgress field is set.
    • getLogSearchProgress

      boolean getLogSearchProgress()
       Whether the solver should log the search progress. By default, it logs to
       LOG(INFO). This can be overwritten by the log_destination parameter.
       
      optional bool log_search_progress = 41 [default = false];
      Returns:
      The logSearchProgress.
    • hasLogFrequencyInSeconds

      boolean hasLogFrequencyInSeconds()
       Indicates how much logging should wait before logging periodic search
       information from specialized workers (lb_tree_search, probing).
       A value < 0 will disable periodic logs.
       
      optional double log_frequency_in_seconds = 212 [default = -1];
      Returns:
      Whether the logFrequencyInSeconds field is set.
    • getLogFrequencyInSeconds

      double getLogFrequencyInSeconds()
       Indicates how much logging should wait before logging periodic search
       information from specialized workers (lb_tree_search, probing).
       A value < 0 will disable periodic logs.
       
      optional double log_frequency_in_seconds = 212 [default = -1];
      Returns:
      The logFrequencyInSeconds.
    • hasModelReductionLogFrequencyInSeconds

      boolean hasModelReductionLogFrequencyInSeconds()
      optional double model_reduction_log_frequency_in_seconds = 218 [default = 5];
      Returns:
      Whether the modelReductionLogFrequencyInSeconds field is set.
    • getModelReductionLogFrequencyInSeconds

      double getModelReductionLogFrequencyInSeconds()
      optional double model_reduction_log_frequency_in_seconds = 218 [default = 5];
      Returns:
      The modelReductionLogFrequencyInSeconds.
    • hasLogSubsolverStatistics

      boolean 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.
       
      optional bool log_subsolver_statistics = 189 [default = true];
      Returns:
      Whether the logSubsolverStatistics field is set.
    • getLogSubsolverStatistics

      boolean 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.
       
      optional bool log_subsolver_statistics = 189 [default = true];
      Returns:
      The logSubsolverStatistics.
    • hasLogPrefix

      boolean hasLogPrefix()
       Add a prefix to all logs.
       
      optional string log_prefix = 185 [default = ""];
      Returns:
      Whether the logPrefix field is set.
    • getLogPrefix

      String getLogPrefix()
       Add a prefix to all logs.
       
      optional string log_prefix = 185 [default = ""];
      Returns:
      The logPrefix.
    • getLogPrefixBytes

      com.google.protobuf.ByteString getLogPrefixBytes()
       Add a prefix to all logs.
       
      optional string log_prefix = 185 [default = ""];
      Returns:
      The bytes for logPrefix.
    • hasLogToStdout

      boolean hasLogToStdout()
       Log to stdout.
       
      optional bool log_to_stdout = 186 [default = true];
      Returns:
      Whether the logToStdout field is set.
    • getLogToStdout

      boolean getLogToStdout()
       Log to stdout.
       
      optional bool log_to_stdout = 186 [default = true];
      Returns:
      The logToStdout.
    • hasLogToResponse

      boolean hasLogToResponse()
       Log to response proto.
       
      optional bool log_to_response = 187 [default = false];
      Returns:
      Whether the logToResponse field is set.
    • getLogToResponse

      boolean getLogToResponse()
       Log to response proto.
       
      optional bool log_to_response = 187 [default = false];
      Returns:
      The logToResponse.
    • hasUsePbResolution

      boolean hasUsePbResolution()
       Whether to use pseudo-Boolean resolution to analyze a conflict. Note that
       this option only make sense if your problem is modelized using
       pseudo-Boolean constraints. If you only have clauses, this shouldn't change
       anything (except slow the solver down).
       
      optional bool use_pb_resolution = 43 [default = false];
      Returns:
      Whether the usePbResolution field is set.
    • getUsePbResolution

      boolean getUsePbResolution()
       Whether to use pseudo-Boolean resolution to analyze a conflict. Note that
       this option only make sense if your problem is modelized using
       pseudo-Boolean constraints. If you only have clauses, this shouldn't change
       anything (except slow the solver down).
       
      optional bool use_pb_resolution = 43 [default = false];
      Returns:
      The usePbResolution.
    • hasMinimizeReductionDuringPbResolution

      boolean hasMinimizeReductionDuringPbResolution()
       A different algorithm during PB resolution. It minimizes the number of
       calls to ReduceCoefficients() which can be time consuming. However, the
       search space will be different and if the coefficients are large, this may
       lead to integer overflows that could otherwise be prevented.
       
      optional bool minimize_reduction_during_pb_resolution = 48 [default = false];
      Returns:
      Whether the minimizeReductionDuringPbResolution field is set.
    • getMinimizeReductionDuringPbResolution

      boolean getMinimizeReductionDuringPbResolution()
       A different algorithm during PB resolution. It minimizes the number of
       calls to ReduceCoefficients() which can be time consuming. However, the
       search space will be different and if the coefficients are large, this may
       lead to integer overflows that could otherwise be prevented.
       
      optional bool minimize_reduction_during_pb_resolution = 48 [default = false];
      Returns:
      The minimizeReductionDuringPbResolution.
    • hasCountAssumptionLevelsInLbd

      boolean hasCountAssumptionLevelsInLbd()
       Whether or not the assumption levels are taken into account during the LBD
       computation. According to the reference below, not counting them improves
       the solver in some situation. Note that this only impact solves under
       assumptions.
       Gilles Audemard, Jean-Marie Lagniez, Laurent Simon, "Improving Glucose for
       Incremental SAT Solving with Assumptions: Application to MUS Extraction"
       Theory and Applications of Satisfiability Testing - SAT 2013, Lecture Notes
       in Computer Science Volume 7962, 2013, pp 309-317.
       
      optional bool count_assumption_levels_in_lbd = 49 [default = true];
      Returns:
      Whether the countAssumptionLevelsInLbd field is set.
    • getCountAssumptionLevelsInLbd

      boolean getCountAssumptionLevelsInLbd()
       Whether or not the assumption levels are taken into account during the LBD
       computation. According to the reference below, not counting them improves
       the solver in some situation. Note that this only impact solves under
       assumptions.
       Gilles Audemard, Jean-Marie Lagniez, Laurent Simon, "Improving Glucose for
       Incremental SAT Solving with Assumptions: Application to MUS Extraction"
       Theory and Applications of Satisfiability Testing - SAT 2013, Lecture Notes
       in Computer Science Volume 7962, 2013, pp 309-317.
       
      optional bool count_assumption_levels_in_lbd = 49 [default = true];
      Returns:
      The countAssumptionLevelsInLbd.
    • hasPresolveBveThreshold

      boolean hasPresolveBveThreshold()
       During presolve, only try to perform the bounded variable elimination (BVE)
       of a variable x if the number of occurrences of x times the number of
       occurrences of not(x) is not greater than this parameter.
       
      optional int32 presolve_bve_threshold = 54 [default = 500];
      Returns:
      Whether the presolveBveThreshold field is set.
    • getPresolveBveThreshold

      int getPresolveBveThreshold()
       During presolve, only try to perform the bounded variable elimination (BVE)
       of a variable x if the number of occurrences of x times the number of
       occurrences of not(x) is not greater than this parameter.
       
      optional int32 presolve_bve_threshold = 54 [default = 500];
      Returns:
      The presolveBveThreshold.
    • hasPresolveBveClauseWeight

      boolean hasPresolveBveClauseWeight()
       During presolve, we apply BVE only if this weight times the number of
       clauses plus the number of clause literals is not increased.
       
      optional int32 presolve_bve_clause_weight = 55 [default = 3];
      Returns:
      Whether the presolveBveClauseWeight field is set.
    • getPresolveBveClauseWeight

      int getPresolveBveClauseWeight()
       During presolve, we apply BVE only if this weight times the number of
       clauses plus the number of clause literals is not increased.
       
      optional int32 presolve_bve_clause_weight = 55 [default = 3];
      Returns:
      The presolveBveClauseWeight.
    • hasPresolveProbingDeterministicTimeLimit

      boolean hasPresolveProbingDeterministicTimeLimit()
       The maximum "deterministic" time limit to spend in probing. A value of
       zero will disable the probing.
       
      optional double presolve_probing_deterministic_time_limit = 57 [default = 30];
      Returns:
      Whether the presolveProbingDeterministicTimeLimit field is set.
    • getPresolveProbingDeterministicTimeLimit

      double getPresolveProbingDeterministicTimeLimit()
       The maximum "deterministic" time limit to spend in probing. A value of
       zero will disable the probing.
       
      optional double presolve_probing_deterministic_time_limit = 57 [default = 30];
      Returns:
      The presolveProbingDeterministicTimeLimit.
    • hasPresolveBlockedClause

      boolean hasPresolveBlockedClause()
       Whether we use an heuristic to detect some basic case of blocked clause
       in the SAT presolve.
       
      optional bool presolve_blocked_clause = 88 [default = true];
      Returns:
      Whether the presolveBlockedClause field is set.
    • getPresolveBlockedClause

      boolean getPresolveBlockedClause()
       Whether we use an heuristic to detect some basic case of blocked clause
       in the SAT presolve.
       
      optional bool presolve_blocked_clause = 88 [default = true];
      Returns:
      The presolveBlockedClause.
    • hasPresolveUseBva

      boolean hasPresolveUseBva()
       Whether or not we use Bounded Variable Addition (BVA) in the presolve.
       
      optional bool presolve_use_bva = 72 [default = true];
      Returns:
      Whether the presolveUseBva field is set.
    • getPresolveUseBva

      boolean getPresolveUseBva()
       Whether or not we use Bounded Variable Addition (BVA) in the presolve.
       
      optional bool presolve_use_bva = 72 [default = true];
      Returns:
      The presolveUseBva.
    • hasPresolveBvaThreshold

      boolean hasPresolveBvaThreshold()
       Apply Bounded Variable Addition (BVA) if the number of clauses is reduced
       by stricly more than this threshold. The algorithm described in the paper
       uses 0, but quick experiments showed that 1 is a good value. It may not be
       worth it to add a new variable just to remove one clause.
       
      optional int32 presolve_bva_threshold = 73 [default = 1];
      Returns:
      Whether the presolveBvaThreshold field is set.
    • getPresolveBvaThreshold

      int getPresolveBvaThreshold()
       Apply Bounded Variable Addition (BVA) if the number of clauses is reduced
       by stricly more than this threshold. The algorithm described in the paper
       uses 0, but quick experiments showed that 1 is a good value. It may not be
       worth it to add a new variable just to remove one clause.
       
      optional int32 presolve_bva_threshold = 73 [default = 1];
      Returns:
      The presolveBvaThreshold.
    • hasMaxPresolveIterations

      boolean hasMaxPresolveIterations()
       In case of large reduction in a presolve iteration, we perform multiple
       presolve iterations. This parameter controls the maximum number of such
       presolve iterations.
       
      optional int32 max_presolve_iterations = 138 [default = 3];
      Returns:
      Whether the maxPresolveIterations field is set.
    • getMaxPresolveIterations

      int getMaxPresolveIterations()
       In case of large reduction in a presolve iteration, we perform multiple
       presolve iterations. This parameter controls the maximum number of such
       presolve iterations.
       
      optional int32 max_presolve_iterations = 138 [default = 3];
      Returns:
      The maxPresolveIterations.
    • hasCpModelPresolve

      boolean hasCpModelPresolve()
       Whether we presolve the cp_model before solving it.
       
      optional bool cp_model_presolve = 86 [default = true];
      Returns:
      Whether the cpModelPresolve field is set.
    • getCpModelPresolve

      boolean getCpModelPresolve()
       Whether we presolve the cp_model before solving it.
       
      optional bool cp_model_presolve = 86 [default = true];
      Returns:
      The cpModelPresolve.
    • hasCpModelProbingLevel

      boolean hasCpModelProbingLevel()
       How much effort do we spend on probing. 0 disables it completely.
       
      optional int32 cp_model_probing_level = 110 [default = 2];
      Returns:
      Whether the cpModelProbingLevel field is set.
    • getCpModelProbingLevel

      int getCpModelProbingLevel()
       How much effort do we spend on probing. 0 disables it completely.
       
      optional int32 cp_model_probing_level = 110 [default = 2];
      Returns:
      The cpModelProbingLevel.
    • hasCpModelUseSatPresolve

      boolean hasCpModelUseSatPresolve()
       Whether we also use the sat presolve when cp_model_presolve is true.
       
      optional bool cp_model_use_sat_presolve = 93 [default = true];
      Returns:
      Whether the cpModelUseSatPresolve field is set.
    • getCpModelUseSatPresolve

      boolean getCpModelUseSatPresolve()
       Whether we also use the sat presolve when cp_model_presolve is true.
       
      optional bool cp_model_use_sat_presolve = 93 [default = true];
      Returns:
      The cpModelUseSatPresolve.
    • hasUseSatInprocessing

      boolean hasUseSatInprocessing()
      optional bool use_sat_inprocessing = 163 [default = false];
      Returns:
      Whether the useSatInprocessing field is set.
    • getUseSatInprocessing

      boolean getUseSatInprocessing()
      optional bool use_sat_inprocessing = 163 [default = false];
      Returns:
      The useSatInprocessing.
    • hasDetectTableWithCost

      boolean hasDetectTableWithCost()
       If true, we detect variable that are unique to a table constraint and only
       there to encode a cost on each tuple. This is usually the case when a WCSP
       (weighted constraint program) is encoded into CP-SAT format.
       This can lead to a dramatic speed-up for such problems but is still
       experimental at this point.
       
      optional bool detect_table_with_cost = 216 [default = false];
      Returns:
      Whether the detectTableWithCost field is set.
    • getDetectTableWithCost

      boolean getDetectTableWithCost()
       If true, we detect variable that are unique to a table constraint and only
       there to encode a cost on each tuple. This is usually the case when a WCSP
       (weighted constraint program) is encoded into CP-SAT format.
       This can lead to a dramatic speed-up for such problems but is still
       experimental at this point.
       
      optional bool detect_table_with_cost = 216 [default = false];
      Returns:
      The detectTableWithCost.
    • hasTableCompressionLevel

      boolean hasTableCompressionLevel()
       How much we try to "compress" a table constraint. Compressing more leads to
       less Booleans and faster propagation but can reduced the quality of the lp
       relaxation. Values goes from 0 to 3 where we always try to fully compress a
       table. At 2, we try to automatically decide if it is worth it.
       
      optional int32 table_compression_level = 217 [default = 2];
      Returns:
      Whether the tableCompressionLevel field is set.
    • getTableCompressionLevel

      int getTableCompressionLevel()
       How much we try to "compress" a table constraint. Compressing more leads to
       less Booleans and faster propagation but can reduced the quality of the lp
       relaxation. Values goes from 0 to 3 where we always try to fully compress a
       table. At 2, we try to automatically decide if it is worth it.
       
      optional int32 table_compression_level = 217 [default = 2];
      Returns:
      The tableCompressionLevel.
    • hasExpandAlldiffConstraints

      boolean hasExpandAlldiffConstraints()
       If true, expand all_different constraints that are not permutations.
       Permutations (#Variables = #Values) are always expanded.
       
      optional bool expand_alldiff_constraints = 170 [default = false];
      Returns:
      Whether the expandAlldiffConstraints field is set.
    • getExpandAlldiffConstraints

      boolean getExpandAlldiffConstraints()
       If true, expand all_different constraints that are not permutations.
       Permutations (#Variables = #Values) are always expanded.
       
      optional bool expand_alldiff_constraints = 170 [default = false];
      Returns:
      The expandAlldiffConstraints.
    • hasDisableConstraintExpansion

      boolean hasDisableConstraintExpansion()
       If true, it disable all constraint expansion.
       This should only be used to test the presolve of expanded constraints.
       
      optional bool disable_constraint_expansion = 181 [default = false];
      Returns:
      Whether the disableConstraintExpansion field is set.
    • getDisableConstraintExpansion

      boolean getDisableConstraintExpansion()
       If true, it disable all constraint expansion.
       This should only be used to test the presolve of expanded constraints.
       
      optional bool disable_constraint_expansion = 181 [default = false];
      Returns:
      The disableConstraintExpansion.
    • hasMergeNoOverlapWorkLimit

      boolean hasMergeNoOverlapWorkLimit()
       During presolve, we use a maximum clique heuristic to merge together
       no-overlap constraints or at most one constraints. This code can be slow,
       so we have a limit in place on the number of explored nodes in the
       underlying graph. The internal limit is an int64, but we use double here to
       simplify manual input.
       
      optional double merge_no_overlap_work_limit = 145 [default = 1000000000000];
      Returns:
      Whether the mergeNoOverlapWorkLimit field is set.
    • getMergeNoOverlapWorkLimit

      double getMergeNoOverlapWorkLimit()
       During presolve, we use a maximum clique heuristic to merge together
       no-overlap constraints or at most one constraints. This code can be slow,
       so we have a limit in place on the number of explored nodes in the
       underlying graph. The internal limit is an int64, but we use double here to
       simplify manual input.
       
      optional double merge_no_overlap_work_limit = 145 [default = 1000000000000];
      Returns:
      The mergeNoOverlapWorkLimit.
    • hasMergeAtMostOneWorkLimit

      boolean hasMergeAtMostOneWorkLimit()
      optional double merge_at_most_one_work_limit = 146 [default = 100000000];
      Returns:
      Whether the mergeAtMostOneWorkLimit field is set.
    • getMergeAtMostOneWorkLimit

      double getMergeAtMostOneWorkLimit()
      optional double merge_at_most_one_work_limit = 146 [default = 100000000];
      Returns:
      The mergeAtMostOneWorkLimit.
    • hasPresolveSubstitutionLevel

      boolean hasPresolveSubstitutionLevel()
       How much substitution (also called free variable aggregation in MIP
       litterature) should we perform at presolve. This currently only concerns
       variable appearing only in linear constraints. For now the value 0 turns it
       off and any positive value performs substitution.
       
      optional int32 presolve_substitution_level = 147 [default = 1];
      Returns:
      Whether the presolveSubstitutionLevel field is set.
    • getPresolveSubstitutionLevel

      int getPresolveSubstitutionLevel()
       How much substitution (also called free variable aggregation in MIP
       litterature) should we perform at presolve. This currently only concerns
       variable appearing only in linear constraints. For now the value 0 turns it
       off and any positive value performs substitution.
       
      optional int32 presolve_substitution_level = 147 [default = 1];
      Returns:
      The presolveSubstitutionLevel.
    • hasPresolveExtractIntegerEnforcement

      boolean hasPresolveExtractIntegerEnforcement()
       If true, we will extract from linear constraints, enforcement literals of
       the form "integer variable at bound => simplified constraint". This should
       always be beneficial except that we don't always handle them as efficiently
       as we could for now. This causes problem on manna81.mps (LP relaxation not
       as tight it seems) and on neos-3354841-apure.mps.gz (too many literals
       created this way).
       
      optional bool presolve_extract_integer_enforcement = 174 [default = false];
      Returns:
      Whether the presolveExtractIntegerEnforcement field is set.
    • getPresolveExtractIntegerEnforcement

      boolean getPresolveExtractIntegerEnforcement()
       If true, we will extract from linear constraints, enforcement literals of
       the form "integer variable at bound => simplified constraint". This should
       always be beneficial except that we don't always handle them as efficiently
       as we could for now. This causes problem on manna81.mps (LP relaxation not
       as tight it seems) and on neos-3354841-apure.mps.gz (too many literals
       created this way).
       
      optional bool presolve_extract_integer_enforcement = 174 [default = false];
      Returns:
      The presolveExtractIntegerEnforcement.
    • hasPresolveInclusionWorkLimit

      boolean hasPresolveInclusionWorkLimit()
       A few presolve operations involve detecting constraints included in other
       constraint. Since there can be a quadratic number of such pairs, and
       processing them usually involve scanning them, the complexity of these
       operations can be big. This enforce a local deterministic limit on the
       number of entries scanned. Default is 1e8.
       A value of zero will disable these presolve rules completely.
       
      optional int64 presolve_inclusion_work_limit = 201 [default = 100000000];
      Returns:
      Whether the presolveInclusionWorkLimit field is set.
    • getPresolveInclusionWorkLimit

      long getPresolveInclusionWorkLimit()
       A few presolve operations involve detecting constraints included in other
       constraint. Since there can be a quadratic number of such pairs, and
       processing them usually involve scanning them, the complexity of these
       operations can be big. This enforce a local deterministic limit on the
       number of entries scanned. Default is 1e8.
       A value of zero will disable these presolve rules completely.
       
      optional int64 presolve_inclusion_work_limit = 201 [default = 100000000];
      Returns:
      The presolveInclusionWorkLimit.
    • hasIgnoreNames

      boolean hasIgnoreNames()
       If true, we don't keep names in our internal copy of the user given model.
       
      optional bool ignore_names = 202 [default = true];
      Returns:
      Whether the ignoreNames field is set.
    • getIgnoreNames

      boolean getIgnoreNames()
       If true, we don't keep names in our internal copy of the user given model.
       
      optional bool ignore_names = 202 [default = true];
      Returns:
      The ignoreNames.
    • hasNumWorkers

      boolean 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_worker'.
       As of 2020-04-10, if you're using SAT via MPSolver (to solve integer
       programs) this field is overridden with a value of 8, if the field is not
       set *explicitly*. Thus, always set this field explicitly or via
       MPSolver::SetNumThreads().
       
      optional int32 num_workers = 206 [default = 0];
      Returns:
      Whether the numWorkers field is set.
    • getNumWorkers

      int 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_worker'.
       As of 2020-04-10, if you're using SAT via MPSolver (to solve integer
       programs) this field is overridden with a value of 8, if the field is not
       set *explicitly*. Thus, always set this field explicitly or via
       MPSolver::SetNumThreads().
       
      optional int32 num_workers = 206 [default = 0];
      Returns:
      The numWorkers.
    • hasNumSearchWorkers

      boolean hasNumSearchWorkers()
      optional int32 num_search_workers = 100 [default = 0];
      Returns:
      Whether the numSearchWorkers field is set.
    • getNumSearchWorkers

      int getNumSearchWorkers()
      optional int32 num_search_workers = 100 [default = 0];
      Returns:
      The numSearchWorkers.
    • hasMinNumLnsWorkers

      boolean hasMinNumLnsWorkers()
       If there is an objective and we are not in interleave mode, we will reserve
       at least this number of worker for LNS thread.
       TODO(user): Also define like for subsolvers the list of "active" type of
       neighborhood used.
       
      optional int32 min_num_lns_workers = 211 [default = 2];
      Returns:
      Whether the minNumLnsWorkers field is set.
    • getMinNumLnsWorkers

      int getMinNumLnsWorkers()
       If there is an objective and we are not in interleave mode, we will reserve
       at least this number of worker for LNS thread.
       TODO(user): Also define like for subsolvers the list of "active" type of
       neighborhood used.
       
      optional int32 min_num_lns_workers = 211 [default = 2];
      Returns:
      The minNumLnsWorkers.
    • getSubsolversList

      List<String> 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.
       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)
       - less_encoding        (only if no objective)
       - 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 usable "num_workers -
       min_num_lns_workers" subsolvers will be scheduled. You can see in the log
       which one are selected for a given run. All the others will be LNS if there
       is an objective, or randomized SAT search for pure satisfiability problems.
       
      repeated string subsolvers = 207;
      Returns:
      A list containing the subsolvers.
    • getSubsolversCount

      int 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.
       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)
       - less_encoding        (only if no objective)
       - 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 usable "num_workers -
       min_num_lns_workers" subsolvers will be scheduled. You can see in the log
       which one are selected for a given run. All the others will be LNS if there
       is an objective, or randomized SAT search for pure satisfiability problems.
       
      repeated string subsolvers = 207;
      Returns:
      The count of subsolvers.
    • getSubsolvers

      String 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.
       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)
       - less_encoding        (only if no objective)
       - 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 usable "num_workers -
       min_num_lns_workers" subsolvers will be scheduled. You can see in the log
       which one are selected for a given run. All the others will be LNS if there
       is an objective, or randomized SAT search for pure satisfiability problems.
       
      repeated string subsolvers = 207;
      Parameters:
      index - The index of the element to return.
      Returns:
      The subsolvers at the given index.
    • getSubsolversBytes

      com.google.protobuf.ByteString 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.
       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)
       - less_encoding        (only if no objective)
       - 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 usable "num_workers -
       min_num_lns_workers" subsolvers will be scheduled. You can see in the log
       which one are selected for a given run. All the others will be LNS if there
       is an objective, or randomized SAT search for pure satisfiability problems.
       
      repeated string subsolvers = 207;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the subsolvers at the given index.
    • getExtraSubsolversList

      List<String> getExtraSubsolversList()
       A convenient way to add more workers types.
       Note that these will be added at the end of the list, so this is only
       useful if you run with many workers.
       
      repeated string extra_subsolvers = 219;
      Returns:
      A list containing the extraSubsolvers.
    • getExtraSubsolversCount

      int getExtraSubsolversCount()
       A convenient way to add more workers types.
       Note that these will be added at the end of the list, so this is only
       useful if you run with many workers.
       
      repeated string extra_subsolvers = 219;
      Returns:
      The count of extraSubsolvers.
    • getExtraSubsolvers

      String getExtraSubsolvers(int index)
       A convenient way to add more workers types.
       Note that these will be added at the end of the list, so this is only
       useful if you run with many workers.
       
      repeated string extra_subsolvers = 219;
      Parameters:
      index - The index of the element to return.
      Returns:
      The extraSubsolvers at the given index.
    • getExtraSubsolversBytes

      com.google.protobuf.ByteString getExtraSubsolversBytes(int index)
       A convenient way to add more workers types.
       Note that these will be added at the end of the list, so this is only
       useful if you run with many workers.
       
      repeated string extra_subsolvers = 219;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the extraSubsolvers at the given index.
    • getIgnoreSubsolversList

      List<String> getIgnoreSubsolversList()
       Rather than fully specifying subsolvers, it is often convenient to just
       remove the ones that are not useful on a given problem.
       
      repeated string ignore_subsolvers = 209;
      Returns:
      A list containing the ignoreSubsolvers.
    • getIgnoreSubsolversCount

      int getIgnoreSubsolversCount()
       Rather than fully specifying subsolvers, it is often convenient to just
       remove the ones that are not useful on a given problem.
       
      repeated string ignore_subsolvers = 209;
      Returns:
      The count of ignoreSubsolvers.
    • getIgnoreSubsolvers

      String 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.
       
      repeated string ignore_subsolvers = 209;
      Parameters:
      index - The index of the element to return.
      Returns:
      The ignoreSubsolvers at the given index.
    • getIgnoreSubsolversBytes

      com.google.protobuf.ByteString 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.
       
      repeated string ignore_subsolvers = 209;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the ignoreSubsolvers at the given index.
    • getSubsolverParamsList

      List<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. It is also
       possible to overwrite the default names above.
       
      repeated .operations_research.sat.SatParameters subsolver_params = 210;
    • getSubsolverParams

      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. It is also
       possible to overwrite the default names above.
       
      repeated .operations_research.sat.SatParameters subsolver_params = 210;
    • getSubsolverParamsCount

      int 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. It is also
       possible to overwrite the default names above.
       
      repeated .operations_research.sat.SatParameters subsolver_params = 210;
    • getSubsolverParamsOrBuilderList

      List<? extends SatParametersOrBuilder> 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. It is also
       possible to overwrite the default names above.
       
      repeated .operations_research.sat.SatParameters subsolver_params = 210;
    • getSubsolverParamsOrBuilder

      SatParametersOrBuilder 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. It is also
       possible to overwrite the default names above.
       
      repeated .operations_research.sat.SatParameters subsolver_params = 210;
    • hasInterleaveSearch

      boolean hasInterleaveSearch()
       Experimental. If this is true, then we interleave all our major search
       strategy and distribute the work amongst num_workers.
       The search is deterministic (independently of num_workers!), and we
       schedule and wait for interleave_batch_size task to be completed before
       synchronizing and scheduling the next batch of tasks.
       
      optional bool interleave_search = 136 [default = false];
      Returns:
      Whether the interleaveSearch field is set.
    • getInterleaveSearch

      boolean getInterleaveSearch()
       Experimental. If this is true, then we interleave all our major search
       strategy and distribute the work amongst num_workers.
       The search is deterministic (independently of num_workers!), and we
       schedule and wait for interleave_batch_size task to be completed before
       synchronizing and scheduling the next batch of tasks.
       
      optional bool interleave_search = 136 [default = false];
      Returns:
      The interleaveSearch.
    • hasInterleaveBatchSize

      boolean hasInterleaveBatchSize()
      optional int32 interleave_batch_size = 134 [default = 1];
      Returns:
      Whether the interleaveBatchSize field is set.
    • getInterleaveBatchSize

      int getInterleaveBatchSize()
      optional int32 interleave_batch_size = 134 [default = 1];
      Returns:
      The interleaveBatchSize.
    • hasShareObjectiveBounds

      boolean hasShareObjectiveBounds()
       Allows objective sharing between workers.
       
      optional bool share_objective_bounds = 113 [default = true];
      Returns:
      Whether the shareObjectiveBounds field is set.
    • getShareObjectiveBounds

      boolean getShareObjectiveBounds()
       Allows objective sharing between workers.
       
      optional bool share_objective_bounds = 113 [default = true];
      Returns:
      The shareObjectiveBounds.
    • hasShareLevelZeroBounds

      boolean hasShareLevelZeroBounds()
       Allows sharing of the bounds of modified variables at level 0.
       
      optional bool share_level_zero_bounds = 114 [default = true];
      Returns:
      Whether the shareLevelZeroBounds field is set.
    • getShareLevelZeroBounds

      boolean getShareLevelZeroBounds()
       Allows sharing of the bounds of modified variables at level 0.
       
      optional bool share_level_zero_bounds = 114 [default = true];
      Returns:
      The shareLevelZeroBounds.
    • hasShareBinaryClauses

      boolean hasShareBinaryClauses()
       Allows sharing of new learned binary clause between workers.
       
      optional bool share_binary_clauses = 203 [default = true];
      Returns:
      Whether the shareBinaryClauses field is set.
    • getShareBinaryClauses

      boolean getShareBinaryClauses()
       Allows sharing of new learned binary clause between workers.
       
      optional bool share_binary_clauses = 203 [default = true];
      Returns:
      The shareBinaryClauses.
    • hasDebugPostsolveWithFullSolver

      boolean hasDebugPostsolveWithFullSolver()
       We have two different postsolve code. The default one should be better and
       it allows for a more powerful presolve, but it can be useful to postsolve
       using the full solver instead.
       
      optional bool debug_postsolve_with_full_solver = 162 [default = false];
      Returns:
      Whether the debugPostsolveWithFullSolver field is set.
    • getDebugPostsolveWithFullSolver

      boolean getDebugPostsolveWithFullSolver()
       We have two different postsolve code. The default one should be better and
       it allows for a more powerful presolve, but it can be useful to postsolve
       using the full solver instead.
       
      optional bool debug_postsolve_with_full_solver = 162 [default = false];
      Returns:
      The debugPostsolveWithFullSolver.
    • hasDebugMaxNumPresolveOperations

      boolean hasDebugMaxNumPresolveOperations()
       If positive, try to stop just after that many presolve rules have been
       applied. This is mainly useful for debugging presolve.
       
      optional int32 debug_max_num_presolve_operations = 151 [default = 0];
      Returns:
      Whether the debugMaxNumPresolveOperations field is set.
    • getDebugMaxNumPresolveOperations

      int getDebugMaxNumPresolveOperations()
       If positive, try to stop just after that many presolve rules have been
       applied. This is mainly useful for debugging presolve.
       
      optional int32 debug_max_num_presolve_operations = 151 [default = 0];
      Returns:
      The debugMaxNumPresolveOperations.
    • hasDebugCrashOnBadHint

      boolean hasDebugCrashOnBadHint()
       Crash if we do not manage to complete the hint into a full solution.
       
      optional bool debug_crash_on_bad_hint = 195 [default = false];
      Returns:
      Whether the debugCrashOnBadHint field is set.
    • getDebugCrashOnBadHint

      boolean getDebugCrashOnBadHint()
       Crash if we do not manage to complete the hint into a full solution.
       
      optional bool debug_crash_on_bad_hint = 195 [default = false];
      Returns:
      The debugCrashOnBadHint.
    • hasUseOptimizationHints

      boolean hasUseOptimizationHints()
       For an optimization problem, whether we follow some hints in order to find
       a better first solution. For a variable with hint, the solver will always
       try to follow the hint. It will revert to the variable_branching default
       otherwise.
       
      optional bool use_optimization_hints = 35 [default = true];
      Returns:
      Whether the useOptimizationHints field is set.
    • getUseOptimizationHints

      boolean getUseOptimizationHints()
       For an optimization problem, whether we follow some hints in order to find
       a better first solution. For a variable with hint, the solver will always
       try to follow the hint. It will revert to the variable_branching default
       otherwise.
       
      optional bool use_optimization_hints = 35 [default = true];
      Returns:
      The useOptimizationHints.
    • hasMinimizeCore

      boolean hasMinimizeCore()
       Whether we use a simple heuristic to try to minimize an UNSAT core.
       
      optional bool minimize_core = 50 [default = true];
      Returns:
      Whether the minimizeCore field is set.
    • getMinimizeCore

      boolean getMinimizeCore()
       Whether we use a simple heuristic to try to minimize an UNSAT core.
       
      optional bool minimize_core = 50 [default = true];
      Returns:
      The minimizeCore.
    • hasFindMultipleCores

      boolean hasFindMultipleCores()
       Whether we try to find more independent cores for a given set of
       assumptions in the core based max-SAT algorithms.
       
      optional bool find_multiple_cores = 84 [default = true];
      Returns:
      Whether the findMultipleCores field is set.
    • getFindMultipleCores

      boolean getFindMultipleCores()
       Whether we try to find more independent cores for a given set of
       assumptions in the core based max-SAT algorithms.
       
      optional bool find_multiple_cores = 84 [default = true];
      Returns:
      The findMultipleCores.
    • hasCoverOptimization

      boolean hasCoverOptimization()
       If true, when the max-sat algo find a core, we compute the minimal number
       of literals in the core that needs to be true to have a feasible solution.
       This is also called core exhaustion in more recent max-SAT papers.
       
      optional bool cover_optimization = 89 [default = true];
      Returns:
      Whether the coverOptimization field is set.
    • getCoverOptimization

      boolean getCoverOptimization()
       If true, when the max-sat algo find a core, we compute the minimal number
       of literals in the core that needs to be true to have a feasible solution.
       This is also called core exhaustion in more recent max-SAT papers.
       
      optional bool cover_optimization = 89 [default = true];
      Returns:
      The coverOptimization.
    • hasMaxSatAssumptionOrder

      boolean hasMaxSatAssumptionOrder()
      optional .operations_research.sat.SatParameters.MaxSatAssumptionOrder max_sat_assumption_order = 51 [default = DEFAULT_ASSUMPTION_ORDER];
      Returns:
      Whether the maxSatAssumptionOrder field is set.
    • getMaxSatAssumptionOrder

      SatParameters.MaxSatAssumptionOrder getMaxSatAssumptionOrder()
      optional .operations_research.sat.SatParameters.MaxSatAssumptionOrder max_sat_assumption_order = 51 [default = DEFAULT_ASSUMPTION_ORDER];
      Returns:
      The maxSatAssumptionOrder.
    • hasMaxSatReverseAssumptionOrder

      boolean hasMaxSatReverseAssumptionOrder()
       If true, adds the assumption in the reverse order of the one defined by
       max_sat_assumption_order.
       
      optional bool max_sat_reverse_assumption_order = 52 [default = false];
      Returns:
      Whether the maxSatReverseAssumptionOrder field is set.
    • getMaxSatReverseAssumptionOrder

      boolean getMaxSatReverseAssumptionOrder()
       If true, adds the assumption in the reverse order of the one defined by
       max_sat_assumption_order.
       
      optional bool max_sat_reverse_assumption_order = 52 [default = false];
      Returns:
      The maxSatReverseAssumptionOrder.
    • hasMaxSatStratification

      boolean hasMaxSatStratification()
      optional .operations_research.sat.SatParameters.MaxSatStratificationAlgorithm max_sat_stratification = 53 [default = STRATIFICATION_DESCENT];
      Returns:
      Whether the maxSatStratification field is set.
    • getMaxSatStratification

      optional .operations_research.sat.SatParameters.MaxSatStratificationAlgorithm max_sat_stratification = 53 [default = STRATIFICATION_DESCENT];
      Returns:
      The maxSatStratification.
    • hasPropagationLoopDetectionFactor

      boolean hasPropagationLoopDetectionFactor()
       Some search decisions might cause a really large number of propagations to
       happen when integer variables with large domains are only reduced by 1 at
       each step. If we propagate more than the number of variable times this
       parameters we try to take counter-measure. Setting this to 0.0 disable this
       feature.
       TODO(user): Setting this to something like 10 helps in most cases, but the
       code is currently buggy and can cause the solve to enter a bad state where
       no progress is made.
       
      optional double propagation_loop_detection_factor = 221 [default = 10];
      Returns:
      Whether the propagationLoopDetectionFactor field is set.
    • getPropagationLoopDetectionFactor

      double getPropagationLoopDetectionFactor()
       Some search decisions might cause a really large number of propagations to
       happen when integer variables with large domains are only reduced by 1 at
       each step. If we propagate more than the number of variable times this
       parameters we try to take counter-measure. Setting this to 0.0 disable this
       feature.
       TODO(user): Setting this to something like 10 helps in most cases, but the
       code is currently buggy and can cause the solve to enter a bad state where
       no progress is made.
       
      optional double propagation_loop_detection_factor = 221 [default = 10];
      Returns:
      The propagationLoopDetectionFactor.
    • hasUsePrecedencesInDisjunctiveConstraint

      boolean hasUsePrecedencesInDisjunctiveConstraint()
       When this is true, then a disjunctive constraint will try to use the
       precedence relations between time intervals to propagate their bounds
       further. For instance if task A and B are both before C and task A and B
       are in disjunction, then we can deduce that task C must start after
       duration(A) + duration(B) instead of simply max(duration(A), duration(B)),
       provided that the start time for all task was currently zero.
       This always result in better propagation, but it is usually slow, so
       depending on the problem, turning this off may lead to a faster solution.
       
      optional bool use_precedences_in_disjunctive_constraint = 74 [default = true];
      Returns:
      Whether the usePrecedencesInDisjunctiveConstraint field is set.
    • getUsePrecedencesInDisjunctiveConstraint

      boolean getUsePrecedencesInDisjunctiveConstraint()
       When this is true, then a disjunctive constraint will try to use the
       precedence relations between time intervals to propagate their bounds
       further. For instance if task A and B are both before C and task A and B
       are in disjunction, then we can deduce that task C must start after
       duration(A) + duration(B) instead of simply max(duration(A), duration(B)),
       provided that the start time for all task was currently zero.
       This always result in better propagation, but it is usually slow, so
       depending on the problem, turning this off may lead to a faster solution.
       
      optional bool use_precedences_in_disjunctive_constraint = 74 [default = true];
      Returns:
      The usePrecedencesInDisjunctiveConstraint.
    • hasUseOverloadCheckerInCumulative

      boolean hasUseOverloadCheckerInCumulative()
       When this is true, the cumulative constraint is reinforced with overload
       checking, i.e., an additional level of reasoning based on energy. This
       additional level supplements the default level of reasoning as well as
       timetable edge finding.
       This always result in better propagation, but it is usually slow, so
       depending on the problem, turning this off may lead to a faster solution.
       
      optional bool use_overload_checker_in_cumulative = 78 [default = false];
      Returns:
      Whether the useOverloadCheckerInCumulative field is set.
    • getUseOverloadCheckerInCumulative

      boolean getUseOverloadCheckerInCumulative()
       When this is true, the cumulative constraint is reinforced with overload
       checking, i.e., an additional level of reasoning based on energy. This
       additional level supplements the default level of reasoning as well as
       timetable edge finding.
       This always result in better propagation, but it is usually slow, so
       depending on the problem, turning this off may lead to a faster solution.
       
      optional bool use_overload_checker_in_cumulative = 78 [default = false];
      Returns:
      The useOverloadCheckerInCumulative.
    • hasUseTimetableEdgeFindingInCumulative

      boolean hasUseTimetableEdgeFindingInCumulative()
       When this is true, the cumulative constraint is reinforced with timetable
       edge finding, i.e., an additional level of reasoning based on the
       conjunction of energy and mandatory parts. This additional level
       supplements the default level of reasoning as well as overload_checker.
       This always result in better propagation, but it is usually slow, so
       depending on the problem, turning this off may lead to a faster solution.
       
      optional bool use_timetable_edge_finding_in_cumulative = 79 [default = false];
      Returns:
      Whether the useTimetableEdgeFindingInCumulative field is set.
    • getUseTimetableEdgeFindingInCumulative

      boolean getUseTimetableEdgeFindingInCumulative()
       When this is true, the cumulative constraint is reinforced with timetable
       edge finding, i.e., an additional level of reasoning based on the
       conjunction of energy and mandatory parts. This additional level
       supplements the default level of reasoning as well as overload_checker.
       This always result in better propagation, but it is usually slow, so
       depending on the problem, turning this off may lead to a faster solution.
       
      optional bool use_timetable_edge_finding_in_cumulative = 79 [default = false];
      Returns:
      The useTimetableEdgeFindingInCumulative.
    • hasUseHardPrecedencesInCumulative

      boolean hasUseHardPrecedencesInCumulative()
       If true, detect and create constraint for integer variable that are "after"
       a set of intervals in the same cumulative constraint.
       Experimental: by default we just use "direct" precedences. If
       exploit_all_precedences is true, we explore the full precedence graph. This
       assumes we have a DAG otherwise it fails.
       
      optional bool use_hard_precedences_in_cumulative = 215 [default = false];
      Returns:
      Whether the useHardPrecedencesInCumulative field is set.
    • getUseHardPrecedencesInCumulative

      boolean getUseHardPrecedencesInCumulative()
       If true, detect and create constraint for integer variable that are "after"
       a set of intervals in the same cumulative constraint.
       Experimental: by default we just use "direct" precedences. If
       exploit_all_precedences is true, we explore the full precedence graph. This
       assumes we have a DAG otherwise it fails.
       
      optional bool use_hard_precedences_in_cumulative = 215 [default = false];
      Returns:
      The useHardPrecedencesInCumulative.
    • hasExploitAllPrecedences

      boolean hasExploitAllPrecedences()
      optional bool exploit_all_precedences = 220 [default = false];
      Returns:
      Whether the exploitAllPrecedences field is set.
    • getExploitAllPrecedences

      boolean getExploitAllPrecedences()
      optional bool exploit_all_precedences = 220 [default = false];
      Returns:
      The exploitAllPrecedences.
    • hasUseDisjunctiveConstraintInCumulative

      boolean hasUseDisjunctiveConstraintInCumulative()
       When this is true, the cumulative constraint is reinforced with propagators
       from the disjunctive constraint to improve the inference on a set of tasks
       that are disjunctive at the root of the problem. This additional level
       supplements the default level of reasoning.
       Propagators of the cumulative constraint will not be used at all if all the
       tasks are disjunctive at root node.
       This always result in better propagation, but it is usually slow, so
       depending on the problem, turning this off may lead to a faster solution.
       
      optional bool use_disjunctive_constraint_in_cumulative = 80 [default = true];
      Returns:
      Whether the useDisjunctiveConstraintInCumulative field is set.
    • getUseDisjunctiveConstraintInCumulative

      boolean getUseDisjunctiveConstraintInCumulative()
       When this is true, the cumulative constraint is reinforced with propagators
       from the disjunctive constraint to improve the inference on a set of tasks
       that are disjunctive at the root of the problem. This additional level
       supplements the default level of reasoning.
       Propagators of the cumulative constraint will not be used at all if all the
       tasks are disjunctive at root node.
       This always result in better propagation, but it is usually slow, so
       depending on the problem, turning this off may lead to a faster solution.
       
      optional bool use_disjunctive_constraint_in_cumulative = 80 [default = true];
      Returns:
      The useDisjunctiveConstraintInCumulative.
    • hasUseTimetablingInNoOverlap2D

      boolean hasUseTimetablingInNoOverlap2D()
       When this is true, the no_overlap_2d constraint is reinforced with
       propagators from the cumulative constraints. It consists of ignoring the
       position of rectangles in one position and projecting the no_overlap_2d on
       the other dimension to create a cumulative constraint. This is done on both
       axis. This additional level supplements the default level of reasoning.
       
      optional bool use_timetabling_in_no_overlap_2d = 200 [default = false];
      Returns:
      Whether the useTimetablingInNoOverlap2d field is set.
    • getUseTimetablingInNoOverlap2D

      boolean getUseTimetablingInNoOverlap2D()
       When this is true, the no_overlap_2d constraint is reinforced with
       propagators from the cumulative constraints. It consists of ignoring the
       position of rectangles in one position and projecting the no_overlap_2d on
       the other dimension to create a cumulative constraint. This is done on both
       axis. This additional level supplements the default level of reasoning.
       
      optional bool use_timetabling_in_no_overlap_2d = 200 [default = false];
      Returns:
      The useTimetablingInNoOverlap2d.
    • hasUseEnergeticReasoningInNoOverlap2D

      boolean hasUseEnergeticReasoningInNoOverlap2D()
       When this is true, the no_overlap_2d constraint is reinforced with
       energetic reasoning. This additional level supplements the default level of
       reasoning.
       
      optional bool use_energetic_reasoning_in_no_overlap_2d = 213 [default = false];
      Returns:
      Whether the useEnergeticReasoningInNoOverlap2d field is set.
    • getUseEnergeticReasoningInNoOverlap2D

      boolean getUseEnergeticReasoningInNoOverlap2D()
       When this is true, the no_overlap_2d constraint is reinforced with
       energetic reasoning. This additional level supplements the default level of
       reasoning.
       
      optional bool use_energetic_reasoning_in_no_overlap_2d = 213 [default = false];
      Returns:
      The useEnergeticReasoningInNoOverlap2d.
    • hasUseDualSchedulingHeuristics

      boolean hasUseDualSchedulingHeuristics()
       When set, it activates a few scheduling parameters to improve the lower
       bound of scheduling problems. This is only effective with multiple workers
       as it modifies the reduced_cost, lb_tree_search, and probing workers.
       
      optional bool use_dual_scheduling_heuristics = 214 [default = true];
      Returns:
      Whether the useDualSchedulingHeuristics field is set.
    • getUseDualSchedulingHeuristics

      boolean getUseDualSchedulingHeuristics()
       When set, it activates a few scheduling parameters to improve the lower
       bound of scheduling problems. This is only effective with multiple workers
       as it modifies the reduced_cost, lb_tree_search, and probing workers.
       
      optional bool use_dual_scheduling_heuristics = 214 [default = true];
      Returns:
      The useDualSchedulingHeuristics.
    • hasLinearizationLevel

      boolean hasLinearizationLevel()
       A non-negative level indicating the type of constraints we consider in the
       LP relaxation. At level zero, no LP relaxation is used. At level 1, only
       the linear constraint and full encoding are added. At level 2, we also add
       all the Boolean constraints.
       
      optional int32 linearization_level = 90 [default = 1];
      Returns:
      Whether the linearizationLevel field is set.
    • getLinearizationLevel

      int getLinearizationLevel()
       A non-negative level indicating the type of constraints we consider in the
       LP relaxation. At level zero, no LP relaxation is used. At level 1, only
       the linear constraint and full encoding are added. At level 2, we also add
       all the Boolean constraints.
       
      optional int32 linearization_level = 90 [default = 1];
      Returns:
      The linearizationLevel.
    • hasBooleanEncodingLevel

      boolean hasBooleanEncodingLevel()
       A non-negative level indicating how much we should try to fully encode
       Integer variables as Boolean.
       
      optional int32 boolean_encoding_level = 107 [default = 1];
      Returns:
      Whether the booleanEncodingLevel field is set.
    • getBooleanEncodingLevel

      int getBooleanEncodingLevel()
       A non-negative level indicating how much we should try to fully encode
       Integer variables as Boolean.
       
      optional int32 boolean_encoding_level = 107 [default = 1];
      Returns:
      The booleanEncodingLevel.
    • hasMaxDomainSizeWhenEncodingEqNeqConstraints

      boolean hasMaxDomainSizeWhenEncodingEqNeqConstraints()
       When loading a*x + b*y ==/!= c when x and y are both fully encoded.
       The solver may decide to replace the linear equation by a set of clauses.
       This is triggered if the sizes of the domains of x and y are below the
       threshold.
       
      optional int32 max_domain_size_when_encoding_eq_neq_constraints = 191 [default = 16];
      Returns:
      Whether the maxDomainSizeWhenEncodingEqNeqConstraints field is set.
    • getMaxDomainSizeWhenEncodingEqNeqConstraints

      int getMaxDomainSizeWhenEncodingEqNeqConstraints()
       When loading a*x + b*y ==/!= c when x and y are both fully encoded.
       The solver may decide to replace the linear equation by a set of clauses.
       This is triggered if the sizes of the domains of x and y are below the
       threshold.
       
      optional int32 max_domain_size_when_encoding_eq_neq_constraints = 191 [default = 16];
      Returns:
      The maxDomainSizeWhenEncodingEqNeqConstraints.
    • hasMaxNumCuts

      boolean hasMaxNumCuts()
       The limit on the number of cuts in our cut pool. When this is reached we do
       not generate cuts anymore.
       TODO(user): We should probably remove this parameters, and just always
       generate cuts but only keep the best n or something.
       
      optional int32 max_num_cuts = 91 [default = 10000];
      Returns:
      Whether the maxNumCuts field is set.
    • getMaxNumCuts

      int getMaxNumCuts()
       The limit on the number of cuts in our cut pool. When this is reached we do
       not generate cuts anymore.
       TODO(user): We should probably remove this parameters, and just always
       generate cuts but only keep the best n or something.
       
      optional int32 max_num_cuts = 91 [default = 10000];
      Returns:
      The maxNumCuts.
    • hasCutLevel

      boolean hasCutLevel()
       Control the global cut effort. Zero will turn off all cut. For now we just
       have one level. Note also that most cuts are only used at linearization
       level >= 2.
       
      optional int32 cut_level = 196 [default = 1];
      Returns:
      Whether the cutLevel field is set.
    • getCutLevel

      int getCutLevel()
       Control the global cut effort. Zero will turn off all cut. For now we just
       have one level. Note also that most cuts are only used at linearization
       level >= 2.
       
      optional int32 cut_level = 196 [default = 1];
      Returns:
      The cutLevel.
    • hasOnlyAddCutsAtLevelZero

      boolean hasOnlyAddCutsAtLevelZero()
       For the cut that can be generated at any level, this control if we only
       try to generate them at the root node.
       
      optional bool only_add_cuts_at_level_zero = 92 [default = false];
      Returns:
      Whether the onlyAddCutsAtLevelZero field is set.
    • getOnlyAddCutsAtLevelZero

      boolean getOnlyAddCutsAtLevelZero()
       For the cut that can be generated at any level, this control if we only
       try to generate them at the root node.
       
      optional bool only_add_cuts_at_level_zero = 92 [default = false];
      Returns:
      The onlyAddCutsAtLevelZero.
    • hasAddObjectiveCut

      boolean hasAddObjectiveCut()
       When the LP objective is fractional, do we add the cut that forces the
       linear objective expression to be greater or equal to this fractional value
       rounded up? We can always do that since our objective is integer, and
       combined with MIR heuristic to reduce the coefficient of such cut, it can
       help.
       
      optional bool add_objective_cut = 197 [default = false];
      Returns:
      Whether the addObjectiveCut field is set.
    • getAddObjectiveCut

      boolean getAddObjectiveCut()
       When the LP objective is fractional, do we add the cut that forces the
       linear objective expression to be greater or equal to this fractional value
       rounded up? We can always do that since our objective is integer, and
       combined with MIR heuristic to reduce the coefficient of such cut, it can
       help.
       
      optional bool add_objective_cut = 197 [default = false];
      Returns:
      The addObjectiveCut.
    • hasAddCgCuts

      boolean hasAddCgCuts()
       Whether we generate and add Chvatal-Gomory cuts to the LP at root node.
       Note that for now, this is not heavily tuned.
       
      optional bool add_cg_cuts = 117 [default = true];
      Returns:
      Whether the addCgCuts field is set.
    • getAddCgCuts

      boolean getAddCgCuts()
       Whether we generate and add Chvatal-Gomory cuts to the LP at root node.
       Note that for now, this is not heavily tuned.
       
      optional bool add_cg_cuts = 117 [default = true];
      Returns:
      The addCgCuts.
    • hasAddMirCuts

      boolean hasAddMirCuts()
       Whether we generate MIR cuts at root node.
       Note that for now, this is not heavily tuned.
       
      optional bool add_mir_cuts = 120 [default = true];
      Returns:
      Whether the addMirCuts field is set.
    • getAddMirCuts

      boolean getAddMirCuts()
       Whether we generate MIR cuts at root node.
       Note that for now, this is not heavily tuned.
       
      optional bool add_mir_cuts = 120 [default = true];
      Returns:
      The addMirCuts.
    • hasAddZeroHalfCuts

      boolean hasAddZeroHalfCuts()
       Whether we generate Zero-Half cuts at root node.
       Note that for now, this is not heavily tuned.
       
      optional bool add_zero_half_cuts = 169 [default = true];
      Returns:
      Whether the addZeroHalfCuts field is set.
    • getAddZeroHalfCuts

      boolean getAddZeroHalfCuts()
       Whether we generate Zero-Half cuts at root node.
       Note that for now, this is not heavily tuned.
       
      optional bool add_zero_half_cuts = 169 [default = true];
      Returns:
      The addZeroHalfCuts.
    • hasAddCliqueCuts

      boolean hasAddCliqueCuts()
       Whether we generate clique cuts from the binary implication graph. Note
       that as the search goes on, this graph will contains new binary clauses
       learned by the SAT engine.
       
      optional bool add_clique_cuts = 172 [default = true];
      Returns:
      Whether the addCliqueCuts field is set.
    • getAddCliqueCuts

      boolean getAddCliqueCuts()
       Whether we generate clique cuts from the binary implication graph. Note
       that as the search goes on, this graph will contains new binary clauses
       learned by the SAT engine.
       
      optional bool add_clique_cuts = 172 [default = true];
      Returns:
      The addCliqueCuts.
    • hasMaxAllDiffCutSize

      boolean 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 = 7];
      Returns:
      Whether the maxAllDiffCutSize field is set.
    • getMaxAllDiffCutSize

      int 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 = 7];
      Returns:
      The maxAllDiffCutSize.
    • hasAddLinMaxCuts

      boolean hasAddLinMaxCuts()
       For the lin max constraints, generates the cuts described in "Strong
       mixed-integer programming formulations for trained neural networks" by Ross
       Anderson et. (https://arxiv.org/pdf/1811.01988.pdf)
       
      optional bool add_lin_max_cuts = 152 [default = true];
      Returns:
      Whether the addLinMaxCuts field is set.
    • getAddLinMaxCuts

      boolean getAddLinMaxCuts()
       For the lin max constraints, generates the cuts described in "Strong
       mixed-integer programming formulations for trained neural networks" by Ross
       Anderson et. (https://arxiv.org/pdf/1811.01988.pdf)
       
      optional bool add_lin_max_cuts = 152 [default = true];
      Returns:
      The addLinMaxCuts.
    • hasMaxIntegerRoundingScaling

      boolean hasMaxIntegerRoundingScaling()
       In the integer rounding procedure used for MIR and Gomory cut, the maximum
       "scaling" we use (must be positive). The lower this is, the lower the
       integer coefficients of the cut will be. Note that cut generated by lower
       values are not necessarily worse than cut generated by larger value. There
       is no strict dominance relationship.
       Setting this to 2 result in the "strong fractional rouding" of Letchford
       and Lodi.
       
      optional int32 max_integer_rounding_scaling = 119 [default = 600];
      Returns:
      Whether the maxIntegerRoundingScaling field is set.
    • getMaxIntegerRoundingScaling

      int getMaxIntegerRoundingScaling()
       In the integer rounding procedure used for MIR and Gomory cut, the maximum
       "scaling" we use (must be positive). The lower this is, the lower the
       integer coefficients of the cut will be. Note that cut generated by lower
       values are not necessarily worse than cut generated by larger value. There
       is no strict dominance relationship.
       Setting this to 2 result in the "strong fractional rouding" of Letchford
       and Lodi.
       
      optional int32 max_integer_rounding_scaling = 119 [default = 600];
      Returns:
      The maxIntegerRoundingScaling.
    • hasAddLpConstraintsLazily

      boolean hasAddLpConstraintsLazily()
       If true, we start by an empty LP, and only add constraints not satisfied
       by the current LP solution batch by batch. A constraint that is only added
       like this is known as a "lazy" constraint in the literature, except that we
       currently consider all constraints as lazy here.
       
      optional bool add_lp_constraints_lazily = 112 [default = true];
      Returns:
      Whether the addLpConstraintsLazily field is set.
    • getAddLpConstraintsLazily

      boolean getAddLpConstraintsLazily()
       If true, we start by an empty LP, and only add constraints not satisfied
       by the current LP solution batch by batch. A constraint that is only added
       like this is known as a "lazy" constraint in the literature, except that we
       currently consider all constraints as lazy here.
       
      optional bool add_lp_constraints_lazily = 112 [default = true];
      Returns:
      The addLpConstraintsLazily.
    • hasMinOrthogonalityForLpConstraints

      boolean hasMinOrthogonalityForLpConstraints()
       While adding constraints, skip the constraints which have orthogonality
       less than 'min_orthogonality_for_lp_constraints' with already added
       constraints during current call. Orthogonality is defined as 1 -
       cosine(vector angle between constraints). A value of zero disable this
       feature.
       
      optional double min_orthogonality_for_lp_constraints = 115 [default = 0.05];
      Returns:
      Whether the minOrthogonalityForLpConstraints field is set.
    • getMinOrthogonalityForLpConstraints

      double getMinOrthogonalityForLpConstraints()
       While adding constraints, skip the constraints which have orthogonality
       less than 'min_orthogonality_for_lp_constraints' with already added
       constraints during current call. Orthogonality is defined as 1 -
       cosine(vector angle between constraints). A value of zero disable this
       feature.
       
      optional double min_orthogonality_for_lp_constraints = 115 [default = 0.05];
      Returns:
      The minOrthogonalityForLpConstraints.
    • hasMaxCutRoundsAtLevelZero

      boolean hasMaxCutRoundsAtLevelZero()
       Max number of time we perform cut generation and resolve the LP at level 0.
       
      optional int32 max_cut_rounds_at_level_zero = 154 [default = 1];
      Returns:
      Whether the maxCutRoundsAtLevelZero field is set.
    • getMaxCutRoundsAtLevelZero

      int getMaxCutRoundsAtLevelZero()
       Max number of time we perform cut generation and resolve the LP at level 0.
       
      optional int32 max_cut_rounds_at_level_zero = 154 [default = 1];
      Returns:
      The maxCutRoundsAtLevelZero.
    • hasMaxConsecutiveInactiveCount

      boolean hasMaxConsecutiveInactiveCount()
       If a constraint/cut in LP is not active for that many consecutive OPTIMAL
       solves, remove it from the LP. Note that it might be added again later if
       it become violated by the current LP solution.
       
      optional int32 max_consecutive_inactive_count = 121 [default = 100];
      Returns:
      Whether the maxConsecutiveInactiveCount field is set.
    • getMaxConsecutiveInactiveCount

      int getMaxConsecutiveInactiveCount()
       If a constraint/cut in LP is not active for that many consecutive OPTIMAL
       solves, remove it from the LP. Note that it might be added again later if
       it become violated by the current LP solution.
       
      optional int32 max_consecutive_inactive_count = 121 [default = 100];
      Returns:
      The maxConsecutiveInactiveCount.
    • hasCutMaxActiveCountValue

      boolean hasCutMaxActiveCountValue()
       These parameters are similar to sat clause management activity parameters.
       They are effective only if the number of generated cuts exceed the storage
       limit. Default values are based on a few experiments on miplib instances.
       
      optional double cut_max_active_count_value = 155 [default = 10000000000];
      Returns:
      Whether the cutMaxActiveCountValue field is set.
    • getCutMaxActiveCountValue

      double getCutMaxActiveCountValue()
       These parameters are similar to sat clause management activity parameters.
       They are effective only if the number of generated cuts exceed the storage
       limit. Default values are based on a few experiments on miplib instances.
       
      optional double cut_max_active_count_value = 155 [default = 10000000000];
      Returns:
      The cutMaxActiveCountValue.
    • hasCutActiveCountDecay

      boolean hasCutActiveCountDecay()
      optional double cut_active_count_decay = 156 [default = 0.8];
      Returns:
      Whether the cutActiveCountDecay field is set.
    • getCutActiveCountDecay

      double getCutActiveCountDecay()
      optional double cut_active_count_decay = 156 [default = 0.8];
      Returns:
      The cutActiveCountDecay.
    • hasCutCleanupTarget

      boolean hasCutCleanupTarget()
       Target number of constraints to remove during cleanup.
       
      optional int32 cut_cleanup_target = 157 [default = 1000];
      Returns:
      Whether the cutCleanupTarget field is set.
    • getCutCleanupTarget

      int getCutCleanupTarget()
       Target number of constraints to remove during cleanup.
       
      optional int32 cut_cleanup_target = 157 [default = 1000];
      Returns:
      The cutCleanupTarget.
    • hasNewConstraintsBatchSize

      boolean hasNewConstraintsBatchSize()
       Add that many lazy constraints (or cuts) at once in the LP. Note that at
       the beginning of the solve, we do add more than this.
       
      optional int32 new_constraints_batch_size = 122 [default = 50];
      Returns:
      Whether the newConstraintsBatchSize field is set.
    • getNewConstraintsBatchSize

      int getNewConstraintsBatchSize()
       Add that many lazy constraints (or cuts) at once in the LP. Note that at
       the beginning of the solve, we do add more than this.
       
      optional int32 new_constraints_batch_size = 122 [default = 50];
      Returns:
      The newConstraintsBatchSize.
    • hasSearchBranching

      boolean hasSearchBranching()
      optional .operations_research.sat.SatParameters.SearchBranching search_branching = 82 [default = AUTOMATIC_SEARCH];
      Returns:
      Whether the searchBranching field is set.
    • getSearchBranching

      SatParameters.SearchBranching getSearchBranching()
      optional .operations_research.sat.SatParameters.SearchBranching search_branching = 82 [default = AUTOMATIC_SEARCH];
      Returns:
      The searchBranching.
    • hasHintConflictLimit

      boolean hasHintConflictLimit()
       Conflict limit used in the phase that exploit the solution hint.
       
      optional int32 hint_conflict_limit = 153 [default = 10];
      Returns:
      Whether the hintConflictLimit field is set.
    • getHintConflictLimit

      int getHintConflictLimit()
       Conflict limit used in the phase that exploit the solution hint.
       
      optional int32 hint_conflict_limit = 153 [default = 10];
      Returns:
      The hintConflictLimit.
    • hasRepairHint

      boolean hasRepairHint()
       If true, the solver tries to repair the solution given in the hint. This
       search terminates after the 'hint_conflict_limit' is reached and the solver
       switches to regular search. If false, then  we do a FIXED_SEARCH using the
       hint until the hint_conflict_limit is reached.
       
      optional bool repair_hint = 167 [default = false];
      Returns:
      Whether the repairHint field is set.
    • getRepairHint

      boolean getRepairHint()
       If true, the solver tries to repair the solution given in the hint. This
       search terminates after the 'hint_conflict_limit' is reached and the solver
       switches to regular search. If false, then  we do a FIXED_SEARCH using the
       hint until the hint_conflict_limit is reached.
       
      optional bool repair_hint = 167 [default = false];
      Returns:
      The repairHint.
    • hasFixVariablesToTheirHintedValue

      boolean hasFixVariablesToTheirHintedValue()
       If true, variables appearing in the solution hints will be fixed to their
       hinted value.
       
      optional bool fix_variables_to_their_hinted_value = 192 [default = false];
      Returns:
      Whether the fixVariablesToTheirHintedValue field is set.
    • getFixVariablesToTheirHintedValue

      boolean getFixVariablesToTheirHintedValue()
       If true, variables appearing in the solution hints will be fixed to their
       hinted value.
       
      optional bool fix_variables_to_their_hinted_value = 192 [default = false];
      Returns:
      The fixVariablesToTheirHintedValue.
    • hasExploitIntegerLpSolution

      boolean hasExploitIntegerLpSolution()
       If true and the Lp relaxation of the problem has an integer optimal
       solution, try to exploit it. Note that since the LP relaxation may not
       contain all the constraints, such a solution is not necessarily a solution
       of the full problem.
       
      optional bool exploit_integer_lp_solution = 94 [default = true];
      Returns:
      Whether the exploitIntegerLpSolution field is set.
    • getExploitIntegerLpSolution

      boolean getExploitIntegerLpSolution()
       If true and the Lp relaxation of the problem has an integer optimal
       solution, try to exploit it. Note that since the LP relaxation may not
       contain all the constraints, such a solution is not necessarily a solution
       of the full problem.
       
      optional bool exploit_integer_lp_solution = 94 [default = true];
      Returns:
      The exploitIntegerLpSolution.
    • hasExploitAllLpSolution

      boolean hasExploitAllLpSolution()
       If true and the Lp relaxation of the problem has a solution, try to exploit
       it. This is same as above except in this case the lp solution might not be
       an integer solution.
       
      optional bool exploit_all_lp_solution = 116 [default = true];
      Returns:
      Whether the exploitAllLpSolution field is set.
    • getExploitAllLpSolution

      boolean getExploitAllLpSolution()
       If true and the Lp relaxation of the problem has a solution, try to exploit
       it. This is same as above except in this case the lp solution might not be
       an integer solution.
       
      optional bool exploit_all_lp_solution = 116 [default = true];
      Returns:
      The exploitAllLpSolution.
    • hasExploitBestSolution

      boolean hasExploitBestSolution()
       When branching on a variable, follow the last best solution value.
       
      optional bool exploit_best_solution = 130 [default = false];
      Returns:
      Whether the exploitBestSolution field is set.
    • getExploitBestSolution

      boolean getExploitBestSolution()
       When branching on a variable, follow the last best solution value.
       
      optional bool exploit_best_solution = 130 [default = false];
      Returns:
      The exploitBestSolution.
    • hasExploitRelaxationSolution

      boolean hasExploitRelaxationSolution()
       When branching on a variable, follow the last best relaxation solution
       value. We use the relaxation with the tightest bound on the objective as
       the best relaxation solution.
       
      optional bool exploit_relaxation_solution = 161 [default = false];
      Returns:
      Whether the exploitRelaxationSolution field is set.
    • getExploitRelaxationSolution

      boolean getExploitRelaxationSolution()
       When branching on a variable, follow the last best relaxation solution
       value. We use the relaxation with the tightest bound on the objective as
       the best relaxation solution.
       
      optional bool exploit_relaxation_solution = 161 [default = false];
      Returns:
      The exploitRelaxationSolution.
    • hasExploitObjective

      boolean hasExploitObjective()
       When branching an a variable that directly affect the objective,
       branch on the value that lead to the best objective first.
       
      optional bool exploit_objective = 131 [default = true];
      Returns:
      Whether the exploitObjective field is set.
    • getExploitObjective

      boolean getExploitObjective()
       When branching an a variable that directly affect the objective,
       branch on the value that lead to the best objective first.
       
      optional bool exploit_objective = 131 [default = true];
      Returns:
      The exploitObjective.
    • hasProbingPeriodAtRoot

      boolean hasProbingPeriodAtRoot()
       If set at zero (the default), it is disabled. Otherwise the solver attempts
       probing at every 'probing_period' root node. Period of 1 enables probing at
       every root node.
       
      optional int64 probing_period_at_root = 142 [default = 0];
      Returns:
      Whether the probingPeriodAtRoot field is set.
    • getProbingPeriodAtRoot

      long getProbingPeriodAtRoot()
       If set at zero (the default), it is disabled. Otherwise the solver attempts
       probing at every 'probing_period' root node. Period of 1 enables probing at
       every root node.
       
      optional int64 probing_period_at_root = 142 [default = 0];
      Returns:
      The probingPeriodAtRoot.
    • hasUseProbingSearch

      boolean hasUseProbingSearch()
       If true, search will continuously probe Boolean variables, and integer
       variable bounds. This parameter is set to true in parallel on the probing
       worker.
       
      optional bool use_probing_search = 176 [default = false];
      Returns:
      Whether the useProbingSearch field is set.
    • getUseProbingSearch

      boolean getUseProbingSearch()
       If true, search will continuously probe Boolean variables, and integer
       variable bounds. This parameter is set to true in parallel on the probing
       worker.
       
      optional bool use_probing_search = 176 [default = false];
      Returns:
      The useProbingSearch.
    • hasUseShavingInProbingSearch

      boolean hasUseShavingInProbingSearch()
       Add a shaving phase (where the solver tries to prove that the lower or
       upper bound of a variable are infeasible) to the probing search.
       
      optional bool use_shaving_in_probing_search = 204 [default = true];
      Returns:
      Whether the useShavingInProbingSearch field is set.
    • getUseShavingInProbingSearch

      boolean getUseShavingInProbingSearch()
       Add a shaving phase (where the solver tries to prove that the lower or
       upper bound of a variable are infeasible) to the probing search.
       
      optional bool use_shaving_in_probing_search = 204 [default = true];
      Returns:
      The useShavingInProbingSearch.
    • hasShavingSearchDeterministicTime

      boolean hasShavingSearchDeterministicTime()
       Specifies the amount of deterministic time spent of each try at shaving a
       bound in the shaving search.
       
      optional double shaving_search_deterministic_time = 205 [default = 0.001];
      Returns:
      Whether the shavingSearchDeterministicTime field is set.
    • getShavingSearchDeterministicTime

      double getShavingSearchDeterministicTime()
       Specifies the amount of deterministic time spent of each try at shaving a
       bound in the shaving search.
       
      optional double shaving_search_deterministic_time = 205 [default = 0.001];
      Returns:
      The shavingSearchDeterministicTime.
    • hasPseudoCostReliabilityThreshold

      boolean hasPseudoCostReliabilityThreshold()
       The solver ignores the pseudo costs of variables with number of recordings
       less than this threshold.
       
      optional int64 pseudo_cost_reliability_threshold = 123 [default = 100];
      Returns:
      Whether the pseudoCostReliabilityThreshold field is set.
    • getPseudoCostReliabilityThreshold

      long getPseudoCostReliabilityThreshold()
       The solver ignores the pseudo costs of variables with number of recordings
       less than this threshold.
       
      optional int64 pseudo_cost_reliability_threshold = 123 [default = 100];
      Returns:
      The pseudoCostReliabilityThreshold.
    • hasOptimizeWithCore

      boolean hasOptimizeWithCore()
       The default optimization method is a simple "linear scan", each time trying
       to find a better solution than the previous one. If this is true, then we
       use a core-based approach (like in max-SAT) when we try to increase the
       lower bound instead.
       
      optional bool optimize_with_core = 83 [default = false];
      Returns:
      Whether the optimizeWithCore field is set.
    • getOptimizeWithCore

      boolean getOptimizeWithCore()
       The default optimization method is a simple "linear scan", each time trying
       to find a better solution than the previous one. If this is true, then we
       use a core-based approach (like in max-SAT) when we try to increase the
       lower bound instead.
       
      optional bool optimize_with_core = 83 [default = false];
      Returns:
      The optimizeWithCore.
    • hasOptimizeWithLbTreeSearch

      boolean hasOptimizeWithLbTreeSearch()
       Do a more conventional tree search (by opposition to SAT based one) where
       we keep all the explored node in a tree. This is meant to be used in a
       portfolio and focus on improving the objective lower bound. Keeping the
       whole tree allow us to report a better objective lower bound coming from
       the worst open node in the tree.
       
      optional bool optimize_with_lb_tree_search = 188 [default = false];
      Returns:
      Whether the optimizeWithLbTreeSearch field is set.
    • getOptimizeWithLbTreeSearch

      boolean getOptimizeWithLbTreeSearch()
       Do a more conventional tree search (by opposition to SAT based one) where
       we keep all the explored node in a tree. This is meant to be used in a
       portfolio and focus on improving the objective lower bound. Keeping the
       whole tree allow us to report a better objective lower bound coming from
       the worst open node in the tree.
       
      optional bool optimize_with_lb_tree_search = 188 [default = false];
      Returns:
      The optimizeWithLbTreeSearch.
    • hasBinarySearchNumConflicts

      boolean hasBinarySearchNumConflicts()
       If non-negative, perform a binary search on the objective variable in order
       to find an [min, max] interval outside of which the solver proved unsat/sat
       under this amount of conflict. This can quickly reduce the objective domain
       on some problems.
       
      optional int32 binary_search_num_conflicts = 99 [default = -1];
      Returns:
      Whether the binarySearchNumConflicts field is set.
    • getBinarySearchNumConflicts

      int getBinarySearchNumConflicts()
       If non-negative, perform a binary search on the objective variable in order
       to find an [min, max] interval outside of which the solver proved unsat/sat
       under this amount of conflict. This can quickly reduce the objective domain
       on some problems.
       
      optional int32 binary_search_num_conflicts = 99 [default = -1];
      Returns:
      The binarySearchNumConflicts.
    • hasOptimizeWithMaxHs

      boolean hasOptimizeWithMaxHs()
       This has no effect if optimize_with_core is false. If true, use a different
       core-based algorithm similar to the max-HS algo for max-SAT. This is a
       hybrid MIP/CP approach and it uses a MIP solver in addition to the CP/SAT
       one. This is also related to the PhD work of tobyodavies@
       "Automatic Logic-Based Benders Decomposition with MiniZinc"
       http://aaai.org/ocs/index.php/AAAI/AAAI17/paper/view/14489
       
      optional bool optimize_with_max_hs = 85 [default = false];
      Returns:
      Whether the optimizeWithMaxHs field is set.
    • getOptimizeWithMaxHs

      boolean getOptimizeWithMaxHs()
       This has no effect if optimize_with_core is false. If true, use a different
       core-based algorithm similar to the max-HS algo for max-SAT. This is a
       hybrid MIP/CP approach and it uses a MIP solver in addition to the CP/SAT
       one. This is also related to the PhD work of tobyodavies@
       "Automatic Logic-Based Benders Decomposition with MiniZinc"
       http://aaai.org/ocs/index.php/AAAI/AAAI17/paper/view/14489
       
      optional bool optimize_with_max_hs = 85 [default = false];
      Returns:
      The optimizeWithMaxHs.
    • hasEnumerateAllSolutions

      boolean hasEnumerateAllSolutions()
       Whether we enumerate all solutions of a problem without objective. Note
       that setting this to true automatically disable some presolve reduction
       that can remove feasible solution. That is it has the same effect as
       setting keep_all_feasible_solutions_in_presolve.
       TODO(user): Do not do that and let the user choose what behavior is best by
       setting keep_all_feasible_solutions_in_presolve ?
       
      optional bool enumerate_all_solutions = 87 [default = false];
      Returns:
      Whether the enumerateAllSolutions field is set.
    • getEnumerateAllSolutions

      boolean getEnumerateAllSolutions()
       Whether we enumerate all solutions of a problem without objective. Note
       that setting this to true automatically disable some presolve reduction
       that can remove feasible solution. That is it has the same effect as
       setting keep_all_feasible_solutions_in_presolve.
       TODO(user): Do not do that and let the user choose what behavior is best by
       setting keep_all_feasible_solutions_in_presolve ?
       
      optional bool enumerate_all_solutions = 87 [default = false];
      Returns:
      The enumerateAllSolutions.
    • hasKeepAllFeasibleSolutionsInPresolve

      boolean hasKeepAllFeasibleSolutionsInPresolve()
       If true, we disable the presolve reductions that remove feasible solutions
       from the search space. Such solution are usually dominated by a "better"
       solution that is kept, but depending on the situation, we might want to
       keep all solutions.
       A trivial example is when a variable is unused. If this is true, then the
       presolve will not fix it to an arbitrary value and it will stay in the
       search space.
       
      optional bool keep_all_feasible_solutions_in_presolve = 173 [default = false];
      Returns:
      Whether the keepAllFeasibleSolutionsInPresolve field is set.
    • getKeepAllFeasibleSolutionsInPresolve

      boolean getKeepAllFeasibleSolutionsInPresolve()
       If true, we disable the presolve reductions that remove feasible solutions
       from the search space. Such solution are usually dominated by a "better"
       solution that is kept, but depending on the situation, we might want to
       keep all solutions.
       A trivial example is when a variable is unused. If this is true, then the
       presolve will not fix it to an arbitrary value and it will stay in the
       search space.
       
      optional bool keep_all_feasible_solutions_in_presolve = 173 [default = false];
      Returns:
      The keepAllFeasibleSolutionsInPresolve.
    • hasFillTightenedDomainsInResponse

      boolean hasFillTightenedDomainsInResponse()
       If true, add information about the derived variable domains to the
       CpSolverResponse. It is an option because it makes the response slighly
       bigger and there is a bit more work involved during the postsolve to
       construct it, but it should still have a low overhead. See the
       tightened_variables field in CpSolverResponse for more details.
       
      optional bool fill_tightened_domains_in_response = 132 [default = false];
      Returns:
      Whether the fillTightenedDomainsInResponse field is set.
    • getFillTightenedDomainsInResponse

      boolean getFillTightenedDomainsInResponse()
       If true, add information about the derived variable domains to the
       CpSolverResponse. It is an option because it makes the response slighly
       bigger and there is a bit more work involved during the postsolve to
       construct it, but it should still have a low overhead. See the
       tightened_variables field in CpSolverResponse for more details.
       
      optional bool fill_tightened_domains_in_response = 132 [default = false];
      Returns:
      The fillTightenedDomainsInResponse.
    • hasFillAdditionalSolutionsInResponse

      boolean hasFillAdditionalSolutionsInResponse()
       If true, the final response addition_solutions field will be filled with
       all solutions from our solutions pool.
       Note that if both this field and enumerate_all_solutions is true, we will
       copy to the pool all of the solution found. So if solution_pool_size is big
       enough, you can get all solutions this way instead of using the solution
       callback.
       Note that this only affect the "final" solution, not the one passed to the
       solution callbacks.
       
      optional bool fill_additional_solutions_in_response = 194 [default = false];
      Returns:
      Whether the fillAdditionalSolutionsInResponse field is set.
    • getFillAdditionalSolutionsInResponse

      boolean getFillAdditionalSolutionsInResponse()
       If true, the final response addition_solutions field will be filled with
       all solutions from our solutions pool.
       Note that if both this field and enumerate_all_solutions is true, we will
       copy to the pool all of the solution found. So if solution_pool_size is big
       enough, you can get all solutions this way instead of using the solution
       callback.
       Note that this only affect the "final" solution, not the one passed to the
       solution callbacks.
       
      optional bool fill_additional_solutions_in_response = 194 [default = false];
      Returns:
      The fillAdditionalSolutionsInResponse.
    • hasInstantiateAllVariables

      boolean hasInstantiateAllVariables()
       If true, the solver will add a default integer branching strategy to the
       already defined search strategy. If not, some variable might still not be
       fixed at the end of the search. For now we assume these variable can just
       be set to their lower bound.
       
      optional bool instantiate_all_variables = 106 [default = true];
      Returns:
      Whether the instantiateAllVariables field is set.
    • getInstantiateAllVariables

      boolean getInstantiateAllVariables()
       If true, the solver will add a default integer branching strategy to the
       already defined search strategy. If not, some variable might still not be
       fixed at the end of the search. For now we assume these variable can just
       be set to their lower bound.
       
      optional bool instantiate_all_variables = 106 [default = true];
      Returns:
      The instantiateAllVariables.
    • hasAutoDetectGreaterThanAtLeastOneOf

      boolean hasAutoDetectGreaterThanAtLeastOneOf()
       If true, then the precedences propagator try to detect for each variable if
       it has a set of "optional incoming arc" for which at least one of them is
       present. This is usually useful to have but can be slow on model with a lot
       of precedence.
       
      optional bool auto_detect_greater_than_at_least_one_of = 95 [default = true];
      Returns:
      Whether the autoDetectGreaterThanAtLeastOneOf field is set.
    • getAutoDetectGreaterThanAtLeastOneOf

      boolean getAutoDetectGreaterThanAtLeastOneOf()
       If true, then the precedences propagator try to detect for each variable if
       it has a set of "optional incoming arc" for which at least one of them is
       present. This is usually useful to have but can be slow on model with a lot
       of precedence.
       
      optional bool auto_detect_greater_than_at_least_one_of = 95 [default = true];
      Returns:
      The autoDetectGreaterThanAtLeastOneOf.
    • hasStopAfterFirstSolution

      boolean hasStopAfterFirstSolution()
       For an optimization problem, stop the solver as soon as we have a solution.
       
      optional bool stop_after_first_solution = 98 [default = false];
      Returns:
      Whether the stopAfterFirstSolution field is set.
    • getStopAfterFirstSolution

      boolean getStopAfterFirstSolution()
       For an optimization problem, stop the solver as soon as we have a solution.
       
      optional bool stop_after_first_solution = 98 [default = false];
      Returns:
      The stopAfterFirstSolution.
    • hasStopAfterPresolve

      boolean hasStopAfterPresolve()
       Mainly used when improving the presolver. When true, stops the solver after
       the presolve is complete.
       
      optional bool stop_after_presolve = 149 [default = false];
      Returns:
      Whether the stopAfterPresolve field is set.
    • getStopAfterPresolve

      boolean getStopAfterPresolve()
       Mainly used when improving the presolver. When true, stops the solver after
       the presolve is complete.
       
      optional bool stop_after_presolve = 149 [default = false];
      Returns:
      The stopAfterPresolve.
    • hasUseLnsOnly

      boolean hasUseLnsOnly()
       LNS parameters.
       
      optional bool use_lns_only = 101 [default = false];
      Returns:
      Whether the useLnsOnly field is set.
    • getUseLnsOnly

      boolean getUseLnsOnly()
       LNS parameters.
       
      optional bool use_lns_only = 101 [default = false];
      Returns:
      The useLnsOnly.
    • hasSolutionPoolSize

      boolean hasSolutionPoolSize()
       Size of the top-n different solutions kept by the solver.
       Currently this only impact the "base" solution chosen for a LNS fragment.
       
      optional int32 solution_pool_size = 193 [default = 3];
      Returns:
      Whether the solutionPoolSize field is set.
    • getSolutionPoolSize

      int getSolutionPoolSize()
       Size of the top-n different solutions kept by the solver.
       Currently this only impact the "base" solution chosen for a LNS fragment.
       
      optional int32 solution_pool_size = 193 [default = 3];
      Returns:
      The solutionPoolSize.
    • hasUseRinsLns

      boolean hasUseRinsLns()
       Turns on relaxation induced neighborhood generator.
       
      optional bool use_rins_lns = 129 [default = true];
      Returns:
      Whether the useRinsLns field is set.
    • getUseRinsLns

      boolean getUseRinsLns()
       Turns on relaxation induced neighborhood generator.
       
      optional bool use_rins_lns = 129 [default = true];
      Returns:
      The useRinsLns.
    • hasUseFeasibilityPump

      boolean hasUseFeasibilityPump()
       Adds a feasibility pump subsolver along with lns subsolvers.
       
      optional bool use_feasibility_pump = 164 [default = true];
      Returns:
      Whether the useFeasibilityPump field is set.
    • getUseFeasibilityPump

      boolean getUseFeasibilityPump()
       Adds a feasibility pump subsolver along with lns subsolvers.
       
      optional bool use_feasibility_pump = 164 [default = true];
      Returns:
      The useFeasibilityPump.
    • hasFpRounding

      boolean hasFpRounding()
      optional .operations_research.sat.SatParameters.FPRoundingMethod fp_rounding = 165 [default = PROPAGATION_ASSISTED];
      Returns:
      Whether the fpRounding field is set.
    • getFpRounding

      optional .operations_research.sat.SatParameters.FPRoundingMethod fp_rounding = 165 [default = PROPAGATION_ASSISTED];
      Returns:
      The fpRounding.
    • hasUseRelaxationLns

      boolean hasUseRelaxationLns()
       Turns on a lns worker which solves relaxed version of the original problem
       by removing constraints from the problem in order to get better bounds.
       
      optional bool use_relaxation_lns = 150 [default = false];
      Returns:
      Whether the useRelaxationLns field is set.
    • getUseRelaxationLns

      boolean getUseRelaxationLns()
       Turns on a lns worker which solves relaxed version of the original problem
       by removing constraints from the problem in order to get better bounds.
       
      optional bool use_relaxation_lns = 150 [default = false];
      Returns:
      The useRelaxationLns.
    • hasDiversifyLnsParams

      boolean hasDiversifyLnsParams()
       If true, registers more lns subsolvers with different parameters.
       
      optional bool diversify_lns_params = 137 [default = false];
      Returns:
      Whether the diversifyLnsParams field is set.
    • getDiversifyLnsParams

      boolean getDiversifyLnsParams()
       If true, registers more lns subsolvers with different parameters.
       
      optional bool diversify_lns_params = 137 [default = false];
      Returns:
      The diversifyLnsParams.
    • hasRandomizeSearch

      boolean hasRandomizeSearch()
       Randomize fixed search.
       
      optional bool randomize_search = 103 [default = false];
      Returns:
      Whether the randomizeSearch field is set.
    • getRandomizeSearch

      boolean getRandomizeSearch()
       Randomize fixed search.
       
      optional bool randomize_search = 103 [default = false];
      Returns:
      The randomizeSearch.
    • hasSearchRandomizationTolerance

      boolean hasSearchRandomizationTolerance()
       Search randomization will collect equivalent 'max valued' variables, and
       pick one randomly. For instance, if the variable strategy is CHOOSE_FIRST,
       all unassigned variables are equivalent. If the variable strategy is
       CHOOSE_LOWEST_MIN, and `lm` is the current lowest min of all unassigned
       variables, then the set of max valued variables will be all unassigned
       variables where
          lm <= variable min <= lm + search_randomization_tolerance
       
      optional int64 search_randomization_tolerance = 104 [default = 0];
      Returns:
      Whether the searchRandomizationTolerance field is set.
    • getSearchRandomizationTolerance

      long getSearchRandomizationTolerance()
       Search randomization will collect equivalent 'max valued' variables, and
       pick one randomly. For instance, if the variable strategy is CHOOSE_FIRST,
       all unassigned variables are equivalent. If the variable strategy is
       CHOOSE_LOWEST_MIN, and `lm` is the current lowest min of all unassigned
       variables, then the set of max valued variables will be all unassigned
       variables where
          lm <= variable min <= lm + search_randomization_tolerance
       
      optional int64 search_randomization_tolerance = 104 [default = 0];
      Returns:
      The searchRandomizationTolerance.
    • hasUseOptionalVariables

      boolean 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.
       
      optional bool use_optional_variables = 108 [default = true];
      Returns:
      Whether the useOptionalVariables field is set.
    • getUseOptionalVariables

      boolean 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.
       
      optional bool use_optional_variables = 108 [default = true];
      Returns:
      The useOptionalVariables.
    • hasUseExactLpReason

      boolean hasUseExactLpReason()
       The solver usually exploit the LP relaxation of a model. If this option is
       true, then whatever is infered by the LP will be used like an heuristic to
       compute EXACT propagation on the IP. So with this option, there is no
       numerical imprecision issues.
       
      optional bool use_exact_lp_reason = 109 [default = true];
      Returns:
      Whether the useExactLpReason field is set.
    • getUseExactLpReason

      boolean getUseExactLpReason()
       The solver usually exploit the LP relaxation of a model. If this option is
       true, then whatever is infered by the LP will be used like an heuristic to
       compute EXACT propagation on the IP. So with this option, there is no
       numerical imprecision issues.
       
      optional bool use_exact_lp_reason = 109 [default = true];
      Returns:
      The useExactLpReason.
    • hasUseBranchingInLp

      boolean hasUseBranchingInLp()
       If true, the solver attemts to generate more info inside lp propagator by
       branching on some variables if certain criteria are met during the search
       tree exploration.
       
      optional bool use_branching_in_lp = 139 [default = false];
      Returns:
      Whether the useBranchingInLp field is set.
    • getUseBranchingInLp

      boolean getUseBranchingInLp()
       If true, the solver attemts to generate more info inside lp propagator by
       branching on some variables if certain criteria are met during the search
       tree exploration.
       
      optional bool use_branching_in_lp = 139 [default = false];
      Returns:
      The useBranchingInLp.
    • hasUseCombinedNoOverlap

      boolean hasUseCombinedNoOverlap()
       This can be beneficial if there is a lot of no-overlap constraints but a
       relatively low number of different intervals in the problem. Like 1000
       intervals, but 1M intervals in the no-overlap constraints covering them.
       
      optional bool use_combined_no_overlap = 133 [default = false];
      Returns:
      Whether the useCombinedNoOverlap field is set.
    • getUseCombinedNoOverlap

      boolean getUseCombinedNoOverlap()
       This can be beneficial if there is a lot of no-overlap constraints but a
       relatively low number of different intervals in the problem. Like 1000
       intervals, but 1M intervals in the no-overlap constraints covering them.
       
      optional bool use_combined_no_overlap = 133 [default = false];
      Returns:
      The useCombinedNoOverlap.
    • hasCatchSigintSignal

      boolean hasCatchSigintSignal()
       Indicates if the CP-SAT layer should catch Control-C (SIGINT) signals
       when calling solve. If set, catching the SIGINT signal will terminate the
       search gracefully, as if a time limit was reached.
       
      optional bool catch_sigint_signal = 135 [default = true];
      Returns:
      Whether the catchSigintSignal field is set.
    • getCatchSigintSignal

      boolean getCatchSigintSignal()
       Indicates if the CP-SAT layer should catch Control-C (SIGINT) signals
       when calling solve. If set, catching the SIGINT signal will terminate the
       search gracefully, as if a time limit was reached.
       
      optional bool catch_sigint_signal = 135 [default = true];
      Returns:
      The catchSigintSignal.
    • hasUseImpliedBounds

      boolean hasUseImpliedBounds()
       Stores and exploits "implied-bounds" in the solver. That is, relations of
       the form literal => (var >= bound). This is currently used to derive
       stronger cuts.
       
      optional bool use_implied_bounds = 144 [default = true];
      Returns:
      Whether the useImpliedBounds field is set.
    • getUseImpliedBounds

      boolean getUseImpliedBounds()
       Stores and exploits "implied-bounds" in the solver. That is, relations of
       the form literal => (var >= bound). This is currently used to derive
       stronger cuts.
       
      optional bool use_implied_bounds = 144 [default = true];
      Returns:
      The useImpliedBounds.
    • hasPolishLpSolution

      boolean hasPolishLpSolution()
       Whether we try to do a few degenerate iteration at the end of an LP solve
       to minimize the fractionality of the integer variable in the basis. This
       helps on some problems, but not so much on others. It also cost of bit of
       time to do such polish step.
       
      optional bool polish_lp_solution = 175 [default = false];
      Returns:
      Whether the polishLpSolution field is set.
    • getPolishLpSolution

      boolean getPolishLpSolution()
       Whether we try to do a few degenerate iteration at the end of an LP solve
       to minimize the fractionality of the integer variable in the basis. This
       helps on some problems, but not so much on others. It also cost of bit of
       time to do such polish step.
       
      optional bool polish_lp_solution = 175 [default = false];
      Returns:
      The polishLpSolution.
    • hasConvertIntervals

      boolean hasConvertIntervals()
       Temporary flag util the feature is more mature. This convert intervals to
       the newer proto format that support affine start/var/end instead of just
       variables.
       
      optional bool convert_intervals = 177 [default = true];
      Returns:
      Whether the convertIntervals field is set.
    • getConvertIntervals

      boolean getConvertIntervals()
       Temporary flag util the feature is more mature. This convert intervals to
       the newer proto format that support affine start/var/end instead of just
       variables.
       
      optional bool convert_intervals = 177 [default = true];
      Returns:
      The convertIntervals.
    • hasSymmetryLevel

      boolean 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.
       
      optional int32 symmetry_level = 183 [default = 2];
      Returns:
      Whether the symmetryLevel field is set.
    • getSymmetryLevel

      int 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.
       
      optional int32 symmetry_level = 183 [default = 2];
      Returns:
      The symmetryLevel.
    • hasMipMaxBound

      boolean hasMipMaxBound()
       We need to bound the maximum magnitude of the variables for CP-SAT, and
       that is the bound we use. If the MIP model expect larger variable value in
       the solution, then the converted model will likely not be relevant.
       
      optional double mip_max_bound = 124 [default = 10000000];
      Returns:
      Whether the mipMaxBound field is set.
    • getMipMaxBound

      double getMipMaxBound()
       We need to bound the maximum magnitude of the variables for CP-SAT, and
       that is the bound we use. If the MIP model expect larger variable value in
       the solution, then the converted model will likely not be relevant.
       
      optional double mip_max_bound = 124 [default = 10000000];
      Returns:
      The mipMaxBound.
    • hasMipVarScaling

      boolean hasMipVarScaling()
       All continuous variable of the problem will be multiplied by this factor.
       By default, we don't do any variable scaling and rely on the MIP model to
       specify continuous variable domain with the wanted precision.
       
      optional double mip_var_scaling = 125 [default = 1];
      Returns:
      Whether the mipVarScaling field is set.
    • getMipVarScaling

      double getMipVarScaling()
       All continuous variable of the problem will be multiplied by this factor.
       By default, we don't do any variable scaling and rely on the MIP model to
       specify continuous variable domain with the wanted precision.
       
      optional double mip_var_scaling = 125 [default = 1];
      Returns:
      The mipVarScaling.
    • hasMipAutomaticallyScaleVariables

      boolean hasMipAutomaticallyScaleVariables()
       If true, some continuous variable might be automatically scaled. For now,
       this is only the case where we detect that a variable is actually an
       integer multiple of a constant. For instance, variables of the form k * 0.5
       are quite frequent, and if we detect this, we will scale such variable
       domain by 2 to make it implied integer.
       
      optional bool mip_automatically_scale_variables = 166 [default = true];
      Returns:
      Whether the mipAutomaticallyScaleVariables field is set.
    • getMipAutomaticallyScaleVariables

      boolean getMipAutomaticallyScaleVariables()
       If true, some continuous variable might be automatically scaled. For now,
       this is only the case where we detect that a variable is actually an
       integer multiple of a constant. For instance, variables of the form k * 0.5
       are quite frequent, and if we detect this, we will scale such variable
       domain by 2 to make it implied integer.
       
      optional bool mip_automatically_scale_variables = 166 [default = true];
      Returns:
      The mipAutomaticallyScaleVariables.
    • hasOnlySolveIp

      boolean hasOnlySolveIp()
       If one try to solve a MIP model with CP-SAT, because we assume all variable
       to be integer after scaling, we will not necessarily have the correct
       optimal. Note however that all feasible solutions are valid since we will
       just solve a more restricted version of the original problem.
       This parameters is here to prevent user to think the solution is optimal
       when it might not be. One will need to manually set this to false to solve
       a MIP model where the optimal might be different.
       Note that this is tested after some MIP presolve steps, so even if not
       all original variable are integer, we might end up with a pure IP after
       presolve and after implied integer detection.
       
      optional bool only_solve_ip = 222 [default = false];
      Returns:
      Whether the onlySolveIp field is set.
    • getOnlySolveIp

      boolean getOnlySolveIp()
       If one try to solve a MIP model with CP-SAT, because we assume all variable
       to be integer after scaling, we will not necessarily have the correct
       optimal. Note however that all feasible solutions are valid since we will
       just solve a more restricted version of the original problem.
       This parameters is here to prevent user to think the solution is optimal
       when it might not be. One will need to manually set this to false to solve
       a MIP model where the optimal might be different.
       Note that this is tested after some MIP presolve steps, so even if not
       all original variable are integer, we might end up with a pure IP after
       presolve and after implied integer detection.
       
      optional bool only_solve_ip = 222 [default = false];
      Returns:
      The onlySolveIp.
    • hasMipWantedPrecision

      boolean hasMipWantedPrecision()
       When scaling constraint with double coefficients to integer coefficients,
       we will multiply by a power of 2 and round the coefficients. We will choose
       the lowest power such that we have no potential overflow (see
       mip_max_activity_exponent) and the worst case constraint activity error
       does not exceed this threshold.
       Note that we also detect constraint with rational coefficients and scale
       them accordingly when it seems better instead of using a power of 2.
       We also relax all constraint bounds by this absolute value. For pure
       integer constraint, if this value if lower than one, this will not change
       anything. However it is needed when scaling MIP problems.
       If we manage to scale a constraint correctly, the maximum error we can make
       will be twice this value (once for the scaling error and once for the
       relaxed bounds). If we are not able to scale that well, we will display
       that fact but still scale as best as we can.
       
      optional double mip_wanted_precision = 126 [default = 1e-06];
      Returns:
      Whether the mipWantedPrecision field is set.
    • getMipWantedPrecision

      double getMipWantedPrecision()
       When scaling constraint with double coefficients to integer coefficients,
       we will multiply by a power of 2 and round the coefficients. We will choose
       the lowest power such that we have no potential overflow (see
       mip_max_activity_exponent) and the worst case constraint activity error
       does not exceed this threshold.
       Note that we also detect constraint with rational coefficients and scale
       them accordingly when it seems better instead of using a power of 2.
       We also relax all constraint bounds by this absolute value. For pure
       integer constraint, if this value if lower than one, this will not change
       anything. However it is needed when scaling MIP problems.
       If we manage to scale a constraint correctly, the maximum error we can make
       will be twice this value (once for the scaling error and once for the
       relaxed bounds). If we are not able to scale that well, we will display
       that fact but still scale as best as we can.
       
      optional double mip_wanted_precision = 126 [default = 1e-06];
      Returns:
      The mipWantedPrecision.
    • hasMipMaxActivityExponent

      boolean hasMipMaxActivityExponent()
       To avoid integer overflow, we always force the maximum possible constraint
       activity (and objective value) according to the initial variable domain to
       be smaller than 2 to this given power. Because of this, we cannot always
       reach the "mip_wanted_precision" parameter above.
       This can go as high as 62, but some internal algo currently abort early if
       they might run into integer overflow, so it is better to keep it a bit
       lower than this.
       
      optional int32 mip_max_activity_exponent = 127 [default = 53];
      Returns:
      Whether the mipMaxActivityExponent field is set.
    • getMipMaxActivityExponent

      int getMipMaxActivityExponent()
       To avoid integer overflow, we always force the maximum possible constraint
       activity (and objective value) according to the initial variable domain to
       be smaller than 2 to this given power. Because of this, we cannot always
       reach the "mip_wanted_precision" parameter above.
       This can go as high as 62, but some internal algo currently abort early if
       they might run into integer overflow, so it is better to keep it a bit
       lower than this.
       
      optional int32 mip_max_activity_exponent = 127 [default = 53];
      Returns:
      The mipMaxActivityExponent.
    • hasMipCheckPrecision

      boolean hasMipCheckPrecision()
       As explained in mip_precision and mip_max_activity_exponent, we cannot
       always reach the wanted precision during scaling. We use this threshold to
       enphasize in the logs when the precision seems bad.
       
      optional double mip_check_precision = 128 [default = 0.0001];
      Returns:
      Whether the mipCheckPrecision field is set.
    • getMipCheckPrecision

      double getMipCheckPrecision()
       As explained in mip_precision and mip_max_activity_exponent, we cannot
       always reach the wanted precision during scaling. We use this threshold to
       enphasize in the logs when the precision seems bad.
       
      optional double mip_check_precision = 128 [default = 0.0001];
      Returns:
      The mipCheckPrecision.
    • hasMipComputeTrueObjectiveBound

      boolean hasMipComputeTrueObjectiveBound()
       Even if we make big error when scaling the objective, we can always derive
       a correct lower bound on the original objective by using the exact lower
       bound on the scaled integer version of the objective. This should be fast,
       but if you don't care about having a precise lower bound, you can turn it
       off.
       
      optional bool mip_compute_true_objective_bound = 198 [default = true];
      Returns:
      Whether the mipComputeTrueObjectiveBound field is set.
    • getMipComputeTrueObjectiveBound

      boolean getMipComputeTrueObjectiveBound()
       Even if we make big error when scaling the objective, we can always derive
       a correct lower bound on the original objective by using the exact lower
       bound on the scaled integer version of the objective. This should be fast,
       but if you don't care about having a precise lower bound, you can turn it
       off.
       
      optional bool mip_compute_true_objective_bound = 198 [default = true];
      Returns:
      The mipComputeTrueObjectiveBound.
    • hasMipMaxValidMagnitude

      boolean 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+30];
      Returns:
      Whether the mipMaxValidMagnitude field is set.
    • getMipMaxValidMagnitude

      double 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+30];
      Returns:
      The mipMaxValidMagnitude.