Trait Ordering.IeeeOrdering

trait IeeeOrdering extends Ordering[Float]

An ordering for Floats which is consistent with IEEE specifications whenever possible.

• lt, lteq, equiv, gteq and gt are consistent with primitive comparison operations for Floats, and return false when called with NaN.

• min and max are consistent with math.min and math.max, and return NaN when called with NaN as either argument.

• compare behaves the same as java.lang.Float.compare.

Because the behavior of Floats specified by IEEE is not consistent with a total ordering when dealing with NaN, there are two orderings defined for Float: TotalOrdering, which is consistent with a total ordering, and IeeeOrdering, which is consistent as much as possible with IEEE spec and floating point operations defined in scala.math.

This ordering may be preferable for numeric contexts.

Inherited classlikes

Source

class OrderingOps(lhs: 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.

Concrete methods

Source

def compare(x: Float, y: Float): Int

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)

Source

override def equiv(x: Float, y: Float): Boolean

Return true if x == y in the ordering.

Source

override def gt(x: Float, y: Float): Boolean

Return true if x > y in the ordering.

Source

override def gteq(x: Float, y: Float): Boolean

Return true if x >= y in the ordering.

Source

override def lt(x: Float, y: Float): Boolean

Return true if x < y in the ordering.

Source

override def lteq(x: Float, y: Float): Boolean

Return true if x <= y in the ordering.

Source

override def max[U <: Float](x: U, y: U): U

Return x if x >= y, otherwise y.

Source

override def min[U <: Float](x: U, y: U): U

Return x if x <= y, otherwise y.

Inherited methods

Source

def isReverseOf(other: Ordering[_]): Boolean

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.

Source

def on[U](f: U => Float): Ordering[U]

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))

Source

def orElse(other: Ordering[Float]): Ordering[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.

case class Pair(a: Int, b: Int)
val pairOrdering = Ordering.by[Pair, Int](_.a)
                          .orElse(Ordering.by[Pair, Int](_.b))

Source

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

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

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

case class Pair(a: Int, b: Int)
val pairOrdering = Ordering.by[Pair, Int](_.a)
                          .orElseBy[Int](_.b)

Source

override def reverse: Ordering[T]

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).

def reversed(): Comparator[T]

def thenComparing[U <: Comparable[_ >: U <: <FromJavaObject>]](x$0: Function[_ >: Float <: <FromJavaObject>, _ <: U]): Comparator[T]

def thenComparing[U <: <FromJavaObject>](x$0: Function[_ >: Float <: <FromJavaObject>, _ <: U], x$1: Comparator[_ >: U <: <FromJavaObject>]): Comparator[T]

def thenComparing(x$0: Comparator[_ >: Float <: <FromJavaObject>]): Comparator[T]

def thenComparingDouble(x$0: ToDoubleFunction[_ >: Float <: <FromJavaObject>]): Comparator[T]

def thenComparingInt(x$0: ToIntFunction[_ >: Float <: <FromJavaObject>]): Comparator[T]

def thenComparingLong(x$0: ToLongFunction[_ >: Float <: <FromJavaObject>]): Comparator[T]

Source

def tryCompare(x: Float, y: Float): Option[Int]

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

Inherited implicits

Source

implicit def mkOrderingOps(lhs: Float): OrderingOps

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