scala.math

Ordering

object Ordering extends LowPriorityOrderingImplicits with Serializable

Source
Ordering.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Ordering
  2. Serializable
  3. Serializable
  4. LowPriorityOrderingImplicits
  5. AnyRef
  6. Any
Visibility
  1. Public
  2. All

Type Members

  1. trait BigDecimalOrdering extends Ordering[BigDecimal]

  2. trait BigIntOrdering extends Ordering[BigInt]

  3. trait BooleanOrdering extends Ordering[Boolean]

  4. trait ByteOrdering extends Ordering[Byte]

  5. trait CharOrdering extends Ordering[Char]

  6. trait DoubleOrdering extends Ordering[Double]

  7. trait ExtraImplicits extends AnyRef

  8. trait FloatOrdering extends Ordering[Float]

  9. trait IntOrdering extends Ordering[Int]

  10. trait LongOrdering extends Ordering[Long]

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

  12. trait ShortOrdering extends Ordering[Short]

  13. trait StringOrdering extends Ordering[String]

  14. trait UnitOrdering extends Ordering[Unit]

Value Members

  1. def != (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  2. def != (arg0: Any): Boolean

    Test two objects for inequality.

    Test two objects for inequality.

    returns

    true if !(this == that), false otherwise.

    Attributes
    final
    Definition Classes
    Any
  3. def ## (): Int

    Equivalent to x.hashCode except for boxed numeric types.

    Equivalent to x.hashCode except for boxed numeric types. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them.

    returns

    a hash value consistent with ==

    Attributes
    final
    Definition Classes
    AnyRef → Any
  4. def == (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  5. def == (arg0: Any): Boolean

    Test two objects for equality.

    Test two objects for equality.

    returns

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

    Attributes
    final
    Definition Classes
    Any
  6. object BigDecimal extends BigDecimalOrdering

    Attributes
    implicit
  7. object BigInt extends BigIntOrdering

    Attributes
    implicit
  8. object Boolean extends BooleanOrdering

    Attributes
    implicit
  9. object Byte extends ByteOrdering

    Attributes
    implicit
  10. object Char extends CharOrdering

    Attributes
    implicit
  11. object Double extends DoubleOrdering

    Attributes
    implicit
  12. object Float extends FloatOrdering

    Attributes
    implicit
  13. object Implicits extends ExtraImplicits

    An object for implicits which for one reason or another we aren't ready to put in the default scope.

  14. object Int extends IntOrdering

    Attributes
    implicit
  15. implicit def Iterable [T] (implicit ord: Ordering[T]): Ordering[Iterable[T]]

    Attributes
    implicit
  16. object Long extends LongOrdering

    Attributes
    implicit
  17. implicit def Option [T] (implicit ord: Ordering[T]): Ordering[Option[T]]

    Attributes
    implicit
  18. object Short extends ShortOrdering

    Attributes
    implicit
  19. object String extends StringOrdering

    Attributes
    implicit
  20. implicit def Tuple2 [T1, T2] (implicit ord1: Ordering[T1], ord2: Ordering[T2]): Ordering[(T1, T2)]

    Attributes
    implicit
  21. implicit def Tuple3 [T1, T2, T3] (implicit ord1: Ordering[T1], ord2: Ordering[T2], ord3: Ordering[T3]): Ordering[(T1, T2, T3)]

    Attributes
    implicit
  22. implicit def Tuple4 [T1, T2, T3, T4] (implicit ord1: Ordering[T1], ord2: Ordering[T2], ord3: Ordering[T3], ord4: Ordering[T4]): Ordering[(T1, T2, T3, T4)]

    Attributes
    implicit
  23. implicit def Tuple5 [T1, T2, T3, T4, T5] (implicit ord1: Ordering[T1], ord2: Ordering[T2], ord3: Ordering[T3], ord4: Ordering[T4], ord5: Ordering[T5]): Ordering[(T1, T2, T3, T4, T5)]

    Attributes
    implicit
  24. implicit def Tuple6 [T1, T2, T3, T4, T5, T6] (implicit ord1: Ordering[T1], ord2: Ordering[T2], ord3: Ordering[T3], ord4: Ordering[T4], ord5: Ordering[T5], ord6: Ordering[T6]): Ordering[(T1, T2, T3, T4, T5, T6)]

    Attributes
    implicit
  25. implicit def Tuple7 [T1, T2, T3, T4, T5, T6, T7] (implicit ord1: Ordering[T1], ord2: Ordering[T2], ord3: Ordering[T3], ord4: Ordering[T4], ord5: Ordering[T5], ord6: Ordering[T6], ord7: Ordering[T7]): Ordering[(T1, T2, T3, T4, T5, T6, T7)]

    Attributes
    implicit
  26. implicit def Tuple8 [T1, T2, T3, T4, T5, T6, T7, T8] (implicit ord1: Ordering[T1], ord2: Ordering[T2], ord3: Ordering[T3], ord4: Ordering[T4], ord5: Ordering[T5], ord6: Ordering[T6], ord7: Ordering[T7], ord8: Ordering[T8]): Ordering[(T1, T2, T3, T4, T5, T6, T7, T8)]

    Attributes
    implicit
  27. implicit def Tuple9 [T1, T2, T3, T4, T5, T6, T7, T8, T9] (implicit ord1: Ordering[T1], ord2: Ordering[T2], ord3: Ordering[T3], ord4: Ordering[T4], ord5: Ordering[T5], ord6: Ordering[T6], ord7: Ordering[T7], ord8: Ordering[T8], ord9: Ordering[T9]): Ordering[(T1, T2, T3, T4, T5, T6, T7, T8, T9)]

    Attributes
    implicit
  28. object Unit extends UnitOrdering

    Attributes
    implicit
  29. def apply [T] (implicit ord: Ordering[T]): Ordering[T]

  30. def asInstanceOf [T0] : T0

    Cast the receiver object to be of type T0.

    Cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.

    returns

    the receiver object.

    Attributes
    final
    Definition Classes
    Any
  31. def by [T, S] (f: (T) ⇒ S)(implicit ord: Ordering[S]): Ordering[T]

  32. def clone (): AnyRef

    Create a copy of the receiver object.

    Create a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  33. implicit def comparatorToOrdering [A] (implicit cmp: Comparator[A]): Ordering[A]

    Attributes
    implicit
    Definition Classes
    LowPriorityOrderingImplicits
  34. def eq (arg0: AnyRef): Boolean

    Tests whether the argument (arg0) is a reference to the receiver object (this).

    Tests whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an equivalence relation on non-null instances of AnyRef, and has three additional properties:

    • It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false.
    • For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
    • null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    returns

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

    Attributes
    final
    Definition Classes
    AnyRef
  35. def equals (arg0: Any): Boolean

    The equality method for reference types.

    The equality method for reference types. See equals in Any.

    returns

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

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

    Called by the garbage collector on the receiver object when there are no more references to the object.

    Called by the garbage collector on the receiver object when there are no more references to the object.

    The details of when and if the finalize method is invoked, as well as the interaction between finalize and non-local returns and exceptions, are all platform dependent.

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  37. def fromLessThan [T] (cmp: (T, T) ⇒ Boolean): Ordering[T]

  38. def getClass (): java.lang.Class[_ <: java.lang.Object]

    A representation that corresponds to the dynamic class of the receiver object.

    A representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    Attributes
    final
    Definition Classes
    AnyRef
  39. def hashCode (): Int

    The hashCode method for reference types.

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

    returns

    the hash code value for this object.

    Definition Classes
    AnyRef → Any
  40. def isInstanceOf [T0] : Boolean

    Test whether the dynamic type of the receiver object is T0.

    Test whether the dynamic type of the receiver object is T0.

    Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    Attributes
    final
    Definition Classes
    Any
  41. def ne (arg0: AnyRef): Boolean

    Equivalent to !(this eq that).

    Equivalent to !(this eq that).

    returns

    true if the argument is not a reference to the receiver object; false otherwise.

    Attributes
    final
    Definition Classes
    AnyRef
  42. def notify (): Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Attributes
    final
    Definition Classes
    AnyRef
  43. def notifyAll (): Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    Attributes
    final
    Definition Classes
    AnyRef
  44. implicit def ordered [A] (implicit arg0: (A) ⇒ Comparable[A]): Ordering[A]

    This would conflict with all the nice implicit Orderings available, but thanks to the magic of prioritized implicits via subclassing we can make Ordered[A] => Ordering[A] only turn up if nothing else works.

    This would conflict with all the nice implicit Orderings available, but thanks to the magic of prioritized implicits via subclassing we can make Ordered[A] => Ordering[A] only turn up if nothing else works. Since Ordered[A] extends Comparable[A] anyway, we can throw in some java interop too.

    Attributes
    implicit
    Definition Classes
    LowPriorityOrderingImplicits
  45. def readResolve (): AnyRef

    Attributes
    protected
  46. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef
  47. def toString (): String

    Creates a String representation of this object.

    Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.

    returns

    a String representation of the object.

    Definition Classes
    AnyRef → Any
  48. def wait (): Unit

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

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

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from Serializable

Inherited from Serializable

Inherited from LowPriorityOrderingImplicits

Inherited from AnyRef

Inherited from Any