java/math/BigInteger.java

2  * Copyright (c) 1996, 2016, Oracle and/or its affiliates. All rights reserved.
5  * This code is free software; you can redistribute it and/or modify it
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
22  * or visit www.oracle.com if you need additional information or have any
57  * division of a negative by a positive yields a negative (or zero) remainder.
71  * {@code or}, {@code xor}) implicitly perform sign extension on the shorter
129      * The signum of this BigInteger: -1 for negative, 0 for zero, or
290      * is negative, or {@code off+len} is greater than the length of
300      *         negative or greater than or equal to the array length.
365      * negative, 0 for zero, or 1 for positive.  The magnitude is a sub-array of
369      * whether signum is -1, 0 or 1.  The {@code magnitude} array is assumed to
374      * {@code len} is negative, or {@code off+len} is greater than the length of
384      *         legal values (-1, 0, and 1), or {@code signum} is 0 and
385      *         {@code magnitude} contains one or more non-zero bytes.
388      *         negative or greater than or equal to the array length.
419      * negative, 0 for zero, or 1 for positive.  The magnitude is a byte array
422      * result in a BigInteger value of 0, whether signum is -1, 0 or 1.  The
431      *         legal values (-1, 0, and 1), or {@code signum} is 0 and
432      *         {@code magnitude} contains one or more non-zero bytes.
466      * consists of an optional minus or plus sign followed by a
467      * sequence of one or more digits in the specified radix.  The
475      *         of a BigInteger in the specified radix, or {@code radix} is
664      * sign followed by a sequence of one or more decimal digits.  The
726      * @throws ArithmeticException {@code bitLength < 2} or {@code bitLength} is too large.
758      * @throws ArithmeticException {@code bitLength < 2} or {@code bitLength} is too large.
807             // Do expensive test if we survive pre-test (or it's inapplicable)
852     * @throws ArithmeticException {@code this < 0} or {@code this} is too large.
1004                 j = -j; // 3 (011) or 7 (111) mod 8
1013                 j = -j; // 3 (011) or 5 (101) mod 8
1030                     j = -j;     // 3 (011) or 5 (101) mod 8
1715      * has complexity of O(n^(log2(3))), or O(n^1.585).  It achieves this
2124      * squareToLen or squareKaratsuba.
2578      * @return -1, 0 or 1 as the value of this BigInteger is negative, zero or
2613      * @throws ArithmeticException {@code m} &le; 0 or the exponent is
2805      * is implcitly one, so squaring it or multiplying by it can be
2838         // modulus that is 512, 768, 1024, or 2048 bits, so this code
3025      * Returns -1, 0 or +1 as big-endian unsigned int array arg1 is less than,
3026      * equal to, or greater than arg2 up to length len.
3175      * @throws ArithmeticException {@code  m} &le; 0, or this BigInteger
3371      * returns a negative BigInteger if and only if either this or val is
3377     public BigInteger or(BigInteger val) {
3659      * @return -1, 0 or 1 as this BigInteger is numerically less than, equal
3660      *         to, or greater than {@code val}.
3681      * @return -1, 0 or 1 as this magnitude array is less than, equal to or
3753         // This test is just an optimization, which may or may not help
4090      * {@link Float#NEGATIVE_INFINITY} or {@link
4115          * SIGNIFICAND_WIDTH + 1 bits, so we have one to help us round up or
4146          * bit is set), or if the fractional part of signif is >= 0.5 and
4175      * {@link Double#NEGATIVE_INFINITY} or {@link
4200          * SIGNIFICAND_WIDTH + 1 bits, so we have one to help us round up or
4239          * bit is set), or if the fractional part of signif is >= 0.5 and