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: 68

Protobuf type operations_research.RoutingSearchParameters

Definition at line 11111 of file RoutingSearchParameters.java.

Inheritance diagram for com.google.ortools.constraintsolver.RoutingSearchParameters.Builder:

Public Member Functions
Builder	clear ()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType ()
com.google.ortools.constraintsolver.RoutingSearchParameters	getDefaultInstanceForType ()
com.google.ortools.constraintsolver.RoutingSearchParameters	build ()
com.google.ortools.constraintsolver.RoutingSearchParameters	buildPartial ()
Builder	mergeFrom (com.google.protobuf.Message other)
Builder	mergeFrom (com.google.ortools.constraintsolver.RoutingSearchParameters other)
final boolean	isInitialized ()
Builder	mergeFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
int	getFirstSolutionStrategyValue ()
Builder	setFirstSolutionStrategyValue (int value)
com.google.ortools.constraintsolver.FirstSolutionStrategy.Value	getFirstSolutionStrategy ()
Builder	setFirstSolutionStrategy (com.google.ortools.constraintsolver.FirstSolutionStrategy.Value value)
Builder	clearFirstSolutionStrategy ()
boolean	getUseUnfilteredFirstSolutionStrategy ()
Builder	setUseUnfilteredFirstSolutionStrategy (boolean value)
Builder	clearUseUnfilteredFirstSolutionStrategy ()
double	getSavingsNeighborsRatio ()
Builder	setSavingsNeighborsRatio (double value)
Builder	clearSavingsNeighborsRatio ()
double	getSavingsMaxMemoryUsageBytes ()
Builder	setSavingsMaxMemoryUsageBytes (double value)
Builder	clearSavingsMaxMemoryUsageBytes ()
boolean	getSavingsAddReverseArcs ()
Builder	setSavingsAddReverseArcs (boolean value)
Builder	clearSavingsAddReverseArcs ()
double	getSavingsArcCoefficient ()
Builder	setSavingsArcCoefficient (double value)
Builder	clearSavingsArcCoefficient ()
double	getCheapestInsertionFarthestSeedsRatio ()
Builder	setCheapestInsertionFarthestSeedsRatio (double value)
Builder	clearCheapestInsertionFarthestSeedsRatio ()
double	getCheapestInsertionFirstSolutionNeighborsRatio ()
Builder	setCheapestInsertionFirstSolutionNeighborsRatio (double value)
Builder	clearCheapestInsertionFirstSolutionNeighborsRatio ()
int	getCheapestInsertionFirstSolutionMinNeighbors ()
Builder	setCheapestInsertionFirstSolutionMinNeighbors (int value)
Builder	clearCheapestInsertionFirstSolutionMinNeighbors ()
double	getCheapestInsertionLsOperatorNeighborsRatio ()
Builder	setCheapestInsertionLsOperatorNeighborsRatio (double value)
Builder	clearCheapestInsertionLsOperatorNeighborsRatio ()
int	getCheapestInsertionLsOperatorMinNeighbors ()
Builder	setCheapestInsertionLsOperatorMinNeighbors (int value)
Builder	clearCheapestInsertionLsOperatorMinNeighbors ()
boolean	getCheapestInsertionFirstSolutionUseNeighborsRatioForInitialization ()
Builder	setCheapestInsertionFirstSolutionUseNeighborsRatioForInitialization (boolean value)
Builder	clearCheapestInsertionFirstSolutionUseNeighborsRatioForInitialization ()
boolean	getCheapestInsertionAddUnperformedEntries ()
Builder	setCheapestInsertionAddUnperformedEntries (boolean value)
Builder	clearCheapestInsertionAddUnperformedEntries ()
int	getLocalCheapestInsertionPickupDeliveryStrategyValue ()
Builder	setLocalCheapestInsertionPickupDeliveryStrategyValue (int value)
com.google.ortools.constraintsolver.RoutingSearchParameters.PairInsertionStrategy	getLocalCheapestInsertionPickupDeliveryStrategy ()
Builder	setLocalCheapestInsertionPickupDeliveryStrategy (com.google.ortools.constraintsolver.RoutingSearchParameters.PairInsertionStrategy value)
Builder	clearLocalCheapestInsertionPickupDeliveryStrategy ()
int	getLocalCheapestCostInsertionPickupDeliveryStrategyValue ()
Builder	setLocalCheapestCostInsertionPickupDeliveryStrategyValue (int value)
com.google.ortools.constraintsolver.RoutingSearchParameters.PairInsertionStrategy	getLocalCheapestCostInsertionPickupDeliveryStrategy ()
Builder	setLocalCheapestCostInsertionPickupDeliveryStrategy (com.google.ortools.constraintsolver.RoutingSearchParameters.PairInsertionStrategy value)
Builder	clearLocalCheapestCostInsertionPickupDeliveryStrategy ()
java.util.List< com.google.ortools.constraintsolver.RoutingSearchParameters.InsertionSortingProperty >	getLocalCheapestInsertionSortingPropertiesList ()
int	getLocalCheapestInsertionSortingPropertiesCount ()
com.google.ortools.constraintsolver.RoutingSearchParameters.InsertionSortingProperty	getLocalCheapestInsertionSortingProperties (int index)
Builder	setLocalCheapestInsertionSortingProperties (int index, com.google.ortools.constraintsolver.RoutingSearchParameters.InsertionSortingProperty value)
Builder	addLocalCheapestInsertionSortingProperties (com.google.ortools.constraintsolver.RoutingSearchParameters.InsertionSortingProperty value)
Builder	addAllLocalCheapestInsertionSortingProperties (java.lang.Iterable<? extends com.google.ortools.constraintsolver.RoutingSearchParameters.InsertionSortingProperty > values)
Builder	clearLocalCheapestInsertionSortingProperties ()
java.util.List< java.lang.Integer >	getLocalCheapestInsertionSortingPropertiesValueList ()
int	getLocalCheapestInsertionSortingPropertiesValue (int index)
Builder	setLocalCheapestInsertionSortingPropertiesValue (int index, int value)
Builder	addLocalCheapestInsertionSortingPropertiesValue (int value)
Builder	addAllLocalCheapestInsertionSortingPropertiesValue (java.lang.Iterable< java.lang.Integer > values)
boolean	getChristofidesUseMinimumMatching ()
Builder	setChristofidesUseMinimumMatching (boolean value)
Builder	clearChristofidesUseMinimumMatching ()
int	getFirstSolutionOptimizationPeriod ()
Builder	setFirstSolutionOptimizationPeriod (int value)
Builder	clearFirstSolutionOptimizationPeriod ()
boolean	hasLocalSearchOperators ()
com.google.ortools.constraintsolver.RoutingSearchParameters.LocalSearchNeighborhoodOperators	getLocalSearchOperators ()
Builder	setLocalSearchOperators (com.google.ortools.constraintsolver.RoutingSearchParameters.LocalSearchNeighborhoodOperators value)
Builder	setLocalSearchOperators (com.google.ortools.constraintsolver.RoutingSearchParameters.LocalSearchNeighborhoodOperators.Builder builderForValue)
Builder	mergeLocalSearchOperators (com.google.ortools.constraintsolver.RoutingSearchParameters.LocalSearchNeighborhoodOperators value)
Builder	clearLocalSearchOperators ()
com.google.ortools.constraintsolver.RoutingSearchParameters.LocalSearchNeighborhoodOperators.Builder	getLocalSearchOperatorsBuilder ()
com.google.ortools.constraintsolver.RoutingSearchParameters.LocalSearchNeighborhoodOperatorsOrBuilder	getLocalSearchOperatorsOrBuilder ()
double	getLsOperatorNeighborsRatio ()
Builder	setLsOperatorNeighborsRatio (double value)
Builder	clearLsOperatorNeighborsRatio ()
int	getLsOperatorMinNeighbors ()
Builder	setLsOperatorMinNeighbors (int value)
Builder	clearLsOperatorMinNeighbors ()
boolean	getUseMultiArmedBanditConcatenateOperators ()
Builder	setUseMultiArmedBanditConcatenateOperators (boolean value)
Builder	clearUseMultiArmedBanditConcatenateOperators ()
double	getMultiArmedBanditCompoundOperatorMemoryCoefficient ()
Builder	setMultiArmedBanditCompoundOperatorMemoryCoefficient (double value)
Builder	clearMultiArmedBanditCompoundOperatorMemoryCoefficient ()
double	getMultiArmedBanditCompoundOperatorExplorationCoefficient ()
Builder	setMultiArmedBanditCompoundOperatorExplorationCoefficient (double value)
Builder	clearMultiArmedBanditCompoundOperatorExplorationCoefficient ()
int	getMaxSwapActiveChainSize ()
Builder	setMaxSwapActiveChainSize (int value)
Builder	clearMaxSwapActiveChainSize ()
int	getRelocateExpensiveChainNumArcsToConsider ()
Builder	setRelocateExpensiveChainNumArcsToConsider (int value)
Builder	clearRelocateExpensiveChainNumArcsToConsider ()
int	getHeuristicExpensiveChainLnsNumArcsToConsider ()
Builder	setHeuristicExpensiveChainLnsNumArcsToConsider (int value)
Builder	clearHeuristicExpensiveChainLnsNumArcsToConsider ()
int	getHeuristicCloseNodesLnsNumNodes ()
Builder	setHeuristicCloseNodesLnsNumNodes (int value)
Builder	clearHeuristicCloseNodesLnsNumNodes ()
int	getLocalSearchMetaheuristicValue ()
Builder	setLocalSearchMetaheuristicValue (int value)
com.google.ortools.constraintsolver.LocalSearchMetaheuristic.Value	getLocalSearchMetaheuristic ()
Builder	setLocalSearchMetaheuristic (com.google.ortools.constraintsolver.LocalSearchMetaheuristic.Value value)
Builder	clearLocalSearchMetaheuristic ()
java.util.List< com.google.ortools.constraintsolver.LocalSearchMetaheuristic.Value >	getLocalSearchMetaheuristicsList ()
int	getLocalSearchMetaheuristicsCount ()
com.google.ortools.constraintsolver.LocalSearchMetaheuristic.Value	getLocalSearchMetaheuristics (int index)
Builder	setLocalSearchMetaheuristics (int index, com.google.ortools.constraintsolver.LocalSearchMetaheuristic.Value value)
Builder	addLocalSearchMetaheuristics (com.google.ortools.constraintsolver.LocalSearchMetaheuristic.Value value)
Builder	addAllLocalSearchMetaheuristics (java.lang.Iterable<? extends com.google.ortools.constraintsolver.LocalSearchMetaheuristic.Value > values)
Builder	clearLocalSearchMetaheuristics ()
java.util.List< java.lang.Integer >	getLocalSearchMetaheuristicsValueList ()
int	getLocalSearchMetaheuristicsValue (int index)
Builder	setLocalSearchMetaheuristicsValue (int index, int value)
Builder	addLocalSearchMetaheuristicsValue (int value)
Builder	addAllLocalSearchMetaheuristicsValue (java.lang.Iterable< java.lang.Integer > values)
int	getNumMaxLocalOptimaBeforeMetaheuristicSwitch ()
Builder	setNumMaxLocalOptimaBeforeMetaheuristicSwitch (int value)
Builder	clearNumMaxLocalOptimaBeforeMetaheuristicSwitch ()
double	getGuidedLocalSearchLambdaCoefficient ()
Builder	setGuidedLocalSearchLambdaCoefficient (double value)
Builder	clearGuidedLocalSearchLambdaCoefficient ()
boolean	getGuidedLocalSearchResetPenaltiesOnNewBestSolution ()
Builder	setGuidedLocalSearchResetPenaltiesOnNewBestSolution (boolean value)
Builder	clearGuidedLocalSearchResetPenaltiesOnNewBestSolution ()
boolean	getGuidedLocalSearchPenalizeWithVehicleClasses ()
Builder	setGuidedLocalSearchPenalizeWithVehicleClasses (boolean value)
Builder	clearGuidedLocalSearchPenalizeWithVehicleClasses ()
boolean	getUseGuidedLocalSearchPenaltiesInLocalSearchOperators ()
Builder	setUseGuidedLocalSearchPenaltiesInLocalSearchOperators (boolean value)
Builder	clearUseGuidedLocalSearchPenaltiesInLocalSearchOperators ()
boolean	getUseDepthFirstSearch ()
Builder	setUseDepthFirstSearch (boolean value)
Builder	clearUseDepthFirstSearch ()
int	getUseCpValue ()
Builder	setUseCpValue (int value)
com.google.ortools.util.OptionalBoolean	getUseCp ()
Builder	setUseCp (com.google.ortools.util.OptionalBoolean value)
Builder	clearUseCp ()
int	getUseCpSatValue ()
Builder	setUseCpSatValue (int value)
com.google.ortools.util.OptionalBoolean	getUseCpSat ()
Builder	setUseCpSat (com.google.ortools.util.OptionalBoolean value)
Builder	clearUseCpSat ()
int	getUseGeneralizedCpSatValue ()
Builder	setUseGeneralizedCpSatValue (int value)
com.google.ortools.util.OptionalBoolean	getUseGeneralizedCpSat ()
Builder	setUseGeneralizedCpSat (com.google.ortools.util.OptionalBoolean value)
Builder	clearUseGeneralizedCpSat ()
boolean	hasSatParameters ()
com.google.ortools.sat.SatParameters	getSatParameters ()
Builder	setSatParameters (com.google.ortools.sat.SatParameters value)
Builder	setSatParameters (com.google.ortools.sat.SatParameters.Builder builderForValue)
Builder	mergeSatParameters (com.google.ortools.sat.SatParameters value)
Builder	clearSatParameters ()
com.google.ortools.sat.SatParameters.Builder	getSatParametersBuilder ()
com.google.ortools.sat.SatParametersOrBuilder	getSatParametersOrBuilder ()
boolean	getReportIntermediateCpSatSolutions ()
Builder	setReportIntermediateCpSatSolutions (boolean value)
Builder	clearReportIntermediateCpSatSolutions ()
int	getFallbackToCpSatSizeThreshold ()
Builder	setFallbackToCpSatSizeThreshold (int value)
Builder	clearFallbackToCpSatSizeThreshold ()
int	getContinuousSchedulingSolverValue ()
Builder	setContinuousSchedulingSolverValue (int value)
com.google.ortools.constraintsolver.RoutingSearchParameters.SchedulingSolver	getContinuousSchedulingSolver ()
Builder	setContinuousSchedulingSolver (com.google.ortools.constraintsolver.RoutingSearchParameters.SchedulingSolver value)
Builder	clearContinuousSchedulingSolver ()
int	getMixedIntegerSchedulingSolverValue ()
Builder	setMixedIntegerSchedulingSolverValue (int value)
com.google.ortools.constraintsolver.RoutingSearchParameters.SchedulingSolver	getMixedIntegerSchedulingSolver ()
Builder	setMixedIntegerSchedulingSolver (com.google.ortools.constraintsolver.RoutingSearchParameters.SchedulingSolver value)
Builder	clearMixedIntegerSchedulingSolver ()
boolean	hasDisableSchedulingBewareThisMayDegradePerformance ()
boolean	getDisableSchedulingBewareThisMayDegradePerformance ()
Builder	setDisableSchedulingBewareThisMayDegradePerformance (boolean value)
Builder	clearDisableSchedulingBewareThisMayDegradePerformance ()
double	getOptimizationStep ()
Builder	setOptimizationStep (double value)
Builder	clearOptimizationStep ()
int	getNumberOfSolutionsToCollect ()
Builder	setNumberOfSolutionsToCollect (int value)
Builder	clearNumberOfSolutionsToCollect ()
long	getSolutionLimit ()
Builder	setSolutionLimit (long value)
Builder	clearSolutionLimit ()
boolean	hasTimeLimit ()
com.google.protobuf.Duration	getTimeLimit ()
Builder	setTimeLimit (com.google.protobuf.Duration value)
Builder	setTimeLimit (com.google.protobuf.Duration.Builder builderForValue)
Builder	mergeTimeLimit (com.google.protobuf.Duration value)
Builder	clearTimeLimit ()
com.google.protobuf.Duration.Builder	getTimeLimitBuilder ()
com.google.protobuf.DurationOrBuilder	getTimeLimitOrBuilder ()
boolean	hasLnsTimeLimit ()
com.google.protobuf.Duration	getLnsTimeLimit ()
Builder	setLnsTimeLimit (com.google.protobuf.Duration value)
Builder	setLnsTimeLimit (com.google.protobuf.Duration.Builder builderForValue)
Builder	mergeLnsTimeLimit (com.google.protobuf.Duration value)
Builder	clearLnsTimeLimit ()
com.google.protobuf.Duration.Builder	getLnsTimeLimitBuilder ()
com.google.protobuf.DurationOrBuilder	getLnsTimeLimitOrBuilder ()
double	getSecondaryLsTimeLimitRatio ()
Builder	setSecondaryLsTimeLimitRatio (double value)
Builder	clearSecondaryLsTimeLimitRatio ()
boolean	hasImprovementLimitParameters ()
com.google.ortools.constraintsolver.RoutingSearchParameters.ImprovementSearchLimitParameters	getImprovementLimitParameters ()
Builder	setImprovementLimitParameters (com.google.ortools.constraintsolver.RoutingSearchParameters.ImprovementSearchLimitParameters value)
Builder	setImprovementLimitParameters (com.google.ortools.constraintsolver.RoutingSearchParameters.ImprovementSearchLimitParameters.Builder builderForValue)
Builder	mergeImprovementLimitParameters (com.google.ortools.constraintsolver.RoutingSearchParameters.ImprovementSearchLimitParameters value)
Builder	clearImprovementLimitParameters ()
com.google.ortools.constraintsolver.RoutingSearchParameters.ImprovementSearchLimitParameters.Builder	getImprovementLimitParametersBuilder ()
com.google.ortools.constraintsolver.RoutingSearchParameters.ImprovementSearchLimitParametersOrBuilder	getImprovementLimitParametersOrBuilder ()
boolean	getUseFullPropagation ()
Builder	setUseFullPropagation (boolean value)
Builder	clearUseFullPropagation ()
boolean	getLogSearch ()
Builder	setLogSearch (boolean value)
Builder	clearLogSearch ()
double	getLogCostScalingFactor ()
Builder	setLogCostScalingFactor (double value)
Builder	clearLogCostScalingFactor ()
double	getLogCostOffset ()
Builder	setLogCostOffset (double value)
Builder	clearLogCostOffset ()
java.lang.String	getLogTag ()
com.google.protobuf.ByteString	getLogTagBytes ()
Builder	setLogTag (java.lang.String value)
Builder	clearLogTag ()
Builder	setLogTagBytes (com.google.protobuf.ByteString value)
boolean	getUseIteratedLocalSearch ()
Builder	setUseIteratedLocalSearch (boolean value)
Builder	clearUseIteratedLocalSearch ()
boolean	hasIteratedLocalSearchParameters ()
com.google.ortools.constraintsolver.IteratedLocalSearchParameters	getIteratedLocalSearchParameters ()
Builder	setIteratedLocalSearchParameters (com.google.ortools.constraintsolver.IteratedLocalSearchParameters value)
Builder	setIteratedLocalSearchParameters (com.google.ortools.constraintsolver.IteratedLocalSearchParameters.Builder builderForValue)
Builder	mergeIteratedLocalSearchParameters (com.google.ortools.constraintsolver.IteratedLocalSearchParameters value)
Builder	clearIteratedLocalSearchParameters ()
com.google.ortools.constraintsolver.IteratedLocalSearchParameters.Builder	getIteratedLocalSearchParametersBuilder ()
com.google.ortools.constraintsolver.IteratedLocalSearchParametersOrBuilder	getIteratedLocalSearchParametersOrBuilder ()

Static Public Member Functions
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor ()

Protected Member Functions
com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable ()

Member Function Documentation

◆ addAllLocalCheapestInsertionSortingProperties()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.addAllLocalCheapestInsertionSortingProperties ( java.lang.Iterable<? extends com.google.ortools.constraintsolver.RoutingSearchParameters.InsertionSortingProperty > values )

The properties used to sort insertion entries in the local cheapest
insertion heuristic, in *decreasing* order of priority. The properties
listed here are applied hierarchically, from highest to lowest priority.
When no properties are provided
(SORTING_PROPERTY_ALLOWED_VEHICLES, SORTING_PROPERTY_PENALTY)
is used by default.

repeated .operations_research.RoutingSearchParameters.InsertionSortingProperty local_cheapest_insertion_sorting_properties = 67;

Parameters

values The localCheapestInsertionSortingProperties to add.

Returns: This builder for chaining.

Definition at line 13009 of file RoutingSearchParameters.java.

◆ addAllLocalCheapestInsertionSortingPropertiesValue()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.addAllLocalCheapestInsertionSortingPropertiesValue ( java.lang.Iterable< java.lang.Integer > values )

The properties used to sort insertion entries in the local cheapest
insertion heuristic, in *decreasing* order of priority. The properties
listed here are applied hierarchically, from highest to lowest priority.
When no properties are provided
(SORTING_PROPERTY_ALLOWED_VEHICLES, SORTING_PROPERTY_PENALTY)
is used by default.

repeated .operations_research.RoutingSearchParameters.InsertionSortingProperty local_cheapest_insertion_sorting_properties = 67;

Parameters

values The enum numeric values on the wire for localCheapestInsertionSortingProperties to add.

Returns: This builder for chaining.

Definition at line 13128 of file RoutingSearchParameters.java.

◆ addAllLocalSearchMetaheuristics()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.addAllLocalSearchMetaheuristics ( java.lang.Iterable<? extends com.google.ortools.constraintsolver.LocalSearchMetaheuristic.Value > values )

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

values The localSearchMetaheuristics to add.

Returns: This builder for chaining.

Definition at line 13977 of file RoutingSearchParameters.java.

◆ addAllLocalSearchMetaheuristicsValue()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.addAllLocalSearchMetaheuristicsValue ( java.lang.Iterable< java.lang.Integer > values )

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

values The enum numeric values on the wire for localSearchMetaheuristics to add.

Returns: This builder for chaining.

Definition at line 14084 of file RoutingSearchParameters.java.

◆ addLocalCheapestInsertionSortingProperties()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.addLocalCheapestInsertionSortingProperties ( com.google.ortools.constraintsolver.RoutingSearchParameters.InsertionSortingProperty value )

The properties used to sort insertion entries in the local cheapest
insertion heuristic, in *decreasing* order of priority. The properties
listed here are applied hierarchically, from highest to lowest priority.
When no properties are provided
(SORTING_PROPERTY_ALLOWED_VEHICLES, SORTING_PROPERTY_PENALTY)
is used by default.

repeated .operations_research.RoutingSearchParameters.InsertionSortingProperty local_cheapest_insertion_sorting_properties = 67;

Parameters

value The localCheapestInsertionSortingProperties to add.

Returns: This builder for chaining.

Definition at line 12988 of file RoutingSearchParameters.java.

◆ addLocalCheapestInsertionSortingPropertiesValue()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.addLocalCheapestInsertionSortingPropertiesValue ( int value )

The properties used to sort insertion entries in the local cheapest
insertion heuristic, in *decreasing* order of priority. The properties
listed here are applied hierarchically, from highest to lowest priority.
When no properties are provided
(SORTING_PROPERTY_ALLOWED_VEHICLES, SORTING_PROPERTY_PENALTY)
is used by default.

repeated .operations_research.RoutingSearchParameters.InsertionSortingProperty local_cheapest_insertion_sorting_properties = 67;

Parameters

value The enum numeric value on the wire for localCheapestInsertionSortingProperties to add.

Returns: This builder for chaining.

Definition at line 13108 of file RoutingSearchParameters.java.

◆ addLocalSearchMetaheuristics()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.addLocalSearchMetaheuristics ( com.google.ortools.constraintsolver.LocalSearchMetaheuristic.Value value )

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

value The localSearchMetaheuristics to add.

Returns: This builder for chaining.

Definition at line 13958 of file RoutingSearchParameters.java.

◆ addLocalSearchMetaheuristicsValue()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.addLocalSearchMetaheuristicsValue ( int value )

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

value The enum numeric value on the wire for localSearchMetaheuristics to add.

Returns: This builder for chaining.

Definition at line 14066 of file RoutingSearchParameters.java.

◆ build()

com.google.ortools.constraintsolver.RoutingSearchParameters com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.build ( )

Definition at line 11252 of file RoutingSearchParameters.java.

◆ buildPartial()

com.google.ortools.constraintsolver.RoutingSearchParameters com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.buildPartial ( )

Definition at line 11261 of file RoutingSearchParameters.java.

◆ clear()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clear ( )

Definition at line 11150 of file RoutingSearchParameters.java.

◆ clearCheapestInsertionAddUnperformedEntries()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearCheapestInsertionAddUnperformedEntries ( )

Whether or not to consider entries making the nodes/pairs unperformed in
the GlobalCheapestInsertion heuristic.

bool cheapest_insertion_add_unperformed_entries = 40;

Returns: This builder for chaining.

Definition at line 12735 of file RoutingSearchParameters.java.

◆ clearCheapestInsertionFarthestSeedsRatio()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearCheapestInsertionFarthestSeedsRatio ( )

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: This builder for chaining.

Definition at line 12438 of file RoutingSearchParameters.java.

◆ clearCheapestInsertionFirstSolutionMinNeighbors()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearCheapestInsertionFirstSolutionMinNeighbors ( )

int32 cheapest_insertion_first_solution_min_neighbors = 44;

Returns: This builder for chaining.

Definition at line 12556 of file RoutingSearchParameters.java.

◆ clearCheapestInsertionFirstSolutionNeighborsRatio()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearCheapestInsertionFirstSolutionNeighborsRatio ( )

Ratio (in ]0, 1]) of closest non start/end nodes to consider as neighbors
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.
The neighborhood ratio is coupled with the corresponding min_neighbors
integer, indicating the minimum number of neighbors to consider for each
node:
num_closest_neighbors =
max(min_neighbors, neighbors_ratio * NUM_NON_START_END_NODES)
This minimum number of neighbors must be greater or equal to 1, its
default value.

Neighbors ratio and minimum number of neighbors for the first solution
heuristic.

double cheapest_insertion_first_solution_neighbors_ratio = 21;

Returns: This builder for chaining.

Definition at line 12524 of file RoutingSearchParameters.java.

◆ clearCheapestInsertionFirstSolutionUseNeighborsRatioForInitialization()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearCheapestInsertionFirstSolutionUseNeighborsRatioForInitialization ( )

Whether or not to only consider closest neighbors when initializing the
assignment for the first solution.

bool cheapest_insertion_first_solution_use_neighbors_ratio_for_initialization = 46;

Returns: This builder for chaining.

Definition at line 12688 of file RoutingSearchParameters.java.

◆ clearCheapestInsertionLsOperatorMinNeighbors()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearCheapestInsertionLsOperatorMinNeighbors ( )

int32 cheapest_insertion_ls_operator_min_neighbors = 45;

Returns: This builder for chaining.

Definition at line 12641 of file RoutingSearchParameters.java.

◆ clearCheapestInsertionLsOperatorNeighborsRatio()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearCheapestInsertionLsOperatorNeighborsRatio ( )

Neighbors ratio and minimum number of neighbors 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: This builder for chaining.

Definition at line 12609 of file RoutingSearchParameters.java.

◆ clearChristofidesUseMinimumMatching()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearChristofidesUseMinimumMatching ( )

If true use minimum matching instead of minimal matching in the
Christofides algorithm.

bool christofides_use_minimum_matching = 30;

Returns: This builder for chaining.

Definition at line 13178 of file RoutingSearchParameters.java.

◆ clearContinuousSchedulingSolver()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearContinuousSchedulingSolver ( )

.operations_research.RoutingSearchParameters.SchedulingSolver continuous_scheduling_solver = 33;

Returns: This builder for chaining.

Definition at line 14933 of file RoutingSearchParameters.java.

◆ clearDisableSchedulingBewareThisMayDegradePerformance()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearDisableSchedulingBewareThisMayDegradePerformance ( )

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: This builder for chaining.

Definition at line 15044 of file RoutingSearchParameters.java.

◆ clearFallbackToCpSatSizeThreshold()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearFallbackToCpSatSizeThreshold ( )

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: This builder for chaining.

Definition at line 14882 of file RoutingSearchParameters.java.

◆ clearFirstSolutionOptimizationPeriod()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearFirstSolutionOptimizationPeriod ( )

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: This builder for chaining.

Definition at line 13240 of file RoutingSearchParameters.java.

◆ clearFirstSolutionStrategy()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearFirstSolutionStrategy ( )

First solution strategies, used as starting point of local search.

.operations_research.FirstSolutionStrategy.Value first_solution_strategy = 1;

Returns: This builder for chaining.

Definition at line 12123 of file RoutingSearchParameters.java.

◆ clearGuidedLocalSearchLambdaCoefficient()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearGuidedLocalSearchLambdaCoefficient ( )

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: This builder for chaining.

Definition at line 14172 of file RoutingSearchParameters.java.

◆ clearGuidedLocalSearchPenalizeWithVehicleClasses()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearGuidedLocalSearchPenalizeWithVehicleClasses ( )

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: This builder for chaining.

Definition at line 14269 of file RoutingSearchParameters.java.

◆ clearGuidedLocalSearchResetPenaltiesOnNewBestSolution()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearGuidedLocalSearchResetPenaltiesOnNewBestSolution ( )

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: This builder for chaining.

Definition at line 14219 of file RoutingSearchParameters.java.

◆ clearHeuristicCloseNodesLnsNumNodes()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearHeuristicCloseNodesLnsNumNodes ( )

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: This builder for chaining.

Definition at line 13796 of file RoutingSearchParameters.java.

◆ clearHeuristicExpensiveChainLnsNumArcsToConsider()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearHeuristicExpensiveChainLnsNumArcsToConsider ( )

Number of expensive arcs to consider cutting in the
FilteredHeuristicExpensiveChainLNSOperator operator.

int32 heuristic_expensive_chain_lns_num_arcs_to_consider = 32;

Returns: This builder for chaining.

Definition at line 13749 of file RoutingSearchParameters.java.

◆ clearImprovementLimitParameters()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearImprovementLimitParameters ( )

The improvement search limit is added to the solver if the following
parameters are set.

.operations_research.RoutingSearchParameters.ImprovementSearchLimitParameters improvement_limit_parameters = 37;

Definition at line 15685 of file RoutingSearchParameters.java.

◆ clearIteratedLocalSearchParameters()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearIteratedLocalSearchParameters ( )

Iterated Local Search parameters.

.operations_research.IteratedLocalSearchParameters iterated_local_search_parameters = 60;

Definition at line 16219 of file RoutingSearchParameters.java.

◆ clearLnsTimeLimit()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearLnsTimeLimit ( )

Limit to the time spent in the completion search for each local search
neighbor.

.google.protobuf.Duration lns_time_limit = 10;

Definition at line 15460 of file RoutingSearchParameters.java.

◆ clearLocalCheapestCostInsertionPickupDeliveryStrategy()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearLocalCheapestCostInsertionPickupDeliveryStrategy ( )

Choice of insertion strategy for pickup/delivery pairs, used in local
cheapest cost insertion, both first solution heuristic and LNS.

.operations_research.RoutingSearchParameters.PairInsertionStrategy local_cheapest_cost_insertion_pickup_delivery_strategy = 55;

Returns: This builder for chaining.

Definition at line 12887 of file RoutingSearchParameters.java.

◆ clearLocalCheapestInsertionPickupDeliveryStrategy()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearLocalCheapestInsertionPickupDeliveryStrategy ( )

Choice of insertion strategy for pickup/delivery pairs, used in local
cheapest insertion, both first solution heuristic and LNS.

.operations_research.RoutingSearchParameters.PairInsertionStrategy local_cheapest_insertion_pickup_delivery_strategy = 49;

Returns: This builder for chaining.

Definition at line 12811 of file RoutingSearchParameters.java.

◆ clearLocalCheapestInsertionSortingProperties()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearLocalCheapestInsertionSortingProperties ( )

The properties used to sort insertion entries in the local cheapest
insertion heuristic, in *decreasing* order of priority. The properties
listed here are applied hierarchically, from highest to lowest priority.
When no properties are provided
(SORTING_PROPERTY_ALLOWED_VEHICLES, SORTING_PROPERTY_PENALTY)
is used by default.

repeated .operations_research.RoutingSearchParameters.InsertionSortingProperty local_cheapest_insertion_sorting_properties = 67;

Returns: This builder for chaining.

Definition at line 13031 of file RoutingSearchParameters.java.

◆ clearLocalSearchMetaheuristic()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearLocalSearchMetaheuristic ( )

Local search metaheuristics used to guide the search.

.operations_research.LocalSearchMetaheuristic.Value local_search_metaheuristic = 4;

Returns: This builder for chaining.

Definition at line 13867 of file RoutingSearchParameters.java.

◆ clearLocalSearchMetaheuristics()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearLocalSearchMetaheuristics ( )

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: This builder for chaining.

Definition at line 13997 of file RoutingSearchParameters.java.

◆ clearLocalSearchOperators()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearLocalSearchOperators ( )

.operations_research.RoutingSearchParameters.LocalSearchNeighborhoodOperators local_search_operators = 3;

Definition at line 13322 of file RoutingSearchParameters.java.

◆ clearLogCostOffset()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearLogCostOffset ( )

double log_cost_offset = 29;

Returns: This builder for chaining.

Definition at line 15969 of file RoutingSearchParameters.java.

◆ clearLogCostScalingFactor()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearLogCostScalingFactor ( )

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: This builder for chaining.

Definition at line 15937 of file RoutingSearchParameters.java.

◆ clearLogSearch()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearLogSearch ( )

--- 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: This builder for chaining.

Definition at line 15890 of file RoutingSearchParameters.java.

◆ clearLogTag()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearLogTag ( )

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: This builder for chaining.

Definition at line 16047 of file RoutingSearchParameters.java.

◆ clearLsOperatorMinNeighbors()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearLsOperatorMinNeighbors ( )

int32 ls_operator_min_neighbors = 54;

Returns: This builder for chaining.

Definition at line 13443 of file RoutingSearchParameters.java.

◆ clearLsOperatorNeighborsRatio()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearLsOperatorNeighborsRatio ( )

Neighbors ratio and minimum number of neighbors considered in local
search operators (see cheapest_insertion_first_solution_neighbors_ratio
and cheapest_insertion_first_solution_min_neighbors for more information).

double ls_operator_neighbors_ratio = 53;

Returns: This builder for chaining.

Definition at line 13411 of file RoutingSearchParameters.java.

◆ clearMaxSwapActiveChainSize()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearMaxSwapActiveChainSize ( )

Maximum size of the chain to make inactive in SwapActiveChainOperator.

int32 max_swap_active_chain_size = 66;

Returns: This builder for chaining.

Definition at line 13640 of file RoutingSearchParameters.java.

◆ clearMixedIntegerSchedulingSolver()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearMixedIntegerSchedulingSolver ( )

.operations_research.RoutingSearchParameters.SchedulingSolver mixed_integer_scheduling_solver = 34;

Returns: This builder for chaining.

Definition at line 14984 of file RoutingSearchParameters.java.

◆ clearMultiArmedBanditCompoundOperatorExplorationCoefficient()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearMultiArmedBanditCompoundOperatorExplorationCoefficient ( )

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: This builder for chaining.

Definition at line 13596 of file RoutingSearchParameters.java.

◆ clearMultiArmedBanditCompoundOperatorMemoryCoefficient()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearMultiArmedBanditCompoundOperatorMemoryCoefficient ( )

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: This builder for chaining.

Definition at line 13546 of file RoutingSearchParameters.java.

◆ clearNumberOfSolutionsToCollect()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearNumberOfSolutionsToCollect ( )

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: This builder for chaining.

Definition at line 15141 of file RoutingSearchParameters.java.

◆ clearNumMaxLocalOptimaBeforeMetaheuristicSwitch()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearNumMaxLocalOptimaBeforeMetaheuristicSwitch ( )

int32 num_max_local_optima_before_metaheuristic_switch = 64;

Returns: This builder for chaining.

Definition at line 14119 of file RoutingSearchParameters.java.

◆ clearOptimizationStep()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearOptimizationStep ( )

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: This builder for chaining.

Definition at line 15094 of file RoutingSearchParameters.java.

◆ clearRelocateExpensiveChainNumArcsToConsider()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearRelocateExpensiveChainNumArcsToConsider ( )

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: This builder for chaining.

Definition at line 13702 of file RoutingSearchParameters.java.

◆ clearReportIntermediateCpSatSolutions()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearReportIntermediateCpSatSolutions ( )

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: This builder for chaining.

Definition at line 14835 of file RoutingSearchParameters.java.

◆ clearSatParameters()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearSatParameters ( )

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;

Definition at line 14734 of file RoutingSearchParameters.java.

◆ clearSavingsAddReverseArcs()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearSavingsAddReverseArcs ( )

Add savings related to reverse arcs when finding the nearest neighbors
of the nodes.

bool savings_add_reverse_arcs = 15;

Returns: This builder for chaining.

Definition at line 12332 of file RoutingSearchParameters.java.

◆ clearSavingsArcCoefficient()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearSavingsArcCoefficient ( )

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: This builder for chaining.

Definition at line 12388 of file RoutingSearchParameters.java.

◆ clearSavingsMaxMemoryUsageBytes()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearSavingsMaxMemoryUsageBytes ( )

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: This builder for chaining.

Definition at line 12285 of file RoutingSearchParameters.java.

◆ clearSavingsNeighborsRatio()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearSavingsNeighborsRatio ( )

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: This builder for chaining.

Definition at line 12226 of file RoutingSearchParameters.java.

◆ clearSecondaryLsTimeLimitRatio()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearSecondaryLsTimeLimitRatio ( )

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: This builder for chaining.

Definition at line 15573 of file RoutingSearchParameters.java.

◆ clearSolutionLimit()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearSolutionLimit ( )

-- Search limits --
Limit to the number of solutions generated during the search. 0 means
"unspecified".

int64 solution_limit = 8;

Returns: This builder for chaining.

Definition at line 15191 of file RoutingSearchParameters.java.

◆ clearTimeLimit()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearTimeLimit ( )

Limit to the time spent in the search.

.google.protobuf.Duration time_limit = 9;

Definition at line 15297 of file RoutingSearchParameters.java.

◆ clearUseCp()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearUseCp ( )

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: This builder for chaining.

Definition at line 14450 of file RoutingSearchParameters.java.

◆ clearUseCpSat()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearUseCpSat ( )

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: This builder for chaining.

Definition at line 14536 of file RoutingSearchParameters.java.

◆ clearUseDepthFirstSearch()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearUseDepthFirstSearch ( )

--- 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: This builder for chaining.

Definition at line 14369 of file RoutingSearchParameters.java.

◆ clearUseFullPropagation()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearUseFullPropagation ( )

--- 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: This builder for chaining.

Definition at line 15810 of file RoutingSearchParameters.java.

◆ clearUseGeneralizedCpSat()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearUseGeneralizedCpSat ( )

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: This builder for chaining.

Definition at line 14622 of file RoutingSearchParameters.java.

◆ clearUseGuidedLocalSearchPenaltiesInLocalSearchOperators()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearUseGuidedLocalSearchPenaltiesInLocalSearchOperators ( )

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: This builder for chaining.

Definition at line 14316 of file RoutingSearchParameters.java.

◆ clearUseIteratedLocalSearch()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearUseIteratedLocalSearch ( )

Whether the solver should use an Iterated Local Search approach to solve
the problem.

bool use_iterated_local_search = 58;

Returns: This builder for chaining.

Definition at line 16113 of file RoutingSearchParameters.java.

◆ clearUseMultiArmedBanditConcatenateOperators()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearUseMultiArmedBanditConcatenateOperators ( )

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: This builder for chaining.

Definition at line 13493 of file RoutingSearchParameters.java.

◆ clearUseUnfilteredFirstSolutionStrategy()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.clearUseUnfilteredFirstSolutionStrategy ( )

--- 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: This builder for chaining.

Definition at line 12176 of file RoutingSearchParameters.java.

◆ getCheapestInsertionAddUnperformedEntries()

boolean com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getCheapestInsertionAddUnperformedEntries ( )

Whether or not to consider entries making the nodes/pairs unperformed in
the GlobalCheapestInsertion heuristic.

bool cheapest_insertion_add_unperformed_entries = 40;

Returns: The cheapestInsertionAddUnperformedEntries.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 12706 of file RoutingSearchParameters.java.

◆ getCheapestInsertionFarthestSeedsRatio()

double com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 12407 of file RoutingSearchParameters.java.

◆ getCheapestInsertionFirstSolutionMinNeighbors()

int com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getCheapestInsertionFirstSolutionMinNeighbors ( )

int32 cheapest_insertion_first_solution_min_neighbors = 44;

Returns: The cheapestInsertionFirstSolutionMinNeighbors.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 12537 of file RoutingSearchParameters.java.

◆ getCheapestInsertionFirstSolutionNeighborsRatio()

double com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getCheapestInsertionFirstSolutionNeighborsRatio ( )

Ratio (in ]0, 1]) of closest non start/end nodes to consider as neighbors
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.
The neighborhood ratio is coupled with the corresponding min_neighbors
integer, indicating the minimum number of neighbors to consider for each
node:
num_closest_neighbors =
max(min_neighbors, neighbors_ratio * NUM_NON_START_END_NODES)
This minimum number of neighbors must be greater or equal to 1, its
default value.

Neighbors ratio and minimum number of neighbors for the first solution
heuristic.

double cheapest_insertion_first_solution_neighbors_ratio = 21;

Returns: The cheapestInsertionFirstSolutionNeighborsRatio.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 12469 of file RoutingSearchParameters.java.

◆ getCheapestInsertionFirstSolutionUseNeighborsRatioForInitialization()

boolean com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getCheapestInsertionFirstSolutionUseNeighborsRatioForInitialization ( )

Whether or not to only consider closest neighbors when initializing the
assignment for the first solution.

bool cheapest_insertion_first_solution_use_neighbors_ratio_for_initialization = 46;

Returns: The cheapestInsertionFirstSolutionUseNeighborsRatioForInitialization.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 12659 of file RoutingSearchParameters.java.

◆ getCheapestInsertionLsOperatorMinNeighbors()

int com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getCheapestInsertionLsOperatorMinNeighbors ( )

int32 cheapest_insertion_ls_operator_min_neighbors = 45;

Returns: The cheapestInsertionLsOperatorMinNeighbors.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 12622 of file RoutingSearchParameters.java.

◆ getCheapestInsertionLsOperatorNeighborsRatio()

double com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getCheapestInsertionLsOperatorNeighborsRatio ( )

Neighbors ratio and minimum number of neighbors 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 com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 12576 of file RoutingSearchParameters.java.

◆ getChristofidesUseMinimumMatching()

boolean com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getChristofidesUseMinimumMatching ( )

If true use minimum matching instead of minimal matching in the
Christofides algorithm.

bool christofides_use_minimum_matching = 30;

Returns: The christofidesUseMinimumMatching.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 13149 of file RoutingSearchParameters.java.

◆ getContinuousSchedulingSolver()

com.google.ortools.constraintsolver.RoutingSearchParameters.SchedulingSolver com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getContinuousSchedulingSolver ( )

.operations_research.RoutingSearchParameters.SchedulingSolver continuous_scheduling_solver = 33;

Returns: The continuousSchedulingSolver.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 14913 of file RoutingSearchParameters.java.

◆ getContinuousSchedulingSolverValue()

int com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getContinuousSchedulingSolverValue ( )

.operations_research.RoutingSearchParameters.SchedulingSolver continuous_scheduling_solver = 33;

Returns: The enum numeric value on the wire for continuousSchedulingSolver.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 14894 of file RoutingSearchParameters.java.

◆ getDefaultInstanceForType()

com.google.ortools.constraintsolver.RoutingSearchParameters com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getDefaultInstanceForType ( )

Definition at line 11247 of file RoutingSearchParameters.java.

◆ getDescriptor()

final com.google.protobuf.Descriptors.Descriptor com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getDescriptor ( )

static

Definition at line 11116 of file RoutingSearchParameters.java.

◆ getDescriptorForType()

com.google.protobuf.Descriptors.Descriptor com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getDescriptorForType ( )

Definition at line 11242 of file RoutingSearchParameters.java.

◆ getDisableSchedulingBewareThisMayDegradePerformance()

boolean com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 15015 of file RoutingSearchParameters.java.

◆ getFallbackToCpSatSizeThreshold()

int com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 14853 of file RoutingSearchParameters.java.

◆ getFirstSolutionOptimizationPeriod()

int com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 13201 of file RoutingSearchParameters.java.

◆ getFirstSolutionStrategy()

com.google.ortools.constraintsolver.FirstSolutionStrategy.Value com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getFirstSolutionStrategy ( )

First solution strategies, used as starting point of local search.

.operations_research.FirstSolutionStrategy.Value first_solution_strategy = 1;

Returns: The firstSolutionStrategy.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 12095 of file RoutingSearchParameters.java.

◆ getFirstSolutionStrategyValue()

int com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 12068 of file RoutingSearchParameters.java.

◆ getGuidedLocalSearchLambdaCoefficient()

double com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 14139 of file RoutingSearchParameters.java.

◆ getGuidedLocalSearchPenalizeWithVehicleClasses()

boolean com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 14238 of file RoutingSearchParameters.java.

◆ getGuidedLocalSearchResetPenaltiesOnNewBestSolution()

boolean com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 14190 of file RoutingSearchParameters.java.

◆ getHeuristicCloseNodesLnsNumNodes()

int com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 13767 of file RoutingSearchParameters.java.

◆ getHeuristicExpensiveChainLnsNumArcsToConsider()

int com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 13720 of file RoutingSearchParameters.java.

◆ getImprovementLimitParameters()

com.google.ortools.constraintsolver.RoutingSearchParameters.ImprovementSearchLimitParameters com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 15604 of file RoutingSearchParameters.java.

◆ getImprovementLimitParametersBuilder()

com.google.ortools.constraintsolver.RoutingSearchParameters.ImprovementSearchLimitParameters.Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getImprovementLimitParametersBuilder ( )

The improvement search limit is added to the solver if the following
parameters are set.

.operations_research.RoutingSearchParameters.ImprovementSearchLimitParameters improvement_limit_parameters = 37;

Definition at line 15703 of file RoutingSearchParameters.java.

◆ getImprovementLimitParametersOrBuilder()

com.google.ortools.constraintsolver.RoutingSearchParameters.ImprovementSearchLimitParametersOrBuilder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getImprovementLimitParametersOrBuilder ( )

The improvement search limit is added to the solver if the following
parameters are set.

.operations_research.RoutingSearchParameters.ImprovementSearchLimitParameters improvement_limit_parameters = 37;

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 15716 of file RoutingSearchParameters.java.

◆ getIteratedLocalSearchParameters()

com.google.ortools.constraintsolver.IteratedLocalSearchParameters com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getIteratedLocalSearchParameters ( )

Iterated Local Search parameters.

.operations_research.IteratedLocalSearchParameters iterated_local_search_parameters = 60;

Returns: The iteratedLocalSearchParameters.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 16142 of file RoutingSearchParameters.java.

◆ getIteratedLocalSearchParametersBuilder()

com.google.ortools.constraintsolver.IteratedLocalSearchParameters.Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getIteratedLocalSearchParametersBuilder ( )

Iterated Local Search parameters.

.operations_research.IteratedLocalSearchParameters iterated_local_search_parameters = 60;

Definition at line 16236 of file RoutingSearchParameters.java.

◆ getIteratedLocalSearchParametersOrBuilder()

com.google.ortools.constraintsolver.IteratedLocalSearchParametersOrBuilder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getIteratedLocalSearchParametersOrBuilder ( )

Iterated Local Search parameters.

.operations_research.IteratedLocalSearchParameters iterated_local_search_parameters = 60;

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 16248 of file RoutingSearchParameters.java.

◆ getLnsTimeLimit()

com.google.protobuf.Duration com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 15379 of file RoutingSearchParameters.java.

◆ getLnsTimeLimitBuilder()

com.google.protobuf.Duration.Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getLnsTimeLimitBuilder ( )

Limit to the time spent in the completion search for each local search
neighbor.

.google.protobuf.Duration lns_time_limit = 10;

Definition at line 15478 of file RoutingSearchParameters.java.

◆ getLnsTimeLimitOrBuilder()

com.google.protobuf.DurationOrBuilder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getLnsTimeLimitOrBuilder ( )

Limit to the time spent in the completion search for each local search
neighbor.

.google.protobuf.Duration lns_time_limit = 10;

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 15491 of file RoutingSearchParameters.java.

◆ getLocalCheapestCostInsertionPickupDeliveryStrategy()

com.google.ortools.constraintsolver.RoutingSearchParameters.PairInsertionStrategy com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getLocalCheapestCostInsertionPickupDeliveryStrategy ( )

Choice of insertion strategy for pickup/delivery pairs, used in local
cheapest cost insertion, both first solution heuristic and LNS.

.operations_research.RoutingSearchParameters.PairInsertionStrategy local_cheapest_cost_insertion_pickup_delivery_strategy = 55;

Returns: The localCheapestCostInsertionPickupDeliveryStrategy.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 12857 of file RoutingSearchParameters.java.

◆ getLocalCheapestCostInsertionPickupDeliveryStrategyValue()

int com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getLocalCheapestCostInsertionPickupDeliveryStrategyValue ( )

Choice of insertion strategy for pickup/delivery pairs, used in local
cheapest cost insertion, both first solution heuristic and LNS.

.operations_research.RoutingSearchParameters.PairInsertionStrategy local_cheapest_cost_insertion_pickup_delivery_strategy = 55;

Returns: The enum numeric value on the wire for localCheapestCostInsertionPickupDeliveryStrategy.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 12828 of file RoutingSearchParameters.java.

◆ getLocalCheapestInsertionPickupDeliveryStrategy()

com.google.ortools.constraintsolver.RoutingSearchParameters.PairInsertionStrategy com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getLocalCheapestInsertionPickupDeliveryStrategy ( )

Choice of insertion strategy for pickup/delivery pairs, used in local
cheapest insertion, both first solution heuristic and LNS.

.operations_research.RoutingSearchParameters.PairInsertionStrategy local_cheapest_insertion_pickup_delivery_strategy = 49;

Returns: The localCheapestInsertionPickupDeliveryStrategy.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 12781 of file RoutingSearchParameters.java.

◆ getLocalCheapestInsertionPickupDeliveryStrategyValue()

int com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getLocalCheapestInsertionPickupDeliveryStrategyValue ( )

Choice of insertion strategy for pickup/delivery pairs, used in local
cheapest insertion, both first solution heuristic and LNS.

.operations_research.RoutingSearchParameters.PairInsertionStrategy local_cheapest_insertion_pickup_delivery_strategy = 49;

Returns: The enum numeric value on the wire for localCheapestInsertionPickupDeliveryStrategy.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 12752 of file RoutingSearchParameters.java.

◆ getLocalCheapestInsertionSortingProperties()

com.google.ortools.constraintsolver.RoutingSearchParameters.InsertionSortingProperty com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getLocalCheapestInsertionSortingProperties ( int index )

The properties used to sort insertion entries in the local cheapest
insertion heuristic, in *decreasing* order of priority. The properties
listed here are applied hierarchically, from highest to lowest priority.
When no properties are provided
(SORTING_PROPERTY_ALLOWED_VEHICLES, SORTING_PROPERTY_PENALTY)
is used by default.

repeated .operations_research.RoutingSearchParameters.InsertionSortingProperty local_cheapest_insertion_sorting_properties = 67;

Parameters

index The index of the element to return.

Returns: The localCheapestInsertionSortingProperties at the given index.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 12948 of file RoutingSearchParameters.java.

◆ getLocalCheapestInsertionSortingPropertiesCount()

int com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getLocalCheapestInsertionSortingPropertiesCount ( )

The properties used to sort insertion entries in the local cheapest
insertion heuristic, in *decreasing* order of priority. The properties
listed here are applied hierarchically, from highest to lowest priority.
When no properties are provided
(SORTING_PROPERTY_ALLOWED_VEHICLES, SORTING_PROPERTY_PENALTY)
is used by default.

repeated .operations_research.RoutingSearchParameters.InsertionSortingProperty local_cheapest_insertion_sorting_properties = 67;

Returns: The count of localCheapestInsertionSortingProperties.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 12931 of file RoutingSearchParameters.java.

◆ getLocalCheapestInsertionSortingPropertiesList()

java.util.List< com.google.ortools.constraintsolver.RoutingSearchParameters.InsertionSortingProperty > com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getLocalCheapestInsertionSortingPropertiesList ( )

The properties used to sort insertion entries in the local cheapest
insertion heuristic, in *decreasing* order of priority. The properties
listed here are applied hierarchically, from highest to lowest priority.
When no properties are provided
(SORTING_PROPERTY_ALLOWED_VEHICLES, SORTING_PROPERTY_PENALTY)
is used by default.

repeated .operations_research.RoutingSearchParameters.InsertionSortingProperty local_cheapest_insertion_sorting_properties = 67;

Returns: A list containing the localCheapestInsertionSortingProperties.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 12914 of file RoutingSearchParameters.java.

◆ getLocalCheapestInsertionSortingPropertiesValue()

int com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getLocalCheapestInsertionSortingPropertiesValue ( int index )

The properties used to sort insertion entries in the local cheapest
insertion heuristic, in *decreasing* order of priority. The properties
listed here are applied hierarchically, from highest to lowest priority.
When no properties are provided
(SORTING_PROPERTY_ALLOWED_VEHICLES, SORTING_PROPERTY_PENALTY)
is used by default.

repeated .operations_research.RoutingSearchParameters.InsertionSortingProperty local_cheapest_insertion_sorting_properties = 67;

Parameters

index The index of the value to return.

Returns: The enum numeric value on the wire of localCheapestInsertionSortingProperties at the given index.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 13069 of file RoutingSearchParameters.java.

◆ getLocalCheapestInsertionSortingPropertiesValueList()

java.util.List< java.lang.Integer > com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getLocalCheapestInsertionSortingPropertiesValueList ( )

The properties used to sort insertion entries in the local cheapest
insertion heuristic, in *decreasing* order of priority. The properties
listed here are applied hierarchically, from highest to lowest priority.
When no properties are provided
(SORTING_PROPERTY_ALLOWED_VEHICLES, SORTING_PROPERTY_PENALTY)
is used by default.

repeated .operations_research.RoutingSearchParameters.InsertionSortingProperty local_cheapest_insertion_sorting_properties = 67;

Returns: A list containing the enum numeric values on the wire for localCheapestInsertionSortingProperties.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 13051 of file RoutingSearchParameters.java.

◆ getLocalSearchMetaheuristic()

com.google.ortools.constraintsolver.LocalSearchMetaheuristic.Value com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getLocalSearchMetaheuristic ( )

Local search metaheuristics used to guide the search.

.operations_research.LocalSearchMetaheuristic.Value local_search_metaheuristic = 4;

Returns: The localSearchMetaheuristic.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 13839 of file RoutingSearchParameters.java.

◆ getLocalSearchMetaheuristics()

com.google.ortools.constraintsolver.LocalSearchMetaheuristic.Value com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getLocalSearchMetaheuristics ( 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 element to return.

Returns: The localSearchMetaheuristics at the given index.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 13922 of file RoutingSearchParameters.java.

◆ getLocalSearchMetaheuristicsCount()

int com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 13907 of file RoutingSearchParameters.java.

◆ getLocalSearchMetaheuristicsList()

java.util.List< com.google.ortools.constraintsolver.LocalSearchMetaheuristic.Value > com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 13892 of file RoutingSearchParameters.java.

◆ getLocalSearchMetaheuristicsValue()

int com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 14031 of file RoutingSearchParameters.java.

◆ getLocalSearchMetaheuristicsValueList()

java.util.List< java.lang.Integer > com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 14015 of file RoutingSearchParameters.java.

◆ getLocalSearchMetaheuristicValue()

int com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 13812 of file RoutingSearchParameters.java.

◆ getLocalSearchOperators()

com.google.ortools.constraintsolver.RoutingSearchParameters.LocalSearchNeighborhoodOperators com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getLocalSearchOperators ( )

.operations_research.RoutingSearchParameters.LocalSearchNeighborhoodOperators local_search_operators = 3;

Returns: The localSearchOperators.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 13261 of file RoutingSearchParameters.java.

◆ getLocalSearchOperatorsBuilder()

com.google.ortools.constraintsolver.RoutingSearchParameters.LocalSearchNeighborhoodOperators.Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getLocalSearchOperatorsBuilder ( )

.operations_research.RoutingSearchParameters.LocalSearchNeighborhoodOperators local_search_operators = 3;

Definition at line 13335 of file RoutingSearchParameters.java.

◆ getLocalSearchOperatorsOrBuilder()

com.google.ortools.constraintsolver.RoutingSearchParameters.LocalSearchNeighborhoodOperatorsOrBuilder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getLocalSearchOperatorsOrBuilder ( )

.operations_research.RoutingSearchParameters.LocalSearchNeighborhoodOperators local_search_operators = 3;

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 13343 of file RoutingSearchParameters.java.

◆ getLogCostOffset()

double com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getLogCostOffset ( )

double log_cost_offset = 29;

Returns: The logCostOffset.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 15950 of file RoutingSearchParameters.java.

◆ getLogCostScalingFactor()

double com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 15908 of file RoutingSearchParameters.java.

◆ getLogSearch()

boolean com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 15839 of file RoutingSearchParameters.java.

◆ getLogTag()

java.lang.String com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 15986 of file RoutingSearchParameters.java.

◆ getLogTagBytes()

com.google.protobuf.ByteString com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 16008 of file RoutingSearchParameters.java.

◆ getLsOperatorMinNeighbors()

int com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getLsOperatorMinNeighbors ( )

int32 ls_operator_min_neighbors = 54;

Returns: The lsOperatorMinNeighbors.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 13424 of file RoutingSearchParameters.java.

◆ getLsOperatorNeighborsRatio()

double com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getLsOperatorNeighborsRatio ( )

Neighbors ratio and minimum number of neighbors considered in local
search operators (see cheapest_insertion_first_solution_neighbors_ratio
and cheapest_insertion_first_solution_min_neighbors for more information).

double ls_operator_neighbors_ratio = 53;

Returns: The lsOperatorNeighborsRatio.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 13380 of file RoutingSearchParameters.java.

◆ getMaxSwapActiveChainSize()

int com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getMaxSwapActiveChainSize ( )

Maximum size of the chain to make inactive in SwapActiveChainOperator.

int32 max_swap_active_chain_size = 66;

Returns: The maxSwapActiveChainSize.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 13613 of file RoutingSearchParameters.java.

◆ getMixedIntegerSchedulingSolver()

com.google.ortools.constraintsolver.RoutingSearchParameters.SchedulingSolver com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getMixedIntegerSchedulingSolver ( )

.operations_research.RoutingSearchParameters.SchedulingSolver mixed_integer_scheduling_solver = 34;

Returns: The mixedIntegerSchedulingSolver.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 14964 of file RoutingSearchParameters.java.

◆ getMixedIntegerSchedulingSolverValue()

int com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getMixedIntegerSchedulingSolverValue ( )

.operations_research.RoutingSearchParameters.SchedulingSolver mixed_integer_scheduling_solver = 34;

Returns: The enum numeric value on the wire for mixedIntegerSchedulingSolver.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 14945 of file RoutingSearchParameters.java.

◆ getMultiArmedBanditCompoundOperatorExplorationCoefficient()

double com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 13565 of file RoutingSearchParameters.java.

◆ getMultiArmedBanditCompoundOperatorMemoryCoefficient()

double com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 13513 of file RoutingSearchParameters.java.

◆ getNumberOfSolutionsToCollect()

int com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 15112 of file RoutingSearchParameters.java.

◆ getNumMaxLocalOptimaBeforeMetaheuristicSwitch()

int com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getNumMaxLocalOptimaBeforeMetaheuristicSwitch ( )

int32 num_max_local_optima_before_metaheuristic_switch = 64;

Returns: The numMaxLocalOptimaBeforeMetaheuristicSwitch.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 14100 of file RoutingSearchParameters.java.

◆ getOptimizationStep()

double com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 15063 of file RoutingSearchParameters.java.

◆ getRelocateExpensiveChainNumArcsToConsider()

int com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 13663 of file RoutingSearchParameters.java.

◆ getReportIntermediateCpSatSolutions()

boolean com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 14806 of file RoutingSearchParameters.java.

◆ getSatParameters()

com.google.ortools.sat.SatParameters com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 14653 of file RoutingSearchParameters.java.

◆ getSatParametersBuilder()

com.google.ortools.sat.SatParameters.Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getSatParametersBuilder ( )

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;

Definition at line 14752 of file RoutingSearchParameters.java.

◆ getSatParametersOrBuilder()

com.google.ortools.sat.SatParametersOrBuilder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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;

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 14765 of file RoutingSearchParameters.java.

◆ getSavingsAddReverseArcs()

boolean com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getSavingsAddReverseArcs ( )

Add savings related to reverse arcs when finding the nearest neighbors
of the nodes.

bool savings_add_reverse_arcs = 15;

Returns: The savingsAddReverseArcs.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 12303 of file RoutingSearchParameters.java.

◆ getSavingsArcCoefficient()

double com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 12353 of file RoutingSearchParameters.java.

◆ getSavingsMaxMemoryUsageBytes()

double com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 12248 of file RoutingSearchParameters.java.

◆ getSavingsNeighborsRatio()

double com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 12195 of file RoutingSearchParameters.java.

◆ getSecondaryLsTimeLimitRatio()

double com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 15536 of file RoutingSearchParameters.java.

◆ getSolutionLimit()

long com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getSolutionLimit ( )

-- Search limits --
Limit to the number of solutions generated during the search. 0 means
"unspecified".

int64 solution_limit = 8;

Returns: The solutionLimit.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 15160 of file RoutingSearchParameters.java.

◆ getTimeLimit()

com.google.protobuf.Duration com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getTimeLimit ( )

Limit to the time spent in the search.

.google.protobuf.Duration time_limit = 9;

Returns: The timeLimit.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 15220 of file RoutingSearchParameters.java.

◆ getTimeLimitBuilder()

com.google.protobuf.Duration.Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getTimeLimitBuilder ( )

Limit to the time spent in the search.

.google.protobuf.Duration time_limit = 9;

Definition at line 15314 of file RoutingSearchParameters.java.

◆ getTimeLimitOrBuilder()

com.google.protobuf.DurationOrBuilder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getTimeLimitOrBuilder ( )

Limit to the time spent in the search.

.google.protobuf.Duration time_limit = 9;

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 15326 of file RoutingSearchParameters.java.

◆ getUseCp()

com.google.ortools.util.OptionalBoolean com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 14418 of file RoutingSearchParameters.java.

◆ getUseCpSat()

com.google.ortools.util.OptionalBoolean com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 14502 of file RoutingSearchParameters.java.

◆ getUseCpSatValue()

int com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 14469 of file RoutingSearchParameters.java.

◆ getUseCpValue()

int com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 14387 of file RoutingSearchParameters.java.

◆ getUseDepthFirstSearch()

boolean com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 14336 of file RoutingSearchParameters.java.

◆ getUseFullPropagation()

boolean com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 15765 of file RoutingSearchParameters.java.

◆ getUseGeneralizedCpSat()

com.google.ortools.util.OptionalBoolean com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 14588 of file RoutingSearchParameters.java.

◆ getUseGeneralizedCpSatValue()

int com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 14555 of file RoutingSearchParameters.java.

◆ getUseGuidedLocalSearchPenaltiesInLocalSearchOperators()

boolean com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 14287 of file RoutingSearchParameters.java.

◆ getUseIteratedLocalSearch()

boolean com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.getUseIteratedLocalSearch ( )

Whether the solver should use an Iterated Local Search approach to solve
the problem.

bool use_iterated_local_search = 58;

Returns: The useIteratedLocalSearch.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 16084 of file RoutingSearchParameters.java.

◆ getUseMultiArmedBanditConcatenateOperators()

boolean com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 13462 of file RoutingSearchParameters.java.

◆ getUseUnfilteredFirstSolutionStrategy()

boolean com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 12143 of file RoutingSearchParameters.java.

◆ hasDisableSchedulingBewareThisMayDegradePerformance()

boolean com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 15002 of file RoutingSearchParameters.java.

◆ hasImprovementLimitParameters()

boolean com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 15592 of file RoutingSearchParameters.java.

◆ hasIteratedLocalSearchParameters()

boolean com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.hasIteratedLocalSearchParameters ( )

Iterated Local Search parameters.

.operations_research.IteratedLocalSearchParameters iterated_local_search_parameters = 60;

Returns: Whether the iteratedLocalSearchParameters field is set.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 16131 of file RoutingSearchParameters.java.

◆ hasLnsTimeLimit()

boolean com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 15367 of file RoutingSearchParameters.java.

◆ hasLocalSearchOperators()

boolean com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.hasLocalSearchOperators ( )

.operations_research.RoutingSearchParameters.LocalSearchNeighborhoodOperators local_search_operators = 3;

Returns: Whether the localSearchOperators field is set.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 13254 of file RoutingSearchParameters.java.

◆ hasSatParameters()

boolean com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.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.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 14641 of file RoutingSearchParameters.java.

◆ hasTimeLimit()

boolean com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.hasTimeLimit ( )

Limit to the time spent in the search.

.google.protobuf.Duration time_limit = 9;

Returns: Whether the timeLimit field is set.

Implements com.google.ortools.constraintsolver.RoutingSearchParametersOrBuilder.

Definition at line 15209 of file RoutingSearchParameters.java.

◆ internalGetFieldAccessorTable()

com.google.protobuf.GeneratedMessage.FieldAccessorTable com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.internalGetFieldAccessorTable ( )

protected

Definition at line 11122 of file RoutingSearchParameters.java.

◆ isInitialized()

final boolean com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.isInitialized ( )

Definition at line 11692 of file RoutingSearchParameters.java.

◆ mergeFrom() [1/3]

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.mergeFrom ( com.google.ortools.constraintsolver.RoutingSearchParameters other )

Definition at line 11489 of file RoutingSearchParameters.java.

◆ mergeFrom() [2/3]

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.mergeFrom	(	com.google.protobuf.CodedInputStream	input,
		com.google.protobuf.ExtensionRegistryLite	extensionRegistry ) throws java.io.IOException

Definition at line 11697 of file RoutingSearchParameters.java.

◆ mergeFrom() [3/3]

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.mergeFrom ( com.google.protobuf.Message other )

Definition at line 11480 of file RoutingSearchParameters.java.

◆ mergeImprovementLimitParameters()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.mergeImprovementLimitParameters ( com.google.ortools.constraintsolver.RoutingSearchParameters.ImprovementSearchLimitParameters value )

The improvement search limit is added to the solver if the following
parameters are set.

.operations_research.RoutingSearchParameters.ImprovementSearchLimitParameters improvement_limit_parameters = 37;

Definition at line 15659 of file RoutingSearchParameters.java.

◆ mergeIteratedLocalSearchParameters()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.mergeIteratedLocalSearchParameters ( com.google.ortools.constraintsolver.IteratedLocalSearchParameters value )

Iterated Local Search parameters.

.operations_research.IteratedLocalSearchParameters iterated_local_search_parameters = 60;

Definition at line 16194 of file RoutingSearchParameters.java.

◆ mergeLnsTimeLimit()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.mergeLnsTimeLimit ( com.google.protobuf.Duration value )

Limit to the time spent in the completion search for each local search
neighbor.

.google.protobuf.Duration lns_time_limit = 10;

Definition at line 15434 of file RoutingSearchParameters.java.

◆ mergeLocalSearchOperators()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.mergeLocalSearchOperators ( com.google.ortools.constraintsolver.RoutingSearchParameters.LocalSearchNeighborhoodOperators value )

.operations_research.RoutingSearchParameters.LocalSearchNeighborhoodOperators local_search_operators = 3;

Definition at line 13301 of file RoutingSearchParameters.java.

◆ mergeSatParameters()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.mergeSatParameters ( com.google.ortools.sat.SatParameters value )

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;

Definition at line 14708 of file RoutingSearchParameters.java.

◆ mergeTimeLimit()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.mergeTimeLimit ( com.google.protobuf.Duration value )

Limit to the time spent in the search.

.google.protobuf.Duration time_limit = 9;

Definition at line 15272 of file RoutingSearchParameters.java.

◆ setCheapestInsertionAddUnperformedEntries()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setCheapestInsertionAddUnperformedEntries ( boolean value )

Whether or not to consider entries making the nodes/pairs unperformed in
the GlobalCheapestInsertion heuristic.

bool cheapest_insertion_add_unperformed_entries = 40;

Parameters

value The cheapestInsertionAddUnperformedEntries to set.

Returns: This builder for chaining.

Definition at line 12719 of file RoutingSearchParameters.java.

◆ setCheapestInsertionFarthestSeedsRatio()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setCheapestInsertionFarthestSeedsRatio ( double value )

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;

Parameters

value The cheapestInsertionFarthestSeedsRatio to set.

Returns: This builder for chaining.

Definition at line 12421 of file RoutingSearchParameters.java.

◆ setCheapestInsertionFirstSolutionMinNeighbors()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setCheapestInsertionFirstSolutionMinNeighbors ( int value )

int32 cheapest_insertion_first_solution_min_neighbors = 44;

Parameters

value The cheapestInsertionFirstSolutionMinNeighbors to set.

Returns: This builder for chaining.

Definition at line 12545 of file RoutingSearchParameters.java.

◆ setCheapestInsertionFirstSolutionNeighborsRatio()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setCheapestInsertionFirstSolutionNeighborsRatio ( double value )

Ratio (in ]0, 1]) of closest non start/end nodes to consider as neighbors
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.
The neighborhood ratio is coupled with the corresponding min_neighbors
integer, indicating the minimum number of neighbors to consider for each
node:
num_closest_neighbors =
max(min_neighbors, neighbors_ratio * NUM_NON_START_END_NODES)
This minimum number of neighbors must be greater or equal to 1, its
default value.

Neighbors ratio and minimum number of neighbors for the first solution
heuristic.

double cheapest_insertion_first_solution_neighbors_ratio = 21;

Parameters

value The cheapestInsertionFirstSolutionNeighborsRatio to set.

Returns: This builder for chaining.

Definition at line 12495 of file RoutingSearchParameters.java.

◆ setCheapestInsertionFirstSolutionUseNeighborsRatioForInitialization()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setCheapestInsertionFirstSolutionUseNeighborsRatioForInitialization ( boolean value )

Whether or not to only consider closest neighbors when initializing the
assignment for the first solution.

bool cheapest_insertion_first_solution_use_neighbors_ratio_for_initialization = 46;

Parameters

value The cheapestInsertionFirstSolutionUseNeighborsRatioForInitialization to set.

Returns: This builder for chaining.

Definition at line 12672 of file RoutingSearchParameters.java.

◆ setCheapestInsertionLsOperatorMinNeighbors()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setCheapestInsertionLsOperatorMinNeighbors ( int value )

int32 cheapest_insertion_ls_operator_min_neighbors = 45;

Parameters

value The cheapestInsertionLsOperatorMinNeighbors to set.

Returns: This builder for chaining.

Definition at line 12630 of file RoutingSearchParameters.java.

◆ setCheapestInsertionLsOperatorNeighborsRatio()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setCheapestInsertionLsOperatorNeighborsRatio ( double value )

Neighbors ratio and minimum number of neighbors 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;

Parameters

value The cheapestInsertionLsOperatorNeighborsRatio to set.

Returns: This builder for chaining.

Definition at line 12591 of file RoutingSearchParameters.java.

◆ setChristofidesUseMinimumMatching()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setChristofidesUseMinimumMatching ( boolean value )

If true use minimum matching instead of minimal matching in the
Christofides algorithm.

bool christofides_use_minimum_matching = 30;

Parameters

value The christofidesUseMinimumMatching to set.

Returns: This builder for chaining.

Definition at line 13162 of file RoutingSearchParameters.java.

◆ setContinuousSchedulingSolver()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setContinuousSchedulingSolver ( com.google.ortools.constraintsolver.RoutingSearchParameters.SchedulingSolver value )

.operations_research.RoutingSearchParameters.SchedulingSolver continuous_scheduling_solver = 33;

Parameters

value The continuousSchedulingSolver to set.

Returns: This builder for chaining.

Definition at line 14922 of file RoutingSearchParameters.java.

◆ setContinuousSchedulingSolverValue()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setContinuousSchedulingSolverValue ( int value )

.operations_research.RoutingSearchParameters.SchedulingSolver continuous_scheduling_solver = 33;

Parameters

value The enum numeric value on the wire for continuousSchedulingSolver to set.

Returns: This builder for chaining.

Definition at line 14902 of file RoutingSearchParameters.java.

◆ setDisableSchedulingBewareThisMayDegradePerformance()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setDisableSchedulingBewareThisMayDegradePerformance ( boolean value )

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;

Parameters

value The disableSchedulingBewareThisMayDegradePerformance to set.

Returns: This builder for chaining.

Definition at line 15028 of file RoutingSearchParameters.java.

◆ setFallbackToCpSatSizeThreshold()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setFallbackToCpSatSizeThreshold ( int value )

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;

Parameters

value The fallbackToCpSatSizeThreshold to set.

Returns: This builder for chaining.

Definition at line 14866 of file RoutingSearchParameters.java.

◆ setFirstSolutionOptimizationPeriod()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setFirstSolutionOptimizationPeriod ( int value )

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;

Parameters

value The firstSolutionOptimizationPeriod to set.

Returns: This builder for chaining.

Definition at line 13219 of file RoutingSearchParameters.java.

◆ setFirstSolutionStrategy()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setFirstSolutionStrategy ( com.google.ortools.constraintsolver.FirstSolutionStrategy.Value value )

First solution strategies, used as starting point of local search.

.operations_research.FirstSolutionStrategy.Value first_solution_strategy = 1;

Parameters

value The firstSolutionStrategy to set.

Returns: This builder for chaining.

Definition at line 12108 of file RoutingSearchParameters.java.

◆ setFirstSolutionStrategyValue()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setFirstSolutionStrategyValue ( int value )

First solution strategies, used as starting point of local search.

.operations_research.FirstSolutionStrategy.Value first_solution_strategy = 1;

Parameters

value The enum numeric value on the wire for firstSolutionStrategy to set.

Returns: This builder for chaining.

Definition at line 12080 of file RoutingSearchParameters.java.

◆ setGuidedLocalSearchLambdaCoefficient()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setGuidedLocalSearchLambdaCoefficient ( double value )

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;

Parameters

value The guidedLocalSearchLambdaCoefficient to set.

Returns: This builder for chaining.

Definition at line 14154 of file RoutingSearchParameters.java.

◆ setGuidedLocalSearchPenalizeWithVehicleClasses()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setGuidedLocalSearchPenalizeWithVehicleClasses ( boolean value )

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;

Parameters

value The guidedLocalSearchPenalizeWithVehicleClasses to set.

Returns: This builder for chaining.

Definition at line 14252 of file RoutingSearchParameters.java.

◆ setGuidedLocalSearchResetPenaltiesOnNewBestSolution()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setGuidedLocalSearchResetPenaltiesOnNewBestSolution ( boolean value )

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;

Parameters

value The guidedLocalSearchResetPenaltiesOnNewBestSolution to set.

Returns: This builder for chaining.

Definition at line 14203 of file RoutingSearchParameters.java.

◆ setHeuristicCloseNodesLnsNumNodes()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setHeuristicCloseNodesLnsNumNodes ( int value )

Number of closest nodes to consider for each node during the destruction
phase of the FilteredHeuristicCloseNodesLNSOperator.

int32 heuristic_close_nodes_lns_num_nodes = 35;

Parameters

value The heuristicCloseNodesLnsNumNodes to set.

Returns: This builder for chaining.

Definition at line 13780 of file RoutingSearchParameters.java.

◆ setHeuristicExpensiveChainLnsNumArcsToConsider()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setHeuristicExpensiveChainLnsNumArcsToConsider ( int value )

Number of expensive arcs to consider cutting in the
FilteredHeuristicExpensiveChainLNSOperator operator.

int32 heuristic_expensive_chain_lns_num_arcs_to_consider = 32;

Parameters

value The heuristicExpensiveChainLnsNumArcsToConsider to set.

Returns: This builder for chaining.

Definition at line 13733 of file RoutingSearchParameters.java.

◆ setImprovementLimitParameters() [1/2]

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setImprovementLimitParameters ( com.google.ortools.constraintsolver.RoutingSearchParameters.ImprovementSearchLimitParameters value )

The improvement search limit is added to the solver if the following
parameters are set.

.operations_research.RoutingSearchParameters.ImprovementSearchLimitParameters improvement_limit_parameters = 37;

Definition at line 15619 of file RoutingSearchParameters.java.

◆ setImprovementLimitParameters() [2/2]

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setImprovementLimitParameters ( com.google.ortools.constraintsolver.RoutingSearchParameters.ImprovementSearchLimitParameters.Builder builderForValue )

The improvement search limit is added to the solver if the following
parameters are set.

.operations_research.RoutingSearchParameters.ImprovementSearchLimitParameters improvement_limit_parameters = 37;

Definition at line 15640 of file RoutingSearchParameters.java.

◆ setIteratedLocalSearchParameters() [1/2]

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setIteratedLocalSearchParameters ( com.google.ortools.constraintsolver.IteratedLocalSearchParameters value )

Iterated Local Search parameters.

.operations_research.IteratedLocalSearchParameters iterated_local_search_parameters = 60;

Definition at line 16156 of file RoutingSearchParameters.java.

◆ setIteratedLocalSearchParameters() [2/2]

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setIteratedLocalSearchParameters ( com.google.ortools.constraintsolver.IteratedLocalSearchParameters.Builder builderForValue )

Iterated Local Search parameters.

.operations_research.IteratedLocalSearchParameters iterated_local_search_parameters = 60;

Definition at line 16176 of file RoutingSearchParameters.java.

◆ setLnsTimeLimit() [1/2]

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setLnsTimeLimit ( com.google.protobuf.Duration value )

Limit to the time spent in the completion search for each local search
neighbor.

.google.protobuf.Duration lns_time_limit = 10;

Definition at line 15394 of file RoutingSearchParameters.java.

◆ setLnsTimeLimit() [2/2]

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setLnsTimeLimit ( com.google.protobuf.Duration.Builder builderForValue )

Limit to the time spent in the completion search for each local search
neighbor.

.google.protobuf.Duration lns_time_limit = 10;

Definition at line 15415 of file RoutingSearchParameters.java.

◆ setLocalCheapestCostInsertionPickupDeliveryStrategy()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setLocalCheapestCostInsertionPickupDeliveryStrategy ( com.google.ortools.constraintsolver.RoutingSearchParameters.PairInsertionStrategy value )

Choice of insertion strategy for pickup/delivery pairs, used in local
cheapest cost insertion, both first solution heuristic and LNS.

.operations_research.RoutingSearchParameters.PairInsertionStrategy local_cheapest_cost_insertion_pickup_delivery_strategy = 55;

Parameters

value The localCheapestCostInsertionPickupDeliveryStrategy to set.

Returns: This builder for chaining.

Definition at line 12871 of file RoutingSearchParameters.java.

◆ setLocalCheapestCostInsertionPickupDeliveryStrategyValue()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setLocalCheapestCostInsertionPickupDeliveryStrategyValue ( int value )

Choice of insertion strategy for pickup/delivery pairs, used in local
cheapest cost insertion, both first solution heuristic and LNS.

.operations_research.RoutingSearchParameters.PairInsertionStrategy local_cheapest_cost_insertion_pickup_delivery_strategy = 55;

Parameters

value The enum numeric value on the wire for localCheapestCostInsertionPickupDeliveryStrategy to set.

Returns: This builder for chaining.

Definition at line 12841 of file RoutingSearchParameters.java.

◆ setLocalCheapestInsertionPickupDeliveryStrategy()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setLocalCheapestInsertionPickupDeliveryStrategy ( com.google.ortools.constraintsolver.RoutingSearchParameters.PairInsertionStrategy value )

Choice of insertion strategy for pickup/delivery pairs, used in local
cheapest insertion, both first solution heuristic and LNS.

.operations_research.RoutingSearchParameters.PairInsertionStrategy local_cheapest_insertion_pickup_delivery_strategy = 49;

Parameters

value The localCheapestInsertionPickupDeliveryStrategy to set.

Returns: This builder for chaining.

Definition at line 12795 of file RoutingSearchParameters.java.

◆ setLocalCheapestInsertionPickupDeliveryStrategyValue()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setLocalCheapestInsertionPickupDeliveryStrategyValue ( int value )

Choice of insertion strategy for pickup/delivery pairs, used in local
cheapest insertion, both first solution heuristic and LNS.

.operations_research.RoutingSearchParameters.PairInsertionStrategy local_cheapest_insertion_pickup_delivery_strategy = 49;

Parameters

value The enum numeric value on the wire for localCheapestInsertionPickupDeliveryStrategy to set.

Returns: This builder for chaining.

Definition at line 12765 of file RoutingSearchParameters.java.

◆ setLocalCheapestInsertionSortingProperties()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setLocalCheapestInsertionSortingProperties	(	int	index,
		com.google.ortools.constraintsolver.RoutingSearchParameters.InsertionSortingProperty	value )

The properties used to sort insertion entries in the local cheapest
insertion heuristic, in *decreasing* order of priority. The properties
listed here are applied hierarchically, from highest to lowest priority.
When no properties are provided
(SORTING_PROPERTY_ALLOWED_VEHICLES, SORTING_PROPERTY_PENALTY)
is used by default.

repeated .operations_research.RoutingSearchParameters.InsertionSortingProperty local_cheapest_insertion_sorting_properties = 67;

Parameters

index	The index to set the value at.
value	The localCheapestInsertionSortingProperties to set.

Returns: This builder for chaining.

Definition at line 12966 of file RoutingSearchParameters.java.

◆ setLocalCheapestInsertionSortingPropertiesValue()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setLocalCheapestInsertionSortingPropertiesValue	(	int	index,
		int	value )

The properties used to sort insertion entries in the local cheapest
insertion heuristic, in *decreasing* order of priority. The properties
listed here are applied hierarchically, from highest to lowest priority.
When no properties are provided
(SORTING_PROPERTY_ALLOWED_VEHICLES, SORTING_PROPERTY_PENALTY)
is used by default.

repeated .operations_research.RoutingSearchParameters.InsertionSortingProperty local_cheapest_insertion_sorting_properties = 67;

Parameters

index	The index to set the value at.
value	The enum numeric value on the wire for localCheapestInsertionSortingProperties to set.

Returns: This builder for chaining.

Definition at line 13087 of file RoutingSearchParameters.java.

◆ setLocalSearchMetaheuristic()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setLocalSearchMetaheuristic ( com.google.ortools.constraintsolver.LocalSearchMetaheuristic.Value value )

Local search metaheuristics used to guide the search.

.operations_research.LocalSearchMetaheuristic.Value local_search_metaheuristic = 4;

Parameters

value The localSearchMetaheuristic to set.

Returns: This builder for chaining.

Definition at line 13852 of file RoutingSearchParameters.java.

◆ setLocalSearchMetaheuristics()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setLocalSearchMetaheuristics	(	int	index,
		com.google.ortools.constraintsolver.LocalSearchMetaheuristic.Value	value )

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 to set the value at.
value	The localSearchMetaheuristics to set.

Returns: This builder for chaining.

Definition at line 13938 of file RoutingSearchParameters.java.

◆ setLocalSearchMetaheuristicsValue()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setLocalSearchMetaheuristicsValue	(	int	index,
		int	value )

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 to set the value at.
value	The enum numeric value on the wire for localSearchMetaheuristics to set.

Returns: This builder for chaining.

Definition at line 14047 of file RoutingSearchParameters.java.

◆ setLocalSearchMetaheuristicValue()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setLocalSearchMetaheuristicValue ( int value )

Local search metaheuristics used to guide the search.

.operations_research.LocalSearchMetaheuristic.Value local_search_metaheuristic = 4;

Parameters

value The enum numeric value on the wire for localSearchMetaheuristic to set.

Returns: This builder for chaining.

Definition at line 13824 of file RoutingSearchParameters.java.

◆ setLocalSearchOperators() [1/2]

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setLocalSearchOperators ( com.google.ortools.constraintsolver.RoutingSearchParameters.LocalSearchNeighborhoodOperators value )

.operations_research.RoutingSearchParameters.LocalSearchNeighborhoodOperators local_search_operators = 3;

Definition at line 13271 of file RoutingSearchParameters.java.

◆ setLocalSearchOperators() [2/2]

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setLocalSearchOperators ( com.google.ortools.constraintsolver.RoutingSearchParameters.LocalSearchNeighborhoodOperators.Builder builderForValue )

.operations_research.RoutingSearchParameters.LocalSearchNeighborhoodOperators local_search_operators = 3;

Definition at line 13287 of file RoutingSearchParameters.java.

◆ setLogCostOffset()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setLogCostOffset ( double value )

double log_cost_offset = 29;

Parameters

value The logCostOffset to set.

Returns: This builder for chaining.

Definition at line 15958 of file RoutingSearchParameters.java.

◆ setLogCostScalingFactor()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setLogCostScalingFactor ( double value )

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;

Parameters

value The logCostScalingFactor to set.

Returns: This builder for chaining.

Definition at line 15921 of file RoutingSearchParameters.java.

◆ setLogSearch()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setLogSearch ( boolean value )

--- 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;

Parameters

value The logSearch to set.

Returns: This builder for chaining.

Definition at line 15863 of file RoutingSearchParameters.java.

◆ setLogTag()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setLogTag ( java.lang.String value )

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;

Parameters

value The logTag to set.

Returns: This builder for chaining.

Definition at line 16030 of file RoutingSearchParameters.java.

◆ setLogTagBytes()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setLogTagBytes ( com.google.protobuf.ByteString value )

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;

Parameters

value The bytes for logTag to set.

Returns: This builder for chaining.

Definition at line 16063 of file RoutingSearchParameters.java.

◆ setLsOperatorMinNeighbors()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setLsOperatorMinNeighbors ( int value )

int32 ls_operator_min_neighbors = 54;

Parameters

value The lsOperatorMinNeighbors to set.

Returns: This builder for chaining.

Definition at line 13432 of file RoutingSearchParameters.java.

◆ setLsOperatorNeighborsRatio()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setLsOperatorNeighborsRatio ( double value )

Neighbors ratio and minimum number of neighbors considered in local
search operators (see cheapest_insertion_first_solution_neighbors_ratio
and cheapest_insertion_first_solution_min_neighbors for more information).

double ls_operator_neighbors_ratio = 53;

Parameters

value The lsOperatorNeighborsRatio to set.

Returns: This builder for chaining.

Definition at line 13394 of file RoutingSearchParameters.java.

◆ setMaxSwapActiveChainSize()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setMaxSwapActiveChainSize ( int value )

Maximum size of the chain to make inactive in SwapActiveChainOperator.

int32 max_swap_active_chain_size = 66;

Parameters

value The maxSwapActiveChainSize to set.

Returns: This builder for chaining.

Definition at line 13625 of file RoutingSearchParameters.java.

◆ setMixedIntegerSchedulingSolver()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setMixedIntegerSchedulingSolver ( com.google.ortools.constraintsolver.RoutingSearchParameters.SchedulingSolver value )

.operations_research.RoutingSearchParameters.SchedulingSolver mixed_integer_scheduling_solver = 34;

Parameters

value The mixedIntegerSchedulingSolver to set.

Returns: This builder for chaining.

Definition at line 14973 of file RoutingSearchParameters.java.

◆ setMixedIntegerSchedulingSolverValue()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setMixedIntegerSchedulingSolverValue ( int value )

.operations_research.RoutingSearchParameters.SchedulingSolver mixed_integer_scheduling_solver = 34;

Parameters

value The enum numeric value on the wire for mixedIntegerSchedulingSolver to set.

Returns: This builder for chaining.

Definition at line 14953 of file RoutingSearchParameters.java.

◆ setMultiArmedBanditCompoundOperatorExplorationCoefficient()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setMultiArmedBanditCompoundOperatorExplorationCoefficient ( double value )

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;

Parameters

value The multiArmedBanditCompoundOperatorExplorationCoefficient to set.

Returns: This builder for chaining.

Definition at line 13579 of file RoutingSearchParameters.java.

◆ setMultiArmedBanditCompoundOperatorMemoryCoefficient()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setMultiArmedBanditCompoundOperatorMemoryCoefficient ( double value )

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;

Parameters

value The multiArmedBanditCompoundOperatorMemoryCoefficient to set.

Returns: This builder for chaining.

Definition at line 13528 of file RoutingSearchParameters.java.

◆ setNumberOfSolutionsToCollect()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setNumberOfSolutionsToCollect ( int value )

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;

Parameters

value The numberOfSolutionsToCollect to set.

Returns: This builder for chaining.

Definition at line 15125 of file RoutingSearchParameters.java.

◆ setNumMaxLocalOptimaBeforeMetaheuristicSwitch()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setNumMaxLocalOptimaBeforeMetaheuristicSwitch ( int value )

int32 num_max_local_optima_before_metaheuristic_switch = 64;

Parameters

value The numMaxLocalOptimaBeforeMetaheuristicSwitch to set.

Returns: This builder for chaining.

Definition at line 14108 of file RoutingSearchParameters.java.

◆ setOptimizationStep()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setOptimizationStep ( double value )

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;

Parameters

value The optimizationStep to set.

Returns: This builder for chaining.

Definition at line 15077 of file RoutingSearchParameters.java.

◆ setRelocateExpensiveChainNumArcsToConsider()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setRelocateExpensiveChainNumArcsToConsider ( int value )

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;

Parameters

value The relocateExpensiveChainNumArcsToConsider to set.

Returns: This builder for chaining.

Definition at line 13681 of file RoutingSearchParameters.java.

◆ setReportIntermediateCpSatSolutions()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setReportIntermediateCpSatSolutions ( boolean value )

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;

Parameters

value The reportIntermediateCpSatSolutions to set.

Returns: This builder for chaining.

Definition at line 14819 of file RoutingSearchParameters.java.

◆ setSatParameters() [1/2]

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setSatParameters ( com.google.ortools.sat.SatParameters value )

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;

Definition at line 14668 of file RoutingSearchParameters.java.

◆ setSatParameters() [2/2]

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setSatParameters ( com.google.ortools.sat.SatParameters.Builder builderForValue )

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;

Definition at line 14689 of file RoutingSearchParameters.java.

◆ setSavingsAddReverseArcs()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setSavingsAddReverseArcs ( boolean value )

Add savings related to reverse arcs when finding the nearest neighbors
of the nodes.

bool savings_add_reverse_arcs = 15;

Parameters

value The savingsAddReverseArcs to set.

Returns: This builder for chaining.

Definition at line 12316 of file RoutingSearchParameters.java.

◆ setSavingsArcCoefficient()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setSavingsArcCoefficient ( double value )

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;

Parameters

value The savingsArcCoefficient to set.

Returns: This builder for chaining.

Definition at line 12369 of file RoutingSearchParameters.java.

◆ setSavingsMaxMemoryUsageBytes()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setSavingsMaxMemoryUsageBytes ( double value )

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;

Parameters

value The savingsMaxMemoryUsageBytes to set.

Returns: This builder for chaining.

Definition at line 12265 of file RoutingSearchParameters.java.

◆ setSavingsNeighborsRatio()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setSavingsNeighborsRatio ( double value )

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;

Parameters

value The savingsNeighborsRatio to set.

Returns: This builder for chaining.

Definition at line 12209 of file RoutingSearchParameters.java.

◆ setSecondaryLsTimeLimitRatio()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setSecondaryLsTimeLimitRatio ( double value )

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;

Parameters

value The secondaryLsTimeLimitRatio to set.

Returns: This builder for chaining.

Definition at line 15553 of file RoutingSearchParameters.java.

◆ setSolutionLimit()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setSolutionLimit ( long value )

-- Search limits --
Limit to the number of solutions generated during the search. 0 means
"unspecified".

int64 solution_limit = 8;

Parameters

value The solutionLimit to set.

Returns: This builder for chaining.

Definition at line 15174 of file RoutingSearchParameters.java.

◆ setTimeLimit() [1/2]

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setTimeLimit ( com.google.protobuf.Duration value )

Limit to the time spent in the search.

.google.protobuf.Duration time_limit = 9;

Definition at line 15234 of file RoutingSearchParameters.java.

◆ setTimeLimit() [2/2]

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setTimeLimit ( com.google.protobuf.Duration.Builder builderForValue )

Limit to the time spent in the search.

.google.protobuf.Duration time_limit = 9;

Definition at line 15254 of file RoutingSearchParameters.java.

◆ setUseCp()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setUseCp ( com.google.ortools.util.OptionalBoolean value )

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;

Parameters

value The useCp to set.

Returns: This builder for chaining.

Definition at line 14433 of file RoutingSearchParameters.java.

◆ setUseCpSat()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setUseCpSat ( com.google.ortools.util.OptionalBoolean value )

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;

Parameters

value The useCpSat to set.

Returns: This builder for chaining.

Definition at line 14518 of file RoutingSearchParameters.java.

◆ setUseCpSatValue()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setUseCpSatValue ( int value )

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;

Parameters

value The enum numeric value on the wire for useCpSat to set.

Returns: This builder for chaining.

Definition at line 14484 of file RoutingSearchParameters.java.

◆ setUseCpValue()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setUseCpValue ( int value )

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;

Parameters

value The enum numeric value on the wire for useCp to set.

Returns: This builder for chaining.

Definition at line 14401 of file RoutingSearchParameters.java.

◆ setUseDepthFirstSearch()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setUseDepthFirstSearch ( boolean value )

--- 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;

Parameters

value The useDepthFirstSearch to set.

Returns: This builder for chaining.

Definition at line 14351 of file RoutingSearchParameters.java.

◆ setUseFullPropagation()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setUseFullPropagation ( boolean value )

--- 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;

Parameters

value The useFullPropagation to set.

Returns: This builder for chaining.

Definition at line 15786 of file RoutingSearchParameters.java.

◆ setUseGeneralizedCpSat()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setUseGeneralizedCpSat ( com.google.ortools.util.OptionalBoolean value )

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;

Parameters

value The useGeneralizedCpSat to set.

Returns: This builder for chaining.

Definition at line 14604 of file RoutingSearchParameters.java.

◆ setUseGeneralizedCpSatValue()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setUseGeneralizedCpSatValue ( int value )

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;

Parameters

value The enum numeric value on the wire for useGeneralizedCpSat to set.

Returns: This builder for chaining.

Definition at line 14570 of file RoutingSearchParameters.java.

◆ setUseGuidedLocalSearchPenaltiesInLocalSearchOperators()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setUseGuidedLocalSearchPenaltiesInLocalSearchOperators ( boolean value )

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;

Parameters

value The useGuidedLocalSearchPenaltiesInLocalSearchOperators to set.

Returns: This builder for chaining.

Definition at line 14300 of file RoutingSearchParameters.java.

◆ setUseIteratedLocalSearch()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setUseIteratedLocalSearch ( boolean value )

Whether the solver should use an Iterated Local Search approach to solve
the problem.

bool use_iterated_local_search = 58;

Parameters

value The useIteratedLocalSearch to set.

Returns: This builder for chaining.

Definition at line 16097 of file RoutingSearchParameters.java.

◆ setUseMultiArmedBanditConcatenateOperators()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setUseMultiArmedBanditConcatenateOperators ( boolean value )

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;

Parameters

value The useMultiArmedBanditConcatenateOperators to set.

Returns: This builder for chaining.

Definition at line 13476 of file RoutingSearchParameters.java.

◆ setUseUnfilteredFirstSolutionStrategy()

Builder com.google.ortools.constraintsolver.RoutingSearchParameters.Builder.setUseUnfilteredFirstSolutionStrategy ( boolean value )

--- 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;

Parameters

value The useUnfilteredFirstSolutionStrategy to set.

Returns: This builder for chaining.

Definition at line 12158 of file RoutingSearchParameters.java.

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

build/java/ortools-java/src/main/java/com/google/ortools/constraintsolver/RoutingSearchParameters.java

Detailed Description

Public Member Functions

Static Public Member Functions

Protected Member Functions

Member Function Documentation

◆ addAllLocalCheapestInsertionSortingProperties()

◆ addAllLocalCheapestInsertionSortingPropertiesValue()

◆ addAllLocalSearchMetaheuristics()

◆ addAllLocalSearchMetaheuristicsValue()

◆ addLocalCheapestInsertionSortingProperties()

◆ addLocalCheapestInsertionSortingPropertiesValue()

◆ addLocalSearchMetaheuristics()

◆ addLocalSearchMetaheuristicsValue()

◆ build()

◆ buildPartial()

◆ clear()

◆ clearCheapestInsertionAddUnperformedEntries()

◆ clearCheapestInsertionFarthestSeedsRatio()

◆ clearCheapestInsertionFirstSolutionMinNeighbors()

◆ clearCheapestInsertionFirstSolutionNeighborsRatio()

◆ clearCheapestInsertionFirstSolutionUseNeighborsRatioForInitialization()

◆ clearCheapestInsertionLsOperatorMinNeighbors()

◆ clearCheapestInsertionLsOperatorNeighborsRatio()

◆ clearChristofidesUseMinimumMatching()

◆ clearContinuousSchedulingSolver()

◆ clearDisableSchedulingBewareThisMayDegradePerformance()

◆ clearFallbackToCpSatSizeThreshold()

◆ clearFirstSolutionOptimizationPeriod()

◆ clearFirstSolutionStrategy()

◆ clearGuidedLocalSearchLambdaCoefficient()

◆ clearGuidedLocalSearchPenalizeWithVehicleClasses()

◆ clearGuidedLocalSearchResetPenaltiesOnNewBestSolution()

◆ clearHeuristicCloseNodesLnsNumNodes()

◆ clearHeuristicExpensiveChainLnsNumArcsToConsider()

◆ clearImprovementLimitParameters()

◆ clearIteratedLocalSearchParameters()

◆ clearLnsTimeLimit()

◆ clearLocalCheapestCostInsertionPickupDeliveryStrategy()

◆ clearLocalCheapestInsertionPickupDeliveryStrategy()

◆ clearLocalCheapestInsertionSortingProperties()

◆ clearLocalSearchMetaheuristic()

◆ clearLocalSearchMetaheuristics()

◆ clearLocalSearchOperators()

◆ clearLogCostOffset()

◆ clearLogCostScalingFactor()

◆ clearLogSearch()

◆ clearLogTag()

◆ clearLsOperatorMinNeighbors()

◆ clearLsOperatorNeighborsRatio()

◆ clearMaxSwapActiveChainSize()

◆ clearMixedIntegerSchedulingSolver()

◆ clearMultiArmedBanditCompoundOperatorExplorationCoefficient()

◆ clearMultiArmedBanditCompoundOperatorMemoryCoefficient()

◆ clearNumberOfSolutionsToCollect()

◆ clearNumMaxLocalOptimaBeforeMetaheuristicSwitch()

◆ clearOptimizationStep()

◆ clearRelocateExpensiveChainNumArcsToConsider()

◆ clearReportIntermediateCpSatSolutions()

◆ clearSatParameters()

◆ clearSavingsAddReverseArcs()

◆ clearSavingsArcCoefficient()

◆ clearSavingsMaxMemoryUsageBytes()

◆ clearSavingsNeighborsRatio()

◆ clearSecondaryLsTimeLimitRatio()

◆ clearSolutionLimit()

◆ clearTimeLimit()

◆ clearUseCp()

◆ clearUseCpSat()

◆ clearUseDepthFirstSearch()

◆ clearUseFullPropagation()

◆ clearUseGeneralizedCpSat()

◆ clearUseGuidedLocalSearchPenaltiesInLocalSearchOperators()

◆ clearUseIteratedLocalSearch()

◆ clearUseMultiArmedBanditConcatenateOperators()

◆ clearUseUnfilteredFirstSolutionStrategy()

◆ getCheapestInsertionAddUnperformedEntries()

◆ getCheapestInsertionFarthestSeedsRatio()

◆ getCheapestInsertionFirstSolutionMinNeighbors()

◆ getCheapestInsertionFirstSolutionNeighborsRatio()

◆ getCheapestInsertionFirstSolutionUseNeighborsRatioForInitialization()