java.math
Class BigInteger

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by java.lang.Number sample code for java.lang.Number definition code for java.lang.Number 
      extended by java.math.BigInteger
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable , Comparable sample code for java.lang.Comparable definition code for java.lang.Comparable <BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger >

public class BigInteger
extends Number sample code for java.lang.Number definition code for java.lang.Number
implements Comparable sample code for java.lang.Comparable definition code for java.lang.Comparable <BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger >

Immutable arbitrary-precision integers. All operations behave as if BigIntegers were represented in two's-complement notation (like Java's primitive integer types). BigInteger provides analogues to all of Java's primitive integer operators, and all relevant methods from java.lang.Math. Additionally, BigInteger provides operations for modular arithmetic, GCD calculation, primality testing, prime generation, bit manipulation, and a few other miscellaneous operations.

Semantics of arithmetic operations exactly mimic those of Java's integer arithmetic operators, as defined in The Java Language Specification. For example, division by zero throws an ArithmeticException, and division of a negative by a positive yields a negative (or zero) remainder. All of the details in the Spec concerning overflow are ignored, as BigIntegers are made as large as necessary to accommodate the results of an operation.

Semantics of shift operations extend those of Java's shift operators to allow for negative shift distances. A right-shift with a negative shift distance results in a left shift, and vice-versa. The unsigned right shift operator (>>>) is omitted, as this operation makes little sense in combination with the "infinite word size" abstraction provided by this class.

Semantics of bitwise logical operations exactly mimic those of Java's bitwise integer operators. The binary operators (and, or, xor) implicitly perform sign extension on the shorter of the two operands prior to performing the operation.

Comparison operations perform signed integer comparisons, analogous to those performed by Java's relational and equality operators.

Modular arithmetic operations are provided to compute residues, perform exponentiation, and compute multiplicative inverses. These methods always return a non-negative result, between 0 and (modulus - 1), inclusive.

Bit operations operate on a single bit of the two's-complement representation of their operand. If necessary, the operand is sign- extended so that it contains the designated bit. None of the single-bit operations can produce a BigInteger with a different sign from the BigInteger being operated on, as they affect only a single bit, and the "infinite word size" abstraction provided by this class ensures that there are infinitely many "virtual sign bits" preceding each BigInteger.

For the sake of brevity and clarity, pseudo-code is used throughout the descriptions of BigInteger methods. The pseudo-code expression (i + j) is shorthand for "a BigInteger whose value is that of the BigInteger i plus that of the BigInteger j." The pseudo-code expression (i == j) is shorthand for "true if and only if the BigInteger i represents the same value as the BigInteger j." Other pseudo-code expressions are interpreted similarly.

All methods and constructors in this class throw NullPointerException when passed a null object reference for any input parameter.

Since:
JDK1.1
See Also:
BigDecimal sample code for java.math.BigDecimal definition code for java.math.BigDecimal , Serialized Form

Field Summary
static BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger ONE sample code for java.math.BigInteger.ONE definition code for java.math.BigInteger.ONE
          The BigInteger constant one.
static BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger TEN sample code for java.math.BigInteger.TEN definition code for java.math.BigInteger.TEN
          The BigInteger constant ten.
static BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger ZERO sample code for java.math.BigInteger.ZERO definition code for java.math.BigInteger.ZERO
          The BigInteger constant zero.
 
Constructor Summary
BigInteger sample code for java.math.BigInteger.BigInteger(byte[]) definition code for java.math.BigInteger.BigInteger(byte[]) (byte[] val)
          Translates a byte array containing the two's-complement binary representation of a BigInteger into a BigInteger.
BigInteger sample code for java.math.BigInteger.BigInteger(int, byte[]) definition code for java.math.BigInteger.BigInteger(int, byte[]) (int signum, byte[] magnitude)
          Translates the sign-magnitude representation of a BigInteger into a BigInteger.
BigInteger sample code for java.math.BigInteger.BigInteger(int, int, java.util.Random) definition code for java.math.BigInteger.BigInteger(int, int, java.util.Random) (int bitLength, int certainty, Random sample code for java.util.Random definition code for java.util.Random  rnd)
          Constructs a randomly generated positive BigInteger that is probably prime, with the specified bitLength.
BigInteger sample code for java.math.BigInteger.BigInteger(int, java.util.Random) definition code for java.math.BigInteger.BigInteger(int, java.util.Random) (int numBits, Random sample code for java.util.Random definition code for java.util.Random  rnd)
          Constructs a randomly generated BigInteger, uniformly distributed over the range 0 to (2numBits - 1), inclusive.
BigInteger sample code for java.math.BigInteger.BigInteger(java.lang.String) definition code for java.math.BigInteger.BigInteger(java.lang.String) (String sample code for java.lang.String definition code for java.lang.String  val)
          Translates the decimal String representation of a BigInteger into a BigInteger.
BigInteger sample code for java.math.BigInteger.BigInteger(java.lang.String, int) definition code for java.math.BigInteger.BigInteger(java.lang.String, int) (String sample code for java.lang.String definition code for java.lang.String  val, int radix)
          Translates the String representation of a BigInteger in the specified radix into a BigInteger.
 
Method Summary
 BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger abs sample code for java.math.BigInteger.abs() definition code for java.math.BigInteger.abs() ()
          Returns a BigInteger whose value is the absolute value of this BigInteger.
 BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger add sample code for java.math.BigInteger.add(java.math.BigInteger) definition code for java.math.BigInteger.add(java.math.BigInteger) (BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  val)
          Returns a BigInteger whose value is (this + val).
 BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger and sample code for java.math.BigInteger.and(java.math.BigInteger) definition code for java.math.BigInteger.and(java.math.BigInteger) (BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  val)
          Returns a BigInteger whose value is (this & val).
 BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger andNot sample code for java.math.BigInteger.andNot(java.math.BigInteger) definition code for java.math.BigInteger.andNot(java.math.BigInteger) (BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  val)
          Returns a BigInteger whose value is (this & ~val).
 int bitCount sample code for java.math.BigInteger.bitCount() definition code for java.math.BigInteger.bitCount() ()
          Returns the number of bits in the two's complement representation of this BigInteger that differ from its sign bit.
 int bitLength sample code for java.math.BigInteger.bitLength() definition code for java.math.BigInteger.bitLength() ()
          Returns the number of bits in the minimal two's-complement representation of this BigInteger, excluding a sign bit.
 BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger clearBit sample code for java.math.BigInteger.clearBit(int) definition code for java.math.BigInteger.clearBit(int) (int n)
          Returns a BigInteger whose value is equivalent to this BigInteger with the designated bit cleared.
 int compareTo sample code for java.math.BigInteger.compareTo(java.math.BigInteger) definition code for java.math.BigInteger.compareTo(java.math.BigInteger) (BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  val)
          Compares this BigInteger with the specified BigInteger.
 BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger divide sample code for java.math.BigInteger.divide(java.math.BigInteger) definition code for java.math.BigInteger.divide(java.math.BigInteger) (BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  val)
          Returns a BigInteger whose value is (this / val).
 BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger [] divideAndRemainder sample code for java.math.BigInteger.divideAndRemainder(java.math.BigInteger) definition code for java.math.BigInteger.divideAndRemainder(java.math.BigInteger) (BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  val)
          Returns an array of two BigIntegers containing (this / val) followed by (this % val).
 double doubleValue sample code for java.math.BigInteger.doubleValue() definition code for java.math.BigInteger.doubleValue() ()
          Converts this BigInteger to a double.
 boolean equals sample code for java.math.BigInteger.equals(java.lang.Object) definition code for java.math.BigInteger.equals(java.lang.Object) (Object sample code for java.lang.Object definition code for java.lang.Object  x)
          Compares this BigInteger with the specified Object for equality.
 BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger flipBit sample code for java.math.BigInteger.flipBit(int) definition code for java.math.BigInteger.flipBit(int) (int n)
          Returns a BigInteger whose value is equivalent to this BigInteger with the designated bit flipped.
 float floatValue sample code for java.math.BigInteger.floatValue() definition code for java.math.BigInteger.floatValue() ()
          Converts this BigInteger to a float.
 BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger gcd sample code for java.math.BigInteger.gcd(java.math.BigInteger) definition code for java.math.BigInteger.gcd(java.math.BigInteger) (BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  val)
          Returns a BigInteger whose value is the greatest common divisor of abs(this) and abs(val).
 int getLowestSetBit sample code for java.math.BigInteger.getLowestSetBit() definition code for java.math.BigInteger.getLowestSetBit() ()
          Returns the index of the rightmost (lowest-order) one bit in this BigInteger (the number of zero bits to the right of the rightmost one bit).
 int hashCode sample code for java.math.BigInteger.hashCode() definition code for java.math.BigInteger.hashCode() ()
          Returns the hash code for this BigInteger.
 int intValue sample code for java.math.BigInteger.intValue() definition code for java.math.BigInteger.intValue() ()
          Converts this BigInteger to an int.
 boolean isProbablePrime sample code for java.math.BigInteger.isProbablePrime(int) definition code for java.math.BigInteger.isProbablePrime(int) (int certainty)
          Returns true if this BigInteger is probably prime, false if it's definitely composite.
 long longValue sample code for java.math.BigInteger.longValue() definition code for java.math.BigInteger.longValue() ()
          Converts this BigInteger to a long.
 BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger max sample code for java.math.BigInteger.max(java.math.BigInteger) definition code for java.math.BigInteger.max(java.math.BigInteger) (BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  val)
          Returns the maximum of this BigInteger and val.
 BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger min sample code for java.math.BigInteger.min(java.math.BigInteger) definition code for java.math.BigInteger.min(java.math.BigInteger) (BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  val)
          Returns the minimum of this BigInteger and val.
 BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger mod sample code for java.math.BigInteger.mod(java.math.BigInteger) definition code for java.math.BigInteger.mod(java.math.BigInteger) (BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  m)
          Returns a BigInteger whose value is (this mod m).
 BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger modInverse sample code for java.math.BigInteger.modInverse(java.math.BigInteger) definition code for java.math.BigInteger.modInverse(java.math.BigInteger) (BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  m)
          Returns a BigInteger whose value is (this-1 mod m).
 BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger modPow sample code for java.math.BigInteger.modPow(java.math.BigInteger, java.math.BigInteger) definition code for java.math.BigInteger.modPow(java.math.BigInteger, java.math.BigInteger) (BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  exponent, BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  m)
          Returns a BigInteger whose value is (thisexponent mod m).
 BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger multiply sample code for java.math.BigInteger.multiply(java.math.BigInteger) definition code for java.math.BigInteger.multiply(java.math.BigInteger) (BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  val)
          Returns a BigInteger whose value is (this * val).
 BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger negate sample code for java.math.BigInteger.negate() definition code for java.math.BigInteger.negate() ()
          Returns a BigInteger whose value is (-this).
 BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger nextProbablePrime sample code for java.math.BigInteger.nextProbablePrime() definition code for java.math.BigInteger.nextProbablePrime() ()
          Returns the first integer greater than this BigInteger that is probably prime.
 BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger not sample code for java.math.BigInteger.not() definition code for java.math.BigInteger.not() ()
          Returns a BigInteger whose value is (~this).
 BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger or sample code for java.math.BigInteger.or(java.math.BigInteger) definition code for java.math.BigInteger.or(java.math.BigInteger) (BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  val)
          Returns a BigInteger whose value is (this | val).
 BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger pow sample code for java.math.BigInteger.pow(int) definition code for java.math.BigInteger.pow(int) (int exponent)
          Returns a BigInteger whose value is (thisexponent).
static BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger probablePrime sample code for java.math.BigInteger.probablePrime(int, java.util.Random) definition code for java.math.BigInteger.probablePrime(int, java.util.Random) (int bitLength, Random sample code for java.util.Random definition code for java.util.Random  rnd)
          Returns a positive BigInteger that is probably prime, with the specified bitLength.
 BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger remainder sample code for java.math.BigInteger.remainder(java.math.BigInteger) definition code for java.math.BigInteger.remainder(java.math.BigInteger) (BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  val)
          Returns a BigInteger whose value is (this % val).
 BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger setBit sample code for java.math.BigInteger.setBit(int) definition code for java.math.BigInteger.setBit(int) (int n)
          Returns a BigInteger whose value is equivalent to this BigInteger with the designated bit set.
 BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger shiftLeft sample code for java.math.BigInteger.shiftLeft(int) definition code for java.math.BigInteger.shiftLeft(int) (int n)
          Returns a BigInteger whose value is (this << n).
 BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger shiftRight sample code for java.math.BigInteger.shiftRight(int) definition code for java.math.BigInteger.shiftRight(int) (int n)
          Returns a BigInteger whose value is (this >> n).
 int signum sample code for java.math.BigInteger.signum() definition code for java.math.BigInteger.signum() ()
          Returns the signum function of this BigInteger.
 BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger subtract sample code for java.math.BigInteger.subtract(java.math.BigInteger) definition code for java.math.BigInteger.subtract(java.math.BigInteger) (BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  val)
          Returns a BigInteger whose value is (this - val).
 boolean testBit sample code for java.math.BigInteger.testBit(int) definition code for java.math.BigInteger.testBit(int) (int n)
          Returns true if and only if the designated bit is set.
 byte[] toByteArray sample code for java.math.BigInteger.toByteArray() definition code for java.math.BigInteger.toByteArray() ()
          Returns a byte array containing the two's-complement representation of this BigInteger.
 String sample code for java.lang.String definition code for java.lang.String toString sample code for java.math.BigInteger.toString() definition code for java.math.BigInteger.toString() ()
          Returns the decimal String representation of this BigInteger.
 String sample code for java.lang.String definition code for java.lang.String toString sample code for java.math.BigInteger.toString(int) definition code for java.math.BigInteger.toString(int) (int radix)
          Returns the String representation of this BigInteger in the given radix.
static BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger valueOf sample code for java.math.BigInteger.valueOf(long) definition code for java.math.BigInteger.valueOf(long) (long val)
          Returns a BigInteger whose value is equal to that of the specified long.
 BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger xor sample code for java.math.BigInteger.xor(java.math.BigInteger) definition code for java.math.BigInteger.xor(java.math.BigInteger) (BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  val)
          Returns a BigInteger whose value is (this ^ val).
 
Methods inherited from class java.lang.Number sample code for java.lang.Number definition code for java.lang.Number
byteValue sample code for java.lang.Number.byteValue() definition code for java.lang.Number.byteValue() , shortValue sample code for java.lang.Number.shortValue() definition code for java.lang.Number.shortValue()
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Field Detail

ZERO sample code for java.math.BigInteger.ZERO

public static final BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  ZERO
The BigInteger constant zero.

Since:
1.2

ONE sample code for java.math.BigInteger.ONE

public static final BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  ONE
The BigInteger constant one.

Since:
1.2

TEN sample code for java.math.BigInteger.TEN

public static final BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  TEN
The BigInteger constant ten.

Since:
1.5
Constructor Detail

BigInteger sample code for java.math.BigInteger(byte[]) definition code for java.math.BigInteger(byte[])

public BigInteger(byte[] val)
Translates a byte array containing the two's-complement binary representation of a BigInteger into a BigInteger. The input array is assumed to be in big-endian byte-order: the most significant byte is in the zeroth element.

Parameters:
val - big-endian two's-complement binary representation of BigInteger.
Throws:
NumberFormatException sample code for java.lang.NumberFormatException definition code for java.lang.NumberFormatException - val is zero bytes long.

BigInteger sample code for java.math.BigInteger(int, byte[]) definition code for java.math.BigInteger(int, byte[])

public BigInteger(int signum,
                  byte[] magnitude)
Translates the sign-magnitude representation of a BigInteger into a BigInteger. The sign is represented as an integer signum value: -1 for negative, 0 for zero, or 1 for positive. The magnitude is a byte array in big-endian byte-order: the most significant byte is in the zeroth element. A zero-length magnitude array is permissible, and will result inin a BigInteger value of 0, whether signum is -1, 0 or 1.

Parameters:
signum - signum of the number (-1 for negative, 0 for zero, 1 for positive).
magnitude - big-endian binary representation of the magnitude of the number.
Throws:
NumberFormatException sample code for java.lang.NumberFormatException definition code for java.lang.NumberFormatException - signum is not one of the three legal values (-1, 0, and 1), or signum is 0 and magnitude contains one or more non-zero bytes.

BigInteger sample code for java.math.BigInteger(java.lang.String, int) definition code for java.math.BigInteger(java.lang.String, int)

public BigInteger(String sample code for java.lang.String definition code for java.lang.String  val,
                  int radix)
Translates the String representation of a BigInteger in the specified radix into a BigInteger. The String representation consists of an optional minus sign followed by a sequence of one or more digits in the specified radix. The character-to-digit mapping is provided by Character.digit. The String may not contain any extraneous characters (whitespace, for example).

Parameters:
val - String representation of BigInteger.
radix - radix to be used in interpreting val.
Throws:
NumberFormatException sample code for java.lang.NumberFormatException definition code for java.lang.NumberFormatException - val is not a valid representation of a BigInteger in the specified radix, or radix is outside the range from Character.MIN_RADIX sample code for java.lang.Character.MIN_RADIX definition code for java.lang.Character.MIN_RADIX to Character.MAX_RADIX sample code for java.lang.Character.MAX_RADIX definition code for java.lang.Character.MAX_RADIX , inclusive.
See Also:
Character.digit(char, int) sample code for java.lang.Character.digit(char, int) definition code for java.lang.Character.digit(char, int)

BigInteger sample code for java.math.BigInteger(java.lang.String) definition code for java.math.BigInteger(java.lang.String)

public BigInteger(String sample code for java.lang.String definition code for java.lang.String  val)
Translates the decimal String representation of a BigInteger into a BigInteger. The String representation consists of an optional minus sign followed by a sequence of one or more decimal digits. The character-to-digit mapping is provided by Character.digit. The String may not contain any extraneous characters (whitespace, for example).

Parameters:
val - decimal String representation of BigInteger.
Throws:
NumberFormatException sample code for java.lang.NumberFormatException definition code for java.lang.NumberFormatException - val is not a valid representation of a BigInteger.
See Also:
Character.digit(char, int) sample code for java.lang.Character.digit(char, int) definition code for java.lang.Character.digit(char, int)

BigInteger sample code for java.math.BigInteger(int, java.util.Random) definition code for java.math.BigInteger(int, java.util.Random)

public BigInteger(int numBits,
                  Random sample code for java.util.Random definition code for java.util.Random  rnd)
Constructs a randomly generated BigInteger, uniformly distributed over the range 0 to (2numBits - 1), inclusive. The uniformity of the distribution assumes that a fair source of random bits is provided in rnd. Note that this constructor always constructs a non-negative BigInteger.

Parameters:
numBits - maximum bitLength of the new BigInteger.
rnd - source of randomness to be used in computing the new BigInteger.
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - numBits is negative.
See Also:
bitLength sample code for java.math.BigInteger.bitLength definition code for java.math.BigInteger.bitLength

BigInteger sample code for java.math.BigInteger(int, int, java.util.Random) definition code for java.math.BigInteger(int, int, java.util.Random)

public BigInteger(int bitLength,
                  int certainty,
                  Random sample code for java.util.Random definition code for java.util.Random  rnd)
Constructs a randomly generated positive BigInteger that is probably prime, with the specified bitLength.

It is recommended that the probablePrime sample code for java.math.BigInteger.probablePrime(int, java.util.Random) definition code for java.math.BigInteger.probablePrime(int, java.util.Random) method be used in preference to this constructor unless there is a compelling need to specify a certainty.

Parameters:
bitLength - bitLength of the returned BigInteger.
certainty - a measure of the uncertainty that the caller is willing to tolerate. The probability that the new BigInteger represents a prime number will exceed (1 - 1/2certainty). The execution time of this constructor is proportional to the value of this parameter.
rnd - source of random bits used to select candidates to be tested for primality.
Throws:
ArithmeticException sample code for java.lang.ArithmeticException definition code for java.lang.ArithmeticException - bitLength < 2.
See Also:
bitLength sample code for java.math.BigInteger.bitLength definition code for java.math.BigInteger.bitLength
Method Detail

probablePrime sample code for java.math.BigInteger.probablePrime(int, java.util.Random) definition code for java.math.BigInteger.probablePrime(int, java.util.Random)

public static BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  probablePrime(int bitLength,
                                       Random sample code for java.util.Random definition code for java.util.Random  rnd)
Returns a positive BigInteger that is probably prime, with the specified bitLength. The probability that a BigInteger returned by this method is composite does not exceed 2-100.

Parameters:
bitLength - bitLength of the returned BigInteger.
rnd - source of random bits used to select candidates to be tested for primality.
Returns:
a BigInteger of bitLength bits that is probably prime
Throws:
ArithmeticException sample code for java.lang.ArithmeticException definition code for java.lang.ArithmeticException - bitLength < 2.
See Also:
bitLength sample code for java.math.BigInteger.bitLength definition code for java.math.BigInteger.bitLength

nextProbablePrime sample code for java.math.BigInteger.nextProbablePrime() definition code for java.math.BigInteger.nextProbablePrime()

public BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  nextProbablePrime()
Returns the first integer greater than this BigInteger that is probably prime. The probability that the number returned by this method is composite does not exceed 2-100. This method will never skip over a prime when searching: if it returns p, there is no prime q such that this < q < p.

Returns:
the first integer greater than this BigInteger that is probably prime.
Throws:
ArithmeticException sample code for java.lang.ArithmeticException definition code for java.lang.ArithmeticException - this < 0.
Since:
1.5

valueOf sample code for java.math.BigInteger.valueOf(long) definition code for java.math.BigInteger.valueOf(long)

public static BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  valueOf(long val)
Returns a BigInteger whose value is equal to that of the specified long. This "static factory method" is provided in preference to a (long) constructor because it allows for reuse of frequently used BigIntegers.

Parameters:
val - value of the BigInteger to return.
Returns:
a BigInteger with the specified value.

add sample code for java.math.BigInteger.add(java.math.BigInteger) definition code for java.math.BigInteger.add(java.math.BigInteger)

public BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  add(BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  val)
Returns a BigInteger whose value is (this + val).

Parameters:
val - value to be added to this BigInteger.
Returns:
this + val

subtract sample code for java.math.BigInteger.subtract(java.math.BigInteger) definition code for java.math.BigInteger.subtract(java.math.BigInteger)

public BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  subtract(BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  val)
Returns a BigInteger whose value is (this - val).

Parameters:
val - value to be subtracted from this BigInteger.
Returns:
this - val

multiply sample code for java.math.BigInteger.multiply(java.math.BigInteger) definition code for java.math.BigInteger.multiply(java.math.BigInteger)

public BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  multiply(BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  val)
Returns a BigInteger whose value is (this * val).

Parameters:
val - value to be multiplied by this BigInteger.
Returns:
this * val

divide sample code for java.math.BigInteger.divide(java.math.BigInteger) definition code for java.math.BigInteger.divide(java.math.BigInteger)

public BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  divide(BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  val)
Returns a BigInteger whose value is (this / val).

Parameters:
val - value by which this BigInteger is to be divided.
Returns:
this / val
Throws:
ArithmeticException sample code for java.lang.ArithmeticException definition code for java.lang.ArithmeticException - val==0

divideAndRemainder sample code for java.math.BigInteger.divideAndRemainder(java.math.BigInteger) definition code for java.math.BigInteger.divideAndRemainder(java.math.BigInteger)

public BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger [] divideAndRemainder(BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  val)
Returns an array of two BigIntegers containing (this / val) followed by (this % val).

Parameters:
val - value by which this BigInteger is to be divided, and the remainder computed.
Returns:
an array of two BigIntegers: the quotient (this / val) is the initial element, and the remainder (this % val) is the final element.
Throws:
ArithmeticException sample code for java.lang.ArithmeticException definition code for java.lang.ArithmeticException - val==0

remainder sample code for java.math.BigInteger.remainder(java.math.BigInteger) definition code for java.math.BigInteger.remainder(java.math.BigInteger)

public BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  remainder(BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  val)
Returns a BigInteger whose value is (this % val).

Parameters:
val - value by which this BigInteger is to be divided, and the remainder computed.
Returns:
this % val
Throws:
ArithmeticException sample code for java.lang.ArithmeticException definition code for java.lang.ArithmeticException - val==0

pow sample code for java.math.BigInteger.pow(int) definition code for java.math.BigInteger.pow(int)

public BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  pow(int exponent)
Returns a BigInteger whose value is (thisexponent). Note that exponent is an integer rather than a BigInteger.

Parameters:
exponent - exponent to which this BigInteger is to be raised.
Returns:
thisexponent
Throws:
ArithmeticException sample code for java.lang.ArithmeticException definition code for java.lang.ArithmeticException - exponent is negative. (This would cause the operation to yield a non-integer value.)

gcd sample code for java.math.BigInteger.gcd(java.math.BigInteger) definition code for java.math.BigInteger.gcd(java.math.BigInteger)

public BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  gcd(BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  val)
Returns a BigInteger whose value is the greatest common divisor of abs(this) and abs(val). Returns 0 if this==0 && val==0.

Parameters:
val - value with which the GCD is to be computed.
Returns:
GCD(abs(this), abs(val))

abs sample code for java.math.BigInteger.abs() definition code for java.math.BigInteger.abs()

public BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  abs()
Returns a BigInteger whose value is the absolute value of this BigInteger.

Returns:
abs(this)

negate sample code for java.math.BigInteger.negate() definition code for java.math.BigInteger.negate()

public BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  negate()
Returns a BigInteger whose value is (-this).

Returns:
-this

signum sample code for java.math.BigInteger.signum() definition code for java.math.BigInteger.signum()

public int signum()
Returns the signum function of this BigInteger.

Returns:
-1, 0 or 1 as the value of this BigInteger is negative, zero or positive.

mod sample code for java.math.BigInteger.mod(java.math.BigInteger) definition code for java.math.BigInteger.mod(java.math.BigInteger)

public BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  mod(BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  m)
Returns a BigInteger whose value is (this mod m). This method differs from remainder in that it always returns a non-negative BigInteger.

Parameters:
m - the modulus.
Returns:
this mod m
Throws:
ArithmeticException sample code for java.lang.ArithmeticException definition code for java.lang.ArithmeticException - m <= 0
See Also:
remainder(java.math.BigInteger) sample code for java.math.BigInteger.remainder(java.math.BigInteger) definition code for java.math.BigInteger.remainder(java.math.BigInteger)

modPow sample code for java.math.BigInteger.modPow(java.math.BigInteger, java.math.BigInteger) definition code for java.math.BigInteger.modPow(java.math.BigInteger, java.math.BigInteger)

public BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  modPow(BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  exponent,
                         BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  m)
Returns a BigInteger whose value is (thisexponent mod m). (Unlike pow, this method permits negative exponents.)

Parameters:
exponent - the exponent.
m - the modulus.
Returns:
thisexponent mod m
Throws:
ArithmeticException sample code for java.lang.ArithmeticException definition code for java.lang.ArithmeticException - m <= 0
See Also:
modInverse(java.math.BigInteger) sample code for java.math.BigInteger.modInverse(java.math.BigInteger) definition code for java.math.BigInteger.modInverse(java.math.BigInteger)

modInverse sample code for java.math.BigInteger.modInverse(java.math.BigInteger) definition code for java.math.BigInteger.modInverse(java.math.BigInteger)

public BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  modInverse(BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  m)
Returns a BigInteger whose value is (this-1 mod m).

Parameters:
m - the modulus.
Returns:
this-1 mod m.
Throws:
ArithmeticException sample code for java.lang.ArithmeticException definition code for java.lang.ArithmeticException - m <= 0, or this BigInteger has no multiplicative inverse mod m (that is, this BigInteger is not relatively prime to m).

shiftLeft sample code for java.math.BigInteger.shiftLeft(int) definition code for java.math.BigInteger.shiftLeft(int)

public BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  shiftLeft(int n)
Returns a BigInteger whose value is (this << n). The shift distance, n, may be negative, in which case this method performs a right shift. (Computes floor(this * 2n).)

Parameters:
n - shift distance, in bits.
Returns:
this << n
See Also:
shiftRight(int) sample code for java.math.BigInteger.shiftRight(int) definition code for java.math.BigInteger.shiftRight(int)

shiftRight sample code for java.math.BigInteger.shiftRight(int) definition code for java.math.BigInteger.shiftRight(int)

public BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  shiftRight(int n)
Returns a BigInteger whose value is (this >> n). Sign extension is performed. The shift distance, n, may be negative, in which case this method performs a left shift. (Computes floor(this / 2n).)

Parameters:
n - shift distance, in bits.
Returns:
this >> n
See Also:
shiftLeft(int) sample code for java.math.BigInteger.shiftLeft(int) definition code for java.math.BigInteger.shiftLeft(int)

and sample code for java.math.BigInteger.and(java.math.BigInteger) definition code for java.math.BigInteger.and(java.math.BigInteger)

public BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  and(BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  val)
Returns a BigInteger whose value is (this & val). (This method returns a negative BigInteger if and only if this and val are both negative.)

Parameters:
val - value to be AND'ed with this BigInteger.
Returns:
this & val

or sample code for java.math.BigInteger.or(java.math.BigInteger) definition code for java.math.BigInteger.or(java.math.BigInteger)

public BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  or(BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  val)
Returns a BigInteger whose value is (this | val). (This method returns a negative BigInteger if and only if either this or val is negative.)

Parameters:
val - value to be OR'ed with this BigInteger.
Returns:
this | val

xor sample code for java.math.BigInteger.xor(java.math.BigInteger) definition code for java.math.BigInteger.xor(java.math.BigInteger)

public BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  xor(BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  val)
Returns a BigInteger whose value is (this ^ val). (This method returns a negative BigInteger if and only if exactly one of this and val are negative.)

Parameters:
val - value to be XOR'ed with this BigInteger.
Returns:
this ^ val

not sample code for java.math.BigInteger.not() definition code for java.math.BigInteger.not()

public BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  not()
Returns a BigInteger whose value is (~this). (This method returns a negative value if and only if this BigInteger is non-negative.)

Returns:
~this

andNot sample code for java.math.BigInteger.andNot(java.math.BigInteger) definition code for java.math.BigInteger.andNot(java.math.BigInteger)

public BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  andNot(BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  val)
Returns a BigInteger whose value is (this & ~val). This method, which is equivalent to and(val.not()), is provided as a convenience for masking operations. (This method returns a negative BigInteger if and only if this is negative and val is positive.)

Parameters:
val - value to be complemented and AND'ed with this BigInteger.
Returns:
this & ~val

testBit sample code for java.math.BigInteger.testBit(int) definition code for java.math.BigInteger.testBit(int)

public boolean testBit(int n)
Returns true if and only if the designated bit is set. (Computes ((this & (1<<n)) != 0).)

Parameters:
n - index of bit to test.
Returns:
true if and only if the designated bit is set.
Throws:
ArithmeticException sample code for java.lang.ArithmeticException definition code for java.lang.ArithmeticException - n is negative.

setBit sample code for java.math.BigInteger.setBit(int) definition code for java.math.BigInteger.setBit(int)

public BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  setBit(int n)
Returns a BigInteger whose value is equivalent to this BigInteger with the designated bit set. (Computes (this | (1<<n)).)

Parameters:
n - index of bit to set.
Returns:
this | (1<<n)
Throws:
ArithmeticException sample code for java.lang.ArithmeticException definition code for java.lang.ArithmeticException - n is negative.

clearBit sample code for java.math.BigInteger.clearBit(int) definition code for java.math.BigInteger.clearBit(int)

public BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  clearBit(int n)
Returns a BigInteger whose value is equivalent to this BigInteger with the designated bit cleared. (Computes (this & ~(1<<n)).)

Parameters:
n - index of bit to clear.
Returns:
this & ~(1<<n)
Throws:
ArithmeticException sample code for java.lang.ArithmeticException definition code for java.lang.ArithmeticException - n is negative.

flipBit sample code for java.math.BigInteger.flipBit(int) definition code for java.math.BigInteger.flipBit(int)

public BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  flipBit(int n)
Returns a BigInteger whose value is equivalent to this BigInteger with the designated bit flipped. (Computes (this ^ (1<<n)).)

Parameters:
n - index of bit to flip.
Returns:
this ^ (1<<n)
Throws:
ArithmeticException sample code for java.lang.ArithmeticException definition code for java.lang.ArithmeticException - n is negative.

getLowestSetBit sample code for java.math.BigInteger.getLowestSetBit() definition code for java.math.BigInteger.getLowestSetBit()

public int getLowestSetBit()
Returns the index of the rightmost (lowest-order) one bit in this BigInteger (the number of zero bits to the right of the rightmost one bit). Returns -1 if this BigInteger contains no one bits. (Computes (this==0? -1 : log2(this & -this)).)

Returns:
index of the rightmost one bit in this BigInteger.

bitLength sample code for java.math.BigInteger.bitLength() definition code for java.math.BigInteger.bitLength()

public int bitLength()
Returns the number of bits in the minimal two's-complement representation of this BigInteger, excluding a sign bit. For positive BigIntegers, this is equivalent to the number of bits in the ordinary binary representation. (Computes (ceil(log2(this < 0 ? -this : this+1))).)

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

bitCount sample code for java.math.BigInteger.bitCount() definition code for java.math.BigInteger.bitCount()

public int bitCount()
Returns the number of bits in the two's complement representation of this BigInteger that differ from its sign bit. This method is useful when implementing bit-vector style sets atop BigIntegers.

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

isProbablePrime sample code for java.math.BigInteger.isProbablePrime(int) definition code for java.math.BigInteger.isProbablePrime(int)

public boolean isProbablePrime(int certainty)
Returns true if this BigInteger is probably prime, false if it's definitely composite. If certainty is <= 0, true is returned.

Parameters:
certainty - a measure of the uncertainty that the caller is willing to tolerate: if the call returns true the probability that this BigInteger is prime exceeds (1 - 1/2certainty). The execution time of this method is proportional to the value of this parameter.
Returns:
true if this BigInteger is probably prime, false if it's definitely composite.

compareTo sample code for java.math.BigInteger.compareTo(java.math.BigInteger) definition code for java.math.BigInteger.compareTo(java.math.BigInteger)

public int compareTo(BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  val)
Compares this BigInteger with the specified BigInteger. This method is provided in preference to individual methods for each of the six boolean comparison operators (<, ==, >, >=, !=, <=). The suggested idiom for performing these comparisons is: (x.compareTo(y) <op> 0), where <op> is one of the six comparison operators.

Specified by:
compareTo sample code for java.lang.Comparable.compareTo(T) definition code for java.lang.Comparable.compareTo(T) in interface Comparable sample code for java.lang.Comparable definition code for java.lang.Comparable <BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger >
Parameters:
val - BigInteger to which this BigInteger is to be compared.
Returns:
-1, 0 or 1 as this BigInteger is numerically less than, equal to, or greater than val.

equals sample code for java.math.BigInteger.equals(java.lang.Object) definition code for java.math.BigInteger.equals(java.lang.Object)

public boolean equals(Object sample code for java.lang.Object definition code for java.lang.Object  x)
Compares this BigInteger with the specified Object for equality.

Overrides:
equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) in class Object sample code for java.lang.Object definition code for java.lang.Object
Parameters:
x - Object to which this BigInteger is to be compared.
Returns:
true if and only if the specified Object is a BigInteger whose value is numerically equal to this BigInteger.
See Also:
Object.hashCode() sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable

min sample code for java.math.BigInteger.min(java.math.BigInteger) definition code for java.math.BigInteger.min(java.math.BigInteger)

public BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  min(BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  val)
Returns the minimum of this BigInteger and val.

Parameters:
val - value with which the minimum is to be computed.
Returns:
the BigInteger whose value is the lesser of this BigInteger and val. If they are equal, either may be returned.

max sample code for java.math.BigInteger.max(java.math.BigInteger) definition code for java.math.BigInteger.max(java.math.BigInteger)

public BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  max(BigInteger sample code for java.math.BigInteger definition code for java.math.BigInteger  val)
Returns the maximum of this BigInteger and val.

Parameters:
val - value with which the maximum is to be computed.
Returns:
the BigInteger whose value is the greater of this and val. If they are equal, either may be returned.

hashCode sample code for java.math.BigInteger.hashCode() definition code for java.math.BigInteger.hashCode()

public int hashCode()
Returns the hash code for this BigInteger.

Overrides:
hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
hash code for this BigInteger.
See Also:
Object.equals(java.lang.Object) sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , Hashtable sample code for java.util.Hashtable definition code for java.util.Hashtable

toString sample code for java.math.BigInteger.toString(int) definition code for java.math.BigInteger.toString(int)

public String sample code for java.lang.String definition code for java.lang.String  toString(int radix)
Returns the String representation of this BigInteger in the given radix. If the radix is outside the range from Character.MIN_RADIX sample code for java.lang.Character.MIN_RADIX definition code for java.lang.Character.MIN_RADIX to Character.MAX_RADIX sample code for java.lang.Character.MAX_RADIX definition code for java.lang.Character.MAX_RADIX inclusive, it will default to 10 (as is the case for Integer.toString). The digit-to-character mapping provided by Character.forDigit is used, and a minus sign is prepended if appropriate. (This representation is compatible with the (String, int) sample code for java.math.BigInteger.BigInteger(java.lang.String, int) definition code for java.math.BigInteger.BigInteger(java.lang.String, int) constructor.)

Parameters:
radix - radix of the String representation.
Returns:
String representation of this BigInteger in the given radix.
See Also:
Integer.toString(int, int) sample code for java.lang.Integer.toString(int, int) definition code for java.lang.Integer.toString(int, int) , Character.forDigit(int, int) sample code for java.lang.Character.forDigit(int, int) definition code for java.lang.Character.forDigit(int, int) , BigInteger(java.lang.String, int) sample code for java.math.BigInteger.BigInteger(java.lang.String, int) definition code for java.math.BigInteger.BigInteger(java.lang.String, int)

toString sample code for java.math.BigInteger.toString() definition code for java.math.BigInteger.toString()

public String sample code for java.lang.String definition code for java.lang.String  toString()
Returns the decimal String representation of this BigInteger. The digit-to-character mapping provided by Character.forDigit is used, and a minus sign is prepended if appropriate. (This representation is compatible with the (String) sample code for java.math.BigInteger.BigInteger(java.lang.String) definition code for java.math.BigInteger.BigInteger(java.lang.String) constructor, and allows for String concatenation with Java's + operator.)

Overrides:
toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() in class Object sample code for java.lang.Object definition code for java.lang.Object
Returns:
decimal String representation of this BigInteger.
See Also:
Character.forDigit(int, int) sample code for java.lang.Character.forDigit(int, int) definition code for java.lang.Character.forDigit(int, int) , BigInteger(java.lang.String) sample code for java.math.BigInteger.BigInteger(java.lang.String) definition code for java.math.BigInteger.BigInteger(java.lang.String)

toByteArray sample code for java.math.BigInteger.toByteArray() definition code for java.math.BigInteger.toByteArray()

public byte[] toByteArray()
Returns a byte array containing the two's-complement representation of this BigInteger. 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 BigInteger, including at least one sign bit, which is (ceil((this.bitLength() + 1)/8)). (This representation is compatible with the (byte[]) sample code for java.math.BigInteger.BigInteger(byte[]) definition code for java.math.BigInteger.BigInteger(byte[]) constructor.)

Returns:
a byte array containing the two's-complement representation of this BigInteger.
See Also:
BigInteger(byte[]) sample code for java.math.BigInteger.BigInteger(byte[]) definition code for java.math.BigInteger.BigInteger(byte[])

intValue sample code for java.math.BigInteger.intValue() definition code for java.math.BigInteger.intValue()

public int intValue()
Converts this BigInteger to an int. This conversion is analogous to a narrowing primitive conversion from long to int as defined in the Java Language Specification: if this BigInteger 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 BigInteger value as well as return a result with the opposite sign.

Specified by:
intValue sample code for java.lang.Number.intValue() definition code for java.lang.Number.intValue() in class Number sample code for java.lang.Number definition code for java.lang.Number
Returns:
this BigInteger converted to an int.

longValue sample code for java.math.BigInteger.longValue() definition code for java.math.BigInteger.longValue()

public long longValue()
Converts this BigInteger to a long. This conversion is analogous to a narrowing primitive conversion from long to int as defined in the Java Language Specification: if this BigInteger 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 BigInteger value as well as return a result with the opposite sign.

Specified by:
longValue sample code for java.lang.Number.longValue() definition code for java.lang.Number.longValue() in class Number sample code for java.lang.Number definition code for java.lang.Number
Returns:
this BigInteger converted to a long.

floatValue sample code for java.math.BigInteger.floatValue() definition code for java.math.BigInteger.floatValue()

public float floatValue()
Converts this BigInteger to a float. This conversion is similar to the narrowing primitive conversion from double to float defined in the Java Language Specification: if this BigInteger has too great a magnitude to represent as a float, it will be converted to Float.NEGATIVE_INFINITY sample code for java.lang.Float.NEGATIVE_INFINITY definition code for java.lang.Float.NEGATIVE_INFINITY or Float.POSITIVE_INFINITY sample code for java.lang.Float.POSITIVE_INFINITY definition code for java.lang.Float.POSITIVE_INFINITY as appropriate. Note that even when the return value is finite, this conversion can lose information about the precision of the BigInteger value.

Specified by:
floatValue sample code for java.lang.Number.floatValue() definition code for java.lang.Number.floatValue() in class Number sample code for java.lang.Number definition code for java.lang.Number
Returns:
this BigInteger converted to a float.

doubleValue sample code for java.math.BigInteger.doubleValue() definition code for java.math.BigInteger.doubleValue()

public double doubleValue()
Converts this BigInteger to a double. This conversion is similar to the narrowing primitive conversion from double to float defined in the Java Language Specification: if this BigInteger has too great a magnitude to represent as a double, it will be converted to Double.NEGATIVE_INFINITY sample code for java.lang.Double.NEGATIVE_INFINITY definition code for java.lang.Double.NEGATIVE_INFINITY or Double.POSITIVE_INFINITY sample code for java.lang.Double.POSITIVE_INFINITY definition code for java.lang.Double.POSITIVE_INFINITY as appropriate. Note that even when the return value is finite, this conversion can lose information about the precision of the BigInteger value.

Specified by:
doubleValue sample code for java.lang.Number.doubleValue() definition code for java.lang.Number.doubleValue() in class Number sample code for java.lang.Number definition code for java.lang.Number
Returns:
this BigInteger converted to a double.