Enum PrimalDualHybridGradientParams.LinesearchRule

java.lang.Object
java.lang.Enum<PrimalDualHybridGradientParams.LinesearchRule>
com.google.ortools.pdlp.PrimalDualHybridGradientParams.LinesearchRule
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<PrimalDualHybridGradientParams.LinesearchRule>, java.lang.constant.Constable
Enclosing class:
PrimalDualHybridGradientParams

public static enum PrimalDualHybridGradientParams.LinesearchRule extends Enum<PrimalDualHybridGradientParams.LinesearchRule> implements com.google.protobuf.ProtocolMessageEnum
Protobuf enum operations_research.pdlp.PrimalDualHybridGradientParams.LinesearchRule
  • Enum Constant Details

    • LINESEARCH_RULE_UNSPECIFIED

      public static final PrimalDualHybridGradientParams.LinesearchRule LINESEARCH_RULE_UNSPECIFIED
      LINESEARCH_RULE_UNSPECIFIED = 0;
    • ADAPTIVE_LINESEARCH_RULE

      public static final PrimalDualHybridGradientParams.LinesearchRule ADAPTIVE_LINESEARCH_RULE
       Applies the heuristic rule presented in Section 3.1 of
       https://arxiv.org/pdf/2106.04756.pdf (further generalized to QP). There
       is not a proof of convergence for it. It is usually the fastest in
       practice but sometimes behaves poorly.
       
      ADAPTIVE_LINESEARCH_RULE = 1;
    • MALITSKY_POCK_LINESEARCH_RULE

      public static final PrimalDualHybridGradientParams.LinesearchRule MALITSKY_POCK_LINESEARCH_RULE
       Applies Malitsky & Pock linesearch rule. This guarantees an
       ergodic O(1/N) convergence rate https://arxiv.org/pdf/1608.08883.pdf.
       This is provably convergent but doesn't usually work as well in practice
       as ADAPTIVE_LINESEARCH_RULE.
       
      MALITSKY_POCK_LINESEARCH_RULE = 2;
    • CONSTANT_STEP_SIZE_RULE

      public static final PrimalDualHybridGradientParams.LinesearchRule CONSTANT_STEP_SIZE_RULE
       Uses a constant step size corresponding to an estimate of the maximum
       singular value of the constraint matrix.
       
      CONSTANT_STEP_SIZE_RULE = 3;
  • Field Details

    • LINESEARCH_RULE_UNSPECIFIED_VALUE

      public static final int LINESEARCH_RULE_UNSPECIFIED_VALUE
      LINESEARCH_RULE_UNSPECIFIED = 0;
      See Also:
    • ADAPTIVE_LINESEARCH_RULE_VALUE

      public static final int ADAPTIVE_LINESEARCH_RULE_VALUE
       Applies the heuristic rule presented in Section 3.1 of
       https://arxiv.org/pdf/2106.04756.pdf (further generalized to QP). There
       is not a proof of convergence for it. It is usually the fastest in
       practice but sometimes behaves poorly.
       
      ADAPTIVE_LINESEARCH_RULE = 1;
      See Also:
    • MALITSKY_POCK_LINESEARCH_RULE_VALUE

      public static final int MALITSKY_POCK_LINESEARCH_RULE_VALUE
       Applies Malitsky & Pock linesearch rule. This guarantees an
       ergodic O(1/N) convergence rate https://arxiv.org/pdf/1608.08883.pdf.
       This is provably convergent but doesn't usually work as well in practice
       as ADAPTIVE_LINESEARCH_RULE.
       
      MALITSKY_POCK_LINESEARCH_RULE = 2;
      See Also:
    • CONSTANT_STEP_SIZE_RULE_VALUE

      public static final int CONSTANT_STEP_SIZE_RULE_VALUE
       Uses a constant step size corresponding to an estimate of the maximum
       singular value of the constraint matrix.
       
      CONSTANT_STEP_SIZE_RULE = 3;
      See Also:
  • Method Details

    • values

      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null
    • getNumber

      public final int getNumber()
      Specified by:
      getNumber in interface com.google.protobuf.Internal.EnumLite
      Specified by:
      getNumber in interface com.google.protobuf.ProtocolMessageEnum
    • valueOf

      Deprecated.
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      value - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null
    • forNumber

      public static PrimalDualHybridGradientParams.LinesearchRule forNumber(int value)
      Parameters:
      value - The numeric wire value of the corresponding enum entry.
      Returns:
      The enum associated with the given numeric wire value.
    • internalGetValueMap

      public static com.google.protobuf.Internal.EnumLiteMap<PrimalDualHybridGradientParams.LinesearchRule> internalGetValueMap()
    • getValueDescriptor

      public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()
      Specified by:
      getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum
    • getDescriptorForType

      public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum
    • getDescriptor

      public static com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()
    • valueOf

      public static PrimalDualHybridGradientParams.LinesearchRule valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      desc - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null