Class MalitskyPockParams

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.ortools.pdlp.MalitskyPockParams
All Implemented Interfaces:
MalitskyPockParamsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class MalitskyPockParams extends com.google.protobuf.GeneratedMessage implements MalitskyPockParamsOrBuilder
Protobuf type operations_research.pdlp.MalitskyPockParams
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    MalitskyPockParams.Builder
    Protobuf type operations_research.pdlp.MalitskyPockParams

    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
    LINESEARCH_CONTRACTION_FACTOR_FIELD_NUMBER
     
    static final int
    STEP_SIZE_DOWNSCALING_FACTOR_FIELD_NUMBER
     
    static final int
    STEP_SIZE_INTERPOLATION_FIELD_NUMBER
     

    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
    equals(Object obj)
     
    static MalitskyPockParams
    getDefaultInstance()
     
    MalitskyPockParams
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    double
    getLinesearchContractionFactor()
    Contraction factor used in the linesearch condition of Malitsky and Pock.
    com.google.protobuf.Parser<MalitskyPockParams>
    getParserForType()
     
    int
    getSerializedSize()
     
    double
    getStepSizeDownscalingFactor()
    At every inner iteration the algorithm can decide to accept the step size or to update it to step_size = step_size_downscaling_factor * step_size.
    double
    getStepSizeInterpolation()
    Malitsky and Pock linesearch rule permits an arbitrary choice of the first step size guess within an interval [m, M].
    int
    hashCode()
     
    boolean
    hasLinesearchContractionFactor()
    Contraction factor used in the linesearch condition of Malitsky and Pock.
    boolean
    hasStepSizeDownscalingFactor()
    At every inner iteration the algorithm can decide to accept the step size or to update it to step_size = step_size_downscaling_factor * step_size.
    boolean
    hasStepSizeInterpolation()
    Malitsky and Pock linesearch rule permits an arbitrary choice of the first step size guess within an interval [m, M].
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static MalitskyPockParams.Builder
    newBuilder()
     
    static MalitskyPockParams.Builder
    newBuilder(MalitskyPockParams prototype)
     
    MalitskyPockParams.Builder
    newBuilderForType()
     
    protected MalitskyPockParams.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static MalitskyPockParams
    parseDelimitedFrom(InputStream input)
     
    static MalitskyPockParams
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MalitskyPockParams
    parseFrom(byte[] data)
     
    static MalitskyPockParams
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MalitskyPockParams
    parseFrom(com.google.protobuf.ByteString data)
     
    static MalitskyPockParams
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MalitskyPockParams
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static MalitskyPockParams
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MalitskyPockParams
    parseFrom(InputStream input)
     
    static MalitskyPockParams
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static MalitskyPockParams
    parseFrom(ByteBuffer data)
     
    static MalitskyPockParams
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<MalitskyPockParams>
    parser()
     
    MalitskyPockParams.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, 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_DOWNSCALING_FACTOR_FIELD_NUMBER

      public static final int STEP_SIZE_DOWNSCALING_FACTOR_FIELD_NUMBER
      See Also:

    • LINESEARCH_CONTRACTION_FACTOR_FIELD_NUMBER

      public static final int LINESEARCH_CONTRACTION_FACTOR_FIELD_NUMBER
      See Also:

    • STEP_SIZE_INTERPOLATION_FIELD_NUMBER

      public static final int STEP_SIZE_INTERPOLATION_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

    • hasStepSizeDownscalingFactor

      public boolean hasStepSizeDownscalingFactor()
       At every inner iteration the algorithm can decide to accept the step size
 or to update it to step_size = step_size_downscaling_factor * step_size.
 This parameter should lie between 0 and 1. The default is the value used in
 Malitsky and Pock (2016).
      optional double step_size_downscaling_factor = 1 [default = 0.7];
      Specified by:
      hasStepSizeDownscalingFactor in interface MalitskyPockParamsOrBuilder
      Returns:
      Whether the stepSizeDownscalingFactor field is set.

    • getStepSizeDownscalingFactor

      public double getStepSizeDownscalingFactor()
       At every inner iteration the algorithm can decide to accept the step size
 or to update it to step_size = step_size_downscaling_factor * step_size.
 This parameter should lie between 0 and 1. The default is the value used in
 Malitsky and Pock (2016).
      optional double step_size_downscaling_factor = 1 [default = 0.7];
      Specified by:
      getStepSizeDownscalingFactor in interface MalitskyPockParamsOrBuilder
      Returns:
      The stepSizeDownscalingFactor.

    • hasLinesearchContractionFactor

      public boolean hasLinesearchContractionFactor()
       Contraction factor used in the linesearch condition of Malitsky and Pock.
 A step size is accepted if primal_weight * primal_stepsize *
 norm(constraint_matrix' * (next_dual - current_dual)) is less
 than linesearch_contraction_factor * norm(next_dual - current_dual).
 The default is the value used in Malitsky and Pock (2016).
      optional double linesearch_contraction_factor = 2 [default = 0.99];
      Specified by:
      hasLinesearchContractionFactor in interface MalitskyPockParamsOrBuilder
      Returns:
      Whether the linesearchContractionFactor field is set.

    • getLinesearchContractionFactor

      public double getLinesearchContractionFactor()
       Contraction factor used in the linesearch condition of Malitsky and Pock.
 A step size is accepted if primal_weight * primal_stepsize *
 norm(constraint_matrix' * (next_dual - current_dual)) is less
 than linesearch_contraction_factor * norm(next_dual - current_dual).
 The default is the value used in Malitsky and Pock (2016).
      optional double linesearch_contraction_factor = 2 [default = 0.99];
      Specified by:
      getLinesearchContractionFactor in interface MalitskyPockParamsOrBuilder
      Returns:
      The linesearchContractionFactor.

    • hasStepSizeInterpolation

      public boolean hasStepSizeInterpolation()
       Malitsky and Pock linesearch rule permits an arbitrary choice of the first
 step size guess within an interval [m, M]. This parameter determines where
 in that interval to pick the step size. In particular, the next stepsize is
 given by m + step_size_interpolation*(M - m). The default is the value used
 in Malitsky and Pock (2016).
      optional double step_size_interpolation = 3 [default = 1];
      Specified by:
      hasStepSizeInterpolation in interface MalitskyPockParamsOrBuilder
      Returns:
      Whether the stepSizeInterpolation field is set.

    • getStepSizeInterpolation

      public double getStepSizeInterpolation()
       Malitsky and Pock linesearch rule permits an arbitrary choice of the first
 step size guess within an interval [m, M]. This parameter determines where
 in that interval to pick the step size. In particular, the next stepsize is
 given by m + step_size_interpolation*(M - m). The default is the value used
 in Malitsky and Pock (2016).
      optional double step_size_interpolation = 3 [default = 1];
      Specified by:
      getStepSizeInterpolation in interface MalitskyPockParamsOrBuilder
      Returns:
      The stepSizeInterpolation.

    • 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 MalitskyPockParams parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static MalitskyPockParams.Builder newBuilder()

    • newBuilder

      public static MalitskyPockParams.Builder newBuilder(MalitskyPockParams prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static MalitskyPockParams getDefaultInstance()

    • parser

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

    • getParserForType

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