Scala 3/API/scala.math/BigInt

BigInt

final class BigInt(val bigInteger: BigInteger) extends ScalaNumber with ScalaNumericConversions with Serializable with Ordered[BigInt]
Companion
object
Source
(source)
class ScalaNumber
class Number
class Object
trait Matchable
class Any

Value members

Methods

override def hashCode(): Int
Returns the hash code for this BigInt.
Definition Classes
Any
Source
(source)
@nowarn("msg=comparing values .* is unsafe due to cooperative equality")
override def equals(that: Any): Boolean
Compares this BigInt with the specified value for equality.
Definition Classes
Any
Source
(source)
override def isValidByte: Boolean
Definition Classes
Source
(source)
override def isValidShort: Boolean
Definition Classes
Source
(source)
override def isValidChar: Boolean
Definition Classes
Source
(source)
override def isValidInt: Boolean
Definition Classes
Source
(source)
def isValidFloat: Boolean
Returns true iff this can be represented exactly by scala.Float; otherwise returns false.
Source
(source)
def isValidDouble: Boolean
Returns true iff this can be represented exactly by scala.Double; otherwise returns false.
Source
(source)
def equals(that: BigInt): Boolean
Compares this BigInt with the specified BigInt for equality.
Source
(source)
def compare(that: BigInt): Int
Compares this BigInt with the specified BigInt
Source
(source)
def +(that: BigInt): BigInt
Addition of BigInts
Source
(source)
def -(that: BigInt): BigInt
Subtraction of BigInts
Source
(source)
def *(that: BigInt): BigInt
Multiplication of BigInts
Source
(source)
def /(that: BigInt): BigInt
Division of BigInts
Source
(source)
def %(that: BigInt): BigInt
Remainder of BigInts
Source
(source)
def /%(that: BigInt): (BigInt, BigInt)
Returns a pair of two BigInts containing (this / that) and (this % that).
Source
(source)
def <<(n: Int): BigInt
Leftshift of BigInt
Source
(source)
def >>(n: Int): BigInt
(Signed) rightshift of BigInt
Source
(source)
def &(that: BigInt): BigInt
Bitwise and of BigInts
Source
(source)
def |(that: BigInt): BigInt
Bitwise or of BigInts
Source
(source)
def ^(that: BigInt): BigInt
Bitwise exclusive-or of BigInts
Source
(source)
def &~(that: BigInt): BigInt
Bitwise and-not of BigInts. Returns a BigInt whose value is (this & ~that).
Source
(source)
def gcd(that: BigInt): BigInt
Returns the greatest common divisor of abs(this) and abs(that)
Source
(source)
def mod(that: BigInt): BigInt
Returns a BigInt whose value is (this mod that). This method differs from % in that it always returns a non-negative BigInt.
Value Params
that
A positive number
Source
(source)
def min(that: BigInt): BigInt
Returns the minimum of this and that
Source
(source)
def max(that: BigInt): BigInt
Returns the maximum of this and that
Source
(source)
def pow(exp: Int): BigInt
Returns a BigInt whose value is (this raised to the power of exp).
Source
(source)
def modPow(exp: BigInt, m: BigInt): BigInt
Returns a BigInt whose value is (this raised to the power of exp modulo m).
Source
(source)
def modInverse(m: BigInt): BigInt
Returns a BigInt whose value is (the inverse of this modulo m).
Source
(source)
def unary_-: BigInt
Returns a BigInt whose value is the negation of this BigInt
Source
(source)
def abs: BigInt
Returns the absolute value of this BigInt
Source
(source)
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.
Source
(source)
def sign: BigInt
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.
Source
(source)
def unary_~: BigInt
Returns the bitwise complement of this BigInt
Source
(source)
def testBit(n: Int): Boolean
Returns true if and only if the designated bit is set.
Source
(source)
def setBit(n: Int): BigInt
Returns a BigInt whose value is equivalent to this BigInt with the designated bit set.
Source
(source)
def clearBit(n: Int): BigInt
Returns a BigInt whose value is equivalent to this BigInt with the designated bit cleared.
Source
(source)
def flipBit(n: Int): BigInt
Returns a BigInt whose value is equivalent to this BigInt with the designated bit flipped.
Source
(source)
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).
Source
(source)
def bitLength: Int
Returns the number of bits in the minimal two's-complement representation of this BigInt, excluding a sign bit.
Source
(source)
def bitCount: Int
Returns the number of bits in the two's complement representation of this BigInt that differ from its sign bit.
Source
(source)
def isProbablePrime(certainty: Int): Boolean
Returns true if this BigInt is probably prime, false if it's definitely composite.
Value Params
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.
Source
(source)
override def byteValue: 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
Source
(source)
override def shortValue: 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
Source
(source)
def charValue: 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.
Source
(source)
def intValue: 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.
Source
(source)
def longValue: 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.
Source
(source)
def floatValue: 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.
Source
(source)
def doubleValue: 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.
Source
(source)
def until(end: BigInt, step: BigInt): Exclusive[BigInt]
Create a NumericRange[BigInt] in range [start;end) with the specified step, where start is the target BigInt.
Value Params
end
the end value of the range (exclusive)
step
the distance between elements (defaults to 1)
Returns
the range
Source
(source)
def to(end: BigInt, step: BigInt): Inclusive[BigInt]
Like until, but inclusive of the end value.
Source
(source)
override def toString(): String
Returns the decimal String representation of this BigInt.
Definition Classes
Any
Source
(source)
def toString(radix: Int): String
Returns the String representation in the specified radix of this BigInt.
Source
(source)
def toByteArray: Array[Byte]
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.
Source
(source)

Fields

Inherited methods

def <(that: BigInt): Boolean
Returns true if this is less than that
Inhertied from
Ordered
Source
(source)
def toChar: Char
Returns the value of this as a scala.Char. This may involve rounding or truncation.
Inhertied from
ScalaNumericAnyConversions
Source
(source)
def toFloat: Float
Returns the value of this as a scala.Float. This may involve rounding or truncation.
Inhertied from
ScalaNumericAnyConversions
Source
(source)
def compareTo(that: BigInt): Int
Result of comparing this with operand that.
Inhertied from
Ordered
Source
(source)
def <=(that: BigInt): Boolean
Returns true if this is less than or equal to that.
Inhertied from
Ordered
Source
(source)
def >(that: BigInt): Boolean
Returns true if this is greater than that.
Inhertied from
Ordered
Source
(source)
def toInt: Int
Returns the value of this as an scala.Int. This may involve rounding or truncation.
Inhertied from
ScalaNumericAnyConversions
Source
(source)
def toByte: Byte
Returns the value of this as a scala.Byte. This may involve rounding or truncation.
Inhertied from
ScalaNumericAnyConversions
Source
(source)
def toDouble: Double
Returns the value of this as a scala.Double. This may involve rounding or truncation.
Inhertied from
ScalaNumericAnyConversions
Source
(source)
def toLong: Long
Returns the value of this as a scala.Long. This may involve rounding or truncation.
Inhertied from
ScalaNumericAnyConversions
Source
(source)
protected def unifiedPrimitiveEquals(x: Any): Boolean
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.
Inhertied from
ScalaNumericAnyConversions
Source
(source)
def >=(that: BigInt): Boolean
Returns true if this is greater than or equal to that.
Inhertied from
Ordered
Source
(source)
def toShort: Short
Returns the value of this as a scala.Short. This may involve rounding or truncation.
Inhertied from
ScalaNumericAnyConversions
Source
(source)