final class BigInt extends ScalaNumber with ScalaNumericConversions with Serializable with Ordered[BigInt]
 Source
 BigInt.scala
 Alphabetic
 By Inheritance
 BigInt
 Ordered
 Comparable
 Serializable
 ScalaNumericConversions
 ScalaNumericAnyConversions
 ScalaNumber
 Number
 Serializable
 AnyRef
 Any
 by orderingToOrdered
 by any2stringadd
 by StringFormat
 by Ensuring
 by ArrowAssoc
 Hide All
 Show All
 Public
 All
Instance Constructors
 new BigInt(bigInteger: BigInteger)
Value Members

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

final
def
##(): Int
Equivalent to
x.hashCode
except for boxed numeric types andnull
.Equivalent to
x.hashCode
except for boxed numeric types andnull
. 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. Fornull
returns a hashcode wherenull.hashCode
throws aNullPointerException
. returns
a hash value consistent with ==
 Definition Classes
 AnyRef → Any

def
%(that: BigInt): BigInt
Remainder of BigInts

def
&(that: BigInt): BigInt
Bitwise and of BigInts

def
&~(that: BigInt): BigInt
Bitwise andnot of BigInts.
Bitwise andnot of BigInts. Returns a BigInt whose value is (this & ~that).

def
*(that: BigInt): BigInt
Multiplication of BigInts

def
+(that: BigInt): BigInt
Addition of BigInts

def
(that: BigInt): BigInt
Subtraction of BigInts

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

def
/(that: BigInt): BigInt
Division of BigInts

def
/%(that: BigInt): (BigInt, BigInt)
Returns a pair of two BigInts containing (this / that) and (this % that).

def
<(that: BigInt): Boolean
Returns true if
this
is less thanthat
Returns true if
this
is less thanthat
 Definition Classes
 Ordered

def
<<(n: Int): BigInt
Leftshift of BigInt

def
<=(that: BigInt): Boolean
Returns true if
this
is less than or equal tothat
.Returns true if
this
is less than or equal tothat
. Definition Classes
 Ordered

final
def
==(arg0: Any): Boolean
The expression
x == that
is equivalent toif (x eq null) that eq null else x.equals(that)
.The expression
x == that
is equivalent toif (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

def
>(that: BigInt): Boolean
Returns true if
this
is greater thanthat
.Returns true if
this
is greater thanthat
. Definition Classes
 Ordered

def
>=(that: BigInt): Boolean
Returns true if
this
is greater than or equal tothat
.Returns true if
this
is greater than or equal tothat
. Definition Classes
 Ordered

def
>>(n: Int): BigInt
(Signed) rightshift of BigInt

def
^(that: BigInt): BigInt
Bitwise exclusiveor of BigInts

def
abs: BigInt
Returns the absolute value of this BigInt

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 aClassCastException
at runtime, while the expressionList(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 typeT0
.
 val bigInteger: BigInteger

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

def
bitLength: Int
Returns the number of bits in the minimal two'scomplement representation of this BigInt, excluding a sign bit.

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 loworder 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

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

def
clearBit(n: Int): BigInt
Returns a BigInt whose value is equivalent to this BigInt with the designated bit cleared.

def
clone(): AnyRef
Create a copy of the receiver object.

def
compare(that: BigInt): Int
Compares this BigInt with the specified BigInt

def
compareTo(that: BigInt): Int
Result of comparing
this
with operandthat
.Result of comparing
this
with operandthat
. Definition Classes
 Ordered → Comparable

def
doubleValue(): Double
Converts this
BigInt
to adouble
.Converts this
BigInt
to adouble
. if thisBigInt
has too great a magnitude to represent as a double, it will be converted toDouble.NEGATIVE_INFINITY
orDouble.POSITIVE_INFINITY
as appropriate. Definition Classes
 BigInt → ScalaNumericAnyConversions → Number

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

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

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

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

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 nonnull instances ofAnyRef
, and has three additional properties: It is consistent: for any nonnull instances
x
andy
of typeAnyRef
, multiple invocations ofx.eq(y)
consistently returnstrue
or consistently returnsfalse
.  For any nonnull instance
x
of typeAnyRef
,x.eq(null)
andnull.eq(x)
returnsfalse
. null.eq(null)
returnstrue
.
When overriding the
equals
orhashCode
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
 It is consistent: for any nonnull instances

def
equals(that: BigInt): Boolean
Compares this BigInt with the specified BigInt for equality.

def
equals(that: Any): Boolean
Compares this BigInt with the specified value for equality.

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 betweenfinalize
and nonlocal 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

def
flipBit(n: Int): BigInt
Returns a BigInt whose value is equivalent to this BigInt with the designated bit flipped.

def
floatValue(): Float
Converts this
BigInt
to afloat
.Converts this
BigInt
to afloat
. If thisBigInt
has too great a magnitude to represent as a float, it will be converted toFloat.NEGATIVE_INFINITY
orFloat.POSITIVE_INFINITY
as appropriate. Definition Classes
 BigInt → ScalaNumericAnyConversions → Number

def
gcd(that: BigInt): BigInt
Returns the greatest common divisor of abs(this) and abs(that)

final
def
getClass(): Class[_]
Returns the runtime class representation of the object.

def
hashCode(): Int
Returns the hash code for this BigInt.

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 loworder 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

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 returnfalse
, while the expressionList(1).isInstanceOf[List[String]]
will returntrue
. 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 typeT0
;false
otherwise.
 Definition Classes
 Any

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.

def
isValidByte: Boolean
Returns
true
iff this has a zero fractional part, and is within the range of scala.Byte MinValue and MaxValue; otherwise returnsfalse
.Returns
true
iff this has a zero fractional part, and is within the range of scala.Byte MinValue and MaxValue; otherwise returnsfalse
. Definition Classes
 BigInt → ScalaNumericAnyConversions

def
isValidChar: Boolean
Returns
true
iff this has a zero fractional part, and is within the range of scala.Char MinValue and MaxValue; otherwise returnsfalse
.Returns
true
iff this has a zero fractional part, and is within the range of scala.Char MinValue and MaxValue; otherwise returnsfalse
. Definition Classes
 BigInt → ScalaNumericAnyConversions

def
isValidDouble: Boolean
Returns
true
iff this can be represented exactly by scala.Double; otherwise returnsfalse
. 
def
isValidFloat: Boolean
Returns
true
iff this can be represented exactly by scala.Float; otherwise returnsfalse
. 
def
isValidInt: Boolean
Returns
true
iff this has a zero fractional part, and is within the range of scala.Int MinValue and MaxValue; otherwise returnsfalse
.Returns
true
iff this has a zero fractional part, and is within the range of scala.Int MinValue and MaxValue; otherwise returnsfalse
. Definition Classes
 BigInt → ScalaNumericAnyConversions
 def isValidLong: Boolean

def
isValidShort: Boolean
Returns
true
iff this has a zero fractional part, and is within the range of scala.Short MinValue and MaxValue; otherwise returnsfalse
.Returns
true
iff this has a zero fractional part, and is within the range of scala.Short MinValue and MaxValue; otherwise returnsfalse
. Definition Classes
 BigInt → ScalaNumericAnyConversions

def
isWhole(): Boolean
 returns
true
if this number has no decimal component,false
otherwise.
 Definition Classes
 BigInt → ScalaNumericAnyConversions → ScalaNumber

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 loworder 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

def
lowestSetBit: Int
Returns the index of the rightmost (lowestorder) one bit in this BigInt (the number of zero bits to the right of the rightmost one bit).

def
max(that: BigInt): BigInt
Returns the maximum of this and that

def
min(that: BigInt): BigInt
Returns the minimum of this and that

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 nonnegative BigInt. 
def
modInverse(m: BigInt): BigInt
Returns a BigInt whose value is (the inverse of this modulo m).

def
modPow(exp: BigInt, m: BigInt): BigInt
Returns a BigInt whose value is (this raised to the power of exp modulo m).

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

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

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

def
pow(exp: Int): BigInt
Returns a BigInt whose value is (this raised to the power of exp).

def
setBit(n: Int): BigInt
Returns a BigInt whose value is equivalent to this BigInt with the designated bit set.

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 loworder 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

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.

final
def
synchronized[T0](arg0: ⇒ T0): T0
 Definition Classes
 AnyRef

def
testBit(n: Int): Boolean
Returns true if and only if the designated bit is set.

def
to(end: BigInt, step: BigInt = BigInt(1)): Inclusive[scala.BigInt]
Like until, but inclusive of the end value.

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

def
toByteArray: Array[Byte]
Returns a byte array containing the two'scomplement representation of this BigInt.
Returns a byte array containing the two'scomplement representation of this BigInt. The byte array will be in bigendian byteorder: 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.

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

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

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

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

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

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

def
toString(radix: Int): String
Returns the String representation in the specified radix of this BigInt.

def
toString(): String
Returns the decimal String representation of this BigInt.

def
unary_: BigInt
Returns a BigInt whose value is the negation of this BigInt

def
unary_~: BigInt
Returns the bitwise complement of this BigInt

def
underlying(): BigInteger
 Definition Classes
 BigInt → ScalaNumericConversions → ScalaNumericAnyConversions → ScalaNumber

def
unifiedPrimitiveEquals(x: Any): Boolean
Should only be called after all known nonprimitive types have been excluded.
Should only be called after all known nonprimitive 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

def
unifiedPrimitiveHashcode(): Int
 Attributes
 protected
 Definition Classes
 ScalaNumericAnyConversions

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

final
def
wait(): Unit
 Definition Classes
 AnyRef
 Annotations
 @throws( ... )

final
def
wait(arg0: Long, arg1: Int): Unit
 Definition Classes
 AnyRef
 Annotations
 @throws( ... )
 final def wait(arg0: Long): Unit

def
(that: BigInt): BigInt
Bitwise or of BigInts

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

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

def
<(that: BigInt): Boolean
Returns true if
this
is less thanthat
Returns true if
this
is less thanthat
 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

def
<=(that: BigInt): Boolean
Returns true if
this
is less than or equal tothat
.Returns true if
this
is less than or equal tothat
. 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

def
>(that: BigInt): Boolean
Returns true if
this
is greater thanthat
.Returns true if
this
is greater thanthat
. 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

def
>=(that: BigInt): Boolean
Returns true if
this
is greater than or equal tothat
.Returns true if
this
is greater than or equal tothat
. 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

def
compare(that: BigInt): Int
Result of comparing
this
with operandthat
.Result of comparing
this
with operandthat
.Implement this method to determine how instances of A will be sorted.
Returns
x
where:x < 0
whenthis < that
x == 0
whenthis == that
x > 0
whenthis > 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

def
compareTo(that: BigInt): Int
Result of comparing
this
with operandthat
.Result of comparing
this
with operandthat
. 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

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 forString.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 ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
This is the documentation for the Scala standard library.
Package structure
The scala package contains core types like
Int
,Float
,Array
orOption
which are accessible in all Scala compilation units without explicit qualification or imports.Notable packages include:
scala.collection
and its subpackages contain Scala's collections frameworkscala.collection.immutable
 Immutable, sequential datastructures such asVector
,List
,Range
,HashMap
orHashSet
scala.collection.mutable
 Mutable, sequential datastructures such asArrayBuffer
,StringBuilder
,HashMap
orHashSet
scala.collection.concurrent
 Mutable, concurrent datastructures such asTrieMap
scala.collection.parallel.immutable
 Immutable, parallel datastructures such asParVector
,ParRange
,ParHashMap
orParHashSet
scala.collection.parallel.mutable
 Mutable, parallel datastructures such asParArray
,ParHashMap
,ParTrieMap
orParHashSet
scala.concurrent
 Primitives for concurrent programming such asFutures
andPromises
scala.io
 Input and output operationsscala.math
 Basic math functions and additional numeric types likeBigInt
andBigDecimal
scala.sys
 Interaction with other processes and the operating systemscala.util.matching
 Regular expressionsOther 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 (scalareflect.jar)scala.xml
 XML parsing, manipulation, and serialization (scalaxml.jar)scala.swing
 A convenient wrapper around Java's GUI framework called Swing (scalaswing.jar)scala.util.parsing
 Parser combinators (scalaparsercombinators.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 forscala.collection.immutable.List
.Other aliases refer to classes provided by the underlying platform. For example, on the JVM,
String
is an alias forjava.lang.String
.