Java Reference
Java Reference
Detailed Description
Definition at line 6 of file RoutingSearchParametersOrBuilder.java.
Member Function Documentation
◆ getCheapestInsertionFarthestSeedsRatio()
| double getCheapestInsertionFarthestSeedsRatio | ( | ) |
Ratio (between 0 and 1) of available vehicles in the model on which farthest nodes of the model are inserted as seeds in the GlobalCheapestInsertion first solution heuristic.
double cheapest_insertion_farthest_seeds_ratio = 16;
- Returns
- The cheapestInsertionFarthestSeedsRatio.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ getCheapestInsertionFirstSolutionNeighborsRatio()
| double getCheapestInsertionFirstSolutionNeighborsRatio | ( | ) |
Ratio (in ]0, 1]) of neighbors to consider for each node when creating new insertions in the parallel/sequential cheapest insertion heuristic. If not overridden, its default value is 1, meaning all neighbors will be considered. Neighbors ratio for the first solution heuristic.
double cheapest_insertion_first_solution_neighbors_ratio = 21;
- Returns
- The cheapestInsertionFirstSolutionNeighborsRatio.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ getCheapestInsertionLsOperatorNeighborsRatio()
| double getCheapestInsertionLsOperatorNeighborsRatio | ( | ) |
Neighbors ratio for the 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).
double cheapest_insertion_ls_operator_neighbors_ratio = 31;
- Returns
- The cheapestInsertionLsOperatorNeighborsRatio.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ 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.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ getContinuousSchedulingSolver()
| com.google.ortools.constraintsolver.RoutingSearchParameters.SchedulingSolver getContinuousSchedulingSolver | ( | ) |
.operations_research.RoutingSearchParameters.SchedulingSolver continuous_scheduling_solver = 33;
- Returns
- The continuousSchedulingSolver.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ getContinuousSchedulingSolverValue()
| int getContinuousSchedulingSolverValue | ( | ) |
.operations_research.RoutingSearchParameters.SchedulingSolver continuous_scheduling_solver = 33;
- Returns
- The enum numeric value on the wire for continuousSchedulingSolver.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ getFirstSolutionStrategy()
| com.google.ortools.constraintsolver.FirstSolutionStrategy.Value getFirstSolutionStrategy | ( | ) |
First solution strategies, used as starting point of local search.
.operations_research.FirstSolutionStrategy.Value first_solution_strategy = 1;
- Returns
- The firstSolutionStrategy.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ 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.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ 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.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ 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.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ 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.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ 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;
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ getLocalSearchMetaheuristic()
| com.google.ortools.constraintsolver.LocalSearchMetaheuristic.Value getLocalSearchMetaheuristic | ( | ) |
Local search metaheuristics used to guide the search.
.operations_research.LocalSearchMetaheuristic.Value local_search_metaheuristic = 4;
- Returns
- The localSearchMetaheuristic.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ 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.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ getLocalSearchOperators()
| com.google.ortools.constraintsolver.RoutingSearchParameters.LocalSearchNeighborhoodOperators getLocalSearchOperators | ( | ) |
.operations_research.RoutingSearchParameters.LocalSearchNeighborhoodOperators local_search_operators = 3;
- Returns
- The localSearchOperators.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ getLocalSearchOperatorsOrBuilder()
| com.google.ortools.constraintsolver.RoutingSearchParameters.LocalSearchNeighborhoodOperatorsOrBuilder getLocalSearchOperatorsOrBuilder | ( | ) |
.operations_research.RoutingSearchParameters.LocalSearchNeighborhoodOperators local_search_operators = 3;
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ getLogCostOffset()
| double getLogCostOffset | ( | ) |
double log_cost_offset = 29;
- Returns
- The logCostOffset.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ 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.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ 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.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ getMixedIntegerSchedulingSolver()
| com.google.ortools.constraintsolver.RoutingSearchParameters.SchedulingSolver getMixedIntegerSchedulingSolver | ( | ) |
.operations_research.RoutingSearchParameters.SchedulingSolver mixed_integer_scheduling_solver = 34;
- Returns
- The mixedIntegerSchedulingSolver.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ getMixedIntegerSchedulingSolverValue()
| int getMixedIntegerSchedulingSolverValue | ( | ) |
.operations_research.RoutingSearchParameters.SchedulingSolver mixed_integer_scheduling_solver = 34;
- Returns
- The enum numeric value on the wire for mixedIntegerSchedulingSolver.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ 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.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ 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.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ 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.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ getSavingsAddReverseArcs()
| boolean getSavingsAddReverseArcs | ( | ) |
Add savings related to reverse arcs when finding the nearest neighbors of the nodes.
bool savings_add_reverse_arcs = 15;
- Returns
- The savingsAddReverseArcs.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ getSavingsArcCoefficient()
| double getSavingsArcCoefficient | ( | ) |
Coefficient of the cost of the arc for which the saving value is being computed: Saving(a-->b) = Cost(a-->end) + Cost(start-->b)
- savings_arc_coefficient * Cost(a-->b) This parameter must be greater than 0, and its default value is 1.
double savings_arc_coefficient = 18;
- Returns
- The savingsArcCoefficient.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ getSavingsMaxMemoryUsageBytes()
| double getSavingsMaxMemoryUsageBytes | ( | ) |
The number of neighbors considered for each node in the Savings heuristic is chosen so that the space used to store the savings doesn't exceed savings_max_memory_usage_bytes, which must be in ]0, 1e10]. NOTE: If both savings_neighbors_ratio and savings_max_memory_usage_bytes are specified, the number of neighbors considered for each node will be the minimum of the two numbers determined by these parameters.
double savings_max_memory_usage_bytes = 23;
- Returns
- The savingsMaxMemoryUsageBytes.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ getSavingsNeighborsRatio()
| double getSavingsNeighborsRatio | ( | ) |
Parameters specific to the Savings first solution heuristic. Ratio (in ]0, 1]) of neighbors to consider for each node when constructing the savings. If unspecified, its value is considered to be 1.0.
double savings_neighbors_ratio = 14;
- Returns
- The savingsNeighborsRatio.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ getSavingsParallelRoutes()
| boolean getSavingsParallelRoutes | ( | ) |
When true, the routes are built in parallel, sequentially otherwise.
bool savings_parallel_routes = 19;
- Returns
- The savingsParallelRoutes.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ 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.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ getTimeLimit()
| com.google.protobuf.Duration getTimeLimit | ( | ) |
Limit to the time spent in the search.
.google.protobuf.Duration time_limit = 9;
- Returns
- The timeLimit.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ getTimeLimitOrBuilder()
| com.google.protobuf.DurationOrBuilder getTimeLimitOrBuilder | ( | ) |
Limit to the time spent in the search.
.google.protobuf.Duration time_limit = 9;
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ getUseCp()
| com.google.ortools.util.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.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ getUseCpSat()
| com.google.ortools.util.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.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ 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.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ 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.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ 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.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ 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.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ 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.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ 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.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ hasLocalSearchOperators()
| boolean hasLocalSearchOperators | ( | ) |
.operations_research.RoutingSearchParameters.LocalSearchNeighborhoodOperators local_search_operators = 3;
- Returns
- Whether the localSearchOperators field is set.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
◆ hasTimeLimit()
| boolean hasTimeLimit | ( | ) |
Limit to the time spent in the search.
.google.protobuf.Duration time_limit = 9;
- Returns
- Whether the timeLimit field is set.
Implemented in RoutingSearchParameters.Builder, and RoutingSearchParameters.
The documentation for this interface was generated from the following file: