Class AdaptiveLinesearchParams

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.ortools.pdlp.AdaptiveLinesearchParams
All Implemented Interfaces:
AdaptiveLinesearchParamsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class AdaptiveLinesearchParams extends com.google.protobuf.GeneratedMessage implements AdaptiveLinesearchParamsOrBuilder
 At the end of each iteration, regardless of whether the step was accepted
 or not, the adaptive rule updates the step_size as the minimum of two
 potential step sizes defined by the following two exponents.
 
Protobuf type operations_research.pdlp.AdaptiveLinesearchParams
See Also:
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    At the end of each iteration, regardless of whether the step was accepted or not, the adaptive rule updates the step_size as the minimum of two potential step sizes defined by the following two exponents.

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

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>, BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, 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
     
    static final int
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, 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
     
     
     
    static final com.google.protobuf.Descriptors.Descriptor
     
    com.google.protobuf.Parser<AdaptiveLinesearchParams>
     
    int
     
    double
    The step size growth exponent defines a step size given by (1 + (total_steps_attempted + 1)^(-step_size_growth_exponent)) * step_size_.
    double
    The step size reduction exponent defines a step size given by (1 - (total_steps_attempted + 1)^(-step_size_reduction_exponent)) * step_size_limit where step_size_limit is the maximum allowed step size at the current iteration.
    int
     
    boolean
    The step size growth exponent defines a step size given by (1 + (total_steps_attempted + 1)^(-step_size_growth_exponent)) * step_size_.
    boolean
    The step size reduction exponent defines a step size given by (1 - (total_steps_attempted + 1)^(-step_size_reduction_exponent)) * step_size_limit where step_size_limit is the maximum allowed step size at the current iteration.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
     
    final boolean
     
     
     
     
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
     
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(byte[] data)
     
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(com.google.protobuf.ByteString data)
     
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
     
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
     
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<AdaptiveLinesearchParams>
     
     
    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, 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 java.lang.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

    • STEP_SIZE_REDUCTION_EXPONENT_FIELD_NUMBER

      public static final int STEP_SIZE_REDUCTION_EXPONENT_FIELD_NUMBER
      See Also:
    • STEP_SIZE_GROWTH_EXPONENT_FIELD_NUMBER

      public static final int STEP_SIZE_GROWTH_EXPONENT_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
    • hasStepSizeReductionExponent

      public boolean hasStepSizeReductionExponent()
       The step size reduction exponent defines a step size given by
       (1 - (total_steps_attempted + 1)^(-step_size_reduction_exponent)) *
       step_size_limit where step_size_limit is the maximum allowed step size at
       the current iteration. This should be between 0.1 and 1.
       
      optional double step_size_reduction_exponent = 1 [default = 0.3];
      Specified by:
      hasStepSizeReductionExponent in interface AdaptiveLinesearchParamsOrBuilder
      Returns:
      Whether the stepSizeReductionExponent field is set.
    • getStepSizeReductionExponent

      public double getStepSizeReductionExponent()
       The step size reduction exponent defines a step size given by
       (1 - (total_steps_attempted + 1)^(-step_size_reduction_exponent)) *
       step_size_limit where step_size_limit is the maximum allowed step size at
       the current iteration. This should be between 0.1 and 1.
       
      optional double step_size_reduction_exponent = 1 [default = 0.3];
      Specified by:
      getStepSizeReductionExponent in interface AdaptiveLinesearchParamsOrBuilder
      Returns:
      The stepSizeReductionExponent.
    • hasStepSizeGrowthExponent

      public boolean hasStepSizeGrowthExponent()
       The step size growth exponent defines a step size given by (1 +
       (total_steps_attempted + 1)^(-step_size_growth_exponent)) * step_size_.
       This should be between 0.1 and 1.
       
      optional double step_size_growth_exponent = 2 [default = 0.6];
      Specified by:
      hasStepSizeGrowthExponent in interface AdaptiveLinesearchParamsOrBuilder
      Returns:
      Whether the stepSizeGrowthExponent field is set.
    • getStepSizeGrowthExponent

      public double getStepSizeGrowthExponent()
       The step size growth exponent defines a step size given by (1 +
       (total_steps_attempted + 1)^(-step_size_growth_exponent)) * step_size_.
       This should be between 0.1 and 1.
       
      optional double step_size_growth_exponent = 2 [default = 0.6];
      Specified by:
      getStepSizeGrowthExponent in interface AdaptiveLinesearchParamsOrBuilder
      Returns:
      The stepSizeGrowthExponent.
    • 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 AdaptiveLinesearchParams parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

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

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

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

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

      public static AdaptiveLinesearchParams parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

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

      public static AdaptiveLinesearchParams parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

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

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

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

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

      public static AdaptiveLinesearchParams.Builder newBuilder()
    • newBuilder

      public static AdaptiveLinesearchParams.Builder newBuilder(AdaptiveLinesearchParams prototype)
    • toBuilder

      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

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

      public static AdaptiveLinesearchParams getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<AdaptiveLinesearchParams> parser()
    • getParserForType

      public com.google.protobuf.Parser<AdaptiveLinesearchParams> 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 AdaptiveLinesearchParams getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder