Class SISRRuinStrategy.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<SISRRuinStrategy.Builder>
com.google.protobuf.GeneratedMessage.Builder<SISRRuinStrategy.Builder>
com.google.ortools.constraintsolver.SISRRuinStrategy.Builder
All Implemented Interfaces:
SISRRuinStrategyOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
SISRRuinStrategy
public static final class SISRRuinStrategy.Builder extends com.google.protobuf.GeneratedMessage.Builder<SISRRuinStrategy.Builder> implements SISRRuinStrategyOrBuilder
 Ruin strategy based on the "Slack Induction by String Removals for Vehicle
 Routing Problems" by Jan Christiaens and Greet Vanden Berghe, Transportation
 Science 2020.
 Link to paper:
 https://kuleuven.limo.libis.be/discovery/fulldisplay?docid=lirias1988666&context=SearchWebhook&vid=32KUL_KUL:Lirias&lang=en&search_scope=lirias_profile&adaptor=SearchWebhook&tab=LIRIAS&query=any,contains,LIRIAS1988666&offset=0

 Note that, in this implementation, the notion of "string" is replaced by
 "sequence".

 The main idea of this ruin is to remove a number of geographically close
 sequences of nodes. In particular, at every ruin application, a maximum
 number max_ruined_routes of routes are disrupted. The value for
 max_ruined_routes is defined as
 (4 * avg_num_removed_visits) / (1 + max_sequence_size) + 1
 with
 - avg_num_removed_visits: user-defined parameter ruling the average number of
 visits that are removed in face of several ruin applications (see also the
 proto message below)
 - max_sequence_size is defined as
 min{max_removed_sequence_size, average_route_size}
 with
 - max_removed_sequence_size: user-defined parameter that specifies
 the maximum number of visits removed from a single route (see also the
 proto message below)
 - average_route_size: the average size of a non-empty route in the current
 solution

 The actual number of ruined routes is then obtained as
 floor(U(1, max_ruined_routes + 1))
 where U is a continuous uniform distribution of real values in the given
 interval.

 The routes affected by the ruin procedure are selected as follows.
 First, a non start/end seed node is randomly selected. The route serving this
 node is the first ruined route. Then, until the required number of routes has
 been ruined, neighbor nodes of the initial seed node are scanned and the
 associated not yet ruined routes are disrupted. Nodes defining the selected
 routes are designated as seed nodes for the "sequence" and "split sequence"
 removal procedures described below.

 For every selected route, a maximum number route_max_sequence_size of nodes
 are removed. In particular, route_max_sequence_size is defined as
 min{route_size, max_sequence_size}
 with route_size being the size of the current route.

 Then, the actual number of removed nodes num_removed_nodes is defined as
 floor(U(1, route_max_sequence_size + 1))
 where U is a continuous uniform distribution of real values in the given
 interval.

 As mentioned above, the selected num_removed_nodes number of nodes is removed
 either via the "sequence" removal or "split sequence" removal procedures. The
 two removal procedures are executed with equal probabilities.

 The "sequence" removal procedure removes a randomly selected sequence of size
 num_removed_nodes that includes the seed node.

 The "split sequence" removal procedure also removes a randomly selected
 sequence of size num_removed_nodes that includes the seed node, but it can
 possibly preserve a subsequence of contiguous nodes.
 In particular, the procedure first selects a sequence of size
 num_removed_nodes + num_bypassed, then num_bypassed contiguous nodes in the
 selected sequence are preserved while the others removed.

 The definition of num_bypassed is as follows. First num_bypassed = 1. The
 current value of num_bypassed is maintaned if
 U(0, 1) < bypass_factor * U(0, 1)
 or the maximum value for num_bypassed, equal to
 route_size - num_removed_nodes
 is reached. The value is incremented of a unit otherwise,
 and the process is repeated. The value assigned to bypass_factor affects the
 number of preserved visits (see also the proto message below).
Protobuf type operations_research.SISRRuinStrategy

  • 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<SISRRuinStrategy.Builder>

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

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

    • mergeFrom

      public SISRRuinStrategy.Builder mergeFrom(SISRRuinStrategy other)

    • isInitialized

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

    • mergeFrom

      public SISRRuinStrategy.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<SISRRuinStrategy.Builder>
      Throws:
      IOException

    • hasMaxRemovedSequenceSize

      public boolean hasMaxRemovedSequenceSize()
       Maximum number of removed visits per sequence. The parameter name in the
 paper is L^{max} and the suggested value is 10.
      optional uint32 max_removed_sequence_size = 1;
      Specified by:
      hasMaxRemovedSequenceSize in interface SISRRuinStrategyOrBuilder
      Returns:
      Whether the maxRemovedSequenceSize field is set.

    • getMaxRemovedSequenceSize

      public int getMaxRemovedSequenceSize()
       Maximum number of removed visits per sequence. The parameter name in the
 paper is L^{max} and the suggested value is 10.
      optional uint32 max_removed_sequence_size = 1;
      Specified by:
      getMaxRemovedSequenceSize in interface SISRRuinStrategyOrBuilder
      Returns:
      The maxRemovedSequenceSize.

    • setMaxRemovedSequenceSize

      public SISRRuinStrategy.Builder setMaxRemovedSequenceSize(int value)
       Maximum number of removed visits per sequence. The parameter name in the
 paper is L^{max} and the suggested value is 10.
      optional uint32 max_removed_sequence_size = 1;
      Parameters:
      value - The maxRemovedSequenceSize to set.
      Returns:
      This builder for chaining.

    • clearMaxRemovedSequenceSize

      public SISRRuinStrategy.Builder clearMaxRemovedSequenceSize()
       Maximum number of removed visits per sequence. The parameter name in the
 paper is L^{max} and the suggested value is 10.
      optional uint32 max_removed_sequence_size = 1;
      Returns:
      This builder for chaining.

    • hasAvgNumRemovedVisits

      public boolean hasAvgNumRemovedVisits()
       Number of visits that are removed on average. The parameter name in the
 paper is \bar{c} and the suggested value is 10.
      optional uint32 avg_num_removed_visits = 2;
      Specified by:
      hasAvgNumRemovedVisits in interface SISRRuinStrategyOrBuilder
      Returns:
      Whether the avgNumRemovedVisits field is set.

    • getAvgNumRemovedVisits

      public int getAvgNumRemovedVisits()
       Number of visits that are removed on average. The parameter name in the
 paper is \bar{c} and the suggested value is 10.
      optional uint32 avg_num_removed_visits = 2;
      Specified by:
      getAvgNumRemovedVisits in interface SISRRuinStrategyOrBuilder
      Returns:
      The avgNumRemovedVisits.

    • setAvgNumRemovedVisits

      public SISRRuinStrategy.Builder setAvgNumRemovedVisits(int value)
       Number of visits that are removed on average. The parameter name in the
 paper is \bar{c} and the suggested value is 10.
      optional uint32 avg_num_removed_visits = 2;
      Parameters:
      value - The avgNumRemovedVisits to set.
      Returns:
      This builder for chaining.

    • clearAvgNumRemovedVisits

      public SISRRuinStrategy.Builder clearAvgNumRemovedVisits()
       Number of visits that are removed on average. The parameter name in the
 paper is \bar{c} and the suggested value is 10.
      optional uint32 avg_num_removed_visits = 2;
      Returns:
      This builder for chaining.

    • hasBypassFactor

      public boolean hasBypassFactor()
       Value in [0, 1] ruling the number of preserved customers in the split
 sequence removal. The parameter name in the paper is \alpha and the
 suggested value is 0.01.
      optional double bypass_factor = 3;
      Specified by:
      hasBypassFactor in interface SISRRuinStrategyOrBuilder
      Returns:
      Whether the bypassFactor field is set.

    • getBypassFactor

      public double getBypassFactor()
       Value in [0, 1] ruling the number of preserved customers in the split
 sequence removal. The parameter name in the paper is \alpha and the
 suggested value is 0.01.
      optional double bypass_factor = 3;
      Specified by:
      getBypassFactor in interface SISRRuinStrategyOrBuilder
      Returns:
      The bypassFactor.

    • setBypassFactor

      public SISRRuinStrategy.Builder setBypassFactor(double value)
       Value in [0, 1] ruling the number of preserved customers in the split
 sequence removal. The parameter name in the paper is \alpha and the
 suggested value is 0.01.
      optional double bypass_factor = 3;
      Parameters:
      value - The bypassFactor to set.
      Returns:
      This builder for chaining.

    • clearBypassFactor

      public SISRRuinStrategy.Builder clearBypassFactor()
       Value in [0, 1] ruling the number of preserved customers in the split
 sequence removal. The parameter name in the paper is \alpha and the
 suggested value is 0.01.
      optional double bypass_factor = 3;
      Returns:
      This builder for chaining.