Trait PartialOrdering.PartialOrdering

trait PartialOrdering[T] extends Equiv[T]

A 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, exposed as the lteq method of this trait. This relation must be:

- reflexive: lteq(x, x) == true, for any x of type T. - anti-symmetric: if lteq(x, y) == true and lteq(y, x) == true then equiv(x, y) == true, for any x and y of type T. - transitive: if lteq(x, y) == true and lteq(y, z) == true then lteq(x, z) == true, for any x, y, and z of type T.

Additionally, a partial ordering induces an equivalence relation on a type T: x and y of type T are equivalent if and only if lteq(x, y) && lteq(y, x) == true. This equivalence relation is exposed as the equiv method, inherited from the Equiv trait.

Supertypes	trait Equiv[T] trait Serializable class Object trait Matchable class Any
Known subtypes	63 types trait Ordering[T] object ValueOrdering.type object DeadlineIsOrdered.type object DurationIsOrdered.type object FiniteDurationIsOrdered.type trait Numeric[T] trait Fractional[T] trait BigDecimalIsFractional object BigDecimalIsFractional.type trait DoubleIsFractional object DoubleIsFractional.type trait FloatIsFractional object FloatIsFractional.type trait Integral[T] trait BigDecimalAsIfIntegral object BigDecimalAsIfIntegral.type trait BigIntIsIntegral object BigIntIsIntegral.type trait ByteIsIntegral object ByteIsIntegral.type trait CharIsIntegral object CharIsIntegral.type trait IntIsIntegral object IntIsIntegral.type trait LongIsIntegral object LongIsIntegral.type trait ShortIsIntegral object ShortIsIntegral.type trait BigDecimalIsConflicted trait BigDecimalOrdering object BigDecimal.type trait BigIntOrdering object BigInt.type trait BooleanOrdering object Boolean.type trait ByteOrdering object Byte.type trait CachedReverse[T] object Int.type trait CharOrdering object Char.type trait IeeeOrdering object IeeeOrdering.type trait TotalOrdering object DeprecatedDoubleOrdering.type object TotalOrdering.type trait IeeeOrdering object IeeeOrdering.type trait TotalOrdering object DeprecatedFloatOrdering.type object TotalOrdering.type trait IntOrdering trait LongOrdering object Long.type trait OptionOrdering[T] trait ShortOrdering object Short.type trait StringOrdering object String.type trait SymbolOrdering object Symbol.type trait UnitOrdering object Unit.type
Self type	PartialOrdering[T]

Abstract methods

Source

def lteq(x: T, y: T): Boolean

Returns true iff x comes before y in the ordering.

Source

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

Concrete methods

Source

def equiv(x: T, y: T): Boolean

Returns true iff x is equivalent to y in the ordering.

Source

def gt(x: T, y: T): Boolean

Returns true iff y comes before x in the ordering and is not the same as x.

Source

def gteq(x: T, y: T): Boolean

Returns true iff y comes before x in the ordering.

Source

def lt(x: T, y: T): Boolean

Returns true iff x comes before y in the ordering and is not the same as y.

Source

def reverse: PartialOrdering[T]