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
-
def
%(that: BigInt): BigInt
Remainder of BigInts
-
def
&(that: BigInt): BigInt
Bitwise and of BigInts
-
def
&~(that: BigInt): BigInt
Bitwise and-not of BigInts.
Bitwise and-not 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
/(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
-
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 exclusive-or of BigInts
-
def
abs: BigInt
Returns the absolute value of this BigInt
- 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's-complement 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 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
-
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.
-
def
clearBit(n: Int): BigInt
Returns a BigInt whose value is equivalent to this BigInt with the designated bit cleared.
-
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
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
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)
-
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 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
-
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 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
-
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).
-
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 non-negative 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).
-
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 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
-
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.
-
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'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.
-
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
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
-
def
|(that: BigInt): BigInt
Bitwise or of BigInts
Shadowed Implicit Value Members
-
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
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 sub-packages contain Scala's collections frameworkscala.collection.immutable
- Immutable, sequential data-structures such asVector
,List
,Range
,HashMap
orHashSet
scala.collection.mutable
- Mutable, sequential data-structures such asArrayBuffer
,StringBuilder
,HashMap
orHashSet
scala.collection.concurrent
- Mutable, concurrent data-structures such asTrieMap
scala.collection.parallel.immutable
- Immutable, parallel data-structures such asParVector
,ParRange
,ParHashMap
orParHashSet
scala.collection.parallel.mutable
- Mutable, parallel data-structures 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 (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 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
.