# BigIntOrdering

object BigIntIsIntegral.type
object BigInt.type

## Type members

### Inherited classlikes

class OrderingOps(lhs: T)

This inner class defines comparison operators available for `T`.

This inner class defines comparison operators available for `T`.

It can't extend `AnyVal` because it is not a top-level class or a member of a statically accessible object.

Inherited from:
Ordering
Source:
Ordering.scala

## Value members

### Concrete methods

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

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

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

The result sign has the following meaning:

- negative if x < y - positive if x > y - zero otherwise (if x == y)

Source:
Ordering.scala

### Inherited methods

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

Return true if `x` == `y` in the ordering.

Return true if `x` == `y` in the ordering.

Definition Classes
Inherited from:
Ordering
Source:
Ordering.scala
override def gt(x: BigInt, y: BigInt): Boolean

Return true if `x` > `y` in the ordering.

Return true if `x` > `y` in the ordering.

Definition Classes
Inherited from:
Ordering
Source:
Ordering.scala
override def gteq(x: BigInt, y: BigInt): Boolean

Return true if `x` >= `y` in the ordering.

Return true if `x` >= `y` in the ordering.

Definition Classes
Inherited from:
Ordering
Source:
Ordering.scala
def isReverseOf(other: Ordering[_]): Boolean

Returns whether or not the other ordering is the opposite ordering of this one.

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.

Inherited from:
Ordering
Source:
Ordering.scala
override def lt(x: BigInt, y: BigInt): Boolean

Return true if `x` < `y` in the ordering.

Return true if `x` < `y` in the ordering.

Definition Classes
Inherited from:
Ordering
Source:
Ordering.scala
override def lteq(x: BigInt, y: BigInt): Boolean

Return true if `x` <= `y` in the ordering.

Return true if `x` <= `y` in the ordering.

Definition Classes
Inherited from:
Ordering
Source:
Ordering.scala
def max[U <: BigInt](x: U, y: U): U

Return `x` if `x` >= `y`, otherwise `y`.

Return `x` if `x` >= `y`, otherwise `y`.

Inherited from:
Ordering
Source:
Ordering.scala
def min[U <: BigInt](x: U, y: U): U

Return `x` if `x` <= `y`, otherwise `y`.

Return `x` if `x` <= `y`, otherwise `y`.

Inherited from:
Ordering
Source:
Ordering.scala
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:

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))``
Inherited from:
Ordering
Source:
Ordering.scala
def orElse(other: Ordering[BigInt]): Ordering[T]

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 `other`s compare function.

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 `other`s compare function.

Value parameters:
other

an Ordering to use if this Ordering returns zero

Example:

``````case class Pair(a: Int, b: Int)
val pairOrdering = Ordering.by[Pair, Int](_.a)
.orElse(Ordering.by[Pair, Int](_.b))``````
Inherited from:
Ordering
Source:
Ordering.scala
def orElseBy[S](f: BigInt => S)(implicit ord: Ordering[S]): Ordering[T]

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:

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

Example:

``````case class Pair(a: Int, b: Int)
val pairOrdering = Ordering.by[Pair, Int](_.a)
.orElseBy[Int](_.b)``````
Inherited from:
Ordering
Source:
Ordering.scala
override def reverse: Ordering[T]

Return the opposite ordering of this one.

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
Inherited from:
Ordering
Source:
Ordering.scala
Inherited from:
Comparator
def thenComparing[U <: Comparable[_ >: U <: <FromJavaObject>]](x\$0: Function[_ >: BigInt <: <FromJavaObject>, _ <: U]): Comparator[T]
Inherited from:
Comparator
def thenComparing[U <: <FromJavaObject>](x\$0: Function[_ >: BigInt <: <FromJavaObject>, _ <: U], x\$1: Comparator[_ >: U <: <FromJavaObject>]): Comparator[T]
Inherited from:
Comparator
def thenComparing(x\$0: Comparator[_ >: BigInt <: <FromJavaObject>]): Comparator[T]
Inherited from:
Comparator
def thenComparingDouble(x\$0: ToDoubleFunction[_ >: BigInt <: <FromJavaObject>]): Comparator[T]
Inherited from:
Comparator
def thenComparingInt(x\$0: ToIntFunction[_ >: BigInt <: <FromJavaObject>]): Comparator[T]
Inherited from:
Comparator
def thenComparingLong(x\$0: ToLongFunction[_ >: BigInt <: <FromJavaObject>]): Comparator[T]
Inherited from:
Comparator

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

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

Inherited from:
Ordering
Source:
Ordering.scala

## Implicits

### Inherited implicits

implicit def mkOrderingOps(lhs: BigInt): OrderingOps

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

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

Inherited from:
Ordering
Source:
Ordering.scala