Order
Related Docs:
object Order
| package kernel
Result of comparing x with y.
Result of comparing x with y. Returns an Int whose sign is:
- negative iff x < y
- zero iff x = y
- positive iff x > y
Return an Eq that gives the result of the and of this and that note this is idempotent
Return an Eq that gives the result of the and of this and that note this is idempotent
Like compare, but returns a cats.kernel.Comparison instead of an Int.
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.
Returns true if x > y, false otherwise.
Returns true if x > y, false otherwise.
Returns true if x >= y, false otherwise.
Returns true if x >= y, false otherwise.
Returns true if x < y, false otherwise.
Returns true if x < y, false otherwise.
Returns true if x <= y, false otherwise.
Returns true if x <= y, false otherwise.
If x >= y, return x, else return y.
If x <= y, return x, else return y.
Returns true if x != y, false otherwise.
Defines an order on B by mapping B to A using f and using As
order to order B.
Defines an order on B by mapping B to A using f and using As
order to order B.
Return an Eq that gives the result of the or of this and that Note this is idempotent
Return an Eq that gives the result of the or of this and that Note this is idempotent
Result of comparing x with y.
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
Like partialCompare, but returns a cats.kernel.Comparison instead of an Double.
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.
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.
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.
Defines an ordering on A where all arrows switch direction.
Defines an ordering on A where all arrows switch direction.
Convert a Order[A] to a scala.math.Ordering[A]
instance.
Result of comparing x with y.
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
Returns a new Order[A] instance that first compares by the original
Order instance and uses the provided Order instance to "break ties".
Returns a new Order[A] instance that first compares by the original
Order instance and uses the provided Order instance to "break ties".
That is, x.whenEqual(y) creates an Order that first orders by x and
then (if two elements are equal) falls back to y for the comparison.
The
Ordertype class is used to define a total ordering on some typeA. 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.