Interface RoutingSearchParametersOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
RoutingSearchParameters, RoutingSearchParameters.Builder
@Generated
public interface RoutingSearchParametersOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionbooleanIf true use minimum matching instead of minimal matching in the Christofides algorithm..operations_research.RoutingSearchParameters.SchedulingSolver continuous_scheduling_solver = 33;int.operations_research.RoutingSearchParameters.SchedulingSolver continuous_scheduling_solver = 33;booleanSetting this to true completely disables the LP and MIP scheduling in the solver.intIf model.Size() is less than the threshold and that no solution has been found, attempt a pass with CP-SAT.intIf non zero, a period p indicates that every p node insertions or additions to a path, an optimization of the current partial solution will be performed.First solution strategies, used as starting point of local search.intFirst solution strategies, used as starting point of local search.Parameters for the global cheapest insertion heuristic when used as first solution heuristic.Parameters for the global cheapest insertion heuristic when used as first solution heuristic.Parameters for the global cheapest insertion heuristic when used in a local search operator (see local_search_operators.use_global_cheapest_insertion_path_lns and local_search_operators.use_global_cheapest_insertion_chain_lns below).Parameters for the global cheapest insertion heuristic when used in a local search operator (see local_search_operators.use_global_cheapest_insertion_path_lns and local_search_operators.use_global_cheapest_insertion_chain_lns below).doubleThese are advanced settings which should not be modified unless you know what you are doing.booleanWhen an arc leaving a vehicle start or arriving at a vehicle end is penalized, this field controls whether to penalize all other equivalent arcs with starts or ends in the same vehicle class.booleanWhether to reset penalties when a new best solution is found.intNumber of closest nodes to consider for each node during the destruction phase of the FilteredHeuristicCloseNodesLNSOperator.intNumber of expensive arcs to consider cutting in the FilteredHeuristicExpensiveChainLNSOperator operator.The improvement search limit is added to the solver if the following parameters are set.The improvement search limit is added to the solver if the following parameters are set.Iterated Local Search parameters.Iterated Local Search parameters.com.google.protobuf.DurationLimit to the time spent in the completion search for each local search neighbor.com.google.protobuf.DurationOrBuilderLimit to the time spent in the completion search for each local search neighbor.Parameters for the local cheapest cost insertion heuristic.Parameters for the local cheapest cost insertion heuristic.Parameters for the local cheapest insertion heuristic.Parameters for the local cheapest insertion heuristic.Local search metaheuristics used to guide the search.getLocalSearchMetaheuristics(int index) Local search metaheuristics alternatively used to guide the search.intLocal search metaheuristics alternatively used to guide the search.Local search metaheuristics alternatively used to guide the search.intgetLocalSearchMetaheuristicsValue(int index) Local search metaheuristics alternatively used to guide the search.Local search metaheuristics alternatively used to guide the search.intLocal search metaheuristics used to guide the search..operations_research.RoutingSearchParameters.LocalSearchNeighborhoodOperators local_search_operators = 3;.operations_research.RoutingSearchParameters.LocalSearchNeighborhoodOperators local_search_operators = 3;doubledouble log_cost_offset = 29;doubleIn logs, cost values will be scaled and offset by the given values in the following way: log_cost_scaling_factor * (cost + log_cost_offset)boolean--- Miscellaneous --- Some of these are advanced settings which should not be modified unless you know what you are doing.In logs, this tag will be appended to each line corresponding to a new solution.com.google.protobuf.ByteStringIn logs, this tag will be appended to each line corresponding to a new solution.intint32 ls_operator_min_neighbors = 54;doubleNeighbors ratio and minimum number of neighbors considered in local search operators (see GlobalCheapestInsertionParameters.neighbors_ratio and GlobalCheapestInsertionParameters.min_neighbors for more information).intMaximum size of the chain to make inactive in SwapActiveChainOperator..operations_research.RoutingSearchParameters.SchedulingSolver mixed_integer_scheduling_solver = 34;int.operations_research.RoutingSearchParameters.SchedulingSolver mixed_integer_scheduling_solver = 34;doublePositive parameter defining the exploration coefficient of the multi-armed bandit compound operator.doubleMemory coefficient related to the multi-armed bandit compound operator.intNumber of solutions to collect during the search.intint32 num_max_local_optima_before_metaheuristic_switch = 64;doubleMinimum step by which the solution must be improved in local search. 0 means "unspecified".intNumber of expensive arcs to consider cutting in the RelocateExpensiveChain neighborhood operator (see LocalSearchNeighborhoodOperators.use_relocate_expensive_chain()).booleanIf use_cp_sat or use_generalized_cp_sat is true, will report intermediate solutions found by CP-SAT to solution listeners.If use_cp_sat or use_generalized_cp_sat is true, contains the SAT algorithm parameters which will be used.If use_cp_sat or use_generalized_cp_sat is true, contains the SAT algorithm parameters which will be used.Parameters for the Savings heuristic.Parameters for the Savings heuristic.doubleRatio of the overall time limit spent in a secondary LS phase with only intra-route and insertion operators, meant to "cleanup" the current solution before stopping the search.long-- Search limits -- Limit to the number of solutions generated during the search. 0 means "unspecified".com.google.protobuf.DurationLimit to the time spent in the search.com.google.protobuf.DurationOrBuilderLimit to the time spent in the search.getUseCp()If true, use the CP solver to find a solution.If true, use the CP-SAT solver to find a solution.intIf true, use the CP-SAT solver to find a solution.intIf true, use the CP solver to find a solution.boolean--- Search control --- If true, the solver should use depth-first search rather than local search to solve the problem.boolean--- Propagation control --- These are advanced settings which should not be modified unless you know what you are doing.If true, use the CP-SAT solver to find a solution on generalized routing model.intIf true, use the CP-SAT solver to find a solution on generalized routing model.booleanWhether to consider arc penalties in cost functions used in local search operators using arc costs.booleanWhether the solver should use an Iterated Local Search approach to solve the problem.booleanIf true, the solver will use multi-armed bandit concatenate operators.boolean--- Advanced first solutions strategy settings --- Don't touch these unless you know what you are doing.booleanSetting this to true completely disables the LP and MIP scheduling in the solver.booleanParameters for the global cheapest insertion heuristic when used as first solution heuristic.booleanParameters for the global cheapest insertion heuristic when used in a local search operator (see local_search_operators.use_global_cheapest_insertion_path_lns and local_search_operators.use_global_cheapest_insertion_chain_lns below).booleanThe improvement search limit is added to the solver if the following parameters are set.booleanIterated Local Search parameters.booleanLimit to the time spent in the completion search for each local search neighbor.booleanParameters for the local cheapest cost insertion heuristic.booleanParameters for the local cheapest insertion heuristic.boolean.operations_research.RoutingSearchParameters.LocalSearchNeighborhoodOperators local_search_operators = 3;booleanIf use_cp_sat or use_generalized_cp_sat is true, contains the SAT algorithm parameters which will be used.booleanParameters for the Savings heuristic.booleanLimit to the time spent in the search.Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitializedMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getFirstSolutionStrategyValue
int getFirstSolutionStrategyValue()First solution strategies, used as starting point of local search.
.operations_research.FirstSolutionStrategy.Value first_solution_strategy = 1;- Returns:
- The enum numeric value on the wire for firstSolutionStrategy.
-
getFirstSolutionStrategy
FirstSolutionStrategy.Value getFirstSolutionStrategy()First solution strategies, used as starting point of local search.
.operations_research.FirstSolutionStrategy.Value first_solution_strategy = 1;- Returns:
- The firstSolutionStrategy.
-
getUseUnfilteredFirstSolutionStrategy
boolean getUseUnfilteredFirstSolutionStrategy()--- Advanced first solutions strategy settings --- Don't touch these unless you know what you are doing. Use filtered version of first solution strategy if available.
bool use_unfiltered_first_solution_strategy = 2;- Returns:
- The useUnfilteredFirstSolutionStrategy.
-
hasSavingsParameters
boolean hasSavingsParameters()Parameters for the Savings heuristic.
.operations_research.SavingsParameters savings_parameters = 70;- Returns:
- Whether the savingsParameters field is set.
-
getSavingsParameters
SavingsParameters getSavingsParameters()Parameters for the Savings heuristic.
.operations_research.SavingsParameters savings_parameters = 70;- Returns:
- The savingsParameters.
-
getSavingsParametersOrBuilder
SavingsParametersOrBuilder getSavingsParametersOrBuilder()Parameters for the Savings heuristic.
.operations_research.SavingsParameters savings_parameters = 70; -
hasGlobalCheapestInsertionFirstSolutionParameters
boolean hasGlobalCheapestInsertionFirstSolutionParameters()Parameters for the global cheapest insertion heuristic when used as first solution heuristic.
.operations_research.GlobalCheapestInsertionParameters global_cheapest_insertion_first_solution_parameters = 71;- Returns:
- Whether the globalCheapestInsertionFirstSolutionParameters field is set.
-
getGlobalCheapestInsertionFirstSolutionParameters
GlobalCheapestInsertionParameters getGlobalCheapestInsertionFirstSolutionParameters()Parameters for the global cheapest insertion heuristic when used as first solution heuristic.
.operations_research.GlobalCheapestInsertionParameters global_cheapest_insertion_first_solution_parameters = 71;- Returns:
- The globalCheapestInsertionFirstSolutionParameters.
-
getGlobalCheapestInsertionFirstSolutionParametersOrBuilder
GlobalCheapestInsertionParametersOrBuilder getGlobalCheapestInsertionFirstSolutionParametersOrBuilder()Parameters for the global cheapest insertion heuristic when used as first solution heuristic.
.operations_research.GlobalCheapestInsertionParameters global_cheapest_insertion_first_solution_parameters = 71; -
hasGlobalCheapestInsertionLsOperatorParameters
boolean hasGlobalCheapestInsertionLsOperatorParameters()Parameters for the global cheapest insertion heuristic when used in a local search operator (see local_search_operators.use_global_cheapest_insertion_path_lns and local_search_operators.use_global_cheapest_insertion_chain_lns below).
.operations_research.GlobalCheapestInsertionParameters global_cheapest_insertion_ls_operator_parameters = 72;- Returns:
- Whether the globalCheapestInsertionLsOperatorParameters field is set.
-
getGlobalCheapestInsertionLsOperatorParameters
GlobalCheapestInsertionParameters getGlobalCheapestInsertionLsOperatorParameters()Parameters for the global cheapest insertion heuristic when used in a local search operator (see local_search_operators.use_global_cheapest_insertion_path_lns and local_search_operators.use_global_cheapest_insertion_chain_lns below).
.operations_research.GlobalCheapestInsertionParameters global_cheapest_insertion_ls_operator_parameters = 72;- Returns:
- The globalCheapestInsertionLsOperatorParameters.
-
getGlobalCheapestInsertionLsOperatorParametersOrBuilder
GlobalCheapestInsertionParametersOrBuilder getGlobalCheapestInsertionLsOperatorParametersOrBuilder()Parameters for the global cheapest insertion heuristic when used in a local search operator (see local_search_operators.use_global_cheapest_insertion_path_lns and local_search_operators.use_global_cheapest_insertion_chain_lns below).
.operations_research.GlobalCheapestInsertionParameters global_cheapest_insertion_ls_operator_parameters = 72; -
hasLocalCheapestInsertionParameters
boolean hasLocalCheapestInsertionParameters()Parameters for the local cheapest insertion heuristic.
.operations_research.LocalCheapestInsertionParameters local_cheapest_insertion_parameters = 68;- Returns:
- Whether the localCheapestInsertionParameters field is set.
-
getLocalCheapestInsertionParameters
LocalCheapestInsertionParameters getLocalCheapestInsertionParameters()Parameters for the local cheapest insertion heuristic.
.operations_research.LocalCheapestInsertionParameters local_cheapest_insertion_parameters = 68;- Returns:
- The localCheapestInsertionParameters.
-
getLocalCheapestInsertionParametersOrBuilder
LocalCheapestInsertionParametersOrBuilder getLocalCheapestInsertionParametersOrBuilder()Parameters for the local cheapest insertion heuristic.
.operations_research.LocalCheapestInsertionParameters local_cheapest_insertion_parameters = 68; -
hasLocalCheapestCostInsertionParameters
boolean hasLocalCheapestCostInsertionParameters()Parameters for the local cheapest cost insertion heuristic.
.operations_research.LocalCheapestInsertionParameters local_cheapest_cost_insertion_parameters = 69;- Returns:
- Whether the localCheapestCostInsertionParameters field is set.
-
getLocalCheapestCostInsertionParameters
LocalCheapestInsertionParameters getLocalCheapestCostInsertionParameters()Parameters for the local cheapest cost insertion heuristic.
.operations_research.LocalCheapestInsertionParameters local_cheapest_cost_insertion_parameters = 69;- Returns:
- The localCheapestCostInsertionParameters.
-
getLocalCheapestCostInsertionParametersOrBuilder
LocalCheapestInsertionParametersOrBuilder getLocalCheapestCostInsertionParametersOrBuilder()Parameters for the local cheapest cost insertion heuristic.
.operations_research.LocalCheapestInsertionParameters local_cheapest_cost_insertion_parameters = 69; -
getChristofidesUseMinimumMatching
boolean getChristofidesUseMinimumMatching()If true use minimum matching instead of minimal matching in the Christofides algorithm.
bool christofides_use_minimum_matching = 30;- Returns:
- The christofidesUseMinimumMatching.
-
getFirstSolutionOptimizationPeriod
int getFirstSolutionOptimizationPeriod()If non zero, a period p indicates that every p node insertions or additions to a path, an optimization of the current partial solution will be performed. As of 12/2023: - this requires that a secondary routing model has been passed to the main one, - this is only supported by LOCAL_CHEAPEST_INSERTION and LOCAL_CHEAPEST_COST_INSERTION.
int32 first_solution_optimization_period = 59;- Returns:
- The firstSolutionOptimizationPeriod.
-
hasLocalSearchOperators
boolean hasLocalSearchOperators().operations_research.RoutingSearchParameters.LocalSearchNeighborhoodOperators local_search_operators = 3;- Returns:
- Whether the localSearchOperators field is set.
-
getLocalSearchOperators
RoutingSearchParameters.LocalSearchNeighborhoodOperators getLocalSearchOperators().operations_research.RoutingSearchParameters.LocalSearchNeighborhoodOperators local_search_operators = 3;- Returns:
- The localSearchOperators.
-
getLocalSearchOperatorsOrBuilder
RoutingSearchParameters.LocalSearchNeighborhoodOperatorsOrBuilder getLocalSearchOperatorsOrBuilder().operations_research.RoutingSearchParameters.LocalSearchNeighborhoodOperators local_search_operators = 3; -
getLsOperatorNeighborsRatio
double getLsOperatorNeighborsRatio()Neighbors ratio and minimum number of neighbors considered in local search operators (see GlobalCheapestInsertionParameters.neighbors_ratio and GlobalCheapestInsertionParameters.min_neighbors for more information).
double ls_operator_neighbors_ratio = 53;- Returns:
- The lsOperatorNeighborsRatio.
-
getLsOperatorMinNeighbors
int getLsOperatorMinNeighbors()int32 ls_operator_min_neighbors = 54;- Returns:
- The lsOperatorMinNeighbors.
-
getUseMultiArmedBanditConcatenateOperators
boolean getUseMultiArmedBanditConcatenateOperators()If true, the solver will use multi-armed bandit concatenate operators. It dynamically chooses the next neighbor operator in order to get the best objective improvement.
bool use_multi_armed_bandit_concatenate_operators = 41;- Returns:
- The useMultiArmedBanditConcatenateOperators.
-
getMultiArmedBanditCompoundOperatorMemoryCoefficient
double getMultiArmedBanditCompoundOperatorMemoryCoefficient()Memory coefficient related to the multi-armed bandit compound operator. Sets how much the objective improvement of previous accepted neighbors influence the current average improvement. This parameter should be between 0 and 1.
double multi_armed_bandit_compound_operator_memory_coefficient = 42;- Returns:
- The multiArmedBanditCompoundOperatorMemoryCoefficient.
-
getMultiArmedBanditCompoundOperatorExplorationCoefficient
double getMultiArmedBanditCompoundOperatorExplorationCoefficient()Positive parameter defining the exploration coefficient of the multi-armed bandit compound operator. Sets how often we explore rarely used and unsuccessful in the past operators
double multi_armed_bandit_compound_operator_exploration_coefficient = 43;- Returns:
- The multiArmedBanditCompoundOperatorExplorationCoefficient.
-
getMaxSwapActiveChainSize
int getMaxSwapActiveChainSize()Maximum size of the chain to make inactive in SwapActiveChainOperator.
int32 max_swap_active_chain_size = 66;- Returns:
- The maxSwapActiveChainSize.
-
getRelocateExpensiveChainNumArcsToConsider
int getRelocateExpensiveChainNumArcsToConsider()Number of expensive arcs to consider cutting in the RelocateExpensiveChain neighborhood operator (see LocalSearchNeighborhoodOperators.use_relocate_expensive_chain()). This parameter must be greater than 2. NOTE(user): The number of neighbors generated by the operator for relocate_expensive_chain_num_arcs_to_consider = K is around K*(K-1)/2 * number_of_routes * number_of_nodes.
int32 relocate_expensive_chain_num_arcs_to_consider = 20;- Returns:
- The relocateExpensiveChainNumArcsToConsider.
-
getHeuristicExpensiveChainLnsNumArcsToConsider
int getHeuristicExpensiveChainLnsNumArcsToConsider()Number of expensive arcs to consider cutting in the FilteredHeuristicExpensiveChainLNSOperator operator.
int32 heuristic_expensive_chain_lns_num_arcs_to_consider = 32;- Returns:
- The heuristicExpensiveChainLnsNumArcsToConsider.
-
getHeuristicCloseNodesLnsNumNodes
int getHeuristicCloseNodesLnsNumNodes()Number of closest nodes to consider for each node during the destruction phase of the FilteredHeuristicCloseNodesLNSOperator.
int32 heuristic_close_nodes_lns_num_nodes = 35;- Returns:
- The heuristicCloseNodesLnsNumNodes.
-
getLocalSearchMetaheuristicValue
int getLocalSearchMetaheuristicValue()Local search metaheuristics used to guide the search.
.operations_research.LocalSearchMetaheuristic.Value local_search_metaheuristic = 4;- Returns:
- The enum numeric value on the wire for localSearchMetaheuristic.
-
getLocalSearchMetaheuristic
LocalSearchMetaheuristic.Value getLocalSearchMetaheuristic()Local search metaheuristics used to guide the search.
.operations_research.LocalSearchMetaheuristic.Value local_search_metaheuristic = 4;- Returns:
- The localSearchMetaheuristic.
-
getLocalSearchMetaheuristicsList
List<LocalSearchMetaheuristic.Value> getLocalSearchMetaheuristicsList()Local search metaheuristics alternatively used to guide the search. Every num_max_local_optima_before_metaheuristic_switch local minima found by a metaheurisitic, the solver will switch to the next metaheuristic. Cannot be defined if local_search_metaheuristic is different from UNSET or AUTOMATIC.
repeated .operations_research.LocalSearchMetaheuristic.Value local_search_metaheuristics = 63;- Returns:
- A list containing the localSearchMetaheuristics.
-
getLocalSearchMetaheuristicsCount
int getLocalSearchMetaheuristicsCount()Local search metaheuristics alternatively used to guide the search. Every num_max_local_optima_before_metaheuristic_switch local minima found by a metaheurisitic, the solver will switch to the next metaheuristic. Cannot be defined if local_search_metaheuristic is different from UNSET or AUTOMATIC.
repeated .operations_research.LocalSearchMetaheuristic.Value local_search_metaheuristics = 63;- Returns:
- The count of localSearchMetaheuristics.
-
getLocalSearchMetaheuristics
Local search metaheuristics alternatively used to guide the search. Every num_max_local_optima_before_metaheuristic_switch local minima found by a metaheurisitic, the solver will switch to the next metaheuristic. Cannot be defined if local_search_metaheuristic is different from UNSET or AUTOMATIC.
repeated .operations_research.LocalSearchMetaheuristic.Value local_search_metaheuristics = 63;- Parameters:
index- The index of the element to return.- Returns:
- The localSearchMetaheuristics at the given index.
-
getLocalSearchMetaheuristicsValueList
Local search metaheuristics alternatively used to guide the search. Every num_max_local_optima_before_metaheuristic_switch local minima found by a metaheurisitic, the solver will switch to the next metaheuristic. Cannot be defined if local_search_metaheuristic is different from UNSET or AUTOMATIC.
repeated .operations_research.LocalSearchMetaheuristic.Value local_search_metaheuristics = 63;- Returns:
- A list containing the enum numeric values on the wire for localSearchMetaheuristics.
-
getLocalSearchMetaheuristicsValue
int getLocalSearchMetaheuristicsValue(int index) Local search metaheuristics alternatively used to guide the search. Every num_max_local_optima_before_metaheuristic_switch local minima found by a metaheurisitic, the solver will switch to the next metaheuristic. Cannot be defined if local_search_metaheuristic is different from UNSET or AUTOMATIC.
repeated .operations_research.LocalSearchMetaheuristic.Value local_search_metaheuristics = 63;- Parameters:
index- The index of the value to return.- Returns:
- The enum numeric value on the wire of localSearchMetaheuristics at the given index.
-
getNumMaxLocalOptimaBeforeMetaheuristicSwitch
int getNumMaxLocalOptimaBeforeMetaheuristicSwitch()int32 num_max_local_optima_before_metaheuristic_switch = 64;- Returns:
- The numMaxLocalOptimaBeforeMetaheuristicSwitch.
-
getGuidedLocalSearchLambdaCoefficient
double getGuidedLocalSearchLambdaCoefficient()These are advanced settings which should not be modified unless you know what you are doing. Lambda coefficient used to penalize arc costs when GUIDED_LOCAL_SEARCH is used. Must be positive.
double guided_local_search_lambda_coefficient = 5;- Returns:
- The guidedLocalSearchLambdaCoefficient.
-
getGuidedLocalSearchResetPenaltiesOnNewBestSolution
boolean getGuidedLocalSearchResetPenaltiesOnNewBestSolution()Whether to reset penalties when a new best solution is found. The effect is that a greedy descent is started before the next penalization phase.
bool guided_local_search_reset_penalties_on_new_best_solution = 51;- Returns:
- The guidedLocalSearchResetPenaltiesOnNewBestSolution.
-
getGuidedLocalSearchPenalizeWithVehicleClasses
boolean getGuidedLocalSearchPenalizeWithVehicleClasses()When an arc leaving a vehicle start or arriving at a vehicle end is penalized, this field controls whether to penalize all other equivalent arcs with starts or ends in the same vehicle class.
bool guided_local_search_penalize_with_vehicle_classes = 61;- Returns:
- The guidedLocalSearchPenalizeWithVehicleClasses.
-
getUseGuidedLocalSearchPenaltiesInLocalSearchOperators
boolean getUseGuidedLocalSearchPenaltiesInLocalSearchOperators()Whether to consider arc penalties in cost functions used in local search operators using arc costs.
bool use_guided_local_search_penalties_in_local_search_operators = 62;- Returns:
- The useGuidedLocalSearchPenaltiesInLocalSearchOperators.
-
getUseDepthFirstSearch
boolean getUseDepthFirstSearch()--- Search control --- If true, the solver should use depth-first search rather than local search to solve the problem.
bool use_depth_first_search = 6;- Returns:
- The useDepthFirstSearch.
-
getUseCpValue
int getUseCpValue()If true, use the CP solver to find a solution. Either local or depth-first search will be used depending on the value of use_depth_first_search. Will be run before the CP-SAT solver (cf. use_cp_sat).
.operations_research.OptionalBoolean use_cp = 28;- Returns:
- The enum numeric value on the wire for useCp.
-
getUseCp
OptionalBoolean getUseCp()If true, use the CP solver to find a solution. Either local or depth-first search will be used depending on the value of use_depth_first_search. Will be run before the CP-SAT solver (cf. use_cp_sat).
.operations_research.OptionalBoolean use_cp = 28;- Returns:
- The useCp.
-
getUseCpSatValue
int getUseCpSatValue()If true, use the CP-SAT solver to find a solution. If use_cp is also true, the CP-SAT solver will be run after the CP solver if there is time remaining and will use the CP solution as a hint for the CP-SAT search. As of 5/2019, only TSP models can be solved.
.operations_research.OptionalBoolean use_cp_sat = 27;- Returns:
- The enum numeric value on the wire for useCpSat.
-
getUseCpSat
OptionalBoolean getUseCpSat()If true, use the CP-SAT solver to find a solution. If use_cp is also true, the CP-SAT solver will be run after the CP solver if there is time remaining and will use the CP solution as a hint for the CP-SAT search. As of 5/2019, only TSP models can be solved.
.operations_research.OptionalBoolean use_cp_sat = 27;- Returns:
- The useCpSat.
-
getUseGeneralizedCpSatValue
int getUseGeneralizedCpSatValue()If true, use the CP-SAT solver to find a solution on generalized routing model. If use_cp is also true, the CP-SAT solver will be run after the CP solver if there is time remaining and will use the CP solution as a hint for the CP-SAT search.
.operations_research.OptionalBoolean use_generalized_cp_sat = 47;- Returns:
- The enum numeric value on the wire for useGeneralizedCpSat.
-
getUseGeneralizedCpSat
OptionalBoolean getUseGeneralizedCpSat()If true, use the CP-SAT solver to find a solution on generalized routing model. If use_cp is also true, the CP-SAT solver will be run after the CP solver if there is time remaining and will use the CP solution as a hint for the CP-SAT search.
.operations_research.OptionalBoolean use_generalized_cp_sat = 47;- Returns:
- The useGeneralizedCpSat.
-
hasSatParameters
boolean hasSatParameters()If use_cp_sat or use_generalized_cp_sat is true, contains the SAT algorithm parameters which will be used.
.operations_research.sat.SatParameters sat_parameters = 48;- Returns:
- Whether the satParameters field is set.
-
getSatParameters
SatParameters getSatParameters()If use_cp_sat or use_generalized_cp_sat is true, contains the SAT algorithm parameters which will be used.
.operations_research.sat.SatParameters sat_parameters = 48;- Returns:
- The satParameters.
-
getSatParametersOrBuilder
SatParametersOrBuilder getSatParametersOrBuilder()If use_cp_sat or use_generalized_cp_sat is true, contains the SAT algorithm parameters which will be used.
.operations_research.sat.SatParameters sat_parameters = 48; -
getReportIntermediateCpSatSolutions
boolean getReportIntermediateCpSatSolutions()If use_cp_sat or use_generalized_cp_sat is true, will report intermediate solutions found by CP-SAT to solution listeners.
bool report_intermediate_cp_sat_solutions = 56;- Returns:
- The reportIntermediateCpSatSolutions.
-
getFallbackToCpSatSizeThreshold
int getFallbackToCpSatSizeThreshold()If model.Size() is less than the threshold and that no solution has been found, attempt a pass with CP-SAT.
int32 fallback_to_cp_sat_size_threshold = 52;- Returns:
- The fallbackToCpSatSizeThreshold.
-
getContinuousSchedulingSolverValue
int getContinuousSchedulingSolverValue().operations_research.RoutingSearchParameters.SchedulingSolver continuous_scheduling_solver = 33;- Returns:
- The enum numeric value on the wire for continuousSchedulingSolver.
-
getContinuousSchedulingSolver
RoutingSearchParameters.SchedulingSolver getContinuousSchedulingSolver().operations_research.RoutingSearchParameters.SchedulingSolver continuous_scheduling_solver = 33;- Returns:
- The continuousSchedulingSolver.
-
getMixedIntegerSchedulingSolverValue
int getMixedIntegerSchedulingSolverValue().operations_research.RoutingSearchParameters.SchedulingSolver mixed_integer_scheduling_solver = 34;- Returns:
- The enum numeric value on the wire for mixedIntegerSchedulingSolver.
-
getMixedIntegerSchedulingSolver
RoutingSearchParameters.SchedulingSolver getMixedIntegerSchedulingSolver().operations_research.RoutingSearchParameters.SchedulingSolver mixed_integer_scheduling_solver = 34;- Returns:
- The mixedIntegerSchedulingSolver.
-
hasDisableSchedulingBewareThisMayDegradePerformance
boolean hasDisableSchedulingBewareThisMayDegradePerformance()Setting this to true completely disables the LP and MIP scheduling in the solver. This overrides the 2 SchedulingSolver options above.
optional bool disable_scheduling_beware_this_may_degrade_performance = 50;- Returns:
- Whether the disableSchedulingBewareThisMayDegradePerformance field is set.
-
getDisableSchedulingBewareThisMayDegradePerformance
boolean getDisableSchedulingBewareThisMayDegradePerformance()Setting this to true completely disables the LP and MIP scheduling in the solver. This overrides the 2 SchedulingSolver options above.
optional bool disable_scheduling_beware_this_may_degrade_performance = 50;- Returns:
- The disableSchedulingBewareThisMayDegradePerformance.
-
getOptimizationStep
double getOptimizationStep()Minimum step by which the solution must be improved in local search. 0 means "unspecified". If this value is fractional, it will get rounded to the nearest integer.
double optimization_step = 7;- Returns:
- The optimizationStep.
-
getNumberOfSolutionsToCollect
int getNumberOfSolutionsToCollect()Number of solutions to collect during the search. Corresponds to the best solutions found during the search. 0 means "unspecified".
int32 number_of_solutions_to_collect = 17;- Returns:
- The numberOfSolutionsToCollect.
-
getSolutionLimit
long getSolutionLimit()-- Search limits -- Limit to the number of solutions generated during the search. 0 means "unspecified".
int64 solution_limit = 8;- Returns:
- The solutionLimit.
-
hasTimeLimit
boolean hasTimeLimit()Limit to the time spent in the search.
.google.protobuf.Duration time_limit = 9;- Returns:
- Whether the timeLimit field is set.
-
getTimeLimit
com.google.protobuf.Duration getTimeLimit()Limit to the time spent in the search.
.google.protobuf.Duration time_limit = 9;- Returns:
- The timeLimit.
-
getTimeLimitOrBuilder
com.google.protobuf.DurationOrBuilder getTimeLimitOrBuilder()Limit to the time spent in the search.
.google.protobuf.Duration time_limit = 9; -
hasLnsTimeLimit
boolean hasLnsTimeLimit()Limit to the time spent in the completion search for each local search neighbor.
.google.protobuf.Duration lns_time_limit = 10;- Returns:
- Whether the lnsTimeLimit field is set.
-
getLnsTimeLimit
com.google.protobuf.Duration getLnsTimeLimit()Limit to the time spent in the completion search for each local search neighbor.
.google.protobuf.Duration lns_time_limit = 10;- Returns:
- The lnsTimeLimit.
-
getLnsTimeLimitOrBuilder
com.google.protobuf.DurationOrBuilder getLnsTimeLimitOrBuilder()Limit to the time spent in the completion search for each local search neighbor.
.google.protobuf.Duration lns_time_limit = 10; -
getSecondaryLsTimeLimitRatio
double getSecondaryLsTimeLimitRatio()Ratio of the overall time limit spent in a secondary LS phase with only intra-route and insertion operators, meant to "cleanup" the current solution before stopping the search. TODO(user): Since these operators are very fast, add a parameter to cap the max time allocated for this second phase (e.g. Duration max_secondary_ls_time_limit).
double secondary_ls_time_limit_ratio = 57;- Returns:
- The secondaryLsTimeLimitRatio.
-
hasImprovementLimitParameters
boolean hasImprovementLimitParameters()The improvement search limit is added to the solver if the following parameters are set.
.operations_research.RoutingSearchParameters.ImprovementSearchLimitParameters improvement_limit_parameters = 37;- Returns:
- Whether the improvementLimitParameters field is set.
-
getImprovementLimitParameters
RoutingSearchParameters.ImprovementSearchLimitParameters getImprovementLimitParameters()The improvement search limit is added to the solver if the following parameters are set.
.operations_research.RoutingSearchParameters.ImprovementSearchLimitParameters improvement_limit_parameters = 37;- Returns:
- The improvementLimitParameters.
-
getImprovementLimitParametersOrBuilder
RoutingSearchParameters.ImprovementSearchLimitParametersOrBuilder getImprovementLimitParametersOrBuilder()The improvement search limit is added to the solver if the following parameters are set.
.operations_research.RoutingSearchParameters.ImprovementSearchLimitParameters improvement_limit_parameters = 37; -
getUseFullPropagation
boolean getUseFullPropagation()--- Propagation control --- These are advanced settings which should not be modified unless you know what you are doing. Use constraints with full propagation in routing model (instead of 'light' propagation only). Full propagation is only necessary when using depth-first search or for models which require strong propagation to finalize the value of secondary variables. Changing this setting to true will slow down the search in most cases and increase memory consumption in all cases.
bool use_full_propagation = 11;- Returns:
- The useFullPropagation.
-
getLogSearch
boolean getLogSearch()--- Miscellaneous --- Some of these are advanced settings which should not be modified unless you know what you are doing. Activates search logging. For each solution found during the search, the following will be displayed: its objective value, the maximum objective value since the beginning of the search, the elapsed time since the beginning of the search, the number of branches explored in the search tree, the number of failures in the search tree, the depth of the search tree, the number of local search neighbors explored, the number of local search neighbors filtered by local search filters, the number of local search neighbors accepted, the total memory used and the percentage of the search done.
bool log_search = 13;- Returns:
- The logSearch.
-
getLogCostScalingFactor
double getLogCostScalingFactor()In logs, cost values will be scaled and offset by the given values in the following way: log_cost_scaling_factor * (cost + log_cost_offset)
double log_cost_scaling_factor = 22;- Returns:
- The logCostScalingFactor.
-
getLogCostOffset
double getLogCostOffset()double log_cost_offset = 29;- Returns:
- The logCostOffset.
-
getLogTag
String getLogTag()In logs, this tag will be appended to each line corresponding to a new solution. Useful to sort out logs when several solves are run in parallel.
string log_tag = 36;- Returns:
- The logTag.
-
getLogTagBytes
com.google.protobuf.ByteString getLogTagBytes()In logs, this tag will be appended to each line corresponding to a new solution. Useful to sort out logs when several solves are run in parallel.
string log_tag = 36;- Returns:
- The bytes for logTag.
-
getUseIteratedLocalSearch
boolean getUseIteratedLocalSearch()Whether the solver should use an Iterated Local Search approach to solve the problem.
bool use_iterated_local_search = 58;- Returns:
- The useIteratedLocalSearch.
-
hasIteratedLocalSearchParameters
boolean hasIteratedLocalSearchParameters()Iterated Local Search parameters.
.operations_research.IteratedLocalSearchParameters iterated_local_search_parameters = 60;- Returns:
- Whether the iteratedLocalSearchParameters field is set.
-
getIteratedLocalSearchParameters
IteratedLocalSearchParameters getIteratedLocalSearchParameters()Iterated Local Search parameters.
.operations_research.IteratedLocalSearchParameters iterated_local_search_parameters = 60;- Returns:
- The iteratedLocalSearchParameters.
-
getIteratedLocalSearchParametersOrBuilder
IteratedLocalSearchParametersOrBuilder getIteratedLocalSearchParametersOrBuilder()Iterated Local Search parameters.
.operations_research.IteratedLocalSearchParameters iterated_local_search_parameters = 60;
-