Class SavingsParameters

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.ortools.constraintsolver.SavingsParameters
All Implemented Interfaces:
SavingsParametersOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class SavingsParameters extends com.google.protobuf.GeneratedMessage implements SavingsParametersOrBuilder
Parameters used to configure savings heuristics.
Protobuf type operations_research.SavingsParameters
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    SavingsParameters.Builder
    Parameters used to configure savings heuristics.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ADD_REVERSE_ARCS_FIELD_NUMBER
     
    static final int
    ARC_COEFFICIENT_FIELD_NUMBER
     
    static final int
    MAX_MEMORY_USAGE_BYTES_FIELD_NUMBER
     
    static final int
    NEIGHBORS_RATIO_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    boolean
    getAddReverseArcs()
    Add savings related to reverse arcs when finding the nearest neighbors of the nodes.
    double
    getArcCoefficient()
    Coefficient of the cost of the arc for which the saving value is being computed: Saving(a-->b) = Cost(a-->end) + Cost(start-->b) - arc_coefficient * Cost(a-->b) This parameter must be greater than 0, and its default value is 1.
    static SavingsParameters
    getDefaultInstance()
     
    SavingsParameters
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    double
    getMaxMemoryUsageBytes()
    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 max_memory_usage_bytes, which must be in ]0, 1e10].
    double
    getNeighborsRatio()
    Ratio (in ]0, 1]) of neighbors to consider for each node when constructing the savings.
    com.google.protobuf.Parser<SavingsParameters>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static SavingsParameters.Builder
    newBuilder()
     
    static SavingsParameters.Builder
    newBuilder(SavingsParameters prototype)
     
    SavingsParameters.Builder
    newBuilderForType()
     
    protected SavingsParameters.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static SavingsParameters
    parseDelimitedFrom(InputStream input)
     
    static SavingsParameters
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SavingsParameters
    parseFrom(byte[] data)
     
    static SavingsParameters
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SavingsParameters
    parseFrom(com.google.protobuf.ByteString data)
     
    static SavingsParameters
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SavingsParameters
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static SavingsParameters
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SavingsParameters
    parseFrom(InputStream input)
     
    static SavingsParameters
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SavingsParameters
    parseFrom(ByteBuffer data)
     
    static SavingsParameters
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<SavingsParameters>
    parser()
     
    SavingsParameters.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • NEIGHBORS_RATIO_FIELD_NUMBER

      public static final int NEIGHBORS_RATIO_FIELD_NUMBER
      See Also:

    • MAX_MEMORY_USAGE_BYTES_FIELD_NUMBER

      public static final int MAX_MEMORY_USAGE_BYTES_FIELD_NUMBER
      See Also:

    • ADD_REVERSE_ARCS_FIELD_NUMBER

      public static final int ADD_REVERSE_ARCS_FIELD_NUMBER
      See Also:

    • ARC_COEFFICIENT_FIELD_NUMBER

      public static final int ARC_COEFFICIENT_FIELD_NUMBER
      See Also:

  • 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

    • getNeighborsRatio

      public double getNeighborsRatio()
      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 neighbors_ratio = 1;
      Specified by:
      getNeighborsRatio in interface SavingsParametersOrBuilder
      Returns:
      The neighborsRatio.

    • getMaxMemoryUsageBytes

      public double getMaxMemoryUsageBytes()
      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
max_memory_usage_bytes, which must be in ]0, 1e10].
NOTE: If both neighbors_ratio and 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 max_memory_usage_bytes = 2;
      Specified by:
      getMaxMemoryUsageBytes in interface SavingsParametersOrBuilder
      Returns:
      The maxMemoryUsageBytes.

    • getAddReverseArcs

      public boolean getAddReverseArcs()
      Add savings related to reverse arcs when finding the nearest neighbors
of the nodes.
      bool add_reverse_arcs = 3;
      Specified by:
      getAddReverseArcs in interface SavingsParametersOrBuilder
      Returns:
      The addReverseArcs.

    • getArcCoefficient

      public double getArcCoefficient()
      Coefficient of the cost of the arc for which the saving value is being
computed:
Saving(a-->b) = Cost(a-->end) + Cost(start-->b)
- arc_coefficient * Cost(a-->b)
This parameter must be greater than 0, and its default value is 1.
      double arc_coefficient = 4;
      Specified by:
      getArcCoefficient in interface SavingsParametersOrBuilder
      Returns:
      The arcCoefficient.

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static SavingsParameters parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SavingsParameters parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SavingsParameters parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SavingsParameters parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SavingsParameters parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SavingsParameters parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SavingsParameters parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SavingsParameters parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SavingsParameters parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SavingsParameters parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SavingsParameters parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SavingsParameters parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public SavingsParameters.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static SavingsParameters.Builder newBuilder()

    • newBuilder

      public static SavingsParameters.Builder newBuilder(SavingsParameters prototype)

    • toBuilder

      public SavingsParameters.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected SavingsParameters.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static SavingsParameters getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SavingsParameters> parser()

    • getParserForType

      public com.google.protobuf.Parser<SavingsParameters> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

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