Scala Standard Library2.12.21 < Back
 

# Packages

-  package root

  This is the documentation for the Scala standard library.

  This is the documentation for the Scala standard library.

  #### Package structure

  The scala package contains core types like `Int`, `Float`, `Array` or `Option` which are accessible in all Scala compilation units without explicit qualification or imports.

  Notable packages include:

  - `scala.collection` and its sub-packages contain Scala's collections framework
    - `scala.collection.immutable` - Immutable, sequential data-structures such as `Vector`, `List`, `Range`, `HashMap` or `HashSet`
    - `scala.collection.mutable` - Mutable, sequential data-structures such as `ArrayBuffer`, `StringBuilder`, `HashMap` or `HashSet`
    - `scala.collection.concurrent` - Mutable, concurrent data-structures such as `TrieMap`
    - `scala.collection.parallel.immutable` - Immutable, parallel data-structures such as `ParVector`, `ParRange`, `ParHashMap` or `ParHashSet`
    - `scala.collection.parallel.mutable` - Mutable, parallel data-structures such as `ParArray`, `ParHashMap`, `ParTrieMap` or `ParHashSet`
  - `scala.concurrent` - Primitives for concurrent programming such as `Futures` and `Promises`
  - `scala.io` - Input and output operations
  - `scala.math` - Basic math functions and additional numeric types like `BigInt` and `BigDecimal`
  - `scala.sys` - Interaction with other processes and the operating system
  - `scala.util.matching` - Regular expressions

  Other packages exist. See the complete list on the right.

  Additional parts of the standard library are shipped as separate libraries. These include:

  - `scala.reflect` - Scala's reflection API (scala-reflect.jar)
  - `scala.xml` - XML parsing, manipulation, and serialization (scala-xml.jar)
  - `scala.swing` - A convenient wrapper around Java's GUI framework called Swing (scala-swing.jar)
  - `scala.util.parsing` - Parser combinators (scala-parser-combinators.jar)

  #### Automatic imports

  Identifiers in the scala package and the `scala.Predef` object are always in scope by default.

  Some of these identifiers are type aliases provided as shortcuts to commonly used classes. For example, `List` is an alias for `scala.collection.immutable.List`.

  Other aliases refer to classes provided by the underlying platform. For example, on the JVM, `String` is an alias for `java.lang.String`.

  Definition Classes
    root
-  package scala

  Core Scala types.

  Core Scala types. They are always available without an explicit import.

  Definition Classes
    root
-  package math

  The package object `scala.math` contains methods for performing basic numeric operations such as elementary exponential, logarithmic, root and trigonometric functions.

  The package object `scala.math` contains methods for performing basic numeric operations such as elementary exponential, logarithmic, root and trigonometric functions.

  All methods forward to java.lang.Math unless otherwise noted.

  Definition Classes
    scala
  See also

    java.lang.Math

- BigDecimal
- BigInt
- Equiv
- Fractional
- Integral
- LowPriorityEquiv
- LowPriorityOrderingImplicits
- Numeric
- Ordered
- Ordering
- PartialOrdering
- PartiallyOrdered
- ScalaNumericAnyConversions
- ScalaNumericConversions

c

scala.math

# BigInt 

###
Companion object BigInt

#### final class BigInt extends ScalaNumber with ScalaNumericConversions with Serializable with Ordered[BigInt]

Source
  BigInt.scala

Linear Supertypes
Ordered[BigInt], Comparable[BigInt], Serializable, ScalaNumericConversions, ScalaNumericAnyConversions, ScalaNumber, Number, java.io.Serializable, AnyRef, Any
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. BigInt
2. Ordered
3. Comparable
4. Serializable
5. ScalaNumericConversions
6. ScalaNumericAnyConversions
7. ScalaNumber
8. Number
9. Serializable
10. AnyRef
11. Any

Implicitly

1. by orderingToOrdered
2. by any2stringadd
3. by StringFormat
4. by Ensuring
5. by ArrowAssoc

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Instance Constructors

1.  new BigInt(bigInteger: BigInteger)

### Value Members

1.  final def !=(arg0: Any): Boolean

   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 %(that: BigInt): BigInt

   Remainder of BigInts

4.  def &(that: BigInt): BigInt

   Bitwise and of BigInts

5.  def &~(that: BigInt): BigInt

   Bitwise and-not of BigInts.

   Bitwise and-not of BigInts. Returns a BigInt whose value is (this & ~that).

6.  def *(that: BigInt): BigInt

   Multiplication of BigInts

7.  def +(that: BigInt): BigInt

   Addition of BigInts

8.  def -(that: BigInt): BigInt

   Subtraction of BigInts

9.  def ->[B](y: B): (BigInt, B)
   Implicit
     This member is added by an implicit conversion from BigInt to ArrowAssoc[BigInt] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
10.  def /(that: BigInt): BigInt

    Division of BigInts

11.  def /%(that: BigInt): (BigInt, BigInt)

    Returns a pair of two BigInts containing (this / that) and (this % that).

12.  def <(that: BigInt): Boolean

    Returns true if `this` is less than `that`

    Returns true if `this` is less than `that`

    Definition Classes
      Ordered
13.  def <<(n: Int): BigInt

    Leftshift of BigInt

14.  def <=(that: BigInt): Boolean

    Returns true if `this` is less than or equal to `that`.

    Returns true if `this` is less than or equal to `that`.

    Definition Classes
      Ordered
15.  final def ==(arg0: Any): Boolean

    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
16.  def >(that: BigInt): Boolean

    Returns true if `this` is greater than `that`.

    Returns true if `this` is greater than `that`.

    Definition Classes
      Ordered
17.  def >=(that: BigInt): Boolean

    Returns true if `this` is greater than or equal to `that`.

    Returns true if `this` is greater than or equal to `that`.

    Definition Classes
      Ordered
18.  def >>(n: Int): BigInt

    (Signed) rightshift of BigInt

19.  def ^(that: BigInt): BigInt

    Bitwise exclusive-or of BigInts

20.  def abs: BigInt

    Returns the absolute value of this BigInt

21.  final def asInstanceOf[T0]: T0

    Cast the receiver object to be of type `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`.

22.  val bigInteger: BigInteger
23.  def bitCount: Int

    Returns the number of bits in the two's complement representation of this BigInt that differ from its sign bit.

24.  def bitLength: Int

    Returns the number of bits in the minimal two's-complement representation of this BigInt, excluding a sign bit.

25.  def byteValue(): Byte

    Converts this BigInt to a `byte`.

    Converts this BigInt to a `byte`. If the BigInt is too big to fit in a byte, only the low-order 8 bits are returned. Note that this conversion can lose information about the overall magnitude of the BigInt value as well as return a result with the opposite sign.

    Definition Classes
      BigInt → ScalaNumericAnyConversions → Number
26.  def charValue: Char

    Converts this BigInt to a `char`.

    Converts this BigInt to a `char`. If the BigInt is too big to fit in a char, only the low-order 16 bits are returned. Note that this conversion can lose information about the overall magnitude of the BigInt value and that it always returns a positive result.

27.  def clearBit(n: Int): BigInt

    Returns a BigInt whose value is equivalent to this BigInt with the designated bit cleared.

28.  def clone(): AnyRef

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

      not specified by SLS as a member of AnyRef

29.  def compare(that: BigInt): Int

    Compares this BigInt with the specified BigInt

    Compares this BigInt with the specified BigInt

    Definition Classes
      BigInt → Ordered
30.  def compareTo(that: BigInt): Int

    Result of comparing `this` with operand `that`.

    Result of comparing `this` with operand `that`.

    Definition Classes
      Ordered → Comparable
31.  def doubleValue(): Double

    Converts this `BigInt` to a `double`.

    Converts this `BigInt` to a `double`. if this `BigInt` has too great a magnitude to represent as a double, it will be converted to `Double.NEGATIVE_INFINITY` or `Double.POSITIVE_INFINITY` as appropriate.

    Definition Classes
      BigInt → ScalaNumericAnyConversions → Number
32.  def ensuring(cond: (BigInt) ⇒ Boolean, msg: ⇒ Any): BigInt
    Implicit
      This member is added by an implicit conversion from BigInt to Ensuring[BigInt] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
33.  def ensuring(cond: (BigInt) ⇒ Boolean): BigInt
    Implicit
      This member is added by an implicit conversion from BigInt to Ensuring[BigInt] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
34.  def ensuring(cond: Boolean, msg: ⇒ Any): BigInt
    Implicit
      This member is added by an implicit conversion from BigInt to Ensuring[BigInt] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
35.  def ensuring(cond: Boolean): BigInt
    Implicit
      This member is added by an implicit conversion from BigInt to Ensuring[BigInt] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
36.  final def eq(arg0: AnyRef): Boolean

    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
37.  def equals(that: BigInt): Boolean

    Compares this BigInt with the specified BigInt for equality.

38.  def equals(that: Any): Boolean

    Compares this BigInt with the specified value for equality.

    Compares this BigInt with the specified value for equality.

    that

      the object to compare against this object for equality.

    returns

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

    Definition Classes
      BigInt → AnyRef → Any
39.  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
      @throws( classOf[java.lang.Throwable] )
    Note

      not specified by SLS as a member of AnyRef

40.  def flipBit(n: Int): BigInt

    Returns a BigInt whose value is equivalent to this BigInt with the designated bit flipped.

41.  def floatValue(): Float

    Converts this `BigInt` to a `float`.

    Converts this `BigInt` to a `float`. If this `BigInt` has too great a magnitude to represent as a float, it will be converted to `Float.NEGATIVE_INFINITY` or `Float.POSITIVE_INFINITY` as appropriate.

    Definition Classes
      BigInt → ScalaNumericAnyConversions → Number
42.  def gcd(that: BigInt): BigInt

    Returns the greatest common divisor of abs(this) and abs(that)

43.  final def getClass(): Class[_]

    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
      @native()
44.  def hashCode(): Int

    Returns the hash code for this BigInt.

    Returns the hash code for this BigInt.

    returns

      the hash code value for this object.

    Definition Classes
      BigInt → AnyRef → Any
45.  def intValue(): Int

    Converts this BigInt to an `int`.

    Converts this BigInt to an `int`. If the BigInt is too big to fit in an int, only the low-order 32 bits are returned. Note that this conversion can lose information about the overall magnitude of the BigInt value as well as return a result with the opposite sign.

    Definition Classes
      BigInt → ScalaNumericAnyConversions → Number
46.  final def isInstanceOf[T0]: Boolean

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

    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
47.  def isProbablePrime(certainty: Int): Boolean

    Returns true if this BigInt is probably prime, false if it's definitely composite.

    Returns true if this BigInt is probably prime, false if it's definitely composite.

    certainty

      a measure of the uncertainty that the caller is willing to tolerate: if the call returns true the probability that this BigInt is prime exceeds (1 - 1/2 ^ certainty). The execution time of this method is proportional to the value of this parameter.

48.  def isValidByte: Boolean

    Returns `true` iff this has a zero fractional part, and is within the range of scala.Byte MinValue and MaxValue; otherwise returns `false`.

    Returns `true` iff this has a zero fractional part, and is within the range of scala.Byte MinValue and MaxValue; otherwise returns `false`.

    Definition Classes
      BigInt → ScalaNumericAnyConversions
49.  def isValidChar: Boolean

    Returns `true` iff this has a zero fractional part, and is within the range of scala.Char MinValue and MaxValue; otherwise returns `false`.

    Returns `true` iff this has a zero fractional part, and is within the range of scala.Char MinValue and MaxValue; otherwise returns `false`.

    Definition Classes
      BigInt → ScalaNumericAnyConversions
50.  def isValidDouble: Boolean

    Returns `true` iff this can be represented exactly by scala.Double; otherwise returns `false`.

51.  def isValidFloat: Boolean

    Returns `true` iff this can be represented exactly by scala.Float; otherwise returns `false`.

52.  def isValidInt: Boolean

    Returns `true` iff this has a zero fractional part, and is within the range of scala.Int MinValue and MaxValue; otherwise returns `false`.

    Returns `true` iff this has a zero fractional part, and is within the range of scala.Int MinValue and MaxValue; otherwise returns `false`.

    Definition Classes
      BigInt → ScalaNumericAnyConversions
53.  def isValidLong: Boolean
54.  def isValidShort: Boolean

    Returns `true` iff this has a zero fractional part, and is within the range of scala.Short MinValue and MaxValue; otherwise returns `false`.

    Returns `true` iff this has a zero fractional part, and is within the range of scala.Short MinValue and MaxValue; otherwise returns `false`.

    Definition Classes
      BigInt → ScalaNumericAnyConversions
55.  def longValue(): Long

    Converts this BigInt to a `long`.

    Converts this BigInt to a `long`. If the BigInt is too big to fit in a long, only the low-order 64 bits are returned. Note that this conversion can lose information about the overall magnitude of the BigInt value as well as return a result with the opposite sign.

    Definition Classes
      BigInt → ScalaNumericAnyConversions → Number
56.  def lowestSetBit: Int

    Returns the index of the rightmost (lowest-order) one bit in this BigInt (the number of zero bits to the right of the rightmost one bit).

57.  def max(that: BigInt): BigInt

    Returns the maximum of this and that

58.  def min(that: BigInt): BigInt

    Returns the minimum of this and that

59.  def mod(that: BigInt): BigInt

    Returns a BigInt whose value is (this mod that).

    Returns a BigInt whose value is (this mod that). This method differs from `%` in that it always returns a non-negative BigInt.

60.  def modInverse(m: BigInt): BigInt

    Returns a BigInt whose value is (the inverse of `this` modulo `m`).

61.  def modPow(exp: BigInt, m: BigInt): BigInt

    Returns a BigInt whose value is (`this` raised to the power of `exp` modulo `m`).

62.  final def ne(arg0: AnyRef): Boolean

    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
63.  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
      @native()
    Note

      not specified by SLS as a member of AnyRef

64.  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
      @native()
    Note

      not specified by SLS as a member of AnyRef

65.  def pow(exp: Int): BigInt

    Returns a BigInt whose value is (`this` raised to the power of `exp`).

66.  def setBit(n: Int): BigInt

    Returns a BigInt whose value is equivalent to this BigInt with the designated bit set.

67.  def shortValue(): Short

    Converts this BigInt to a `short`.

    Converts this BigInt to a `short`. If the BigInt is too big to fit in a short, only the low-order 16 bits are returned. Note that this conversion can lose information about the overall magnitude of the BigInt value as well as return a result with the opposite sign.

    Definition Classes
      BigInt → ScalaNumericAnyConversions → Number
68.  def signum: Int

    Returns the sign of this BigInt; -1 if it is less than 0, +1 if it is greater than 0, 0 if it is equal to 0.

69.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
70.  def testBit(n: Int): Boolean

    Returns true if and only if the designated bit is set.

71.  def to(end: BigInt, step: BigInt = BigInt(1)): Inclusive[scala.BigInt]

    Like until, but inclusive of the end value.

72.  def toByte: Byte

    Returns the value of this as a scala.Byte.

    Returns the value of this as a scala.Byte. This may involve rounding or truncation.

    Definition Classes
      ScalaNumericAnyConversions
73.  def toByteArray: Array[Byte]

    Returns a byte array containing the two's-complement representation of this BigInt.

    Returns a byte array containing the two's-complement representation of this BigInt. The byte array will be in big-endian byte-order: the most significant byte is in the zeroth element. The array will contain the minimum number of bytes required to represent this BigInt, including at least one sign bit.

74.  def toChar: Char

    Returns the value of this as a scala.Char.

    Returns the value of this as a scala.Char. This may involve rounding or truncation.

    Definition Classes
      ScalaNumericAnyConversions
75.  def toDouble: Double

    Returns the value of this as a scala.Double.

    Returns the value of this as a scala.Double. This may involve rounding or truncation.

    Definition Classes
      ScalaNumericAnyConversions
76.  def toFloat: Float

    Returns the value of this as a scala.Float.

    Returns the value of this as a scala.Float. This may involve rounding or truncation.

    Definition Classes
      ScalaNumericAnyConversions
77.  def toInt: Int

    Returns the value of this as an scala.Int.

    Returns the value of this as an scala.Int. This may involve rounding or truncation.

    Definition Classes
      ScalaNumericAnyConversions
78.  def toLong: Long

    Returns the value of this as a scala.Long.

    Returns the value of this as a scala.Long. This may involve rounding or truncation.

    Definition Classes
      ScalaNumericAnyConversions
79.  def toShort: Short

    Returns the value of this as a scala.Short.

    Returns the value of this as a scala.Short. This may involve rounding or truncation.

    Definition Classes
      ScalaNumericAnyConversions
80.  def toString(radix: Int): String

    Returns the String representation in the specified radix of this BigInt.

81.  def toString(): String

    Returns the decimal String representation of this BigInt.

    Returns the decimal String representation of this BigInt.

    returns

      a String representation of the object.

    Definition Classes
      BigInt → AnyRef → Any
82.  def unary_-: BigInt

    Returns a BigInt whose value is the negation of this BigInt

83.  def unary_~: BigInt

    Returns the bitwise complement of this BigInt

84.  def underlying(): BigInteger
    Definition Classes
      BigInt → ScalaNumericConversions → ScalaNumericAnyConversions → ScalaNumber
85.  def unifiedPrimitiveEquals(x: Any): Boolean

    Should only be called after all known non-primitive types have been excluded.

    Should only be called after all known non-primitive types have been excluded. This method won't dispatch anywhere else after checking against the primitives to avoid infinite recursion between equals and this on unknown "Number" variants.

    Additionally, this should only be called if the numeric type is happy to be converted to Long, Float, and Double. If for instance a BigInt much larger than the Long range is sent here, it will claim equality with whatever Long is left in its lower 64 bits. Or a BigDecimal with more precision than Double can hold: same thing. There's no way given the interface available here to prevent this error.

    Attributes
      protected
    Definition Classes
      ScalaNumericAnyConversions
86.  def unifiedPrimitiveHashcode(): Int
    Attributes
      protected
    Definition Classes
      ScalaNumericAnyConversions
87.  def until(end: BigInt, step: BigInt = BigInt(1)): Exclusive[scala.BigInt]

    Create a `NumericRange[BigInt]` in range `[start;end)` with the specified step, where start is the target BigInt.

    Create a `NumericRange[BigInt]` in range `[start;end)` with the specified step, where start is the target BigInt.

    end

      the end value of the range (exclusive)

    step

      the distance between elements (defaults to 1)

    returns

      the range

88.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
89.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
90.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... ) @native()
91.  def |(that: BigInt): BigInt

    Bitwise or of BigInts

92.  def →[B](y: B): (BigInt, B)
    Implicit
      This member is added by an implicit conversion from BigInt to ArrowAssoc[BigInt] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
      ArrowAssoc

### Shadowed Implicit Value Members

1.  def +(other: String): String
   Implicit
     This member is added by an implicit conversion from BigInt to any2stringadd[BigInt] performed by method any2stringadd in scala.Predef.
   Shadowing
     This implicitly inherited member is shadowed by one or more members in this class.
     To access this member you can use a type ascription:

         (bigInt: any2stringadd[BigInt]).+(other)

   Definition Classes
     any2stringadd
2.  def <(that: BigInt): Boolean

   Returns true if `this` is less than `that`

   Returns true if `this` is less than `that`

   Implicit
     This member is added by an implicit conversion from BigInt to Ordered[BigInt] performed by method orderingToOrdered in scala.math.Ordered.
   Shadowing
     This implicitly inherited member is shadowed by one or more members in this class.
     To access this member you can use a type ascription:

         (bigInt: Ordered[BigInt]).<(that)

   Definition Classes
     Ordered
3.  def <=(that: BigInt): Boolean

   Returns true if `this` is less than or equal to `that`.

   Returns true if `this` is less than or equal to `that`.

   Implicit
     This member is added by an implicit conversion from BigInt to Ordered[BigInt] performed by method orderingToOrdered in scala.math.Ordered.
   Shadowing
     This implicitly inherited member is shadowed by one or more members in this class.
     To access this member you can use a type ascription:

         (bigInt: Ordered[BigInt]).<=(that)

   Definition Classes
     Ordered
4.  def >(that: BigInt): Boolean

   Returns true if `this` is greater than `that`.

   Returns true if `this` is greater than `that`.

   Implicit
     This member is added by an implicit conversion from BigInt to Ordered[BigInt] performed by method orderingToOrdered in scala.math.Ordered.
   Shadowing
     This implicitly inherited member is shadowed by one or more members in this class.
     To access this member you can use a type ascription:

         (bigInt: Ordered[BigInt]).>(that)

   Definition Classes
     Ordered
5.  def >=(that: BigInt): Boolean

   Returns true if `this` is greater than or equal to `that`.

   Returns true if `this` is greater than or equal to `that`.

   Implicit
     This member is added by an implicit conversion from BigInt to Ordered[BigInt] performed by method orderingToOrdered in scala.math.Ordered.
   Shadowing
     This implicitly inherited member is shadowed by one or more members in this class.
     To access this member you can use a type ascription:

         (bigInt: Ordered[BigInt]).>=(that)

   Definition Classes
     Ordered
6.  def compare(that: BigInt): Int

   Result of comparing `this` with operand `that`.

   Result of comparing `this` with operand `that`.

   Implement this method to determine how instances of A will be sorted.

   Returns `x` where:

   - `x < 0` when `this < that`
   - `x == 0` when `this == that`
   - `x > 0` when `this > that`
   Implicit
     This member is added by an implicit conversion from BigInt to Ordered[BigInt] performed by method orderingToOrdered in scala.math.Ordered.
   Shadowing
     This implicitly inherited member is shadowed by one or more members in this class.
     To access this member you can use a type ascription:

         (bigInt: Ordered[BigInt]).compare(that)

   Definition Classes
     Ordered
7.  def compareTo(that: BigInt): Int

   Result of comparing `this` with operand `that`.

   Result of comparing `this` with operand `that`.

   Implicit
     This member is added by an implicit conversion from BigInt to Ordered[BigInt] performed by method orderingToOrdered in scala.math.Ordered.
   Shadowing
     This implicitly inherited member is shadowed by one or more members in this class.
     To access this member you can use a type ascription:

         (bigInt: Ordered[BigInt]).compareTo(that)

   Definition Classes
     Ordered → Comparable

### Deprecated Value Members

1.  def formatted(fmtstr: String): 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 BigInt to StringFormat[BigInt] performed by method StringFormat in scala.Predef.
   Definition Classes
     StringFormat
   Annotations
     @deprecated @inline()
   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 isWhole(): Boolean

   returns

     `true` if this number has no decimal component, `false` otherwise.

   Definition Classes
     BigInt → ScalaNumericAnyConversions → ScalaNumber
   Annotations
     @deprecated
   Deprecated

     (Since version 2.12.15) isWhole on an integer type is always true

### Inherited from Ordered[BigInt]

### Inherited from Comparable[BigInt]

### Inherited from Serializable

### Inherited from ScalaNumericConversions

### Inherited from ScalaNumericAnyConversions

### Inherited from ScalaNumber

### Inherited from Number

### Inherited from java.io.Serializable

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion orderingToOrdered from BigInt to Ordered[BigInt]

### Inherited by implicit conversion any2stringadd from BigInt to any2stringadd[BigInt]

### Inherited by implicit conversion StringFormat from BigInt to StringFormat[BigInt]

### Inherited by implicit conversion Ensuring from BigInt to Ensuring[BigInt]

### Inherited by implicit conversion ArrowAssoc from BigInt to ArrowAssoc[BigInt]

### Ungrouped