Trait/Object

zio.prelude

Ord

Related Docs: object Ord | package prelude

Permalink

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( "No implicit Ord defined for ${A}." )
Linear Supertypes
Known Subclasses
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. All

Abstract Value Members

  1. abstract def checkCompare(l: A, r: A): Ordering

    Permalink

    Returns the result of comparing two values of type A.

    Returns the result of comparing two values of type A.

    Attributes
    protected
    Definition Classes
    OrdPartialOrd

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. final def both[B](that: ⇒ Ord[B]): Ord[(A, B)]

    Permalink

    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

  6. final def both[B](that: ⇒ PartialOrd[B]): PartialOrd[(A, B)]

    Permalink

    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
  7. final def both[B](that: ⇒ Equal[B]): Equal[(A, B)]

    Permalink

    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
  8. final def bothWith[B, C](that: ⇒ Ord[B])(f: (C) ⇒ (A, B)): Ord[C]

    Permalink

    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.

  9. final def bothWith[B, C](that: ⇒ PartialOrd[B])(f: (C) ⇒ (A, B)): PartialOrd[C]

    Permalink

    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
  10. final def bothWith[B, C](that: ⇒ Equal[B])(f: (C) ⇒ (A, B)): Equal[C]

    Permalink

    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
  11. def checkEqual(l: A, r: A): Boolean

    Permalink

    Returns whether two values of type A are equal.

    Returns whether two values of type A are equal.

    Attributes
    protected
    Definition Classes
    OrdPartialOrdEqual
  12. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. final def compare(l: A, r: A): Ordering

    Permalink

    Returns the result of comparing two values of type A.

    Returns the result of comparing two values of type A.

    Definition Classes
    OrdPartialOrd
  14. def contramap[B](f: (B) ⇒ A): Ord[B]

    Permalink

    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
    OrdPartialOrdEqual
  15. final def either[B](that: ⇒ Ord[B]): Ord[Either[A, B]]

    Permalink

    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.

  16. final def either[B](that: ⇒ PartialOrd[B]): PartialOrd[Either[A, B]]

    Permalink

    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
  17. final def either[B](that: ⇒ Equal[B]): Equal[Either[A, B]]

    Permalink

    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
  18. final def eitherWith[B, C](that: ⇒ Ord[B])(f: (C) ⇒ Either[A, B]): Ord[C]

    Permalink

    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.

  19. final def eitherWith[B, C](that: ⇒ PartialOrd[B])(f: (C) ⇒ Either[A, B]): PartialOrd[C]

    Permalink

    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
  20. final def eitherWith[B, C](that: ⇒ Equal[B])(f: (C) ⇒ Either[A, B]): Equal[C]

    Permalink

    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
  21. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  22. final def equal(l: A, r: A): Boolean

    Permalink

    Returns whether two values of type A are equal.

    Returns whether two values of type A are equal.

    Definition Classes
    Equal
  23. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  24. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  25. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  26. def greater(l: A, r: A): Boolean

    Permalink

    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
  27. def greaterOrEqual(l: A, r: A): Boolean

    Permalink

    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
  28. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  29. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  30. def less(l: A, r: A): Boolean

    Permalink

    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
  31. def lessOrEqual(l: A, r: A): Boolean

    Permalink

    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
  32. final def mapOrdering(f: (Ordering) ⇒ Ordering): Ord[A]

    Permalink

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

  33. final def mapPartialOrdering(f: (PartialOrdering) ⇒ PartialOrdering): PartialOrd[A]

    Permalink

    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
  34. final def max[A1 <: A](l: A1, r: A1): A1

    Permalink

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

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

    Permalink

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

  36. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  37. final def notEqual(l: A, r: A): Boolean

    Permalink

    Returns whether two values of type A are not equal.

    Returns whether two values of type A are not equal.

    Definition Classes
    Equal
  38. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  39. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  40. final def reverse: Ord[A]

    Permalink

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

  41. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  42. def toScala[A1 <: A]: scala.math.Ordering[A1]

    Permalink
    Definition Classes
    OrdEqual
  43. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  44. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from PartialOrd[A]

Inherited from Equal[A]

Inherited from AnyRef

Inherited from Any

Ungrouped