An ordering forFloats which is consistent with IEEE specifications whenever possible.
lt,lteq,equiv,gteqandgtare consistent with primitive comparison operations forFloats, and returnfalsewhen called withNaN.minandmaxare consistent withmath.minandmath.max, and returnNaNwhen called withNaNas either argument.comparebehaves the same asjava.lang.Float.compare.
Because the behavior ofFloats specified by IEEE is not consistent with a total ordering when dealing withNaN, there are two orderings defined forFloat:TotalOrdering, which is consistent with a total ordering, andIeeeOrdering, which is consistent as much as possible with IEEE spec and floating point operations defined inscala.math.
This ordering may be preferable for numeric contexts.
Attributes
- See also
- Companion
- object
- Source
- Ordering.scala
- Graph
- Supertypes
- traitPartialOrdering[Float]traitSerializabletraitComparator[Float]classObjecttraitMatchableclassAnyShow all
- Known subtypes
- objectFloatIsFractionalobjectIeeeOrdering
Members list
Type members
Inherited classlikes
This inner class defines comparison operators available forT.
This inner class defines comparison operators available forT.
It can't extendAnyVal because it is not a top-level class or a member of a statically accessible object.
Attributes
- Inherited from:
- Ordering
- Source
- Ordering.scala
- Supertypes
Value members
Concrete methods
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)
Attributes
- Source
- Ordering.scala
Return true ifx ==y in the ordering.
Return true ifx >y in the ordering.
Return true ifx >=y in the ordering.
Return true ifx <y in the ordering.
Return true ifx <=y in the ordering.
Returnx ifx >=y, otherwisey.
Returnx ifx <=y, otherwisey.
Inherited methods
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 toother == this.reverse.
Implementations should only override this method if they are overridingreverse as well.
Attributes
- Inherited from:
- Ordering
- Source
- Ordering.scala
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))Attributes
- Inherited from:
- Ordering
- Source
- Ordering.scala
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 ofothers 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 ofothers compare function.
Value parameters
- other
an Ordering to use if this Ordering returns zero
Attributes
- Example
case class Pair(a: Int, b: Int)val pairOrdering = Ordering.by[Pair, Int](_.a) .orElse(Ordering.by[Pair, Int](_.b))- Inherited from:
- Ordering
- Source
- Ordering.scala
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 ofOrdering.by(f) toorElse.
Attributes
- Example
case class Pair(a: Int, b: Int)val pairOrdering = Ordering.by[Pair, Int](_.a) .orElseBy[Int](_.b)- Inherited from:
- Ordering
- Source
- Ordering.scala
Return the opposite ordering of this one.
Return the opposite ordering of this one.
Implementations overriding this method MUST overrideisReverseOf as well if they change the behavior at all (for example, caching does not require overriding it).
Attributes
- Definition Classes
- Inherited from:
- Ordering
- Source
- Ordering.scala
Attributes
- Inherited from:
- Comparator
Attributes
- Inherited from:
- Comparator
Attributes
- Inherited from:
- Comparator
Attributes
- Inherited from:
- Comparator
Attributes
- Inherited from:
- Comparator
Attributes
- Inherited from:
- Comparator
Attributes
- Inherited from:
- Comparator
Returns whether a comparison betweenx andy is defined, and if so the result ofcompare(x, y).
Returns whether a comparison betweenx andy is defined, and if so the result ofcompare(x, y).
Attributes
- Inherited from:
- Ordering
- Source
- Ordering.scala
Implicits
Inherited implicits
This implicit method augmentsT with the comparison operators defined inscala.math.Ordering.Ops.
This implicit method augmentsT with the comparison operators defined inscala.math.Ordering.Ops.
Attributes
- Inherited from:
- Ordering
- Source
- Ordering.scala