W3cubDocs

/Scala 2.13 Library

Class 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], ScalaNumericConversions, ScalaNumericAnyConversions, ScalaNumber, Number, java.io.Serializable, AnyRef, Any

Instance Constructors

new BigInt(bigInteger: BigInteger)

Value Members

final def !=(arg0: Any): Boolean

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

def %(that: BigInt): BigInt

def &(that: BigInt): BigInt

def &~(that: BigInt): BigInt

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

def *(that: BigInt): BigInt

def +(that: BigInt): BigInt

def -(that: BigInt): BigInt

def ->[B](y: B): (BigInt, B)

Implicit
This member is added by an implicit conversion from BigInt toArrowAssoc[BigInt] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()

def /(that: BigInt): BigInt

def /%(that: BigInt): (BigInt, BigInt)

def <(that: BigInt): Boolean

Returns true if this is less than that

Definition Classes
Ordered

def <<(n: Int): BigInt

def <=(that: BigInt): Boolean

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

Definition Classes
Ordered

final def ==(arg0: Any): Boolean

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

def >(that: BigInt): Boolean

Returns true if this is greater than that.

Definition Classes
Ordered

def >=(that: BigInt): Boolean

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

Definition Classes
Ordered

def >>(n: Int): BigInt

def ^(that: BigInt): BigInt

def abs: BigInt

final def asInstanceOf[T0]: 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.

val bigInteger: BigInteger

def bitCount: Int

def bitLength: Int

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
BigIntScalaNumericAnyConversions → Number

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.

def clearBit(n: Int): BigInt

def clone(): AnyRef

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[java.lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
Note

not specified by SLS as a member of AnyRef

def compare(that: BigInt): Int

Compares this BigInt with the specified BigInt

Definition Classes
BigIntOrdered

def compareTo(that: BigInt): Int

Result of comparing this with operand that.

Definition Classes
Ordered → Comparable

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.

Definition Classes
BigIntScalaNumericAnyConversions → Number

def ensuring(cond: (BigInt) => Boolean, msg: => Any): BigInt

Implicit
This member is added by an implicit conversion from BigInt toEnsuring[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 toEnsuring[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 toEnsuring[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 toEnsuring[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).

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

def equals(that: BigInt): Boolean

def equals(that: Any): Boolean

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

def finalize(): Unit

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[java.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

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.

Definition Classes
BigIntScalaNumericAnyConversions → Number

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

def gcd(that: BigInt): BigInt

final def getClass(): Class[_ <: AnyRef]

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

def hashCode(): Int

Returns the hash code for this BigInt.

returns

the hash code value for this object.

Definition Classes
BigInt → AnyRef → Any

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.

Definition Classes
BigIntScalaNumericAnyConversions → Number

final def isInstanceOf[T0]: Boolean

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

def isProbablePrime(certainty: Int): Boolean

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 returns false.

Definition Classes
BigIntScalaNumericAnyConversions

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.

Definition Classes
BigIntScalaNumericAnyConversions

def isValidDouble: Boolean

def isValidFloat: Boolean

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.

Definition Classes
BigIntScalaNumericAnyConversions

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 returns false.

Definition Classes
BigIntScalaNumericAnyConversions

def isWhole: Boolean

returns

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

Definition Classes
BigIntScalaNumericAnyConversions → ScalaNumber

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.

Definition Classes
BigIntScalaNumericAnyConversions → Number

def lowestSetBit: Int

def max(that: BigInt): BigInt

def min(that: BigInt): BigInt

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.

def modInverse(m: BigInt): BigInt

def modPow(exp: BigInt, m: BigInt): BigInt

final def ne(arg0: AnyRef): Boolean

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.

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.

Definition Classes
AnyRef
Annotations
@native()
Note

not specified by SLS as a member of AnyRef

def pow(exp: Int): BigInt

def setBit(n: Int): BigInt

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
BigIntScalaNumericAnyConversions → Number

def sign: BigInt

def signum: Int

final def synchronized[T0](arg0: => T0): T0

Definition Classes
AnyRef

def testBit(n: Int): Boolean

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

def toByte: 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. 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. This may involve rounding or truncation.

Definition Classes
ScalaNumericAnyConversions

def toDouble: 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. This may involve rounding or truncation.

Definition Classes
ScalaNumericAnyConversions

def toInt: 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. This may involve rounding or truncation.

Definition Classes
ScalaNumericAnyConversions

def toShort: Short

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

Definition Classes
ScalaNumericAnyConversions

def toString(radix: Int): String

def toString(): String

Returns the decimal String representation of this BigInt.

returns

a String representation of the object.

Definition Classes
BigInt → AnyRef → Any

def unary_-: BigInt

def unary_~: BigInt

def underlying(): BigInteger

Definition Classes
BigIntScalaNumericConversions → ScalaNumber

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.

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.

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(classOf[java.lang.InterruptedException])

final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()

def |(that: BigInt): BigInt

Shadowed Implicit Value Members

def +(other: String): String

Implicit
This member is added by an implicit conversion from BigInt toany2stringadd[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 than that

Implicit
This member is added by an implicit conversion from BigInt toOrdered[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 to that.

Implicit
This member is added by an implicit conversion from BigInt toOrdered[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 that.

Implicit
This member is added by an implicit conversion from BigInt toOrdered[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 to that.

Implicit
This member is added by an implicit conversion from BigInt toOrdered[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 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 toOrdered[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 operand that.

Implicit
This member is added by an implicit conversion from BigInt toOrdered[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

© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.13.0/scala/math/BigInt.html