Object scala.math.Ordering.BigInt

implicit object BigInt extends BigIntOrdering

Source
Ordering.scala
Linear Supertypes
BigIntOrdering, Ordering[BigInt], PartialOrdering[BigInt], Equiv[BigInt], java.io.Serializable, Comparator[BigInt], AnyRef, Any

Type Members

class OrderingOps extends AnyRef

This inner class defines comparison operators available for T.

Definition Classes
Ordering

Value Members

final def !=(arg0: Any): Boolean

Test two objects for inequality.

returns

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

Definition Classes
AnyRef → Any

final def ##(): Int

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

final def ==(arg0: Any): Boolean

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

final def asInstanceOf[T0]: T0

Cast the receiver object to be of type T0.

Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.

returns

the receiver object.

Definition Classes
Any
Exceptions thrown

ClassCastException if the receiver object is not an instance of the erasure of type T0.

def clone(): AnyRef

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[java.lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
Note

not specified by SLS as a member of AnyRef

def compare(x: BigInt, y: BigInt): Int

Returns an integer whose sign communicates how x compares to y.

The result sign has the following meaning:

    negative if x < ypositive if x > yzero otherwise (if x == y)
Definition Classes
BigIntOrderingOrdering → Comparator

final def eq(arg0: AnyRef): Boolean

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

def equals(arg0: AnyRef): Boolean

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

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

Return true if x == y in the ordering.

Definition Classes
OrderingPartialOrderingEquiv

def finalize(): Unit

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[java.lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
Note

not specified by SLS as a member of AnyRef

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

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
@native()

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

Return true if x > y in the ordering.

Definition Classes
OrderingPartialOrdering

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

Return true if x >= y in the ordering.

Definition Classes
OrderingPartialOrdering

def hashCode(): Int

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

returns

the hash code value for this object.

Definition Classes
AnyRef → Any
Annotations
@native()

final def isInstanceOf[T0]: Boolean

Test whether the dynamic type of the receiver object is T0.

Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.

returns

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

Definition Classes
Any

def isReverseOf(other: Ordering[_]): Boolean

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.

Definition Classes
Ordering

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

Return true if x < y in the ordering.

Definition Classes
OrderingPartialOrdering

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

Return true if x <= y in the ordering.

Definition Classes
OrderingPartialOrdering

def max[U <: BigInt](x: U, y: U): U

Return x if x >= y, otherwise y.

Definition Classes
Ordering

def min[U <: BigInt](x: U, y: U): U

Return x if x <= y, otherwise y.

Definition Classes
Ordering

implicit def mkOrderingOps(lhs: BigInt): OrderingOps

This implicit method augments T with the comparison operators defined in scala.math.Ordering.Ops.

Definition Classes
Ordering

final def ne(arg0: AnyRef): Boolean

Equivalent to !(this eq that).

returns

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

Definition Classes
AnyRef

final def notify(): Unit

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

Definition Classes
AnyRef
Annotations
@native()
Note

not specified by SLS as a member of AnyRef

final def notifyAll(): Unit

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

Definition Classes
AnyRef
Annotations
@native()
Note

not specified by SLS as a member of AnyRef

def on[U](f: (U) => BigInt): Ordering[U]

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))
Definition Classes
Ordering

def orElse(other: Ordering[BigInt]): Ordering[BigInt]

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 others compare function.

other

an Ordering to use if this Ordering returns zero

Definition Classes
Ordering
Example:
    case class Pair(a: Int, b: Int)
    
    val pairOrdering = Ordering.by[Pair, Int](_.a)
                               .orElse(Ordering.by[Pair, Int](_.b))

def orElseBy[S](f: (BigInt) => S)(implicit ord: Ordering[S]): Ordering[BigInt]

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.

Definition Classes
Ordering
Example:
    case class Pair(a: Int, b: Int)
    
    val pairOrdering = Ordering.by[Pair, Int](_.a)
                               .orElseBy[Int](_.b)

def reverse: Ordering[BigInt]

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).

Definition Classes
OrderingPartialOrdering

def reversed(): Comparator[BigInt]

Definition Classes
Comparator

final def synchronized[T0](arg0: => T0): T0

Definition Classes
AnyRef

def thenComparing[U <: Comparable[_ >: U <: AnyRef]](arg0: java.util.function.Function[_ >: BigInt <: AnyRef, _ <: U]): Comparator[BigInt]

Definition Classes
Comparator

def thenComparing[U <: AnyRef](arg0: java.util.function.Function[_ >: BigInt <: AnyRef, _ <: U], arg1: Comparator[_ >: U <: AnyRef]): Comparator[BigInt]

Definition Classes
Comparator

def thenComparing(arg0: Comparator[_ >: BigInt <: AnyRef]): Comparator[BigInt]

Definition Classes
Comparator

def thenComparingDouble(arg0: ToDoubleFunction[_ >: BigInt <: AnyRef]): Comparator[BigInt]

Definition Classes
Comparator

def thenComparingInt(arg0: ToIntFunction[_ >: BigInt <: AnyRef]): Comparator[BigInt]

Definition Classes
Comparator

def thenComparingLong(arg0: ToLongFunction[_ >: BigInt <: AnyRef]): Comparator[BigInt]

Definition Classes
Comparator

def toString(): String

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

def tryCompare(x: BigInt, y: BigInt): Some[Int]

Returns whether a comparison between x and y is defined, and if so the result of compare(x, y).

Definition Classes
OrderingPartialOrdering

final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()

© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.13.0/scala/math/Ordering$$BigInt$.html