t

# PartialOrdering

### Companion object PartialOrdering

#### traitPartialOrdering[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.

Self Type
PartialOrdering[T]
Source
PartialOrdering.scala
Linear Supertypes
Type Hierarchy
Ordering
1. Alphabetic
2. By Inheritance
Inherited
1. PartialOrdering
2. Equiv
3. Serializable
4. AnyRef
5. Any
Implicitly
2. by StringFormat
3. by Ensuring
4. by ArrowAssoc
1. Hide All
2. Show All
Visibility
1. Public
2. Protected

### Abstract Value Members

1. abstract def lteq(x: T, y: T)

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

2. abstract def tryCompare(x: T, y: T): Option[Int]

Result of comparing `x` with operand `y`.

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 Value Members

1. final def !=(arg0: Any)

Test two objects for inequality.

Test two objects for inequality.

returns

`true` if !(this == that), false otherwise.

Definition Classes
AnyRef → Any
2. final def ##: Int

Equivalent to `x.hashCode` except for boxed numeric types and `null`.

Equivalent to `x.hashCode` except for boxed numeric types and `null`. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For `null` returns a hashcode where `null.hashCode` throws a `NullPointerException`.

returns

a hash value consistent with ==

Definition Classes
AnyRef → Any
3. def +(other: String)
Implicit
This member is added by an implicit conversion from PartialOrdering[T] toany2stringadd[PartialOrdering[T]] performed by method any2stringadd in scala.Predef.
Definition Classes
4. def ->[B](y: B): (PartialOrdering[T], B)
Implicit
This member is added by an implicit conversion from PartialOrdering[T] toArrowAssoc[PartialOrdering[T]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
()
5. final def ==(arg0: Any)

The expression `x == that` is equivalent to `if (x eq null) that eq null else x.equals(that)`.

The expression `x == that` is equivalent to `if (x eq null) that eq null else x.equals(that)`.

returns

`true` if the receiver object is equivalent to the argument; `false` otherwise.

Definition Classes
AnyRef → Any
6. final def asInstanceOf[T0]: T0

Forces the compiler to treat the receiver object as having type `T0`, even though doing so may violate type safety.

Forces the compiler to treat the receiver object as having type `T0`, even though doing so may violate type safety.

This method is useful when you believe you have type information the compiler doesn't, and it also isn't possible to check the type at runtime. In such situations, skipping type safety is the only option.

It is platform dependent whether `asInstanceOf` has any effect at runtime. It might do a runtime type test on the erasure of `T0`, insert a conversion (such as boxing/unboxing), fill in a default value, or do nothing at all.

In particular, `asInstanceOf` is not a type test. It does **not** mean:

```this match {
case x: T0 => x
case _     => throw ClassCastException("...")```

Use pattern matching or isInstanceOf for type testing instead.

Situations where `asInstanceOf` is useful:

• when flow analysis fails to deduce `T0` automatically
• when down-casting a type parameter or an abstract type member (which cannot be checked at runtime due to type erasure) If there is any doubt and you are able to type test instead, you should do so.

Be careful of using `asInstanceOf` when `T0` is a primitive type. When `T0` is primitive, `asInstanceOf` may insert a conversion instead of a type test. If your intent is to convert, use a `toT` method (`x.toChar`, `x.toByte`, etc.).

returns

Definition Classes
Any
Exceptions thrown

`ClassCastException` if the receiver is not an instance of the erasure of `T0`, if that can be checked on this platform

7. def clone()

Create a copy of the receiver object.

Create a copy of the receiver object.

The default implementation of the `clone` method is platform dependent.

returns

a copy of the receiver object.

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
(classOf[java.lang.CloneNotSupportedException]) ()
Note

not specified by SLS as a member of AnyRef

8. def ensuring(cond: (PartialOrdering[T]) => Boolean, msg: => Any): PartialOrdering[T]
Implicit
This member is added by an implicit conversion from PartialOrdering[T] toEnsuring[PartialOrdering[T]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
9. def ensuring(cond: (PartialOrdering[T]) => Boolean): PartialOrdering[T]
Implicit
This member is added by an implicit conversion from PartialOrdering[T] toEnsuring[PartialOrdering[T]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
10. def ensuring(cond: Boolean, msg: => Any): PartialOrdering[T]
Implicit
This member is added by an implicit conversion from PartialOrdering[T] toEnsuring[PartialOrdering[T]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
11. def ensuring(cond: Boolean): PartialOrdering[T]
Implicit
This member is added by an implicit conversion from PartialOrdering[T] toEnsuring[PartialOrdering[T]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
12. final def eq(arg0: AnyRef)

Tests whether the argument (`that`) is a reference to the receiver object (`this`).

Tests whether the argument (`that`) is a reference to the receiver object (`this`).

The `eq` method implements an equivalence relation on non-null instances of `AnyRef`, and has three additional properties:

• It is consistent: for any non-null instances `x` and `y` of type `AnyRef`, multiple invocations of `x.eq(y)` consistently returns `true` or consistently returns `false`.
• For any non-null instance `x` of type `AnyRef`, `x.eq(null)` and `null.eq(x)` returns `false`.
• `null.eq(null)` returns `true`.

When overriding the `equals` or `hashCode` methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (`o1 eq o2`), they should be equal to each other (`o1 == o2`) and they should hash to the same value (`o1.hashCode == o2.hashCode`).

returns

`true` if the argument is a reference to the receiver object; `false` otherwise.

Definition Classes
AnyRef
13. def equals(arg0: AnyRef)

The equality method for reference types.

The equality method for reference types. Default implementation delegates to `eq`.

See also `equals` in scala.Any.

returns

`true` if the receiver object is equivalent to the argument; `false` otherwise.

Definition Classes
AnyRef → Any
14. def equiv(x: T, y: T)

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

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

Definition Classes
PartialOrderingEquiv
15. def finalize(): Unit

Called by the garbage collector on the receiver object when there are no more references to the object.

Called by the garbage collector on the receiver object when there are no more references to the object.

The details of when and if the `finalize` method is invoked, as well as the interaction between `finalize` and non-local returns and exceptions, are all platform dependent.

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
(classOf[java.lang.Throwable])
Note

not specified by SLS as a member of AnyRef

16. final def getClass(): Class[_ <: AnyRef]

Returns the runtime class representation of the object.

Returns the runtime class representation of the object.

returns

a class object corresponding to the runtime type of the receiver.

Definition Classes
AnyRef → Any
Annotations
()
17. def gt(x: T, y: T)

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

18. def gteq(x: T, y: T)

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

19. def hashCode(): Int

The hashCode method for reference types.

The hashCode method for reference types. See hashCode in scala.Any.

returns

the hash code value for this object.

Definition Classes
AnyRef → Any
Annotations
()
20. final def isInstanceOf[T0]

Test whether the dynamic type of the receiver object has the same erasure as `T0`.

Test whether the dynamic type of the receiver object has the same erasure as `T0`.

Depending on what `T0` is, the test is done in one of the below ways:

• `T0` is a non-parameterized class type, e.g. `BigDecimal`: this method returns `true` if the value of the receiver object is a `BigDecimal` or a subtype of `BigDecimal`.
• `T0` is a parameterized class type, e.g. `List[Int]`: this method returns `true` if the value of the receiver object is some `List[X]` for any `X`. For example, `List(1, 2, 3).isInstanceOf[List[String]]` will return true.
• `T0` is some singleton type `x.type` or literal `x`: this method returns `this.eq(x)`. For example, `x.isInstanceOf[1]` is equivalent to `x.eq(1)`
• `T0` is an intersection `X with Y` or `X & Y: this method is equivalent to `x.isInstanceOf[X] && x.isInstanceOf[Y]
• `T0` is a union `X | Y`: this method is equivalent to `x.isInstanceOf[X] || x.isInstanceOf[Y]`
• `T0` is a type parameter or an abstract type member: this method is equivalent to `isInstanceOf[U]` where `U` is `T0`'s upper bound, `Any` if `T0` is unbounded. For example, `x.isInstanceOf[A]` where `A` is an unbounded type parameter will return true for any value of `x`.

This is exactly equivalent to the type pattern `_: T0`

returns

`true` if the receiver object is an instance of erasure of type `T0`; `false` otherwise.

Definition Classes
Any
Note

due to the unexpectedness of `List(1, 2, 3).isInstanceOf[List[String]]` returning true and `x.isInstanceOf[A]` where `A` is a type parameter or abstract member returning true, these forms issue a warning.

21. def lt(x: T, y: T)

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

22. final def ne(arg0: AnyRef)

Equivalent to `!(this eq that)`.

Equivalent to `!(this eq that)`.

returns

`true` if the argument is not a reference to the receiver object; `false` otherwise.

Definition Classes
AnyRef
23. final def notify(): Unit

Wakes up a single thread that is waiting on the receiver object's monitor.

Wakes up a single thread that is waiting on the receiver object's monitor.

Definition Classes
AnyRef
Annotations
()
Note

not specified by SLS as a member of AnyRef

24. final def notifyAll(): Unit

Wakes up all threads that are waiting on the receiver object's monitor.

Wakes up all threads that are waiting on the receiver object's monitor.

Definition Classes
AnyRef
Annotations
()
Note

not specified by SLS as a member of AnyRef

25. def reverse: PartialOrdering[T]
26. final def synchronized[T0](arg0: => T0): T0

Executes the code in `body` with an exclusive lock on `this`.

Executes the code in `body` with an exclusive lock on `this`.

returns

the result of `body`

Definition Classes
AnyRef
27. def toString()

Creates a String representation of this object.

Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.

returns

a String representation of the object.

Definition Classes
AnyRef → Any
28. final def wait(): Unit
Definition Classes
AnyRef
Annotations
(classOf[java.lang.InterruptedException])
Note

not specified by SLS as a member of AnyRef

29. final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
(classOf[java.lang.InterruptedException])
Note

not specified by SLS as a member of AnyRef

30. final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
(classOf[java.lang.InterruptedException]) ()
Note

not specified by SLS as a member of AnyRef

### Deprecated Value Members

1. def formatted(fmtstr: String)

Returns string formatted according to given `format` string.

Returns string formatted according to given `format` string. Format strings are as for `String.format` (@see java.lang.String.format).

Implicit
This member is added by an implicit conversion from PartialOrdering[T] toStringFormat[PartialOrdering[T]] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
()
Deprecated

(Since version 2.12.16) Use `formatString.format(value)` instead of `value.formatted(formatString)`, or use the `f""` string interpolator. In Java 15 and later, `formatted` resolves to the new method in String which has reversed parameters.

2. def [B](y: B): (PartialOrdering[T], B)
Implicit
This member is added by an implicit conversion from PartialOrdering[T] toArrowAssoc[PartialOrdering[T]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
Deprecated

(Since version 2.13.0) Use `->` instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.