scala.math

BigInt

class BigInt extends ScalaNumber with ScalaNumericConversions

go to: companion
linear super types: ScalaNumericConversions, ScalaNumber, Number, Serializable, AnyRef, Any
source: BigInt.scala
    version
  1. 1.0, 15/07/2003

Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. BigInt
  2. ScalaNumericConversions
  3. ScalaNumber
  4. Number
  5. Serializable
  6. AnyRef
  7. Any
Visibility
  1. Public
  2. All
Impl.
  1. Concrete
  2. Abstract

Instance constructors

  1. new BigInt (bigInteger: BigInteger)

Value Members

  1. def != (arg0: AnyRef) : Boolean

    attributes: final
    definition classes: AnyRef
  2. def != (arg0: Any) : Boolean

    o != arg0 is the same as !(o == (arg0)).

    o != arg0 is the same as !(o == (arg0)).

    arg0

    the object to compare against this object for dis-equality.

    returns

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

    attributes: final
    definition classes: Any
  3. def ## () : Int

    attributes: final
    definition classes: AnyRef → Any
  4. def $asInstanceOf [T0] () : T0

    attributes: final
    definition classes: AnyRef
  5. def $isInstanceOf [T0] () : Boolean

    attributes: final
    definition classes: AnyRef
  6. def % (that: BigInt) : BigInt

    Remainder of BigInts

    Remainder of BigInts

  7. def & (that: BigInt) : BigInt

    Bitwise and of BigInts

    Bitwise and of BigInts

  8. def &~ (that: BigInt) : BigInt

    Bitwise and-not of BigInts.

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

  9. def * (that: BigInt) : BigInt

    Multiplication of BigInts

    Multiplication of BigInts

  10. def + (that: BigInt) : BigInt

    Addition of BigInts

    Addition of BigInts

  11. def - (that: BigInt) : BigInt

    Subtraction of BigInts

    Subtraction of BigInts

  12. def / (that: BigInt) : BigInt

    Division of BigInts

    Division of BigInts

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

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

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

  14. def < (that: BigInt) : Boolean

    Less-than of BigInts

    Less-than of BigInts

  15. def << (n: Int) : BigInt

    Leftshift of BigInt

    Leftshift of BigInt

  16. def <= (that: BigInt) : Boolean

    Less-than-or-equals comparison of BigInts

    Less-than-or-equals comparison of BigInts

  17. def == (arg0: AnyRef) : Boolean

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    o == arg0 is the same as if (o eq null) arg0 eq null else o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

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

    attributes: final
    definition classes: AnyRef
  18. def == (arg0: Any) : Boolean

    o == arg0 is the same as o.equals(arg0).

    o == arg0 is the same as o.equals(arg0).

    arg0

    the object to compare against this object for equality.

    returns

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

    attributes: final
    definition classes: Any
  19. def > (that: BigInt) : Boolean

    Greater-than comparison of BigInts

    Greater-than comparison of BigInts

  20. def >= (that: BigInt) : Boolean

    Greater-than-or-equals comparison of BigInts

    Greater-than-or-equals comparison of BigInts

  21. def >> (n: Int) : BigInt

    (Signed) rightshift of BigInt

    (Signed) rightshift of BigInt

  22. def ^ (that: BigInt) : BigInt

    Bitwise exclusive-or of BigInts

    Bitwise exclusive-or of BigInts

  23. def abs : BigInt

    Returns the absolute value of this BigInt

    Returns the absolute value of this BigInt

  24. def asInstanceOf [T0] : T0

    This method is used to cast the receiver object to be of type T0.

    This method is used to 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 expression1.asInstanceOf[String] will throw a ClassCastException 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 typed.

    returns

    the receiver object.

    attributes: final
    definition classes: Any
  25. val bigInteger : BigInteger

  26. def bitCount : Int

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

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

  27. def bitLength : Int

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

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

  28. 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 → Number
  29. 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.

  30. def clearBit (n: Int) : BigInt

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

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

  31. def clone () : AnyRef

    This method creates and returns a copy of the receiver object.

    This method creates and returns 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
  32. def compare (that: BigInt) : Int

    Compares this BigInt with the specified BigInt

    Compares this BigInt with the specified BigInt

  33. 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 → Number
  34. def eq (arg0: AnyRef) : Boolean

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    This method is used to test whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an [http://en.wikipedia.org/wiki/Equivalence_relation equivalence relation] on non-null instances of AnyRef: * It is reflexive: for any non-null instance x of type AnyRef, x.eq(x) returns true. * It is symmetric: for any non-null instances x and y of type AnyRef, x.eq(y) returns true if and only if y.eq(x) returns true. * It is transitive: for any non-null instances x, y, and z of type AnyRef if x.eq(y) returns true and y.eq(z) returns true, then x.eq(z) returns true.

    Additionally, the eq method has three other 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).

    arg0

    the object to compare against this object for reference equality.

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    attributes: final
    definition classes: AnyRef
  35. def equals (that: BigInt) : Boolean

    Compares this BigInt with the specified BigInt for equality.

    Compares this BigInt with the specified BigInt for equality.

  36. def equals (that: Any) : Boolean

    Compares this BigInt with the specified value for equality.

    Compares this BigInt with the specified value for [email protected] true if the receiver object is equivalent to the argument; false otherwise. */

    definition classes: BigInt → AnyRef → Any
  37. def finalize () : Unit

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    This method is called by the garbage collector on the receiver object when garbage collection determines that there are no more references to the object.

    The details of when and if the finalize method are invoked, as well as the interaction between finalizeand non-local returns and exceptions, are all platform dependent.

    attributes: protected[lang]
    definition classes: AnyRef
  38. def flipBit (n: Int) : BigInt

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

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

  39. 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 → Number
  40. def gcd (that: BigInt) : BigInt

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

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

  41. def getClass () : java.lang.Class[_ <: java.lang.Object]

    Returns a representation that corresponds to the dynamic class of the receiver object.

    Returns a representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    attributes: final
    definition classes: AnyRef
  42. def hashCode () : Int

    Returns the hash code for this BigInt.

    Returns the hash code for this [email protected] the hash code value for the object. */

    definition classes: BigInt → AnyRef → Any
  43. def intValue () : Int

    Converts this BigInt to an int.

    Converts this BigInt to an int. If the BigInt is too big to fit in a char, 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 → Number
  44. def isInstanceOf [T0] : Boolean

    This method is used to test whether the dynamic type of the receiver object is T0.

    This method is used to test whether the dynamic type of the receiver object is T0.

    Note that the test result of the test is modulo Scala's erasure semantics. Therefore the expression1.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 requested typed.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    attributes: final
    definition classes: Any
  45. 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.

  46. def isValidByte : Boolean

    definition classes: ScalaNumericConversions
  47. def isValidChar : Boolean

    definition classes: ScalaNumericConversions
  48. def isValidInt : Boolean

    definition classes: ScalaNumericConversions
  49. def isValidShort : Boolean

    definition classes: ScalaNumericConversions
  50. def isWhole () : Boolean

    attributes: protected[math]
    definition classes: BigInt → ScalaNumber
  51. 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 char, 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 → Number
  52. 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).

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

  53. def max (that: BigInt) : BigInt

    Returns the maximum of this and that

    Returns the maximum of this and that

  54. def min (that: BigInt) : BigInt

    Returns the minimum of this and that

    Returns the minimum of this and that

  55. def mod (that: BigInt) : BigInt

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

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

  56. def modInverse (m: BigInt) : BigInt

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

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

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

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

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

  58. def ne (arg0: AnyRef) : Boolean

    o.ne(arg0) is the same as !(o.eq(arg0)).

    o.ne(arg0) is the same as !(o.eq(arg0)).

    arg0

    the object to compare against this object for reference dis-equality.

    returns

    false if the argument is not a reference to the receiver object; true otherwise.

    attributes: final
    definition classes: AnyRef
  59. 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.

    attributes: final
    definition classes: AnyRef
  60. 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.

    attributes: final
    definition classes: AnyRef
  61. def pow (exp: Int) : BigInt

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

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

  62. def setBit (n: Int) : BigInt

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

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

  63. 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 byte, 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 → Number
  64. def signum : Int

    Returns the sign of this BigInt, i.

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

  65. def synchronized [T0] (arg0: T0) : T0

    attributes: final
    definition classes: AnyRef
  66. def testBit (n: Int) : Boolean

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

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

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

    Like until, but inclusive of the end value.

    Like until, but inclusive of the end value.

  68. def toByte : Byte

    definition classes: ScalaNumericConversions
  69. 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.

  70. def toChar : Char

    definition classes: ScalaNumericConversions
  71. def toDouble : Double

    definition classes: ScalaNumericConversions
  72. def toFloat : Float

    definition classes: ScalaNumericConversions
  73. def toInt : Int

    definition classes: ScalaNumericConversions
  74. def toLong : Long

    definition classes: ScalaNumericConversions
  75. def toShort : Short

    definition classes: ScalaNumericConversions
  76. def toString (radix: Int) : String

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

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

  77. def toString () : String

    Returns the decimal String representation of this BigInt.

    Returns the decimal String representation of this [email protected] a string representation of the object. */

    definition classes: BigInt → AnyRef → Any
  78. def unary_- : BigInt

    Returns a BigInt whose value is the negation of this BigInt

    Returns a BigInt whose value is the negation of this BigInt

  79. def underlying () : BigInteger

    definition classes: BigInt → ScalaNumber
  80. 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: ScalaNumericConversions
  81. def unifiedPrimitiveHashcode () : Int

    attributes: protected
    definition classes: ScalaNumericConversions
  82. 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.

    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

  83. def wait () : Unit

    attributes: final
    definition classes: AnyRef
  84. def wait (arg0: Long, arg1: Int) : Unit

    attributes: final
    definition classes: AnyRef
  85. def wait (arg0: Long) : Unit

    attributes: final
    definition classes: AnyRef
  86. def | (that: BigInt) : BigInt

    Bitwise or of BigInts

    Bitwise or of BigInts

  87. def ~ : BigInt

    Returns the bitwise complement of this BigNum

    Returns the bitwise complement of this BigNum

Inherited from ScalaNumericConversions

Inherited from ScalaNumber

Inherited from Number

Inherited from Serializable

Inherited from AnyRef

Inherited from Any