Package operations_research.pdlp

Enum Solvers.PrimalDualHybridGradientParams.RestartStrategy

    • Enum Constant Detail

      • ADAPTIVE_HEURISTIC

        public static final Solvers.PrimalDualHybridGradientParams.RestartStrategy ADAPTIVE_HEURISTIC
         A heuristic that adaptively decides on every major iteration whether to
 restart (this is forced approximately on increasing powers-of-two
 iterations), and if so to the current or to the average, based on
 reduction in a potential function. The rule more or less follows the
 description of the adaptive restart scheme in
 https://arxiv.org/pdf/2106.04756.pdf.
        ADAPTIVE_HEURISTIC = 3;

      • ADAPTIVE_DISTANCE_BASED

        public static final Solvers.PrimalDualHybridGradientParams.RestartStrategy ADAPTIVE_DISTANCE_BASED
         A distance-based restarting scheme that restarts the algorithm whenever
 an appropriate potential function is reduced sufficiently. This check
 happens at every major iteration.
 TODO(user): Cite paper for the restart strategy and definition of the
 potential function, when available.
        ADAPTIVE_DISTANCE_BASED = 4;

    • Field Detail

      • RESTART_STRATEGY_UNSPECIFIED_VALUE

        public static final int RESTART_STRATEGY_UNSPECIFIED_VALUE
        RESTART_STRATEGY_UNSPECIFIED = 0;
        See Also:
        Constant Field Values

      • NO_RESTARTS_VALUE

        public static final int NO_RESTARTS_VALUE
         No restarts are performed. The average solution is cleared every major
 iteration, but the current solution is not changed.
        NO_RESTARTS = 1;
        See Also:
        Constant Field Values

      • EVERY_MAJOR_ITERATION_VALUE

        public static final int EVERY_MAJOR_ITERATION_VALUE
         On every major iteration, the current solution is reset to the average
 since the last major iteration.
        EVERY_MAJOR_ITERATION = 2;
        See Also:
        Constant Field Values

      • ADAPTIVE_HEURISTIC_VALUE

        public static final int ADAPTIVE_HEURISTIC_VALUE
         A heuristic that adaptively decides on every major iteration whether to
 restart (this is forced approximately on increasing powers-of-two
 iterations), and if so to the current or to the average, based on
 reduction in a potential function. The rule more or less follows the
 description of the adaptive restart scheme in
 https://arxiv.org/pdf/2106.04756.pdf.
        ADAPTIVE_HEURISTIC = 3;
        See Also:
        Constant Field Values

      • ADAPTIVE_DISTANCE_BASED_VALUE

        public static final int ADAPTIVE_DISTANCE_BASED_VALUE
         A distance-based restarting scheme that restarts the algorithm whenever
 an appropriate potential function is reduced sufficiently. This check
 happens at every major iteration.
 TODO(user): Cite paper for the restart strategy and definition of the
 potential function, when available.
        ADAPTIVE_DISTANCE_BASED = 4;
        See Also:
        Constant Field Values

    • Method Detail

      • values

        public static Solvers.PrimalDualHybridGradientParams.RestartStrategy[] 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.RestartStrategy c : Solvers.PrimalDualHybridGradientParams.RestartStrategy.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.RestartStrategy 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.RestartStrategy 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.RestartStrategy 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