Scala Library
|
|
scala/math/PartialOrdering.scala
]
trait
PartialOrdering[T]
extends
Equiv[T] with
AnyRefA trait for representing partial orderings. It is important to distinguish between a type that has a partial order and a representation of partial ordering on some type. This trait is for representing the latter.
A partial ordering
is a binary relation on a type T
that is also an equivalence
relation on values of type T
. This relation is exposed as
the lteq
method of the PartialOrdering
trait.
This relation must be:
lteq(x, x) == true
, for any x
of
type T
.lteq(x, y) == true
and
lteq(y, x) == true
then equiv(x, y)
, for any
x
and y
of type T
.lteq(x, y) == true
and
lteq(y, z) == true
then lteq(x, z) == true
,
for any x
, y
, and z
of type
T
.Method Summary | |
def
|
equiv
(x : T, y : T) : Boolean
Returns
true iff x is equivalent to
y in the ordering. |
def
|
gt
(x : T, y : T) : Boolean
Returns
true iff y comes before
x in the ordering and is not the same as x . |
def
|
gteq
(x : T, y : T) : Boolean
Returns
true iff y comes before
x in the ordering. |
def
|
lt
(x : T, y : T) : Boolean
Returns
true iff x comes before
y in the ordering and is not the same as y . |
abstract def
|
lteq
(x : T, y : T) : Boolean
Returns
true iff x comes before
y in the ordering. |
def
|
reverse : PartialOrdering[T] |
abstract def
|
tryCompare
(x : T, y : T) : Option[Int]
Result of comparing
x with operand y .
Returns None if operands are not comparable.
If operands are comparable, returns Some(r) where
r < 0 iff x < y
r == 0 iff x == y
r > 0 iff x > y |
Methods inherited from AnyRef | |
getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize, ==, !=, eq, ne, synchronized |
Methods inherited from Any | |
==, !=, isInstanceOf, asInstanceOf |
Method Details |
x
with operand y
.
Returns None
if operands are not comparable.
If operands are comparable, returns Some(r)
where
r < 0
iff x < y
r == 0
iff x == y
r > 0
iff x > y
true
iff x
comes before
y
in the ordering.true
iff y
comes before
x
in the ordering.true
iff x
comes before
y
in the ordering and is not the same as y
.true
iff y
comes before
x
in the ordering and is not the same as x
.true
iff x
is equivalent to
y
in the ordering.
def
reverse : PartialOrdering[T]
Scala Library
|
|