Scala 3
3.3.1
LearnInstallPlaygroundFind A LibraryCommunityBlog
LearnInstallPlaygroundFind A LibraryCommunityBlog
API
Generated with
Copyright (c) 2002-2023, LAMP/EPFL
Copyright (c) 2002-2023, LAMP/EPFL
Scala 3/scala/scala.math/Ordering/Float/IeeeOrdering

IeeeOrdering

scala.math.Ordering.Float.IeeeOrdering
See theIeeeOrdering companion object
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.

Attributes

See also
Companion
object
Source
Ordering.scala
Graph
Supertypes
trait Ordering[Float]
trait Equiv[Float]
trait Serializable
trait Comparator[Float]
class Object
trait Matchable
class Any
Show all
Known subtypes
object IeeeOrdering

Members list

Type members

Inherited classlikes

class OrderingOps(lhs: T)

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.

Attributes

Inherited from:
Ordering
Source
Ordering.scala
Supertypes
class Object
trait Matchable
class Any

Value members

Concrete methods

def compare(x: Float, y: Float): 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)

Attributes

Source
Ordering.scala
override def equiv(x: Float, y: Float): Boolean

Return true if x == y in the ordering.

Return true if x == y in the ordering.

Attributes

Definition Classes
Source
Ordering.scala
override def gt(x: Float, y: Float): Boolean

Return true if x > y in the ordering.

Return true if x > y in the ordering.

Attributes

Definition Classes
Source
Ordering.scala
override def gteq(x: Float, y: Float): Boolean

Return true if x >= y in the ordering.

Return true if x >= y in the ordering.

Attributes

Definition Classes
Source
Ordering.scala
override def lt(x: Float, y: Float): Boolean

Return true if x < y in the ordering.

Return true if x < y in the ordering.

Attributes

Definition Classes
Source
Ordering.scala
override def lteq(x: Float, y: Float): Boolean

Return true if x <= y in the ordering.

Return true if x <= y in the ordering.

Attributes

Definition Classes
Source
Ordering.scala
override def max[U <: Float](x: U, y: U): U

Return x if x >= y, otherwise y.

Return x if x >= y, otherwise y.

Attributes

Definition Classes
Source
Ordering.scala
override def min[U <: Float](x: U, y: U): U

Return x if x <= y, otherwise y.

Return x if x <= y, otherwise y.

Attributes

Definition Classes
Source
Ordering.scala

Inherited methods

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.

Attributes

Inherited from:
Ordering
Source
Ordering.scala
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:

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

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.

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

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.

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
override def reverse: Ordering[Float]

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

Attributes

Definition Classes
Inherited from:
Ordering
Source
Ordering.scala
def reversed(): Comparator[Float]

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

Inherited from:
Comparator
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).

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

Attributes

Inherited from:
Ordering
Source
Ordering.scala

Implicits

Inherited implicits

implicit def mkOrderingOps(lhs: Float): 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.

Attributes

Inherited from:
Ordering
Source
Ordering.scala
Generated with
Copyright (c) 2002-2023, LAMP/EPFL
Copyright (c) 2002-2023, LAMP/EPFL