Class BigInteger

public static final BigInteger ONE

The constant one as a BigInteger.

Since:

1.2

public static final BigInteger TEN

The constant ten as a BigInteger.

Since:

1.5

public static final BigInteger ZERO

The constant zero as a BigInteger.

Since:

1.2

public BigInteger(byte[] val)

public BigInteger(int signum,
                  byte[] magnitude)

public BigInteger(int bitLength,
                  int certainty,
                  Random rnd)

public BigInteger(int numBits,
                  Random rnd)

public BigInteger(String val)

public BigInteger(String s,
                  int radix)

public BigInteger abs()

public BigInteger add(BigInteger val)

public BigInteger and(BigInteger y)

Return the logical (bit-wise) "and" of two BigIntegers.

public BigInteger andNot(BigInteger val)

public int bitCount()

Count one bits in a BigInteger. If argument is negative, count zero bits instead.

public int bitLength()

Calculates ceiling(log2(this <320 ? -this : this+1)) See Common Lisp: the Language, 2nd ed, p. 361.

public BigInteger clearBit(int n)

public int compareTo(BigInteger val)

Since:

1.2

public BigInteger divide(BigInteger val)

public BigInteger[] divideAndRemainder(BigInteger val)

public double doubleValue()

Return the value of this Number as a float.

Overrides:

doubleValue in interface Number

Returns:

the double value

public boolean equals(Object obj)

Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

• It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
• It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
• It must be reflexive. a.equals(a) must always be true.
• It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
• a.equals(null) must be false.
• It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

This is typically overridden to throw a ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.

Overrides:

equals in interface Object

Parameters:

obj - the Object to compare to

Returns:

whether this Object is semantically equal to another

See Also:

Object.hashCode()

public BigInteger flipBit(int n)

public float floatValue()

Return the value of this Number as a float.

Overrides:

floatValue in interface Number

Returns:

the float value

public BigInteger gcd(BigInteger y)

public int getLowestSetBit()

public int hashCode()

Get a value that represents this Object, as uniquely as possible within the confines of an int.

There are some requirements on this method which subclasses must follow:

• Semantic equality implies identical hashcodes. In other words, if a.equals(b) is true, then a.hashCode() == b.hashCode() must be as well. However, the reverse is not necessarily true, and two objects may have the same hashcode without being equal.
• It must be consistent. Whichever value o.hashCode() returns on the first invocation must be the value returned on all later invocations as long as the object exists. Notice, however, that the result of hashCode may change between separate executions of a Virtual Machine, because it is not invoked on the same object.

Notice that since hashCode is used in Hashtable and other hashing classes, a poor implementation will degrade the performance of hashing (so don't blindly implement it as returning a constant!). Also, if calculating the hash is time-consuming, a class may consider caching the results.

The default implementation returns System.identityHashCode(this)

Overrides:

hashCode in interface Object

Returns:

the hash code for this Object

See Also:

Object.equals(Object), System.identityHashCode(Object)

public int intValue()

Return the value of this Number as an int.

Overrides:

intValue in interface Number

Returns:

the int value

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.

public long longValue()

Return the value of this Number as a long.

Overrides:

longValue in interface Number

Returns:

the long value

public BigInteger max(BigInteger val)

public BigInteger min(BigInteger val)

public BigInteger mod(BigInteger m)

public BigInteger modInverse(BigInteger y)

public BigInteger modPow(BigInteger exponent,
                         BigInteger m)

public BigInteger multiply(BigInteger y)

public BigInteger negate()

public BigInteger not()

Return the logical (bit-wise) negation of a BigInteger.

public BigInteger or(BigInteger y)

Return the logical (bit-wise) "(inclusive) or" of two BigIntegers.

public BigInteger pow(int exponent)

Calculate the integral power of a BigInteger.

Parameters:

exponent - the exponent (must be non-negative)

public static BigInteger probablePrime(int bitLength,
                                       Random rnd)

Return a BigInteger that is bitLength bits long with a probability <322^-100 of being composite.

Parameters:

bitLength - length in bits of resulting number

rnd - random number generator to use

Throws:

ArithmeticException - if bitLength <322

Since:

1.4

public BigInteger remainder(BigInteger val)

public BigInteger setBit(int n)

public BigInteger shiftLeft(int n)

public BigInteger shiftRight(int n)

public int signum()

public BigInteger subtract(BigInteger val)

public boolean testBit(int n)

public byte[] toByteArray()

public String toString()

Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() and such.

It is typical, but not required, to ensure that this method never completes abruptly with a RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

Overrides:

toString in interface Object

Returns:

the String representing this Object, which may be null

See Also:

getClass(), Object.hashCode(), Class.getName(), Integer.toHexString(int)

public String toString(int radix)

public static BigInteger valueOf(long val)

Return a (possibly-shared) BigInteger with a given long value.

public BigInteger xor(BigInteger y)

Return the logical (bit-wise) "exclusive or" of two BigIntegers.