ToggleOrder

class ToggleOrder[A](implicit A: Order[A]) extends Order[Toggle[A]]
trait Order[Toggle[A]]
trait Eq[Toggle[A]]
trait Serializable
class Object
trait Matchable
class Any

Value members

Concrete methods

override def compare(x: Toggle[A], y: Toggle[A]): Int
Definition Classes

Inherited methods

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

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

Inherited from:
Order
override def eqv(x: Toggle[A], y: Toggle[A]): Boolean

Returns true if x = y, false otherwise.

Returns true if x = y, false otherwise.

Definition Classes
Inherited from:
Order
override def gt(x: Toggle[A], y: Toggle[A]): Boolean

Returns true if x > y, false otherwise.

Returns true if x > y, false otherwise.

Definition Classes
Inherited from:
Order
override def gteqv(x: Toggle[A], y: Toggle[A]): Boolean

Returns true if x >= y, false otherwise.

Returns true if x >= y, false otherwise.

Definition Classes
Inherited from:
Order
override def lt(x: Toggle[A], y: Toggle[A]): Boolean

Returns true if x < y, false otherwise.

Returns true if x < y, false otherwise.

Definition Classes
Inherited from:
Order
override def lteqv(x: Toggle[A], y: Toggle[A]): Boolean

Returns true if x <= y, false otherwise.

Returns true if x <= y, false otherwise.

Definition Classes
Inherited from:
Order
def max(x: Toggle[A], y: Toggle[A]): Toggle[A]

If x > y, return x, else return y.

If x > y, return x, else return y.

Inherited from:
Order
def min(x: Toggle[A], y: Toggle[A]): Toggle[A]

If x < y, return x, else return y.

If x < y, return x, else return y.

Inherited from:
Order
override def neqv(x: Toggle[A], y: Toggle[A]): Boolean

Returns true if x != y, false otherwise.

Returns true if x != y, false otherwise.

Note: this default implementation provided by Order is the same as the one defined in Eq, but for purposes of binary compatibility, the override in Order has not yet been removed. See this discussion.

Definition Classes
Inherited from:
Order
def partialCompare(x: Toggle[A], y: Toggle[A]): Double
Inherited from:
Order
def partialComparison(x: Toggle[A], y: Toggle[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.

Inherited from:
PartialOrder
def pmax(x: Toggle[A], y: Toggle[A]): Option[Toggle[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.

Inherited from:
PartialOrder
def pmin(x: Toggle[A], y: Toggle[A]): Option[Toggle[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.

Inherited from:
PartialOrder
def toOrdering: Ordering[Toggle[A]]

Convert a Order[A] to a scala.math.Ordering[A] instance.

Convert a Order[A] to a scala.math.Ordering[A] instance.

Inherited from:
Order
def tryCompare(x: Toggle[A], y: Toggle[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
Inherited from:
PartialOrder