Detailed Description

Parameters used to configure global cheapest insertion heuristics.

Protobuf type operations_research.GlobalCheapestInsertionParameters

Definition at line 355 of file GlobalCheapestInsertionParameters.java.

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

Public Member Functions
Builder	clear ()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType ()
com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters	getDefaultInstanceForType ()
com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters	build ()
com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters	buildPartial ()
Builder	mergeFrom (com.google.protobuf.Message other)
Builder	mergeFrom (com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters other)
final boolean	isInitialized ()
Builder	mergeFrom (com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
double	getFarthestSeedsRatio ()
Builder	setFarthestSeedsRatio (double value)
Builder	clearFarthestSeedsRatio ()
double	getNeighborsRatio ()
Builder	setNeighborsRatio (double value)
Builder	clearNeighborsRatio ()
int	getMinNeighbors ()
Builder	setMinNeighbors (int value)
Builder	clearMinNeighbors ()
boolean	getUseNeighborsRatioForInitialization ()
Builder	setUseNeighborsRatioForInitialization (boolean value)
Builder	clearUseNeighborsRatioForInitialization ()
boolean	getAddUnperformedEntries ()
Builder	setAddUnperformedEntries (boolean value)
Builder	clearAddUnperformedEntries ()

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

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

Member Function Documentation

◆ build()

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

Definition at line 406 of file GlobalCheapestInsertionParameters.java.

◆ buildPartial()

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

Definition at line 415 of file GlobalCheapestInsertionParameters.java.

◆ clear()

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

Definition at line 383 of file GlobalCheapestInsertionParameters.java.

◆ clearAddUnperformedEntries()

Builder com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.Builder.clearAddUnperformedEntries ( )

Whether or not to consider entries making the nodes/pairs unperformed.
More precisely, if true, entries are created for making the nodes/pairs
unperformed, and when the cost of making a node unperformed is lower than
all insertions, the node/pair will be made unperformed. If false, only
entries making a node/pair performed are considered.

bool add_unperformed_entries = 7;

Returns: This builder for chaining.

Definition at line 797 of file GlobalCheapestInsertionParameters.java.

◆ clearFarthestSeedsRatio()

Builder com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.Builder.clearFarthestSeedsRatio ( )

Ratio (between 0 and 1) of available vehicles in the model on which
farthest nodes of the model are inserted as seeds.

double farthest_seeds_ratio = 1;

Returns: This builder for chaining.

Definition at line 576 of file GlobalCheapestInsertionParameters.java.

◆ clearMinNeighbors()

Builder com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.Builder.clearMinNeighbors ( )

int32 min_neighbors = 3;

Returns: This builder for chaining.

Definition at line 685 of file GlobalCheapestInsertionParameters.java.

◆ clearNeighborsRatio()

Builder com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.Builder.clearNeighborsRatio ( )

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.

double neighbors_ratio = 2;

Returns: This builder for chaining.

Definition at line 653 of file GlobalCheapestInsertionParameters.java.

◆ clearUseNeighborsRatioForInitialization()

Builder com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.Builder.clearUseNeighborsRatioForInitialization ( )

Whether or not to only consider closest neighbors when initializing the
assignment. More precisely, if true, only closest neighbors (see
neighbors_ratio and min_neighbors) are considered as insertion positions
during initialization. Otherwise, all possible insertion positions are
considered.

bool use_neighbors_ratio_for_initialization = 6;

Returns: This builder for chaining.

Definition at line 741 of file GlobalCheapestInsertionParameters.java.

◆ getAddUnperformedEntries()

boolean com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.Builder.getAddUnperformedEntries ( )

Whether or not to consider entries making the nodes/pairs unperformed.
More precisely, if true, entries are created for making the nodes/pairs
unperformed, and when the cost of making a node unperformed is lower than
all insertions, the node/pair will be made unperformed. If false, only
entries making a node/pair performed are considered.

bool add_unperformed_entries = 7;

Returns: The addUnperformedEntries.

Implements com.google.ortools.constraintsolver.GlobalCheapestInsertionParametersOrBuilder.

Definition at line 762 of file GlobalCheapestInsertionParameters.java.

◆ getDefaultInstanceForType()

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

Definition at line 401 of file GlobalCheapestInsertionParameters.java.

◆ getDescriptor()

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

static

Definition at line 360 of file GlobalCheapestInsertionParameters.java.

◆ getDescriptorForType()

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

Definition at line 396 of file GlobalCheapestInsertionParameters.java.

◆ getFarthestSeedsRatio()

double com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.Builder.getFarthestSeedsRatio ( )

Ratio (between 0 and 1) of available vehicles in the model on which
farthest nodes of the model are inserted as seeds.

double farthest_seeds_ratio = 1;

Returns: The farthestSeedsRatio.

Implements com.google.ortools.constraintsolver.GlobalCheapestInsertionParametersOrBuilder.

Definition at line 547 of file GlobalCheapestInsertionParameters.java.

◆ getMinNeighbors()

int com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.Builder.getMinNeighbors ( )

int32 min_neighbors = 3;

Returns: The minNeighbors.

Implements com.google.ortools.constraintsolver.GlobalCheapestInsertionParametersOrBuilder.

Definition at line 666 of file GlobalCheapestInsertionParameters.java.

◆ getNeighborsRatio()

double com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.Builder.getNeighborsRatio ( )

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.

double neighbors_ratio = 2;

Returns: The neighborsRatio.

Implements com.google.ortools.constraintsolver.GlobalCheapestInsertionParametersOrBuilder.

Definition at line 604 of file GlobalCheapestInsertionParameters.java.

◆ getUseNeighborsRatioForInitialization()

boolean com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.Builder.getUseNeighborsRatioForInitialization ( )

Whether or not to only consider closest neighbors when initializing the
assignment. More precisely, if true, only closest neighbors (see
neighbors_ratio and min_neighbors) are considered as insertion positions
during initialization. Otherwise, all possible insertion positions are
considered.

bool use_neighbors_ratio_for_initialization = 6;

Returns: The useNeighborsRatioForInitialization.

Implements com.google.ortools.constraintsolver.GlobalCheapestInsertionParametersOrBuilder.

Definition at line 706 of file GlobalCheapestInsertionParameters.java.

◆ internalGetFieldAccessorTable()

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

protected

Definition at line 366 of file GlobalCheapestInsertionParameters.java.

◆ isInitialized()

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

Definition at line 474 of file GlobalCheapestInsertionParameters.java.

◆ mergeFrom() [1/3]

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

Definition at line 451 of file GlobalCheapestInsertionParameters.java.

◆ mergeFrom() [2/3]

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

Definition at line 479 of file GlobalCheapestInsertionParameters.java.

◆ mergeFrom() [3/3]

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

Definition at line 442 of file GlobalCheapestInsertionParameters.java.

◆ setAddUnperformedEntries()

Builder com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.Builder.setAddUnperformedEntries ( boolean value )

Whether or not to consider entries making the nodes/pairs unperformed.
More precisely, if true, entries are created for making the nodes/pairs
unperformed, and when the cost of making a node unperformed is lower than
all insertions, the node/pair will be made unperformed. If false, only
entries making a node/pair performed are considered.

bool add_unperformed_entries = 7;

Parameters

value The addUnperformedEntries to set.

Returns: This builder for chaining.

Definition at line 778 of file GlobalCheapestInsertionParameters.java.

◆ setFarthestSeedsRatio()

Builder com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.Builder.setFarthestSeedsRatio ( double value )

Ratio (between 0 and 1) of available vehicles in the model on which
farthest nodes of the model are inserted as seeds.

double farthest_seeds_ratio = 1;

Parameters

value The farthestSeedsRatio to set.

Returns: This builder for chaining.

Definition at line 560 of file GlobalCheapestInsertionParameters.java.

◆ setMinNeighbors()

Builder com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.Builder.setMinNeighbors ( int value )

int32 min_neighbors = 3;

Parameters

value The minNeighbors to set.

Returns: This builder for chaining.

Definition at line 674 of file GlobalCheapestInsertionParameters.java.

◆ setNeighborsRatio()

Builder com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.Builder.setNeighborsRatio ( 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.

double neighbors_ratio = 2;

Parameters

value The neighborsRatio to set.

Returns: This builder for chaining.

Definition at line 627 of file GlobalCheapestInsertionParameters.java.

◆ setUseNeighborsRatioForInitialization()

Builder com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.Builder.setUseNeighborsRatioForInitialization ( boolean value )

Whether or not to only consider closest neighbors when initializing the
assignment. More precisely, if true, only closest neighbors (see
neighbors_ratio and min_neighbors) are considered as insertion positions
during initialization. Otherwise, all possible insertion positions are
considered.

bool use_neighbors_ratio_for_initialization = 6;

Parameters

value The useNeighborsRatioForInitialization to set.

Returns: This builder for chaining.

Definition at line 722 of file GlobalCheapestInsertionParameters.java.

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

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

Detailed Description

Public Member Functions

Static Public Member Functions

Protected Member Functions

Member Function Documentation

◆ build()

◆ buildPartial()

◆ clear()

◆ clearAddUnperformedEntries()

◆ clearFarthestSeedsRatio()

◆ clearMinNeighbors()

◆ clearNeighborsRatio()

◆ clearUseNeighborsRatioForInitialization()

◆ getAddUnperformedEntries()

◆ getDefaultInstanceForType()

◆ getDescriptor()

◆ getDescriptorForType()

◆ getFarthestSeedsRatio()

◆ getMinNeighbors()

◆ getNeighborsRatio()

◆ getUseNeighborsRatioForInitialization()

◆ internalGetFieldAccessorTable()

◆ isInitialized()

◆ mergeFrom() [1/3]

◆ mergeFrom() [2/3]

◆ mergeFrom() [3/3]

◆ setAddUnperformedEntries()

◆ setFarthestSeedsRatio()

◆ setMinNeighbors()

◆ setNeighborsRatio()

◆ setUseNeighborsRatioForInitialization()