我认为程序员应该曾经实现过他自己的 bignum-library,所以欢迎来到这里。
(当然,稍后你会发现 BigInteger 更好,并使用它,但它是一个宝贵的学习经验。)
(您可以关注本课程生活的源代码on github。另外,我将这个(稍微打磨)改成了14-part blog series。)
在 Java 中创建一个简单的大数类
那么,我们需要什么?
一是数字的表示,
基于 Java 提供给我们的数据类型。
您认为十进制转换是最复杂的部分,让我们保持基于十进制的模式。为了提高效率,我们不会存储真正的十进制数字,而是以1 000 000 000 = 10^9 < 2^30 为基数。这适合 Java int(最多 2^31 或 2^32),并且两个这样的 digits 的乘积非常适合 Java long。
final static int BASE = 1000000000;
final static int BASE_DECIMAL_DIGITS = 9;
然后是数字数组:
private int[] digits;
我们是以小端还是大端存储数字,即较大的部分在前还是在后?这并不重要,所以我们决定使用大端,因为这是人类想要阅读的方式。 (现在我们专注于非负值 - 稍后我们将为负数添加符号位。)
出于测试目的,我们添加了一个构造函数,允许从这样的 int[] 进行初始化。
/**
* creates a DecimalBigInt based on an array of digits.
* @param digits a list of digits, each between 0 (inclusive)
* and {@link BASE} (exclusive).
* @throws IllegalArgumentException if any digit is out of range.
*/
public DecimalBigInt(int... digits) {
for(int digit : digits) {
if(digit < 0 || BASE <= digit) {
throw new IllegalArgumentException("digit " + digit +
" out of range!");
}
}
this.digits = digits.clone();
}
作为额外的好处,这个构造函数也可以用于单个int(如果小于BASE),甚至可以用于没有int(我们将其解释为0)。所以,我们现在可以这样做了:
DecimalBigInt d = new DecimalBigInt(7, 5, 2, 12345);
System.out.println(d);
这给了我们de.fencing_game.paul.examples.DecimalBigInt@6af62373,不是那么有用。所以,我们添加一个toString() 方法:
/**
* A simple string view for debugging purposes.
* (Will be replaced later with a real decimal conversion.)
*/
public String toString() {
return "Big" + Arrays.toString(digits);
}
现在的输出是Big[7, 5, 2, 12345],这对测试更有用,不是吗?
二、十进制格式的转换。
我们在这里很幸运:我们的基数 (10^9) 是我们想要从 (10) 转换的基数的幂。因此,我们总是有相同数量 (9) 的十进制数字代表一个“我们的格式”数字。 (当然开头可能少了一些数字。)在下面的代码中,decimal是一个十进制数字的字符串。
int decLen = decimal.length();
int bigLen = (decLen-1) / BASE_DECIMAL_DIGITS + 1;
这个奇怪的公式是Java int 的写法bigLen = ceil(decLen/BASE_DECIMAL_DIGITS)。 (我希望它是正确的,我们稍后会测试它。)
int firstSome = decLen - (bigLen-1) * BASE_DECIMAL_DIGITS;
这是第一个十进制数字的长度,应介于 1 和 9(含)之间。
我们创建我们的数组:
int[] digits = new int[bigLen];
遍历要创建的数字:
for(int i = 0; i < bigLen; i++) {
我们的个数字中的每一个都由原始数字中的一个数字块表示:
String block =
decimal.substring(Math.max(firstSome + (i-1)*BASE_DECIMAL_DIGITS, 0),
firstSome + i *BASE_DECIMAL_DIGITS);
(这里需要Math.max 用于第一个较短的块。)
我们现在使用通常的整数解析函数,并将结果放入数组中:
digits[i] = Integer.parseInt(block);
}
从现在创建的数组中,我们创建了 DecimalBigInt 对象:
return new DecimalBigInt(digits);
让我们看看这是否有效:
DecimalBigInt d2 = DecimalBigInt.valueOf("12345678901234567890");
System.out.println(d2);
输出:
Big[12, 345678901, 234567890]
看起来不错 :-) 我们也应该用其他一些数字(不同长度)对其进行测试。
下一部分将是十进制格式,这应该会更容易。
三、转换成十进制格式。
我们需要将每个数字输出为 9 个十进制数字。为此,我们可以使用 Formatter 类,它支持类似 printf 的格式字符串。
一个简单的变体是这样的:
public String toDecimalString() {
Formatter f = new Formatter();
for(int digit : digits) {
f.format("%09d", digit);
}
return f.toString();
}
这将为我们的两个号码返回 000000007000000005000000002000012345 和 000000012345678901234567890。这适用于往返(即,将其提供给 valueOf 方法会给出等效对象),但前导零看起来不太好(并且可能与八进制数混淆)。所以我们需要分解我们漂亮的 for-each 循环,并为第一个和后面的数字使用不同的格式字符串。
public String toDecimalString() {
Formatter f = new Formatter();
f.format("%d", digits[0]);
for(int i = 1; i < digits.length; i++) {
f.format("%09d", digits[i]);
}
return f.toString();
}
加法。
让我们从加法开始,因为这很简单(我们可以稍后将它的一部分用于乘法)。
/**
* calculates the sum of this and that.
*/
public DecimalBigInt plus(DecimalBigInt that) {
...
}
我想要您可以像阅读公式一样阅读的方法名称,因此 plus、minus、times 而不是 add、subtract、multiply。
那么,加法是如何工作的?对于大于 9 的十进制数,它的工作原理与我们在学校学到的相同:添加相应的数字,如果其中一些结果大于 10(或在我们的例子中为 BASE),则将一个带到下一个数字.这可能会导致生成的数字比原始数字多一位。
首先我们看两个数字具有相同位数的简单情况。那么它看起来就像这样:
int[] result = new int[this.digits.length];
int carry = 0;
for(int i = this.digits.length-1; i > 0; i--) {
int digSum = carry + this.digits[i] + that.digits[i];
result[i] = digSum % BASE;
carry = digSum / BASE;
}
if(carry > 0) {
int[] temp = new int[result.length + 1];
System.arraycopy(result, 0, temp, 1, result.length);
temp[0] = carry;
result = temp;
}
return new DecimalBigInt(result);
(我们从右到左,所以我们可以将任何溢出带到下一个数字。如果我们决定使用 Little Endian 格式会更漂亮。)
如果两个数字的位数不同,就会变得有点复杂。
为了让它尽可能简单,我们将其拆分为几个方法:
此方法将一位数字添加到数组中的元素(可能已经包含一些非零值),并将结果存储回数组中。如果有溢出,我们通过递归调用将它带到下一个数字(索引少一个,而不是多一个)。这样我们就可以确保我们的数字始终保持在有效范围内。
/**
* adds one digit from the addend to the corresponding digit
* of the result.
* If there is carry, it is recursively added to the next digit
* of the result.
*/
private void addDigit(int[] result, int resultIndex,
int addendDigit)
{
int sum = result[resultIndex] + addendDigit;
result[resultIndex] = sum % BASE;
int carry = sum / BASE;
if(carry > 0) {
addDigit(result, resultIndex - 1, carry);
}
}
下一个对要添加的整个数字数组执行相同操作:
/**
* adds all the digits from the addend array to the result array.
*/
private void addDigits(int[] result, int resultIndex,
int... addend)
{
int addendIndex = addend.length - 1;
while(addendIndex >= 0) {
addDigit(result, resultIndex,
addend[addendIndex]);
addendIndex--;
resultIndex--;
}
}
现在我们可以实现我们的plus 方法了:
/**
* calculates the sum of this and that.
*/
public DecimalBigInt plus(DecimalBigInt that) {
int[] result = new int[Math.max(this.digits.length,
that.digits.length)+ 1];
addDigits(result, result.length-1, this.digits);
addDigits(result, result.length-1, that.digits);
// cut of leading zero, if any
if(result[0] == 0) {
result = Arrays.copyOfRange(result, 1, result.length);
}
return new DecimalBigInt(result);
}
如果我们先看看是否有可能溢出,我们可以在这里做得更好一些,然后才创建比需要大一个的数组。
啊,一个测试:d2.plus(d2) 给出了Big[24, 691357802, 469135780],看起来是对的。
乘法。
让我们回想一下,我们是如何在纸上将更大的数字相乘的?
123 * 123
----------
369 <== 123 * 3
246 <== 123 * 2
123 <== 123 * 1
--------
15129
所以,我们必须将第一个数的每个数字[i]与第二个数字的每个数字[j]相乘,然后将结果的数字[i+j]中的乘积相加(并注意进位) .当然,这里的索引是从右算起,而不是从左算起。 (现在我真希望我使用的是 little-endian 数字。)
由于我们两个数字的乘积可能超出int 的范围,因此我们使用long 进行乘法运算。
/**
* multiplies two digits and adds the product to the result array
* at the right digit-position.
*/
private void multiplyDigit(int[] result, int resultIndex,
int firstFactor, int secondFactor) {
long prod = (long)firstFactor * (long)secondFactor;
int prodDigit = (int)(prod % BASE);
int carry = (int)(prod / BASE);
addDigits(result, resultIndex, carry, prodDigit);
}
现在我们可以看到为什么我声明我的addDigits 方法采用resultIndex 参数。 (而且我只是将最后一个参数更改为 varargs 参数,以便能够更好地在此处编写。)
所以,这里是交叉乘法:
private void multiplyDigits(int[] result, int resultIndex,
int[] leftFactor, int[] rightFactor) {
for(int i = 0; i < leftFactor.length; i++) {
for(int j = 0; j < rightFactor.length; j++) {
multiplyDigit(result, resultIndex - (i + j),
leftFactor[leftFactor.length-i-1],
rightFactor[rightFactor.length-j-1]);
}
}
}
我希望我的索引计算正确。如果使用 little-endian 表示,则应该是 multiplyDigit(result, resultIndex + i + j, leftFactor[i], rightFactor[j]) - 更清晰,不是吗?
我们的times 方法现在只需分配结果数组,调用multiplyDigits 并包装结果。
/**
* returns the product {@code this × that}.
*/
public DecimalBigInt times(DecimalBigInt that) {
int[] result = new int[this.digits.length + that.digits.length];
multiplyDigits(result, result.length-1,
this.digits, that.digits);
// cut off leading zero, if any
if(result[0] == 0) {
result = Arrays.copyOfRange(result, 1, result.length);
}
return new DecimalBigInt(result);
}
对于测试,d2.times(d2) 给出Big[152, 415787532, 388367501, 905199875, 19052100],这与我的 Emacs calc 在这里计算的结果相同。
比较
我们希望能够比较我们的两个对象。所以,我们实现了Comparable<DecimalBigInt> 及其 compareTo 方法。
public int compareTo(DecimalBigInt that) {
如何知道我们的一个数字是否大于另一个?首先,我们比较数组的长度。由于我们注意不要引入任何前导零(是吗?),所以更长的数组应该有更大的数字。
if(this.digits.length < that.digits.length) {
return -1;
}
if (that.digits.length < this.digits.length) {
return 1;
}
如果长度相同,我们可以按元素进行比较。由于我们使用大端(即大端在前),我们从头开始。
for(int i = 0; i < this.digits.length; i++) {
if(this.digits[i] < that.digits[i]) {
return -1;
}
if(that.digits[i] < this.digits[i]) {
return 1;
}
}
如果一切都一样,显然我们的数字是相同的,我们可以返回0。
return 0;
}
equals + hashCode()
每个好的不可变类都应该以合适(且兼容)的方式实现equals() 和hashCode()。
对于我们的hashCode(),我们只是将数字相加,然后将它们乘以一个小素数,以确保数字转换不会产生相同的哈希码:
/**
* calculates a hashCode for this object.
*/
public int hashCode() {
int hash = 0;
for(int digit : digits) {
hash = hash * 13 + digit;
}
return hash;
}
在equals() 方法中,我们可以简单地委托给 compareTo 方法,而不是再次实现相同的算法:
/**
* compares this object with another object for equality.
* A DecimalBigInt is equal to another object only if this other
* object is also a DecimalBigInt and both represent the same
* natural number.
*/
public boolean equals(Object o) {
return o instanceof DecimalBigInt &&
this.compareTo((DecimalBigInt)o) == 0;
}
那么,今天就够了。减法(可能是负数)和除法更复杂,所以我现在省略它们。 计算 90 的阶乘应该足够了。
计算大阶乘:
这里是阶乘函数:
/**
* calculates the factorial of an int number.
* This uses a simple iterative loop.
*/
public static DecimalBigInt factorial(int n) {
DecimalBigInt fac = new DecimalBigInt(1);
for(int i = 2; i <= n; i++) {
fac = fac.times(new DecimalBigInt(i));
}
return fac;
}
这给了我们
fac(90) = 1485715964481761497309522733620825737885569961284688766942216863704985393094065876545992131370884059645617234469978112000000000000000000000
从任意基数表示转换
在 frodosamoa 的下一个问题的提示下,我写了my answer about how to convert from arbitrary (positional) number systems in the one in which we can (or want to) calculate。 (在示例中,我从三进制转换为十进制,而问题是关于十进制到二进制。)
在这里,我们想要从任意数字系统(好的,基数在 2 到 36 之间,所以我们可以使用 Character.digit() 将个位数转换为整数)转换为我们的系统,基数为 BASE (= 1.000.000.000 ,但这在这里并不重要)。
基本上,我们使用Horner scheme 来计算多项式的值,其中数字为由基数给出的点处的系数。
sum[i=0..n] digit[i] * radix^i
可以用这个循环计算:
value = 0;
for i = n .. 0
value = value * radix + digit[i]
return value
由于我们的输入字符串是大端的,我们不必倒计时,但可以使用简单的增强 for 循环。
(它在 Java 中看起来更丑,因为我们没有运算符重载,也没有从 int 到我们的自动装箱
DecimalBigInt 类型。)
public static DecimalBigInt valueOf(String text, int radix) {
DecimalBigInt bigRadix = new DecimalBigInt(radix);
DecimalBigInt value = new DecimalBigInt(); // 0
for(char digit : text.toCharArray()) {
DecimalBigInt bigDigit =
new DecimalBigInt(Character.digit(digit, radix));
value = value.times(bigRadix).plus(bigDigit);
}
return value;
}
在my actual implementation 中,我添加了一些错误检查(和异常抛出)以确保我们确实有一个有效的数字,当然还有一个文档注释。
将转换为任意位置系统更复杂,因为它涉及余数和除法(通过任意基数),我们还没有实现 - 所以现在还没有。当我对如何进行除法有一个好主意时,它就会完成。 (这里我们只需要除以小(一位数)数字,这可能比一般除法更容易。)
小数除法
在学校,我学会了long division。这是一个小(一位数)除数的示例,采用我们在德国使用的符号(带有关于背景计算的注释,我们通常不会写),采用十进制:
12345 : 6 = 02057 1 / 6 = 0
-0┊┊┊┊ 0 * 6 = 0
──┊┊┊┊
12┊┊┊ 12 / 6 = 2
-12┊┊┊ 2 * 6 = 12
──┊┊┊
03┊┊ 3 / 6 = 0
- 0┊┊ 0 * 6 = 0
──┊┊
34┊ 34 / 6 = 5
-30┊ 5 * 6 = 30
──┊
45 45 / 6 = 7
-42 7 * 6 = 42
──
3 ==> quotient 2057, remainder 3.
当然,我们不需要计算这些乘积 (0, 12, 0, 30, 42)
如果我们有原生余数运算,则减去它们。然后看起来
像这样(当然,我们这里不需要写操作):
12345 : 6 = 02057 1 / 6 = 0, 1 % 6 = 1
12┊┊┊ 12 / 6 = 2, 12 % 6 = 0
03┊┊ 3 / 6 = 0, 3 % 6 = 3
34┊ 34 / 6 = 5, 34 % 6 = 4
45 45 / 6 = 7, 45 % 6 = 3
3
==> quotient 2057, remainder 3.
这已经很像short division,如果我们用另一种格式写的话。
我们可以观察(并证明)以下几点:
如果我们有一个两位数 x 的第一位数字小于除数 d,则x / d 是一位数,x % d 也是一位数,小于 d。这与归纳一起表明,我们只需要用除数除(余数)两位数。
回到我们使用基数 BASE 的大数字:所有两位数都可以表示为 Java long,我们有原生的 / 和 %。
/**
* does one step in the short division algorithm, i.e. divides
* a two-digit number by a one-digit one.
*
* @param result the array to put the quotient digit in.
* @param resultIndex the index in the result array where
* the quotient digit should be put.
* @param divident the last digit of the divident.
* @param lastRemainder the first digit of the divident (being the
* remainder of the operation one digit to the left).
* This must be < divisor.
* @param divisor the divisor.
* @returns the remainder of the division operation.
*/
private int divideDigit(int[] result, int resultIndex,
int divident, int lastRemainder,
int divisor) {
assert divisor < BASE;
assert lastRemainder < divisor;
long ent = divident + (long)BASE * lastRemainder;
long quot = ent / divisor;
long rem = ent % divisor;
assert quot < BASE;
assert rem < divisor;
result[resultIndex] = (int)quot;
return (int)rem;
}
我们现在将在循环中调用此方法,始终将上一次回调的结果作为lastRemainder 提供。
/**
* The short division algorithm, like described in
* <a href="http://en.wikipedia.org/wiki/Short_division">Wikipedia's
* article <em>Short division</em></a>.
* @param result an array where we should put the quotient digits in.
* @param resultIndex the index in the array where the highest order digit
* should be put, the next digits will follow.
* @param divident the array with the divident's digits. (These will only
* be read, not written to.)
* @param dividentIndex the index in the divident array where we should
* start dividing. We will continue until the end of the array.
* @param divisor the divisor. This must be a number smaller than
* {@link #BASE}.
* @return the remainder, which will be a number smaller than
* {@code divisor}.
*/
private int divideDigits(int[] result, int resultIndex,
int[] divident, int dividentIndex,
int divisor) {
int remainder = 0;
for(; dividentIndex < divident.length; dividentIndex++, resultIndex++) {
remainder = divideDigit(result, resultIndex,
divident[dividentIndex],
remainder, divisor);
}
return remainder;
}
这个方法仍然返回一个int,余数。
现在我们想要一个返回 DecimalBigInt 的公共方法,所以我们创建了一个。它的任务是检查参数,为工作方法创建一个数组,丢弃剩余部分,并根据结果创建一个 DecimalBigInt。 (构造函数删除可能存在的前导零。)
/**
* Divides this number by a small number.
* @param divisor an integer with {@code 0 < divisor < BASE}.
* @return the integer part of the quotient, ignoring the remainder.
* @throws IllegalArgumentException if the divisor is <= 0 or >= BASE.
*/
public DecimalBigInt divideBy(int divisor)
{
if(divisor <= 0 || BASE <= divisor) {
throw new IllegalArgumentException("divisor " + divisor +
" out of range!");
}
int[] result = new int[digits.length];
divideDigits(result, 0,
digits, 0,
divisor);
return new DecimalBigInt(result);
}
我们也有类似的方法,它返回余数:
/**
* Divides this number by a small number, returning the remainder.
* @param divisor an integer with {@code 0 < divisor < BASE}.
* @return the remainder from the division {@code this / divisor}.
* @throws IllegalArgumentException if the divisor is <= 0 or >= BASE.
*/
public int modulo(int divisor) {
if(divisor <= 0 || BASE <= divisor) {
throw new IllegalArgumentException("divisor " + divisor +
" out of range!");
}
int[] result = new int[digits.length];
return divideDigits(result, 0,
digits, 0,
divisor);
}
这些方法可以这样调用:
DecimalBigInt d3_by_100 = d3.divideBy(100);
System.out.println("d3/100 = " + d3_by_100);
System.out.println("d3%100 = " + d3.modulo(100));
转换为任意基数
现在我们有了转换为任意基数的基础知识。当然,也不是很随意,只允许小于BASE 的基数,但这应该不是太大的问题。
正如在另一个关于转换数字的答案中已经回答的那样,我们必须执行“除法,余数,乘法,加法”。“乘法-加法”部分实际上只是将各个数字放在一起,因此我们可以将其替换为简单的数组访问。
由于我们总是需要商和余数,所以我们不会使用公共方法modulo 和divideBy,而是重复调用divideDigits 方法。
/**
* converts this number to an arbitrary radix.
* @param radix the target radix, {@code 1 < radix < BASE}.
* @return the digits of this number in the base-radix system,
* in big-endian order.
*/
public int[] convertTo(int radix)
{
if(radix <= 1 || BASE <= radix) {
throw new IllegalArgumentException("radix " + radix +
" out of range!");
}
首先,对 0 的特殊情况处理。
// zero has no digits.
if(digits.length == 0)
return new int[0];
然后,我们为结果数字创建一个数组(足够长),
和其他一些变量。
// raw estimation how many output digits we will need.
// This is just enough in cases like BASE-1, and up to
// 30 digits (for base 2) too much for something like (1,0,0).
int len = (int) (Math.log(BASE) / Math.log(radix) * digits.length)+1;
int[] rDigits = new int[len];
int rIndex = len-1;
int[] current = digits;
int quotLen = digits.length;
quotLen 是最后一个商的位数(不包括前导零)。如果这是 0,我们就完成了。
while(quotLen > 0) {
下一个商的新数组。
int[] quot = new int[quotLen];
商和余数运算。商现在在quot,
rem 中的其余部分。
int rem = divideDigits(quot, 0,
current, current.length - quotLen,
radix);
我们将余数放入输出数组(从最后一位开始填充)。
rDigits[rIndex] = rem;
rIndex --;
然后我们为下一轮交换数组。
current = quot;
如果商中有前导零(最多有一个,因为
radix 小于 BASE),我们将商的大小缩小一。下一个数组
会更小。
if(current[0] == 0) {
// omit leading zeros in next round.
quotLen--;
}
}
循环结束后,rDigits 数组中可能有前导零,我们将它们截掉。
// cut of leading zeros in rDigits:
while(rIndex < 0 || rDigits[rIndex] == 0) {
rIndex++;
}
return Arrays.copyOfRange(rDigits, rIndex, rDigits.length);
}
就是这样。不过,它看起来有点复杂。以下是如何使用它的示例:
System.out.println("d4 in base 11: " +
Arrays.toString(d4.convertTo(11)));
System.out.println("d5 in base 7: " +
Arrays.toString(d5.convertTo(7)));
这些打印 [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 0] 和 [1, 2, 3, 4, 5, 6, 0, 1, 2, 3, 4, 5, 6, 0, 1, 2, 3, 4, 5, 6, 0],与我们之前解析的数字相同(不过来自字符串)。
基于此我们也可以格式化为字符串:
/**
* Converts the number to a String in a given radix.
* This uses {@link Character.digit} to convert each digit
* to one character.
* @param radix the radix to use, between {@link Character.MIN_RADIX}
* and {@link Character.MAX_RADIX}.
* @return a String containing the digits of this number in the
* specified radix, using '0' .. '9' and 'a' .. 'z' (as much as needed).
*/
public String toString(int radix) {
if(radix < Character.MIN_RADIX || Character.MAX_RADIX < radix) {
throw new IllegalArgumentException("radix out of range: " + radix);
}
if(digits.length == 0)
return "0";
int[] rdigits = convertTo(radix);
StringBuilder b = new StringBuilder(rdigits.length);
for(int dig : rdigits) {
b.append(Character.forDigit(dig, radix));
}
return b.toString();
}