Class GlobalCheapestInsertionParameters.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<GlobalCheapestInsertionParameters.Builder>
com.google.protobuf.GeneratedMessage.Builder<GlobalCheapestInsertionParameters.Builder>
com.google.ortools.constraintsolver.GlobalCheapestInsertionParameters.Builder
All Implemented Interfaces:
GlobalCheapestInsertionParametersOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
GlobalCheapestInsertionParameters
public static final class GlobalCheapestInsertionParameters.Builder extends com.google.protobuf.GeneratedMessage.Builder<GlobalCheapestInsertionParameters.Builder> implements GlobalCheapestInsertionParametersOrBuilder
Parameters used to configure global cheapest insertion heuristics.
Protobuf type operations_research.GlobalCheapestInsertionParameters

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<GlobalCheapestInsertionParameters.Builder>

    • clear

      public GlobalCheapestInsertionParameters.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<GlobalCheapestInsertionParameters.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<GlobalCheapestInsertionParameters.Builder>

    • getDefaultInstanceForType

      public GlobalCheapestInsertionParameters getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public GlobalCheapestInsertionParameters build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public GlobalCheapestInsertionParameters buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public GlobalCheapestInsertionParameters.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GlobalCheapestInsertionParameters.Builder>

    • mergeFrom

      public GlobalCheapestInsertionParameters.Builder mergeFrom(GlobalCheapestInsertionParameters other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<GlobalCheapestInsertionParameters.Builder>

    • mergeFrom

      public GlobalCheapestInsertionParameters.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GlobalCheapestInsertionParameters.Builder>
      Throws:
      IOException

    • getFarthestSeedsRatio

      public double 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;
      Specified by:
      getFarthestSeedsRatio in interface GlobalCheapestInsertionParametersOrBuilder
      Returns:
      The farthestSeedsRatio.

    • setFarthestSeedsRatio

      public 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.

    • clearFarthestSeedsRatio

      public 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.

    • getNeighborsRatio

      public double 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;
      Specified by:
      getNeighborsRatio in interface GlobalCheapestInsertionParametersOrBuilder
      Returns:
      The neighborsRatio.

    • setNeighborsRatio

      public 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.

    • clearNeighborsRatio

      public 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.

    • getMinNeighbors

      public int getMinNeighbors()
      int32 min_neighbors = 3;
      Specified by:
      getMinNeighbors in interface GlobalCheapestInsertionParametersOrBuilder
      Returns:
      The minNeighbors.

    • setMinNeighbors

      public GlobalCheapestInsertionParameters.Builder setMinNeighbors(int value)
      int32 min_neighbors = 3;
      Parameters:
      value - The minNeighbors to set.
      Returns:
      This builder for chaining.

    • clearMinNeighbors

      public GlobalCheapestInsertionParameters.Builder clearMinNeighbors()
      int32 min_neighbors = 3;
      Returns:
      This builder for chaining.

    • getUseNeighborsRatioForInitialization

      public boolean 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;
      Specified by:
      getUseNeighborsRatioForInitialization in interface GlobalCheapestInsertionParametersOrBuilder
      Returns:
      The useNeighborsRatioForInitialization.

    • setUseNeighborsRatioForInitialization

      public 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.

    • clearUseNeighborsRatioForInitialization

      public 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.

    • getAddUnperformedEntries

      public boolean 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;
      Specified by:
      getAddUnperformedEntries in interface GlobalCheapestInsertionParametersOrBuilder
      Returns:
      The addUnperformedEntries.

    • setAddUnperformedEntries

      public 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.

    • clearAddUnperformedEntries

      public 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.