couldbe-cats
API
Generated with
couldbe-cats/eu.throup.couldbe/EqCouldBeGiven

EqCouldBeGiven

eu.throup.couldbe.EqCouldBeGiven
class EqCouldBeGiven[A] extends Hash[CouldBeGiven[A]] with PartialOrder[CouldBeGiven[A]]

Attributes

Graph
Supertypes
trait PartialOrder[CouldBeGiven[A]]
trait Hash[CouldBeGiven[A]]
trait Eq[CouldBeGiven[A]]
trait Serializable
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Concrete methods

override def hash(x: CouldBeGiven[A]): Int

Returns the hash code of the given object under this hashing scheme.

Returns the hash code of the given object under this hashing scheme.

Attributes

Definition Classes
Hash
override def partialCompare(x: CouldBeGiven[A], y: CouldBeGiven[A]): Double

Result of comparing x with y. Returns NaN if operands are not comparable. If operands are comparable, returns a Double whose sign is:

Result of comparing x with y. Returns NaN if operands are not comparable. If operands are comparable, returns a Double whose sign is:

  • negative iff x < y
  • zero iff x = y
  • positive iff x > y

Attributes

Definition Classes
PartialOrder

Inherited methods

def eqv(x: CouldBeGiven[A], y: CouldBeGiven[A]): Boolean

Returns true if x = y, false otherwise.

Returns true if x = y, false otherwise.

Attributes

Inherited from:
PartialOrder
def gt(x: CouldBeGiven[A], y: CouldBeGiven[A]): Boolean

Returns true if x > y, false otherwise.

Returns true if x > y, false otherwise.

Attributes

Inherited from:
PartialOrder
def gteqv(x: CouldBeGiven[A], y: CouldBeGiven[A]): Boolean

Returns true if x >= y, false otherwise.

Returns true if x >= y, false otherwise.

Attributes

Inherited from:
PartialOrder
def lt(x: CouldBeGiven[A], y: CouldBeGiven[A]): Boolean

Returns true if x < y, false otherwise.

Returns true if x < y, false otherwise.

Attributes

Inherited from:
PartialOrder
def lteqv(x: CouldBeGiven[A], y: CouldBeGiven[A]): Boolean

Returns true if x <= y, false otherwise.

Returns true if x <= y, false otherwise.

Attributes

Inherited from:
PartialOrder
def neqv(x: CouldBeGiven[A], y: CouldBeGiven[A]): Boolean

Returns false if x and y are equivalent, true otherwise.

Returns false if x and y are equivalent, true otherwise.

Attributes

Inherited from:
Eq
def partialComparison(x: CouldBeGiven[A], y: CouldBeGiven[A]): Option[Comparison]

Like partialCompare, but returns a cats.kernel.Comparison instead of an Double. Has the benefit of being able to pattern match on, but not as performant.

Like partialCompare, but returns a cats.kernel.Comparison instead of an Double. Has the benefit of being able to pattern match on, but not as performant.

Attributes

Inherited from:
PartialOrder
def pmax(x: CouldBeGiven[A], y: CouldBeGiven[A]): Option[A]

Returns Some(x) if x >= y, Some(y) if x < y, otherwise None.

Returns Some(x) if x >= y, Some(y) if x < y, otherwise None.

Attributes

Inherited from:
PartialOrder
def pmin(x: CouldBeGiven[A], y: CouldBeGiven[A]): Option[A]

Returns Some(x) if x <= y, Some(y) if x > y, otherwise None.

Returns Some(x) if x <= y, Some(y) if x > y, otherwise None.

Attributes

Inherited from:
PartialOrder
def tryCompare(x: CouldBeGiven[A], y: CouldBeGiven[A]): Option[Int]

Result of comparing x with y. Returns None if operands are not comparable. If operands are comparable, returns Some[Int] where the Int sign is:

Result of comparing x with y. Returns None if operands are not comparable. If operands are comparable, returns Some[Int] where the Int sign is:

  • negative iff x < y
  • zero iff x = y
  • positive iff x > y

Attributes

Inherited from:
PartialOrder
Generated with