Java Reference

Java Reference

RoutingSearchParameters

Detailed Description

Parameters defining the search used to solve vehicle routing problems.
If a parameter is unset (or, equivalently, set to its default value),
then the routing library will pick its preferred value for that parameter
automatically: this should be the case for most parameters.
To see those "default" parameters, call GetDefaultRoutingSearchParameters().
Next ID: 35

Protobuf type

operations_research.RoutingSearchParameters

Definition at line 18 of file RoutingSearchParameters.java.

Classes

class  Builder
 
class  LocalSearchNeighborhoodOperators
 
interface  LocalSearchNeighborhoodOperatorsOrBuilder
 
enum  SchedulingSolver
 

Public Member Functions

.lang.Override final com.google.protobuf.UnknownFieldSet getUnknownFields ()
 
.lang.Override int getFirstSolutionStrategyValue ()
 
.lang.Override com.google.ortools.constraintsolver.FirstSolutionStrategy.Value getFirstSolutionStrategy ()
 
.lang.Override boolean getUseUnfilteredFirstSolutionStrategy ()
 
.lang.Override double getSavingsNeighborsRatio ()
 
.lang.Override double getSavingsMaxMemoryUsageBytes ()
 
.lang.Override boolean getSavingsAddReverseArcs ()
 
.lang.Override double getSavingsArcCoefficient ()
 
.lang.Override boolean getSavingsParallelRoutes ()
 
.lang.Override double getCheapestInsertionFarthestSeedsRatio ()
 
.lang.Override double getCheapestInsertionFirstSolutionNeighborsRatio ()
 
.lang.Override double getCheapestInsertionLsOperatorNeighborsRatio ()
 
.lang.Override boolean getChristofidesUseMinimumMatching ()
 
.lang.Override boolean hasLocalSearchOperators ()
 .operations_research.RoutingSearchParameters.LocalSearchNeighborhoodOperators local_search_operators = 3; More...
 
.lang.Override com.google.ortools.constraintsolver.RoutingSearchParameters.LocalSearchNeighborhoodOperators getLocalSearchOperators ()
 .operations_research.RoutingSearchParameters.LocalSearchNeighborhoodOperators local_search_operators = 3; More...
 
.lang.Override com.google.ortools.constraintsolver.RoutingSearchParameters.LocalSearchNeighborhoodOperatorsOrBuilder getLocalSearchOperatorsOrBuilder ()
 .operations_research.RoutingSearchParameters.LocalSearchNeighborhoodOperators local_search_operators = 3; More...
 
.lang.Override int getRelocateExpensiveChainNumArcsToConsider ()
 
.lang.Override int getHeuristicExpensiveChainLnsNumArcsToConsider ()
 
.lang.Override int getLocalSearchMetaheuristicValue ()
 
.lang.Override com.google.ortools.constraintsolver.LocalSearchMetaheuristic.Value getLocalSearchMetaheuristic ()
 
.lang.Override double getGuidedLocalSearchLambdaCoefficient ()
 
.lang.Override boolean getUseDepthFirstSearch ()
 
.lang.Override int getUseCpValue ()
 
.lang.Override com.google.ortools.util.OptionalBoolean getUseCp ()
 
.lang.Override int getUseCpSatValue ()
 
.lang.Override com.google.ortools.util.OptionalBoolean getUseCpSat ()
 
.lang.Override int getContinuousSchedulingSolverValue ()
 .operations_research.RoutingSearchParameters.SchedulingSolver continuous_scheduling_solver = 33; More...
 
.lang.Override com.google.ortools.constraintsolver.RoutingSearchParameters.SchedulingSolver getContinuousSchedulingSolver ()
 .operations_research.RoutingSearchParameters.SchedulingSolver continuous_scheduling_solver = 33; More...
 
.lang.Override int getMixedIntegerSchedulingSolverValue ()
 .operations_research.RoutingSearchParameters.SchedulingSolver mixed_integer_scheduling_solver = 34; More...
 
.lang.Override com.google.ortools.constraintsolver.RoutingSearchParameters.SchedulingSolver getMixedIntegerSchedulingSolver ()
 .operations_research.RoutingSearchParameters.SchedulingSolver mixed_integer_scheduling_solver = 34; More...
 
.lang.Override double getOptimizationStep ()
 
.lang.Override int getNumberOfSolutionsToCollect ()
 
.lang.Override long getSolutionLimit ()
 
.lang.Override boolean hasTimeLimit ()
 
.lang.Override com.google.protobuf.Duration getTimeLimit ()
 
.lang.Override com.google.protobuf.DurationOrBuilder getTimeLimitOrBuilder ()
 
.lang.Override boolean hasLnsTimeLimit ()
 
.lang.Override com.google.protobuf.Duration getLnsTimeLimit ()
 
.lang.Override com.google.protobuf.DurationOrBuilder getLnsTimeLimitOrBuilder ()
 
.lang.Override boolean getUseFullPropagation ()
 
.lang.Override boolean getLogSearch ()
 
.lang.Override double getLogCostScalingFactor ()
 
.lang.Override double getLogCostOffset ()
 double log_cost_offset = 29; More...
 
.lang.Override final boolean isInitialized ()
 
.lang.Override void writeTo (com.google.protobuf.CodedOutputStream output) throws java.io.IOException
 
.lang.Override int getSerializedSize ()
 
.lang.Override boolean equals (final java.lang.Object obj)
 
.lang.Override int hashCode ()
 
.lang.Override Builder newBuilderForType ()
 
.lang.Override Builder toBuilder ()
 
.lang.Override com.google.protobuf.Parser< RoutingSearchParametersgetParserForType ()
 
.lang.Override com.google.ortools.constraintsolver.RoutingSearchParameters getDefaultInstanceForType ()
 

Static Public Member Functions

static final com.google.protobuf.Descriptors.Descriptor getDescriptor ()
 
static com.google.ortools.constraintsolver.RoutingSearchParameters parseFrom (java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
 
static com.google.ortools.constraintsolver.RoutingSearchParameters parseFrom (java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
 
static com.google.ortools.constraintsolver.RoutingSearchParameters parseFrom (com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
 
static com.google.ortools.constraintsolver.RoutingSearchParameters parseFrom (com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
 
static com.google.ortools.constraintsolver.RoutingSearchParameters parseFrom (byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
 
static com.google.ortools.constraintsolver.RoutingSearchParameters parseFrom (byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
 
static com.google.ortools.constraintsolver.RoutingSearchParameters parseFrom (java.io.InputStream input) throws java.io.IOException
 
static com.google.ortools.constraintsolver.RoutingSearchParameters parseFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
 
static com.google.ortools.constraintsolver.RoutingSearchParameters parseDelimitedFrom (java.io.InputStream input) throws java.io.IOException
 
static com.google.ortools.constraintsolver.RoutingSearchParameters parseDelimitedFrom (java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
 
static com.google.ortools.constraintsolver.RoutingSearchParameters parseFrom (com.google.protobuf.CodedInputStream input) throws java.io.IOException
 
static com.google.ortools.constraintsolver.RoutingSearchParameters parseFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
 
static Builder newBuilder ()
 
static Builder newBuilder (com.google.ortools.constraintsolver.RoutingSearchParameters prototype)
 
static com.google.ortools.constraintsolver.RoutingSearchParameters getDefaultInstance ()
 
static com.google.protobuf.Parser< RoutingSearchParametersparser ()
 

Static Public Attributes

static final int FIRST_SOLUTION_STRATEGY_FIELD_NUMBER = 1
 
static final int USE_UNFILTERED_FIRST_SOLUTION_STRATEGY_FIELD_NUMBER = 2
 
static final int SAVINGS_NEIGHBORS_RATIO_FIELD_NUMBER = 14
 
static final int SAVINGS_MAX_MEMORY_USAGE_BYTES_FIELD_NUMBER = 23
 
static final int SAVINGS_ADD_REVERSE_ARCS_FIELD_NUMBER = 15
 
static final int SAVINGS_ARC_COEFFICIENT_FIELD_NUMBER = 18
 
static final int SAVINGS_PARALLEL_ROUTES_FIELD_NUMBER = 19
 
static final int CHEAPEST_INSERTION_FARTHEST_SEEDS_RATIO_FIELD_NUMBER = 16
 
static final int CHEAPEST_INSERTION_FIRST_SOLUTION_NEIGHBORS_RATIO_FIELD_NUMBER = 21
 
static final int CHEAPEST_INSERTION_LS_OPERATOR_NEIGHBORS_RATIO_FIELD_NUMBER = 31
 
static final int CHRISTOFIDES_USE_MINIMUM_MATCHING_FIELD_NUMBER = 30
 
static final int LOCAL_SEARCH_OPERATORS_FIELD_NUMBER = 3
 
static final int RELOCATE_EXPENSIVE_CHAIN_NUM_ARCS_TO_CONSIDER_FIELD_NUMBER = 20
 
static final int HEURISTIC_EXPENSIVE_CHAIN_LNS_NUM_ARCS_TO_CONSIDER_FIELD_NUMBER = 32
 
static final int LOCAL_SEARCH_METAHEURISTIC_FIELD_NUMBER = 4
 
static final int GUIDED_LOCAL_SEARCH_LAMBDA_COEFFICIENT_FIELD_NUMBER = 5
 
static final int USE_DEPTH_FIRST_SEARCH_FIELD_NUMBER = 6
 
static final int USE_CP_FIELD_NUMBER = 28
 
static final int USE_CP_SAT_FIELD_NUMBER = 27
 
static final int CONTINUOUS_SCHEDULING_SOLVER_FIELD_NUMBER = 33
 
static final int MIXED_INTEGER_SCHEDULING_SOLVER_FIELD_NUMBER = 34
 
static final int OPTIMIZATION_STEP_FIELD_NUMBER = 7
 
static final int NUMBER_OF_SOLUTIONS_TO_COLLECT_FIELD_NUMBER = 17
 
static final int SOLUTION_LIMIT_FIELD_NUMBER = 8
 
static final int TIME_LIMIT_FIELD_NUMBER = 9
 
static final int LNS_TIME_LIMIT_FIELD_NUMBER = 10
 
static final int USE_FULL_PROPAGATION_FIELD_NUMBER = 11
 
static final int LOG_SEARCH_FIELD_NUMBER = 13
 
static final int LOG_COST_SCALING_FACTOR_FIELD_NUMBER = 22
 
static final int LOG_COST_OFFSET_FIELD_NUMBER = 29
 

Protected Member Functions

.lang.Override java.lang.Object newInstance (UnusedPrivateParameter unused)
 
.lang.Override com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable ()
 
.lang.Override Builder newBuilderForType (com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
 

Member Function Documentation

◆ equals()

.lang.Override boolean equals ( final java.lang.Object  obj)
inline

Definition at line 7591 of file RoutingSearchParameters.java.

◆ getCheapestInsertionFarthestSeedsRatio()

.lang.Override double getCheapestInsertionFarthestSeedsRatio ( )
inline
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.

Implements RoutingSearchParametersOrBuilder.

Definition at line 6864 of file RoutingSearchParameters.java.

◆ getCheapestInsertionFirstSolutionNeighborsRatio()

.lang.Override double getCheapestInsertionFirstSolutionNeighborsRatio ( )
inline
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.

Implements RoutingSearchParametersOrBuilder.

Definition at line 6883 of file RoutingSearchParameters.java.

◆ getCheapestInsertionLsOperatorNeighborsRatio()

.lang.Override double getCheapestInsertionLsOperatorNeighborsRatio ( )
inline
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.

Implements RoutingSearchParametersOrBuilder.

Definition at line 6900 of file RoutingSearchParameters.java.

◆ getChristofidesUseMinimumMatching()

.lang.Override boolean getChristofidesUseMinimumMatching ( )
inline
If true use minimum matching instead of minimal matching in the
Christofides algorithm.

bool christofides_use_minimum_matching = 30;

Returns
The christofidesUseMinimumMatching.

Implements RoutingSearchParametersOrBuilder.

Definition at line 6916 of file RoutingSearchParameters.java.

◆ getContinuousSchedulingSolver()

.lang.Override com.google.ortools.constraintsolver.RoutingSearchParameters.SchedulingSolver getContinuousSchedulingSolver ( )
inline

.operations_research.RoutingSearchParameters.SchedulingSolver continuous_scheduling_solver = 33;

Returns
The continuousSchedulingSolver.

Implements RoutingSearchParametersOrBuilder.

Definition at line 7122 of file RoutingSearchParameters.java.

◆ getContinuousSchedulingSolverValue()

.lang.Override int getContinuousSchedulingSolverValue ( )
inline

.operations_research.RoutingSearchParameters.SchedulingSolver continuous_scheduling_solver = 33;

Returns
The enum numeric value on the wire for continuousSchedulingSolver.

Implements RoutingSearchParametersOrBuilder.

Definition at line 7115 of file RoutingSearchParameters.java.

◆ getDefaultInstance()

static com.google.ortools.constraintsolver.RoutingSearchParameters getDefaultInstance ( )
inlinestatic

Definition at line 10176 of file RoutingSearchParameters.java.

◆ getDefaultInstanceForType()

.lang.Override com.google.ortools.constraintsolver.RoutingSearchParameters getDefaultInstanceForType ( )
inline

Definition at line 10201 of file RoutingSearchParameters.java.

◆ getDescriptor()

static final com.google.protobuf.Descriptors.Descriptor getDescriptor ( )
inlinestatic

Definition at line 266 of file RoutingSearchParameters.java.

◆ getFirstSolutionStrategy()

.lang.Override com.google.ortools.constraintsolver.FirstSolutionStrategy.Value getFirstSolutionStrategy ( )
inline
First solution strategies, used as starting point of local search.

.operations_research.FirstSolutionStrategy.Value first_solution_strategy = 1;

Returns
The firstSolutionStrategy.

Implements RoutingSearchParametersOrBuilder.

Definition at line 6741 of file RoutingSearchParameters.java.

◆ getFirstSolutionStrategyValue()

.lang.Override int getFirstSolutionStrategyValue ( )
inline
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.

Implements RoutingSearchParametersOrBuilder.

Definition at line 6730 of file RoutingSearchParameters.java.

◆ getGuidedLocalSearchLambdaCoefficient()

.lang.Override double getGuidedLocalSearchLambdaCoefficient ( )
inline
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.

Implements RoutingSearchParametersOrBuilder.

Definition at line 7024 of file RoutingSearchParameters.java.

◆ getHeuristicExpensiveChainLnsNumArcsToConsider()

.lang.Override int getHeuristicExpensiveChainLnsNumArcsToConsider ( )
inline
Number of expensive arcs to consider cutting in the
FilteredHeuristicExpensiveChainLNSOperator operator.

int32 heuristic_expensive_chain_lns_num_arcs_to_consider = 32;

Returns
The heuristicExpensiveChainLnsNumArcsToConsider.

Implements RoutingSearchParametersOrBuilder.

Definition at line 6979 of file RoutingSearchParameters.java.

◆ getLnsTimeLimit()

.lang.Override com.google.protobuf.Duration getLnsTimeLimit ( )
inline
Limit to the time spent in the completion search for each local search
neighbor.

.google.protobuf.Duration lns_time_limit = 10;

Returns
The lnsTimeLimit.

Implements RoutingSearchParametersOrBuilder.

Definition at line 7260 of file RoutingSearchParameters.java.

◆ getLnsTimeLimitOrBuilder()

.lang.Override com.google.protobuf.DurationOrBuilder getLnsTimeLimitOrBuilder ( )
inline
Limit to the time spent in the completion search for each local search
neighbor.

.google.protobuf.Duration lns_time_limit = 10;

Implements RoutingSearchParametersOrBuilder.

Definition at line 7272 of file RoutingSearchParameters.java.

◆ getLocalSearchMetaheuristic()

.lang.Override com.google.ortools.constraintsolver.LocalSearchMetaheuristic.Value getLocalSearchMetaheuristic ( )
inline
Local search metaheuristics used to guide the search.

.operations_research.LocalSearchMetaheuristic.Value local_search_metaheuristic = 4;

Returns
The localSearchMetaheuristic.

Implements RoutingSearchParametersOrBuilder.

Definition at line 7004 of file RoutingSearchParameters.java.

◆ getLocalSearchMetaheuristicValue()

.lang.Override int getLocalSearchMetaheuristicValue ( )
inline
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.

Implements RoutingSearchParametersOrBuilder.

Definition at line 6993 of file RoutingSearchParameters.java.

◆ getLocalSearchOperators()

.operations_research.RoutingSearchParameters.LocalSearchNeighborhoodOperators local_search_operators = 3;

Returns
The localSearchOperators.

Implements RoutingSearchParametersOrBuilder.

Definition at line 6935 of file RoutingSearchParameters.java.

◆ getLocalSearchOperatorsOrBuilder()

.operations_research.RoutingSearchParameters.LocalSearchNeighborhoodOperators local_search_operators = 3;

Implements RoutingSearchParametersOrBuilder.

Definition at line 6942 of file RoutingSearchParameters.java.

◆ getLogCostOffset()

.lang.Override double getLogCostOffset ( )
inline

double log_cost_offset = 29;

Returns
The logCostOffset.

Implements RoutingSearchParametersOrBuilder.

Definition at line 7348 of file RoutingSearchParameters.java.

◆ getLogCostScalingFactor()

.lang.Override double getLogCostScalingFactor ( )
inline
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.

Implements RoutingSearchParametersOrBuilder.

Definition at line 7337 of file RoutingSearchParameters.java.

◆ getLogSearch()

.lang.Override boolean getLogSearch ( )
inline
--- 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.

Implements RoutingSearchParametersOrBuilder.

Definition at line 7321 of file RoutingSearchParameters.java.

◆ getMixedIntegerSchedulingSolver()

.lang.Override com.google.ortools.constraintsolver.RoutingSearchParameters.SchedulingSolver getMixedIntegerSchedulingSolver ( )
inline

.operations_research.RoutingSearchParameters.SchedulingSolver mixed_integer_scheduling_solver = 34;

Returns
The mixedIntegerSchedulingSolver.

Implements RoutingSearchParametersOrBuilder.

Definition at line 7141 of file RoutingSearchParameters.java.

◆ getMixedIntegerSchedulingSolverValue()

.lang.Override int getMixedIntegerSchedulingSolverValue ( )
inline

.operations_research.RoutingSearchParameters.SchedulingSolver mixed_integer_scheduling_solver = 34;

Returns
The enum numeric value on the wire for mixedIntegerSchedulingSolver.

Implements RoutingSearchParametersOrBuilder.

Definition at line 7134 of file RoutingSearchParameters.java.

◆ getNumberOfSolutionsToCollect()

.lang.Override int getNumberOfSolutionsToCollect ( )
inline
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.

Implements RoutingSearchParametersOrBuilder.

Definition at line 7176 of file RoutingSearchParameters.java.

◆ getOptimizationStep()

.lang.Override double getOptimizationStep ( )
inline
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.

Implements RoutingSearchParametersOrBuilder.

Definition at line 7160 of file RoutingSearchParameters.java.

◆ getParserForType()

.lang.Override com.google.protobuf.Parser<RoutingSearchParameters> getParserForType ( )
inline

Definition at line 10196 of file RoutingSearchParameters.java.

◆ getRelocateExpensiveChainNumArcsToConsider()

.lang.Override int getRelocateExpensiveChainNumArcsToConsider ( )
inline
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.

Implements RoutingSearchParametersOrBuilder.

Definition at line 6963 of file RoutingSearchParameters.java.

◆ getSavingsAddReverseArcs()

.lang.Override boolean getSavingsAddReverseArcs ( )
inline
Add savings related to reverse arcs when finding the nearest neighbors
of the nodes.

bool savings_add_reverse_arcs = 15;

Returns
The savingsAddReverseArcs.

Implements RoutingSearchParametersOrBuilder.

Definition at line 6813 of file RoutingSearchParameters.java.

◆ getSavingsArcCoefficient()

.lang.Override double getSavingsArcCoefficient ( )
inline
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.

Implements RoutingSearchParametersOrBuilder.

Definition at line 6832 of file RoutingSearchParameters.java.

◆ getSavingsMaxMemoryUsageBytes()

.lang.Override double getSavingsMaxMemoryUsageBytes ( )
inline
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.

Implements RoutingSearchParametersOrBuilder.

Definition at line 6797 of file RoutingSearchParameters.java.

◆ getSavingsNeighborsRatio()

.lang.Override double getSavingsNeighborsRatio ( )
inline
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.

Implements RoutingSearchParametersOrBuilder.

Definition at line 6777 of file RoutingSearchParameters.java.

◆ getSavingsParallelRoutes()

.lang.Override boolean getSavingsParallelRoutes ( )
inline
When true, the routes are built in parallel, sequentially otherwise.

bool savings_parallel_routes = 19;

Returns
The savingsParallelRoutes.

Implements RoutingSearchParametersOrBuilder.

Definition at line 6847 of file RoutingSearchParameters.java.

◆ getSerializedSize()

.lang.Override int getSerializedSize ( )
inline

Definition at line 7460 of file RoutingSearchParameters.java.

◆ getSolutionLimit()

.lang.Override long getSolutionLimit ( )
inline
-- Search limits --
Limit to the number of solutions generated during the search. 0 means
"unspecified".

int64 solution_limit = 8;

Returns
The solutionLimit.

Implements RoutingSearchParametersOrBuilder.

Definition at line 7193 of file RoutingSearchParameters.java.

◆ getTimeLimit()

.lang.Override com.google.protobuf.Duration getTimeLimit ( )
inline
Limit to the time spent in the search.

.google.protobuf.Duration time_limit = 9;

Returns
The timeLimit.

Implements RoutingSearchParametersOrBuilder.

Definition at line 7220 of file RoutingSearchParameters.java.

◆ getTimeLimitOrBuilder()

.lang.Override com.google.protobuf.DurationOrBuilder getTimeLimitOrBuilder ( )
inline
Limit to the time spent in the search.

.google.protobuf.Duration time_limit = 9;

Implements RoutingSearchParametersOrBuilder.

Definition at line 7231 of file RoutingSearchParameters.java.

◆ getUnknownFields()

.lang.Override final com.google.protobuf.UnknownFieldSet getUnknownFields ( )
inline

Definition at line 45 of file RoutingSearchParameters.java.

◆ getUseCp()

.lang.Override com.google.ortools.util.OptionalBoolean getUseCp ( )
inline
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.

Implements RoutingSearchParametersOrBuilder.

Definition at line 7070 of file RoutingSearchParameters.java.

◆ getUseCpSat()

.lang.Override com.google.ortools.util.OptionalBoolean getUseCpSat ( )
inline
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.

Implements RoutingSearchParametersOrBuilder.

Definition at line 7103 of file RoutingSearchParameters.java.

◆ getUseCpSatValue()

.lang.Override int getUseCpSatValue ( )
inline
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.

Implements RoutingSearchParametersOrBuilder.

Definition at line 7089 of file RoutingSearchParameters.java.

◆ getUseCpValue()

.lang.Override int getUseCpValue ( )
inline
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.

Implements RoutingSearchParametersOrBuilder.

Definition at line 7057 of file RoutingSearchParameters.java.

◆ getUseDepthFirstSearch()

.lang.Override boolean getUseDepthFirstSearch ( )
inline
--- 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.

Implements RoutingSearchParametersOrBuilder.

Definition at line 7041 of file RoutingSearchParameters.java.

◆ getUseFullPropagation()

.lang.Override boolean getUseFullPropagation ( )
inline
--- 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.

Implements RoutingSearchParametersOrBuilder.

Definition at line 7295 of file RoutingSearchParameters.java.

◆ getUseUnfilteredFirstSolutionStrategy()

.lang.Override boolean getUseUnfilteredFirstSolutionStrategy ( )
inline
--- 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.

Implements RoutingSearchParametersOrBuilder.

Definition at line 6760 of file RoutingSearchParameters.java.

◆ hashCode()

.lang.Override int hashCode ( )
inline

Definition at line 7678 of file RoutingSearchParameters.java.

◆ hasLnsTimeLimit()

.lang.Override boolean hasLnsTimeLimit ( )
inline
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.

Implements RoutingSearchParametersOrBuilder.

Definition at line 7247 of file RoutingSearchParameters.java.

◆ hasLocalSearchOperators()

.lang.Override boolean hasLocalSearchOperators ( )
inline

.operations_research.RoutingSearchParameters.LocalSearchNeighborhoodOperators local_search_operators = 3;

Returns
Whether the localSearchOperators field is set.

Implements RoutingSearchParametersOrBuilder.

Definition at line 6927 of file RoutingSearchParameters.java.

◆ hasTimeLimit()

.lang.Override boolean hasTimeLimit ( )
inline
Limit to the time spent in the search.

.google.protobuf.Duration time_limit = 9;

Returns
Whether the timeLimit field is set.

Implements RoutingSearchParametersOrBuilder.

Definition at line 7208 of file RoutingSearchParameters.java.

◆ internalGetFieldAccessorTable()

.lang.Override com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable ( )
inlineprotected

Definition at line 272 of file RoutingSearchParameters.java.

◆ isInitialized()

.lang.Override final boolean isInitialized ( )
inline

Definition at line 7354 of file RoutingSearchParameters.java.

◆ newBuilder() [1/2]

static Builder newBuilder ( )
inlinestatic

Definition at line 7845 of file RoutingSearchParameters.java.

◆ newBuilder() [2/2]

static Builder newBuilder ( com.google.ortools.constraintsolver.RoutingSearchParameters  prototype)
inlinestatic

Definition at line 7848 of file RoutingSearchParameters.java.

◆ newBuilderForType() [1/2]

.lang.Override Builder newBuilderForType ( )
inline

Definition at line 7844 of file RoutingSearchParameters.java.

◆ newBuilderForType() [2/2]

.lang.Override Builder newBuilderForType ( com.google.protobuf.GeneratedMessageV3.BuilderParent  parent)
inlineprotected

Definition at line 7858 of file RoutingSearchParameters.java.

◆ newInstance()

.lang.Override java.lang.Object newInstance ( UnusedPrivateParameter  unused)
inlineprotected

Definition at line 38 of file RoutingSearchParameters.java.

◆ parseDelimitedFrom() [1/2]

static com.google.ortools.constraintsolver.RoutingSearchParameters parseDelimitedFrom ( java.io.InputStream  input) throws java.io.IOException
inlinestatic

Definition at line 7817 of file RoutingSearchParameters.java.

◆ parseDelimitedFrom() [2/2]

static com.google.ortools.constraintsolver.RoutingSearchParameters parseDelimitedFrom ( java.io.InputStream  input,
com.google.protobuf.ExtensionRegistryLite  extensionRegistry 
) throws java.io.IOException
inlinestatic

Definition at line 7822 of file RoutingSearchParameters.java.

◆ parseFrom() [1/10]

static com.google.ortools.constraintsolver.RoutingSearchParameters parseFrom ( byte[]  data) throws com.google.protobuf.InvalidProtocolBufferException
inlinestatic

Definition at line 7795 of file RoutingSearchParameters.java.

◆ parseFrom() [2/10]

static com.google.ortools.constraintsolver.RoutingSearchParameters parseFrom ( byte[]  data,
com.google.protobuf.ExtensionRegistryLite  extensionRegistry 
) throws com.google.protobuf.InvalidProtocolBufferException
inlinestatic

Definition at line 7799 of file RoutingSearchParameters.java.

◆ parseFrom() [3/10]

static com.google.ortools.constraintsolver.RoutingSearchParameters parseFrom ( com.google.protobuf.ByteString  data) throws com.google.protobuf.InvalidProtocolBufferException
inlinestatic

Definition at line 7784 of file RoutingSearchParameters.java.

◆ parseFrom() [4/10]

static com.google.ortools.constraintsolver.RoutingSearchParameters parseFrom ( com.google.protobuf.ByteString  data,
com.google.protobuf.ExtensionRegistryLite  extensionRegistry 
) throws com.google.protobuf.InvalidProtocolBufferException
inlinestatic

Definition at line 7789 of file RoutingSearchParameters.java.

◆ parseFrom() [5/10]

static com.google.ortools.constraintsolver.RoutingSearchParameters parseFrom ( com.google.protobuf.CodedInputStream  input) throws java.io.IOException
inlinestatic

Definition at line 7829 of file RoutingSearchParameters.java.

◆ parseFrom() [6/10]

static com.google.ortools.constraintsolver.RoutingSearchParameters parseFrom ( com.google.protobuf.CodedInputStream  input,
com.google.protobuf.ExtensionRegistryLite  extensionRegistry 
) throws java.io.IOException
inlinestatic

Definition at line 7835 of file RoutingSearchParameters.java.

◆ parseFrom() [7/10]

static com.google.ortools.constraintsolver.RoutingSearchParameters parseFrom ( java.io.InputStream  input) throws java.io.IOException
inlinestatic

Definition at line 7805 of file RoutingSearchParameters.java.

◆ parseFrom() [8/10]

static com.google.ortools.constraintsolver.RoutingSearchParameters parseFrom ( java.io.InputStream  input,
com.google.protobuf.ExtensionRegistryLite  extensionRegistry 
) throws java.io.IOException
inlinestatic

Definition at line 7810 of file RoutingSearchParameters.java.

◆ parseFrom() [9/10]

static com.google.ortools.constraintsolver.RoutingSearchParameters parseFrom ( java.nio.ByteBuffer  data) throws com.google.protobuf.InvalidProtocolBufferException
inlinestatic

Definition at line 7773 of file RoutingSearchParameters.java.

◆ parseFrom() [10/10]

static com.google.ortools.constraintsolver.RoutingSearchParameters parseFrom ( java.nio.ByteBuffer  data,
com.google.protobuf.ExtensionRegistryLite  extensionRegistry 
) throws com.google.protobuf.InvalidProtocolBufferException
inlinestatic

Definition at line 7778 of file RoutingSearchParameters.java.

◆ parser()

static com.google.protobuf.Parser<RoutingSearchParameters> parser ( )
inlinestatic

Definition at line 10191 of file RoutingSearchParameters.java.

◆ toBuilder()

.lang.Override Builder toBuilder ( )
inline

Definition at line 7852 of file RoutingSearchParameters.java.

◆ writeTo()

.lang.Override void writeTo ( com.google.protobuf.CodedOutputStream  output) throws java.io.IOException
inline

Definition at line 7364 of file RoutingSearchParameters.java.

Member Data Documentation

◆ CHEAPEST_INSERTION_FARTHEST_SEEDS_RATIO_FIELD_NUMBER

final int CHEAPEST_INSERTION_FARTHEST_SEEDS_RATIO_FIELD_NUMBER = 16
static

Definition at line 6851 of file RoutingSearchParameters.java.

◆ CHEAPEST_INSERTION_FIRST_SOLUTION_NEIGHBORS_RATIO_FIELD_NUMBER

final int CHEAPEST_INSERTION_FIRST_SOLUTION_NEIGHBORS_RATIO_FIELD_NUMBER = 21
static

Definition at line 6868 of file RoutingSearchParameters.java.

◆ CHEAPEST_INSERTION_LS_OPERATOR_NEIGHBORS_RATIO_FIELD_NUMBER

final int CHEAPEST_INSERTION_LS_OPERATOR_NEIGHBORS_RATIO_FIELD_NUMBER = 31
static

Definition at line 6887 of file RoutingSearchParameters.java.

◆ CHRISTOFIDES_USE_MINIMUM_MATCHING_FIELD_NUMBER

final int CHRISTOFIDES_USE_MINIMUM_MATCHING_FIELD_NUMBER = 30
static

Definition at line 6904 of file RoutingSearchParameters.java.

◆ CONTINUOUS_SCHEDULING_SOLVER_FIELD_NUMBER

final int CONTINUOUS_SCHEDULING_SOLVER_FIELD_NUMBER = 33
static

Definition at line 7109 of file RoutingSearchParameters.java.

◆ FIRST_SOLUTION_STRATEGY_FIELD_NUMBER

final int FIRST_SOLUTION_STRATEGY_FIELD_NUMBER = 1
static

Definition at line 6720 of file RoutingSearchParameters.java.

◆ GUIDED_LOCAL_SEARCH_LAMBDA_COEFFICIENT_FIELD_NUMBER

final int GUIDED_LOCAL_SEARCH_LAMBDA_COEFFICIENT_FIELD_NUMBER = 5
static

Definition at line 7010 of file RoutingSearchParameters.java.

◆ HEURISTIC_EXPENSIVE_CHAIN_LNS_NUM_ARCS_TO_CONSIDER_FIELD_NUMBER

final int HEURISTIC_EXPENSIVE_CHAIN_LNS_NUM_ARCS_TO_CONSIDER_FIELD_NUMBER = 32
static

Definition at line 6967 of file RoutingSearchParameters.java.

◆ LNS_TIME_LIMIT_FIELD_NUMBER

final int LNS_TIME_LIMIT_FIELD_NUMBER = 10
static

Definition at line 7235 of file RoutingSearchParameters.java.

◆ LOCAL_SEARCH_METAHEURISTIC_FIELD_NUMBER

final int LOCAL_SEARCH_METAHEURISTIC_FIELD_NUMBER = 4
static

Definition at line 6983 of file RoutingSearchParameters.java.

◆ LOCAL_SEARCH_OPERATORS_FIELD_NUMBER

final int LOCAL_SEARCH_OPERATORS_FIELD_NUMBER = 3
static

Definition at line 6920 of file RoutingSearchParameters.java.

◆ LOG_COST_OFFSET_FIELD_NUMBER

final int LOG_COST_OFFSET_FIELD_NUMBER = 29
static

Definition at line 7341 of file RoutingSearchParameters.java.

◆ LOG_COST_SCALING_FACTOR_FIELD_NUMBER

final int LOG_COST_SCALING_FACTOR_FIELD_NUMBER = 22
static

Definition at line 7325 of file RoutingSearchParameters.java.

◆ LOG_SEARCH_FIELD_NUMBER

final int LOG_SEARCH_FIELD_NUMBER = 13
static

Definition at line 7299 of file RoutingSearchParameters.java.

◆ MIXED_INTEGER_SCHEDULING_SOLVER_FIELD_NUMBER

final int MIXED_INTEGER_SCHEDULING_SOLVER_FIELD_NUMBER = 34
static

Definition at line 7128 of file RoutingSearchParameters.java.

◆ NUMBER_OF_SOLUTIONS_TO_COLLECT_FIELD_NUMBER

final int NUMBER_OF_SOLUTIONS_TO_COLLECT_FIELD_NUMBER = 17
static

Definition at line 7164 of file RoutingSearchParameters.java.

◆ OPTIMIZATION_STEP_FIELD_NUMBER

final int OPTIMIZATION_STEP_FIELD_NUMBER = 7
static

Definition at line 7147 of file RoutingSearchParameters.java.

◆ RELOCATE_EXPENSIVE_CHAIN_NUM_ARCS_TO_CONSIDER_FIELD_NUMBER

final int RELOCATE_EXPENSIVE_CHAIN_NUM_ARCS_TO_CONSIDER_FIELD_NUMBER = 20
static

Definition at line 6946 of file RoutingSearchParameters.java.

◆ SAVINGS_ADD_REVERSE_ARCS_FIELD_NUMBER

final int SAVINGS_ADD_REVERSE_ARCS_FIELD_NUMBER = 15
static

Definition at line 6801 of file RoutingSearchParameters.java.

◆ SAVINGS_ARC_COEFFICIENT_FIELD_NUMBER

final int SAVINGS_ARC_COEFFICIENT_FIELD_NUMBER = 18
static

Definition at line 6817 of file RoutingSearchParameters.java.

◆ SAVINGS_MAX_MEMORY_USAGE_BYTES_FIELD_NUMBER

final int SAVINGS_MAX_MEMORY_USAGE_BYTES_FIELD_NUMBER = 23
static

Definition at line 6781 of file RoutingSearchParameters.java.

◆ SAVINGS_NEIGHBORS_RATIO_FIELD_NUMBER

final int SAVINGS_NEIGHBORS_RATIO_FIELD_NUMBER = 14
static

Definition at line 6764 of file RoutingSearchParameters.java.

◆ SAVINGS_PARALLEL_ROUTES_FIELD_NUMBER

final int SAVINGS_PARALLEL_ROUTES_FIELD_NUMBER = 19
static

Definition at line 6836 of file RoutingSearchParameters.java.

◆ SOLUTION_LIMIT_FIELD_NUMBER

final int SOLUTION_LIMIT_FIELD_NUMBER = 8
static

Definition at line 7180 of file RoutingSearchParameters.java.

◆ TIME_LIMIT_FIELD_NUMBER

final int TIME_LIMIT_FIELD_NUMBER = 9
static

Definition at line 7197 of file RoutingSearchParameters.java.

◆ USE_CP_FIELD_NUMBER

final int USE_CP_FIELD_NUMBER = 28
static

Definition at line 7045 of file RoutingSearchParameters.java.

◆ USE_CP_SAT_FIELD_NUMBER

final int USE_CP_SAT_FIELD_NUMBER = 27
static

Definition at line 7076 of file RoutingSearchParameters.java.

◆ USE_DEPTH_FIRST_SEARCH_FIELD_NUMBER

final int USE_DEPTH_FIRST_SEARCH_FIELD_NUMBER = 6
static

Definition at line 7028 of file RoutingSearchParameters.java.

◆ USE_FULL_PROPAGATION_FIELD_NUMBER

final int USE_FULL_PROPAGATION_FIELD_NUMBER = 11
static

Definition at line 7276 of file RoutingSearchParameters.java.

◆ USE_UNFILTERED_FIRST_SOLUTION_STRATEGY_FIELD_NUMBER

final int USE_UNFILTERED_FIRST_SOLUTION_STRATEGY_FIELD_NUMBER = 2
static

Definition at line 6747 of file RoutingSearchParameters.java.


The documentation for this class was generated from the following file: