Google OR-Tools v9.15
a fast and portable software suite for combinatorial optimization
Loading...
Searching...
No Matches
com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters Class Reference

Detailed Description

Parameters used to configure global cheapest insertion heuristics.

Protobuf type operations_research.GlobalCheapestInsertionParameters

Definition at line 16 of file GlobalCheapestInsertionParameters.java.

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

Classes

class  Builder

Public Member Functions

double getFarthestSeedsRatio ()
double getNeighborsRatio ()
int getMinNeighbors ()
boolean getUseNeighborsRatioForInitialization ()
boolean getAddUnperformedEntries ()
final boolean isInitialized ()
void writeTo (com.google.protobuf.CodedOutputStream output) throws java.io.IOException
int getSerializedSize ()
boolean equals (final java.lang.Object obj)
int hashCode ()
Builder newBuilderForType ()
Builder toBuilder ()
com.google.protobuf.Parser< GlobalCheapestInsertionParameters > getParserForType ()
com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters getDefaultInstanceForType ()

Static Public Member Functions

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

Static Public Attributes

static final int FARTHEST_SEEDS_RATIO_FIELD_NUMBER = 1
static final int NEIGHBORS_RATIO_FIELD_NUMBER = 2
static final int MIN_NEIGHBORS_FIELD_NUMBER = 3
static final int USE_NEIGHBORS_RATIO_FOR_INITIALIZATION_FIELD_NUMBER = 6
static final int ADD_UNPERFORMED_ENTRIES_FIELD_NUMBER = 7

Protected Member Functions

com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable ()
Builder newBuilderForType (com.google.protobuf.GeneratedMessage.BuilderParent parent)

Member Function Documentation

◆ equals()

boolean com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.equals ( final java.lang.Object obj)

Definition at line 205 of file GlobalCheapestInsertionParameters.java.

◆ getAddUnperformedEntries()

boolean com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.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 137 of file GlobalCheapestInsertionParameters.java.

◆ getDefaultInstance()

com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.getDefaultInstance ( )
static

Definition at line 813 of file GlobalCheapestInsertionParameters.java.

◆ getDefaultInstanceForType()

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

Definition at line 849 of file GlobalCheapestInsertionParameters.java.

◆ getDescriptor()

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

Definition at line 38 of file GlobalCheapestInsertionParameters.java.

◆ getFarthestSeedsRatio()

double com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.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 62 of file GlobalCheapestInsertionParameters.java.

◆ getMinNeighbors()

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

int32 min_neighbors = 3;

Returns
The minNeighbors.

Implements com.google.ortools.constraintsolver.GlobalCheapestInsertionParametersOrBuilder.

Definition at line 99 of file GlobalCheapestInsertionParameters.java.

◆ getNeighborsRatio()

double com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.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 88 of file GlobalCheapestInsertionParameters.java.

◆ getParserForType()

com.google.protobuf.Parser< GlobalCheapestInsertionParameters > com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.getParserForType ( )

Definition at line 844 of file GlobalCheapestInsertionParameters.java.

◆ getSerializedSize()

int com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.getSerializedSize ( )

Definition at line 174 of file GlobalCheapestInsertionParameters.java.

◆ getUseNeighborsRatioForInitialization()

boolean com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.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 118 of file GlobalCheapestInsertionParameters.java.

◆ hashCode()

int com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.hashCode ( )

Definition at line 231 of file GlobalCheapestInsertionParameters.java.

◆ internalGetFieldAccessorTable()

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

Definition at line 44 of file GlobalCheapestInsertionParameters.java.

◆ isInitialized()

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

Definition at line 143 of file GlobalCheapestInsertionParameters.java.

◆ newBuilder() [1/2]

Builder com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.newBuilder ( )
static

Definition at line 330 of file GlobalCheapestInsertionParameters.java.

◆ newBuilder() [2/2]

Builder com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.newBuilder ( com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters prototype)
static

Definition at line 333 of file GlobalCheapestInsertionParameters.java.

◆ newBuilderForType() [1/2]

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

Definition at line 329 of file GlobalCheapestInsertionParameters.java.

◆ newBuilderForType() [2/2]

Builder com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.newBuilderForType ( com.google.protobuf.GeneratedMessage.BuilderParent parent)
protected

Definition at line 343 of file GlobalCheapestInsertionParameters.java.

◆ parseDelimitedFrom() [1/2]

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

Definition at line 301 of file GlobalCheapestInsertionParameters.java.

◆ parseDelimitedFrom() [2/2]

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

Definition at line 307 of file GlobalCheapestInsertionParameters.java.

◆ parseFrom() [1/10]

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

Definition at line 278 of file GlobalCheapestInsertionParameters.java.

◆ parseFrom() [2/10]

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

Definition at line 282 of file GlobalCheapestInsertionParameters.java.

◆ parseFrom() [3/10]

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

Definition at line 267 of file GlobalCheapestInsertionParameters.java.

◆ parseFrom() [4/10]

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

Definition at line 272 of file GlobalCheapestInsertionParameters.java.

◆ parseFrom() [5/10]

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

Definition at line 314 of file GlobalCheapestInsertionParameters.java.

◆ parseFrom() [6/10]

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

Definition at line 320 of file GlobalCheapestInsertionParameters.java.

◆ parseFrom() [7/10]

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

Definition at line 288 of file GlobalCheapestInsertionParameters.java.

◆ parseFrom() [8/10]

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

Definition at line 293 of file GlobalCheapestInsertionParameters.java.

◆ parseFrom() [9/10]

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

Definition at line 256 of file GlobalCheapestInsertionParameters.java.

◆ parseFrom() [10/10]

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

Definition at line 261 of file GlobalCheapestInsertionParameters.java.

◆ parser()

com.google.protobuf.Parser< GlobalCheapestInsertionParameters > com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.parser ( )
static

Definition at line 839 of file GlobalCheapestInsertionParameters.java.

◆ toBuilder()

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

Definition at line 337 of file GlobalCheapestInsertionParameters.java.

◆ writeTo()

void com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.writeTo ( com.google.protobuf.CodedOutputStream output) throws java.io.IOException

Definition at line 153 of file GlobalCheapestInsertionParameters.java.

Member Data Documentation

◆ ADD_UNPERFORMED_ENTRIES_FIELD_NUMBER

final int com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.ADD_UNPERFORMED_ENTRIES_FIELD_NUMBER = 7
static

Definition at line 122 of file GlobalCheapestInsertionParameters.java.

◆ FARTHEST_SEEDS_RATIO_FIELD_NUMBER

final int com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.FARTHEST_SEEDS_RATIO_FIELD_NUMBER = 1
static

Definition at line 50 of file GlobalCheapestInsertionParameters.java.

◆ MIN_NEIGHBORS_FIELD_NUMBER

final int com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.MIN_NEIGHBORS_FIELD_NUMBER = 3
static

Definition at line 92 of file GlobalCheapestInsertionParameters.java.

◆ NEIGHBORS_RATIO_FIELD_NUMBER

final int com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.NEIGHBORS_RATIO_FIELD_NUMBER = 2
static

Definition at line 66 of file GlobalCheapestInsertionParameters.java.

◆ USE_NEIGHBORS_RATIO_FOR_INITIALIZATION_FIELD_NUMBER

final int com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.USE_NEIGHBORS_RATIO_FOR_INITIALIZATION_FIELD_NUMBER = 6
static

Definition at line 103 of file GlobalCheapestInsertionParameters.java.

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