Packages

implicit object Char extends CharOrdering

Source
Ordering.scala
Linear Supertypes
CharOrdering, Ordering[Char], PartialOrdering[Char], Equiv[Char], java.io.Serializable, Comparator[Char], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Char
  2. CharOrdering
  3. Ordering
  4. PartialOrdering
  5. Equiv
  6. Serializable
  7. Comparator
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

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.

    Definition Classes
    Ordering

Value Members

  1. def compare(x: Char, y: Char): 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
    CharOrderingOrdering → Comparator
  2. def equiv(x: Char, y: Char): Boolean

    Return true if x == y in the ordering.

    Return true if x == y in the ordering.

    Definition Classes
    OrderingPartialOrderingEquiv
  3. def gt(x: Char, y: Char): Boolean

    Return true if x > y in the ordering.

    Return true if x > y in the ordering.

    Definition Classes
    OrderingPartialOrdering
  4. def gteq(x: Char, y: Char): Boolean

    Return true if x >= y in the ordering.

    Return true if x >= y in the ordering.

    Definition Classes
    OrderingPartialOrdering
  5. 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
  6. def lt(x: Char, y: Char): Boolean

    Return true if x < y in the ordering.

    Return true if x < y in the ordering.

    Definition Classes
    OrderingPartialOrdering
  7. def lteq(x: Char, y: Char): Boolean

    Return true if x <= y in the ordering.

    Return true if x <= y in the ordering.

    Definition Classes
    OrderingPartialOrdering
  8. def max[U <: Char](x: U, y: U): U

    Return x if x >= y, otherwise y.

    Return x if x >= y, otherwise y.

    Definition Classes
    Ordering
  9. def min[U <: Char](x: U, y: U): U

    Return x if x <= y, otherwise y.

    Return x if x <= y, otherwise y.

    Definition Classes
    Ordering
  10. implicit def mkOrderingOps(lhs: Char): 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
  11. def on[U](f: (U) => Char): 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
  12. def orElse(other: Ordering[Char]): Ordering[Char]

    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))
  13. def orElseBy[S](f: (Char) => S)(implicit ord: Ordering[S]): Ordering[Char]

    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)
  14. def reverse: Ordering[Char]

    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
  15. def reversed(): Comparator[Char]
    Definition Classes
    Comparator
  16. def thenComparing[U <: Comparable[_ >: U <: AnyRef]](arg0: java.util.function.Function[_ >: Char <: AnyRef, _ <: U]): Comparator[Char]
    Definition Classes
    Comparator
  17. def thenComparing[U <: AnyRef](arg0: java.util.function.Function[_ >: Char <: AnyRef, _ <: U], arg1: Comparator[_ >: U <: AnyRef]): Comparator[Char]
    Definition Classes
    Comparator
  18. def thenComparing(arg0: Comparator[_ >: Char <: AnyRef]): Comparator[Char]
    Definition Classes
    Comparator
  19. def thenComparingDouble(arg0: ToDoubleFunction[_ >: Char <: AnyRef]): Comparator[Char]
    Definition Classes
    Comparator
  20. def thenComparingInt(arg0: ToIntFunction[_ >: Char <: AnyRef]): Comparator[Char]
    Definition Classes
    Comparator
  21. def thenComparingLong(arg0: ToLongFunction[_ >: Char <: AnyRef]): Comparator[Char]
    Definition Classes
    Comparator
  22. def tryCompare(x: Char, y: Char): 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