Packages

t

scala.math.Ordering

OptionOrdering

trait OptionOrdering[T] extends Ordering[Option[T]]

Source
Ordering.scala
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OptionOrdering
  2. Ordering
  3. PartialOrdering
  4. Equiv
  5. Serializable
  6. Comparator
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. class OrderingOps extends AnyRef

    This inner class defines comparison operators available for T.

    This inner class defines comparison operators available for T.

    It can't extend AnyVal because it is not a top-level class or a member of a statically accessible object.

    Definition Classes
    Ordering

Abstract Value Members

  1. abstract def optionOrdering: Ordering[T]

Concrete Value Members

  1. def compare(x: Option[T], y: Option[T]): Int

    Returns an integer whose sign communicates how x compares to y.

    Returns an integer whose sign communicates how x compares to y.

    The result sign has the following meaning:

    • negative if x < y
    • positive if x > y
    • zero otherwise (if x == y)
    Definition Classes
    OptionOrderingOrdering → Comparator
  2. def equals(obj: Any): Boolean

    The equality method for reference types.

    The equality method for reference types. Default implementation delegates to eq.

    See also equals in scala.Any.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    OptionOrdering → Comparator → AnyRef → Any
  3. def equiv(x: Option[T], y: Option[T]): Boolean

    Return true if x == y in the ordering.

    Return true if x == y in the ordering.

    Definition Classes
    OrderingPartialOrderingEquiv
  4. def gt(x: Option[T], y: Option[T]): Boolean

    Return true if x > y in the ordering.

    Return true if x > y in the ordering.

    Definition Classes
    OrderingPartialOrdering
  5. def gteq(x: Option[T], y: Option[T]): Boolean

    Return true if x >= y in the ordering.

    Return true if x >= y in the ordering.

    Definition Classes
    OrderingPartialOrdering
  6. def hashCode(): Int

    The hashCode method for reference types.

    The hashCode method for reference types. See hashCode in scala.Any.

    returns

    the hash code value for this object.

    Definition Classes
    OptionOrdering → AnyRef → Any
  7. def isReverseOf(other: Ordering[_]): Boolean

    Returns whether or not the other ordering is the opposite ordering of this one.

    Returns whether or not the other ordering is the opposite ordering of this one.

    Equivalent to other == this.reverse.

    Implementations should only override this method if they are overriding reverse as well.

    Definition Classes
    Ordering
  8. def lt(x: Option[T], y: Option[T]): Boolean

    Return true if x < y in the ordering.

    Return true if x < y in the ordering.

    Definition Classes
    OrderingPartialOrdering
  9. def lteq(x: Option[T], y: Option[T]): Boolean

    Return true if x <= y in the ordering.

    Return true if x <= y in the ordering.

    Definition Classes
    OrderingPartialOrdering
  10. def max[U <: Option[T]](x: U, y: U): U

    Return x if x >= y, otherwise y.

    Return x if x >= y, otherwise y.

    Definition Classes
    Ordering
  11. def min[U <: Option[T]](x: U, y: U): U

    Return x if x <= y, otherwise y.

    Return x if x <= y, otherwise y.

    Definition Classes
    Ordering
  12. implicit def mkOrderingOps(lhs: Option[T]): OrderingOps

    This implicit method augments T with the comparison operators defined in scala.math.Ordering.Ops.

    This implicit method augments T with the comparison operators defined in scala.math.Ordering.Ops.

    Definition Classes
    Ordering
  13. def on[U](f: (U) => Option[T]): Ordering[U]

    Given f, a function from U into T, creates an Ordering[U] whose compare function is equivalent to:

    Given f, a function from U into T, creates an Ordering[U] whose compare function is equivalent to:

    def compare(x:U, y:U) = Ordering[T].compare(f(x), f(y))
    Definition Classes
    Ordering
  14. def orElse(other: Ordering[Option[T]]): Ordering[Option[T]]

    Creates an Ordering[T] whose compare function returns the result of this Ordering's compare function, if it is non-zero, or else the result of others compare function.

    Creates an Ordering[T] whose compare function returns the result of this Ordering's compare function, if it is non-zero, or else the result of others compare function.

    other

    an Ordering to use if this Ordering returns zero

    Definition Classes
    Ordering
    Example:
    1. case class Pair(a: Int, b: Int)
      
      val pairOrdering = Ordering.by[Pair, Int](_.a)
                                 .orElse(Ordering.by[Pair, Int](_.b))
  15. def orElseBy[S](f: (Option[T]) => S)(implicit ord: Ordering[S]): Ordering[Option[T]]

    Given f, a function from T into S, creates an Ordering[T] whose compare function returns the result of this Ordering's compare function, if it is non-zero, or else a result equivalent to:

    Given f, a function from T into S, creates an Ordering[T] whose compare function returns the result of this Ordering's compare function, if it is non-zero, or else a result equivalent to:

    Ordering[S].compare(f(x), f(y))

    This function is equivalent to passing the result of Ordering.by(f) to orElse.

    Definition Classes
    Ordering
    Example:
    1. case class Pair(a: Int, b: Int)
      
      val pairOrdering = Ordering.by[Pair, Int](_.a)
                                 .orElseBy[Int](_.b)
  16. def reverse: Ordering[Option[T]]

    Return the opposite ordering of this one.

    Return the opposite ordering of this one.

    Implementations overriding this method MUST override isReverseOf as well if they change the behavior at all (for example, caching does not require overriding it).

    Definition Classes
    OrderingPartialOrdering
  17. def reversed(): Comparator[Option[T]]
    Definition Classes
    Comparator
  18. def thenComparing[U <: Comparable[_ >: U <: AnyRef]](arg0: java.util.function.Function[_ >: Option[T] <: AnyRef, _ <: U]): Comparator[Option[T]]
    Definition Classes
    Comparator
  19. def thenComparing[U <: AnyRef](arg0: java.util.function.Function[_ >: Option[T] <: AnyRef, _ <: U], arg1: Comparator[_ >: U <: AnyRef]): Comparator[Option[T]]
    Definition Classes
    Comparator
  20. def thenComparing(arg0: Comparator[_ >: Option[T] <: AnyRef]): Comparator[Option[T]]
    Definition Classes
    Comparator
  21. def thenComparingDouble(arg0: ToDoubleFunction[_ >: Option[T] <: AnyRef]): Comparator[Option[T]]
    Definition Classes
    Comparator
  22. def thenComparingInt(arg0: ToIntFunction[_ >: Option[T] <: AnyRef]): Comparator[Option[T]]
    Definition Classes
    Comparator
  23. def thenComparingLong(arg0: ToLongFunction[_ >: Option[T] <: AnyRef]): Comparator[Option[T]]
    Definition Classes
    Comparator
  24. def tryCompare(x: Option[T], y: Option[T]): Some[Int]

    Returns whether a comparison between x and y is defined, and if so the result of compare(x, y).

    Returns whether a comparison between x and y is defined, and if so the result of compare(x, y).

    Definition Classes
    OrderingPartialOrdering