Packages

trait Ord[-A] extends PartialOrd[A]

Ord[A] provides implicit evidence that values of type A have a total ordering.

Self Type
Ord[A]
Annotations
@implicitNotFound()
Linear Supertypes
PartialOrd[A], Equal[A], AnyRef, Any
Known Subclasses
HashOrd
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Ord
  2. PartialOrd
  3. Equal
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Concrete Value Members

  1. final def both[B](that: => Ord[B]): Ord[(A, B)]

    Constructs an Ord[(A, B)] given an Ord[A] and Ord[B] by first comparing the A values, and then if the A values are equal comparing the B values

  2. final def both[B](that: => PartialOrd[B]): PartialOrd[(A, B)]

    Constructs an PartialOrd[(A, B)] given an PartialOrd[A] and PartialOrd[B] by first comparing the A values, and then if the A values are equal comparing the B values

    Constructs an PartialOrd[(A, B)] given an PartialOrd[A] and PartialOrd[B] by first comparing the A values, and then if the A values are equal comparing the B values

    Definition Classes
    PartialOrd
  3. final def both[B](that: => Equal[B]): Equal[(A, B)]

    Constructs an Equal[(A, B)] given an Equal[A] and Equal[B] by first comparing the A values for equality and then comparing the B values for equality, if necessary.

    Constructs an Equal[(A, B)] given an Equal[A] and Equal[B] by first comparing the A values for equality and then comparing the B values for equality, if necessary.

    Definition Classes
    Equal
  4. final def bothWith[B, C](that: => Ord[B])(f: (C) => (A, B)): Ord[C]

    Constructs an Ord[C] given an Ord[A], an Ord[B] and a function f to transform a C value into an (A, B).

    Constructs an Ord[C] given an Ord[A], an Ord[B] and a function f to transform a C value into an (A, B). The instance will convert each C value into an (A, B), compare the A values, and then if the A values are equal compare the B values.

  5. final def bothWith[B, C](that: => PartialOrd[B])(f: (C) => (A, B)): PartialOrd[C]

    Constructs an PartialOrd[C] given an PartialOrd[A], an PartialOrd[B] and a function f to transform a C value into an (A, B).

    Constructs an PartialOrd[C] given an PartialOrd[A], an PartialOrd[B] and a function f to transform a C value into an (A, B). The instance will convert each C value into an (A, B), compare the A values, and then if the A values are equal compare the B values.

    Definition Classes
    PartialOrd
  6. final def bothWith[B, C](that: => Equal[B])(f: (C) => (A, B)): Equal[C]

    Constructs an Equal[C] given an Equal[A], an Equal[B] and a function f to transform a C value into an (A, B).

    Constructs an Equal[C] given an Equal[A], an Equal[B] and a function f to transform a C value into an (A, B). The instance will convert each C value into an (A, B), compare the A values for equality, and then compare the B values for equality if necessary.

    Definition Classes
    Equal
  7. final def compare(l: A, r: A): Ordering

    Returns the result of comparing two values of type A.

    Returns the result of comparing two values of type A.

    Definition Classes
    Ord → PartialOrd
  8. def contramap[B](f: (B) => A): Ord[B]

    Constructs an Ord[B] given an Ord[A] and a function f to transform a B value into an A value.

    Constructs an Ord[B] given an Ord[A] and a function f to transform a B value into an A value. The instance will convert each B value into an A and compare the A values.

    Definition Classes
    Ord → PartialOrd → Equal
  9. final def either[B](that: => Ord[B]): Ord[Either[A, B]]

    Constructs an Ord[Either[A, B]] given an Ord[A] and an Ord[B].

    Constructs an Ord[Either[A, B]] given an Ord[A] and an Ord[B]. If one value is Left and one value is Right it will treat the Left value as less than the Right value. Otherwise, it will compare the two values.

  10. final def either[B](that: => PartialOrd[B]): PartialOrd[Either[A, B]]

    Constructs an PartialOrd[Either[A, B]] given an PartialOrd[A] and an PartialOrd[B].

    Constructs an PartialOrd[Either[A, B]] given an PartialOrd[A] and an PartialOrd[B]. If one value is Left and one value is Right it will treat the Left value as less than the Right value. Otherwise, it will compare the two values.

    Definition Classes
    PartialOrd
  11. final def either[B](that: => Equal[B]): Equal[Either[A, B]]

    Constructs an Equal[Either[A, B]] given an Equal[A] and an Equal[B].

    Constructs an Equal[Either[A, B]] given an Equal[A] and an Equal[B]. The instance will compare the Either[A, B] values and if both are Right or Left compare them for equality.

    Definition Classes
    Equal
  12. final def eitherWith[B, C](that: => Ord[B])(f: (C) => Either[A, B]): Ord[C]

    Constructs an Ord[C] given an Ord[A], an Ord[B], and a function f to transform a C value into an Either[A, B].

    Constructs an Ord[C] given an Ord[A], an Ord[B], and a function f to transform a C value into an Either[A, B]. The instance will convert each C value into an Either[A, B]. If one value is Left and one value is Right it will treat the Left value as less than the Right value. Otherwise, it will compare the two values.

  13. final def eitherWith[B, C](that: => PartialOrd[B])(f: (C) => Either[A, B]): PartialOrd[C]

    Constructs an PartialOrd[C] given an PartialOrd[A], an PartialOrd[B], and a function f to transform a C value into an Either[A, B].

    Constructs an PartialOrd[C] given an PartialOrd[A], an PartialOrd[B], and a function f to transform a C value into an Either[A, B]. The instance will convert each C value into an Either[A, B]. If one value is Left and one value is Right it will treat the Left value as less than the Right value. Otherwise, it will compare the two values.

    Definition Classes
    PartialOrd
  14. final def eitherWith[B, C](that: => Equal[B])(f: (C) => Either[A, B]): Equal[C]

    Constructs an Equal[C] given an Equal[A], an Equal[B], and a function f to transform a C value into an Either[A, B].

    Constructs an Equal[C] given an Equal[A], an Equal[B], and a function f to transform a C value into an Either[A, B]. The instance will convert each C value into an Either[A, B] and then if both are Right or Left compare them for equality.

    Definition Classes
    Equal
  15. final def equal(l: A, r: A): Boolean

    Returns whether two values of type A are equal.

    Returns whether two values of type A are equal.

    Definition Classes
    Equal
  16. def greater(l: A, r: A): Boolean

    Returns whether the left value is greater than the right value.

    Returns whether the left value is greater than the right value.

    Definition Classes
    PartialOrd
  17. def greaterOrEqual(l: A, r: A): Boolean

    Returns whether the left value is greater than or equal to the right value.

    Returns whether the left value is greater than or equal to the right value.

    Definition Classes
    PartialOrd
  18. def less(l: A, r: A): Boolean

    Returns whether the left value is less than the right value.

    Returns whether the left value is less than the right value.

    Definition Classes
    PartialOrd
  19. def lessOrEqual(l: A, r: A): Boolean

    Returns whether the left value is less than or equal to the right value.

    Returns whether the left value is less than or equal to the right value.

    Definition Classes
    PartialOrd
  20. final def mapOrdering(f: (Ordering) => Ordering): Ord[A]

    Constructs a new Ord[A] by mapping the result of this ordering using the specified function.

  21. final def mapPartialOrdering(f: (PartialOrdering) => PartialOrdering): PartialOrd[A]

    Constructs a new PartialOrd[A] by mapping the result of this ordering using the specified function.

    Constructs a new PartialOrd[A] by mapping the result of this ordering using the specified function.

    Definition Classes
    PartialOrd
  22. final def max[A1 <: A](l: A1, r: A1): A1

    Returns the maximum of the left value and the right value.

  23. final def min[A1 <: A](l: A1, r: A1): A1

    Returns the minimum of the left value and the right value.

  24. final def notEqual(l: A, r: A): Boolean

    Returns whether two values of type A are not equal.

    Returns whether two values of type A are not equal.

    Definition Classes
    Equal
  25. final def reverse: Ord[A]

    Returns a new ordering that is the reverse of this one.

  26. def toScala[A1 <: A]: scala.math.Ordering[A1]
    Definition Classes
    Ord → Equal