Package io.deephaven.util.compare

Class BooleanComparisons

java.lang.Object
io.deephaven.util.compare.BooleanComparisons
public class BooleanComparisons extends Object

  • Constructor Summary

    Constructors
    Constructor
    Description
    BooleanComparisons()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static int
    compare(boolean lhs, boolean rhs)
    Compares two booleans with false before true.
    static boolean
    eq(boolean lhs, boolean rhs)
    Compare two booleans for equality consistent with compare(boolean, boolean); that is compare(lhs, rhs) == 0 ⇒ eq(lhs, rhs) and compare(lhs, rhs) != 0 ⇒ !eq(lhs, rhs).
    static boolean
    geq(boolean lhs, boolean rhs)
    Logically equivalent to compare(lhs, rhs) >= 0.
    static boolean
    gt(boolean lhs, boolean rhs)
    Logically equivalent to compare(lhs, rhs) > 0.
    static int
    hashCode(boolean x)
    Returns a hash code for a boolean value consistent with eq(boolean, boolean); that is, eq(x, y) ⇒ hashCode(x) == hashCode(y).
    static boolean
    leq(boolean lhs, boolean rhs)
    Logically equivalent to compare(lhs, rhs) <= 0.
    static boolean
    lt(boolean lhs, boolean rhs)
    Logically equivalent to compare(lhs, rhs) < 0.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • BooleanComparisons

      public BooleanComparisons()

  • Method Details

    • compare

      public static int compare(boolean lhs, boolean rhs)
      Compares two booleans with false before true.
      Parameters:
      lhs - the first value
      rhs - the second value
      Returns:
      the value 0 if lhs is equal to rhs; a value less than 0 if lhs is less than rhs; and a value greater than 0 if lhs is greater than rhs

    • eq

      public static boolean eq(boolean lhs, boolean rhs)
      Compare two booleans for equality consistent with compare(boolean, boolean); that is compare(lhs, rhs) == 0 ⇒ eq(lhs, rhs) and compare(lhs, rhs) != 0 ⇒ !eq(lhs, rhs).

      Logically equivalent to compare(lhs, rhs) == 0.

      Parameters:
      lhs - the first value
      rhs - the second value
      Returns:
      true if the values are equal, false otherwise

    • hashCode

      public static int hashCode(boolean x)
      Returns a hash code for a boolean value consistent with eq(boolean, boolean); that is, eq(x, y) ⇒ hashCode(x) == hashCode(y).
      Parameters:
      x - the value to hash
      Returns:
      a hash code value for a boolean value

    • gt

      public static boolean gt(boolean lhs, boolean rhs)
      Logically equivalent to compare(lhs, rhs) > 0.
      Parameters:
      lhs - the first value
      rhs - the second value
      Returns:
      true iff lhs is greater than rhs

    • lt

      public static boolean lt(boolean lhs, boolean rhs)
      Logically equivalent to compare(lhs, rhs) < 0.
      Parameters:
      lhs - the first value
      rhs - the second value
      Returns:
      true iff lhs is less than rhs

    • geq

      public static boolean geq(boolean lhs, boolean rhs)
      Logically equivalent to compare(lhs, rhs) >= 0.
      Parameters:
      lhs - the first value
      rhs - the second value
      Returns:
      true iff lhs is greater than or equal to rhs

    • leq

      public static boolean leq(boolean lhs, boolean rhs)
      Logically equivalent to compare(lhs, rhs) <= 0.
      Parameters:
      lhs - the first value
      rhs - the second value
      Returns:
      true iff lhs is less than or equal to rhs