Scala 3/scala/scala.math/PartialOrdering

PartialOrdering

scala.math.PartialOrdering

See thePartialOrdering companion object

trait PartialOrdering[T] extends Equiv[T], Pure

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.

Type parameters

T: the type of elements being ordered

Attributes

Companion: object
Source: PartialOrdering.scala
Graph
Supertypes: trait Pure

trait Equiv[T]

trait Serializable

class Object

trait Matchable

class Any
Show all
Known subtypes: trait Ordering[T]

object DeadlineIsOrdered

object DurationIsOrdered

object FiniteDurationIsOrdered

object Enumeration.this.ValueOrdering

trait Numeric[T]

trait Fractional[T]

trait BigDecimalIsFractional

object BigDecimalIsFractional

trait DoubleIsFractional

object DoubleIsFractional

trait FloatIsFractional

object FloatIsFractional

trait Integral[T]

trait BigDecimalAsIfIntegral

object BigDecimalAsIfIntegral

trait BigIntIsIntegral

object BigIntIsIntegral

trait ByteIsIntegral

object ByteIsIntegral

trait CharIsIntegral

object CharIsIntegral

trait IntIsIntegral

object IntIsIntegral

trait LongIsIntegral

object LongIsIntegral

trait ShortIsIntegral

object ShortIsIntegral

trait BigDecimalIsConflicted

trait BigDecimalOrdering

object BigDecimal

trait BigIntOrdering

object BigInt

trait BooleanOrdering

object Boolean

trait ByteOrdering

object Byte

trait CachedReverse[T]

object Int

trait CharOrdering

object Char

trait IeeeOrdering

object IeeeOrdering

trait TotalOrdering

object DeprecatedDoubleOrdering

object TotalOrdering

trait IeeeOrdering

object IeeeOrdering

trait TotalOrdering

object DeprecatedFloatOrdering

object TotalOrdering

trait IntOrdering

trait LongOrdering

object Long

trait OptionOrdering[T]

trait ShortOrdering

object Short

trait StringOrdering

object String

trait SymbolOrdering

object Symbol

trait UnitOrdering

object Unit
Show all
Self type: PartialOrdering[T]

Members list

Value members

Abstract methods

Returns **true** iff x comes before y in the ordering.

Value parameters

x: the first element to compare
y: the second element to compare

Attributes

Returns: true if x is less than or equal to y in this ordering; false if x > y or if x and y are incomparable
Source: PartialOrdering.scala

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

Value parameters

x: the first element to compare
y: the second element to compare

Attributes

Returns: Some(r) where r < 0 if x < y, r == 0 if x equals y, and r > 0 if x > y; None if x and y are incomparable
Source: PartialOrdering.scala

Concrete methods

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

Value parameters

x: the first element to compare
y: the second element to compare

Attributes

Source: PartialOrdering.scala

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

Value parameters

x: the first element to compare
y: the second element to compare

Attributes

Returns: true if x is strictly greater than y in this ordering; false otherwise, including when x and y are incomparable
Source: PartialOrdering.scala

Returns **true** iff y comes before x in the ordering.

Value parameters

x: the first element to compare
y: the second element to compare

Attributes

Returns: true if x is greater than or equal to y in this ordering; false if x < y or if x and y are incomparable
Source: PartialOrdering.scala

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

Value parameters

x: the first element to compare
y: the second element to compare

Attributes

Returns: true if x is strictly less than y in this ordering; false otherwise, including when x and y are incomparable
Source: PartialOrdering.scala

Attributes

Source: PartialOrdering.scala

In this article

Generated with