Package com.google.ortools.glop

Enum GlopParameters.CostScalingAlgorithm

java.lang.Object
java.lang.Enum<GlopParameters.CostScalingAlgorithm>
com.google.ortools.glop.GlopParameters.CostScalingAlgorithm
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<GlopParameters.CostScalingAlgorithm>, java.lang.constant.Constable
Enclosing class:
GlopParameters
public static enum GlopParameters.CostScalingAlgorithm extends Enum<GlopParameters.CostScalingAlgorithm> implements com.google.protobuf.ProtocolMessageEnum
 This is only used if use_scaling is true. After the scaling is done, we
 also scale the objective by a constant factor. This is important because
 scaling the cost has a direct influence on the meaning of the
 dual_feasibility_tolerance. Because we usually use a fixed tolerance, the
 objective must be well scaled to make sense.
Protobuf enum operations_research.glop.GlopParameters.CostScalingAlgorithm

  • Enum Constant Details

    • NO_COST_SCALING

      public static final GlopParameters.CostScalingAlgorithm NO_COST_SCALING
       Leave the cost as is.
      NO_COST_SCALING = 0;

    • CONTAIN_ONE_COST_SCALING

      public static final GlopParameters.CostScalingAlgorithm CONTAIN_ONE_COST_SCALING
       This is the most defensive option. It makes sure that
 [min_cost_magnitude, max_cost_magnitude] contains 1.0, and if not, it
 makes the closest magnitude bound equal to one.
      CONTAIN_ONE_COST_SCALING = 1;

    • MEAN_COST_SCALING

      public static final GlopParameters.CostScalingAlgorithm MEAN_COST_SCALING
       Make the mean of the non-zero costs equals to one.
      MEAN_COST_SCALING = 2;

    • MEDIAN_COST_SCALING

      public static final GlopParameters.CostScalingAlgorithm MEDIAN_COST_SCALING
       Make the median of the non-zero costs equals to one.
      MEDIAN_COST_SCALING = 3;

  • Field Details

    • NO_COST_SCALING_VALUE

      public static final int NO_COST_SCALING_VALUE
       Leave the cost as is.
      NO_COST_SCALING = 0;
      See Also:

    • CONTAIN_ONE_COST_SCALING_VALUE

      public static final int CONTAIN_ONE_COST_SCALING_VALUE
       This is the most defensive option. It makes sure that
 [min_cost_magnitude, max_cost_magnitude] contains 1.0, and if not, it
 makes the closest magnitude bound equal to one.
      CONTAIN_ONE_COST_SCALING = 1;
      See Also:

    • MEAN_COST_SCALING_VALUE

      public static final int MEAN_COST_SCALING_VALUE
       Make the mean of the non-zero costs equals to one.
      MEAN_COST_SCALING = 2;
      See Also:

    • MEDIAN_COST_SCALING_VALUE

      public static final int MEDIAN_COST_SCALING_VALUE
       Make the median of the non-zero costs equals to one.
      MEDIAN_COST_SCALING = 3;
      See Also:

  • Method Details

    • values

      public static GlopParameters.CostScalingAlgorithm[] 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

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

    • forNumber

      public static GlopParameters.CostScalingAlgorithm 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<GlopParameters.CostScalingAlgorithm> 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 final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

    • valueOf

      public static GlopParameters.CostScalingAlgorithm 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