An ordering for Double
s which is consistent with IEEE specifications whenever possible.
-
lt
,lteq
,equiv
,gteq
andgt
are consistent with primitive comparison operations forDouble
s, and returnfalse
when called withNaN
. -
min
andmax
are consistent withmath.min
andmath.max
, and returnNaN
when called withNaN
as either argument. -
compare
behaves the same as java.lang.Double.compare.
Because the behavior of Double
s specified by IEEE is not consistent with a total ordering when dealing with NaN
, there are two orderings defined for Double
: 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 PartialOrdering[Double]trait Serializabletrait Comparator[Double]class Objecttrait Matchableclass AnyShow all
- Known subtypes
-
object DoubleIsFractionalobject IeeeOrdering
Members list
Type members
Inherited classlikes
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
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 if x
== y
in the ordering.
Return true if x
> y
in the ordering.
Return true if x
>= y
in the ordering.
Return true if x
< y
in the ordering.
Return true if x
<= y
in the ordering.
Return x
if x
>= y
, otherwise y
.
Return x
if x
<= y
, otherwise y
.
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 to other == this.reverse
.
Implementations should only override this method if they are overriding reverse 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 of other
s 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 other
s 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 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
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
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 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
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