Package com.google.ortools.sat

Enum SatParameters.Polarity

java.lang.Object
java.lang.Enum<SatParameters.Polarity>
com.google.ortools.sat.SatParameters.Polarity
All Implemented Interfaces:
com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, java.io.Serializable, java.lang.Comparable<SatParameters.Polarity>, java.lang.constant.Constable
Enclosing class:
SatParameters
public static enum SatParameters.Polarity
extends java.lang.Enum<SatParameters.Polarity>
implements com.google.protobuf.ProtocolMessageEnum
 Specifies the initial polarity (true/false) when the solver branches on a
 variable. This can be modified later by the user, or the phase saving
 heuristic.
 Note(user): POLARITY_FALSE is usually a good choice because of the
 "natural" way to express a linear boolean problem.
Protobuf enum operations_research.sat.SatParameters.Polarity

  • Enum Constant Details

    • POLARITY_TRUE

      public static final SatParameters.Polarity POLARITY_TRUE
      POLARITY_TRUE = 0;

    • POLARITY_FALSE

      public static final SatParameters.Polarity POLARITY_FALSE
      POLARITY_FALSE = 1;

    • POLARITY_RANDOM

      public static final SatParameters.Polarity POLARITY_RANDOM
      POLARITY_RANDOM = 2;

    • POLARITY_WEIGHTED_SIGN

      public static final SatParameters.Polarity POLARITY_WEIGHTED_SIGN
       Choose the sign that tends to satisfy the most constraints. This is
 computed using a weighted sum: if a literal l appears in a constraint of
 the form: ... + coeff * l +... <= rhs with positive coefficients and
 rhs, then -sign(l) * coeff / rhs is added to the weight of l.variable().
      POLARITY_WEIGHTED_SIGN = 3;

    • POLARITY_REVERSE_WEIGHTED_SIGN

      public static final SatParameters.Polarity POLARITY_REVERSE_WEIGHTED_SIGN
       The opposite choice of POLARITY_WEIGHTED_SIGN.
      POLARITY_REVERSE_WEIGHTED_SIGN = 4;

  • Field Details

    • POLARITY_TRUE_VALUE

      public static final int POLARITY_TRUE_VALUE
      POLARITY_TRUE = 0;
      See Also:
      Constant Field Values

    • POLARITY_FALSE_VALUE

      public static final int POLARITY_FALSE_VALUE
      POLARITY_FALSE = 1;
      See Also:
      Constant Field Values

    • POLARITY_RANDOM_VALUE

      public static final int POLARITY_RANDOM_VALUE
      POLARITY_RANDOM = 2;
      See Also:
      Constant Field Values

    • POLARITY_WEIGHTED_SIGN_VALUE

      public static final int POLARITY_WEIGHTED_SIGN_VALUE
       Choose the sign that tends to satisfy the most constraints. This is
 computed using a weighted sum: if a literal l appears in a constraint of
 the form: ... + coeff * l +... <= rhs with positive coefficients and
 rhs, then -sign(l) * coeff / rhs is added to the weight of l.variable().
      POLARITY_WEIGHTED_SIGN = 3;
      See Also:
      Constant Field Values

    • POLARITY_REVERSE_WEIGHTED_SIGN_VALUE

      public static final int POLARITY_REVERSE_WEIGHTED_SIGN_VALUE
       The opposite choice of POLARITY_WEIGHTED_SIGN.
      POLARITY_REVERSE_WEIGHTED_SIGN = 4;
      See Also:
      Constant Field Values

  • Method Details

    • values

      public static SatParameters.Polarity[] 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 SatParameters.Polarity 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 SatParameters.Polarity 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

    • forNumber

      public static SatParameters.Polarity 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<SatParameters.Polarity> 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 SatParameters.Polarity 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