Package operations_research.pdlp

Enum Solvers.PrimalDualHybridGradientParams.LinesearchRule

    • Enum Constant Detail

      • ADAPTIVE_LINESEARCH_RULE

        public static final Solvers.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 Solvers.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;

    • Field Detail

      • LINESEARCH_RULE_UNSPECIFIED_VALUE

        public static final int LINESEARCH_RULE_UNSPECIFIED_VALUE
        LINESEARCH_RULE_UNSPECIFIED = 0;
        See Also:
        Constant Field Values

      • 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:
        Constant Field Values

      • 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 Field Values

      • 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:
        Constant Field Values

    • Method Detail

      • values

        public static Solvers.PrimalDualHybridGradientParams.LinesearchRule[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (Solvers.PrimalDualHybridGradientParams.LinesearchRule c : Solvers.PrimalDualHybridGradientParams.LinesearchRule.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static Solvers.PrimalDualHybridGradientParams.LinesearchRule valueOf​(java.lang.String name)
        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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.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
public static Solvers.PrimalDualHybridGradientParams.LinesearchRule valueOf​(int value)
        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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • 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 final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

      • valueOf

        public static Solvers.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null