The Order
type class is used to define a total ordering on some type A
.
An order is defined by a relation <=, which obeys the following laws:
The Order
type class is used to define a total ordering on some type A
.
An order is defined by a relation <=, which obeys the following laws:
- either x <= y or y <= x (totality)
- if x <= y and y <= x, then x == y (antisymmetry)
- if x <= y and y <= z, then x <= z (transitivity)
The truth table for compare is defined as follows:
x <= y x >= y Int true true = 0 (corresponds to x == y) true false < 0 (corresponds to x < y) false true > 0 (corresponds to x > y)
By the totality law, x <= y and y <= x cannot be both false.
- Companion
- object
Value members
Abstract methods
Result of comparing x
with y
. Returns an Int whose sign is:
Result of comparing x
with y
. Returns an Int whose sign is:
- negative iff
x < y
- zero iff
x = y
- positive iff
x > y
Result of comparing x
with y
. Returns an Int whose sign is:
Result of comparing x
with y
. Returns an Int whose sign is:
- negative iff
x < y
- zero iff
x = y
- positive iff
x > y
Result of comparing x
with y
. Returns an Int whose sign is:
Result of comparing x
with y
. Returns an Int whose sign is:
- negative iff
x < y
- zero iff
x = y
- positive iff
x > y
Result of comparing x
with y
. Returns an Int whose sign is:
Result of comparing x
with y
. Returns an Int whose sign is:
- negative iff
x < y
- zero iff
x = y
- positive iff
x > y
Result of comparing x
with y
. Returns an Int whose sign is:
Result of comparing x
with y
. Returns an Int whose sign is:
- negative iff
x < y
- zero iff
x = y
- positive iff
x > y
Result of comparing x
with y
. Returns an Int whose sign is:
Result of comparing x
with y
. Returns an Int whose sign is:
- negative iff
x < y
- zero iff
x = y
- positive iff
x > y
Result of comparing x
with y
. Returns an Int whose sign is:
Result of comparing x
with y
. Returns an Int whose sign is:
- negative iff
x < y
- zero iff
x = y
- positive iff
x > y
Result of comparing x
with y
. Returns an Int whose sign is:
Result of comparing x
with y
. Returns an Int whose sign is:
- negative iff
x < y
- zero iff
x = y
- positive iff
x > y
Result of comparing x
with y
. Returns an Int whose sign is:
Result of comparing x
with y
. Returns an Int whose sign is:
- negative iff
x < y
- zero iff
x = y
- positive iff
x > y
Result of comparing x
with y
. Returns an Int whose sign is:
Result of comparing x
with y
. Returns an Int whose sign is:
- negative iff
x < y
- zero iff
x = y
- positive iff
x > y
Result of comparing x
with y
. Returns an Int whose sign is:
Result of comparing x
with y
. Returns an Int whose sign is:
- negative iff
x < y
- zero iff
x = y
- positive iff
x > y
Concrete 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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Returns true if x
= y
, false otherwise.
Returns true if x
= y
, false otherwise.
- Definition Classes
- PartialOrder -> Eq
Returns true if x
>= y
, false otherwise.
Returns true if x
>= y
, false otherwise.
- Definition Classes
Returns true if x
<= y
, false otherwise.
Returns true if x
<= y
, false otherwise.
- Definition Classes
If x > y, return x, else return y.
If x > y, return x, else return y.
If x > y, return x, else return y.
If x > y, return x, else return y.
If x > y, return x, else return y.
If x > y, return x, else return y.
If x > y, return x, else return y.
If x > y, return x, else return y.
If x > y, return x, else return y.
If x > y, return x, else return y.
If x > y, return x, else return y.
If x > y, return x, else return y.
If x > y, return x, else return y.
If x > y, return x, else return y.
If x > y, return x, else return y.
If x > y, return x, else return y.
If x > y, return x, else return y.
If x > y, return x, else return y.
If x > y, return x, else return y.
If x > y, return x, else return y.
If x > y, return x, else return y.
If x > y, return x, else return y.
If x < y, return x, else return y.
If x < y, return x, else return y.
If x < y, return x, else return y.
If x < y, return x, else return y.
If x < y, return x, else return y.
If x < y, return x, else return y.
If x < y, return x, else return y.
If x < y, return x, else return y.
If x < y, return x, else return y.
If x < y, return x, else return y.
If x < y, return x, else return y.
If x < y, return x, else return y.
If x < y, return x, else return y.
If x < y, return x, else return y.
If x < y, return x, else return y.
If x < y, return x, else return y.
If x < y, return x, else return y.
If x < y, return x, else return y.
If x < y, return x, else return y.
If x < y, return x, else return y.
If x < y, return x, else return y.
If x < y, return x, else return y.
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
Convert a Order[A]
to a scala.math.Ordering[A]
instance.
Convert a Order[A]
to a scala.math.Ordering[A]
instance.
Convert a Order[A]
to a scala.math.Ordering[A]
instance.
Convert a Order[A]
to a scala.math.Ordering[A]
instance.
Convert a Order[A]
to a scala.math.Ordering[A]
instance.
Convert a Order[A]
to a scala.math.Ordering[A]
instance.
Convert a Order[A]
to a scala.math.Ordering[A]
instance.
Convert a Order[A]
to a scala.math.Ordering[A]
instance.
Convert a Order[A]
to a scala.math.Ordering[A]
instance.
Convert a Order[A]
to a scala.math.Ordering[A]
instance.
Convert a Order[A]
to a scala.math.Ordering[A]
instance.
Convert a Order[A]
to a scala.math.Ordering[A]
instance.
Convert a Order[A]
to a scala.math.Ordering[A]
instance.
Convert a Order[A]
to a scala.math.Ordering[A]
instance.
Convert a Order[A]
to a scala.math.Ordering[A]
instance.
Convert a Order[A]
to a scala.math.Ordering[A]
instance.
Convert a Order[A]
to a scala.math.Ordering[A]
instance.
Convert a Order[A]
to a scala.math.Ordering[A]
instance.
Convert a Order[A]
to a scala.math.Ordering[A]
instance.
Convert a Order[A]
to a scala.math.Ordering[A]
instance.
Convert a Order[A]
to a scala.math.Ordering[A]
instance.
Convert a Order[A]
to a scala.math.Ordering[A]
instance.
Inherited methods
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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