module big import math.util import math.bits import strings import strconv const ( digit_array = '0123456789abcdefghijklmnopqrstuvwxyz'.bytes() ) // big.Integer // ----------- // It has the following properties: // 1. Every "digit" is an integer in the range [0, 2^32). // 2. The signum can be one of three values: -1, 0, +1 for // negative, zero, and positive values, respectively. // 3. There should be no leading zeros in the digit array. // 4. The digits are stored in little endian format, that is, // the digits with a lower positional value (towards the right // when represented as a string) have a lower index, and vice versa. pub struct Integer { digits []u32 pub: signum int } fn int_signum(value int) int { if value == 0 { return 0 } return if value < 0 { -1 } else { 1 } } pub fn integer_from_int(value int) Integer { if value == 0 { return zero_int } return Integer{ digits: [u32(util.iabs(value))] signum: int_signum(value) } } pub fn integer_from_u32(value u32) Integer { if value == 0 { return zero_int } return Integer{ digits: [value] signum: 1 } } pub fn integer_from_i64(value i64) Integer { if value == 0 { return zero_int } signum_value := if value < 0 { -1 } else { 1 } abs_value := u64(value * signum_value) lower := u32(abs_value) upper := u32(abs_value >> 32) if upper == 0 { return Integer{ digits: [lower] signum: signum_value } } else { return Integer{ digits: [lower, upper] signum: signum_value } } } pub fn integer_from_u64(value u64) Integer { if value == 0 { return zero_int } lower := u32(value & 0x00000000ffffffff) upper := u32((value & 0xffffffff00000000) >> 32) if upper == 0 { return Integer{ digits: [lower] signum: 1 } } else { return Integer{ digits: [lower, upper] signum: 1 } } } [params] pub struct IntegerConfig { signum int = 1 } pub fn integer_from_bytes(input []byte, config IntegerConfig) Integer { // Thank you to Miccah (@mcastorina) for this implementation and relevant unit tests. if input.len == 0 { return integer_from_int(0) } // pad input mut padded_input := []byte{len: ((input.len + 3) & ~0x3) - input.len, cap: (input.len + 3) & ~0x3, init: 0x0} padded_input << input mut digits := []u32{len: padded_input.len / 4} // combine every 4 bytes into a u32 and insert into n.digits for i := 0; i < padded_input.len; i += 4 { x3 := u32(padded_input[i]) x2 := u32(padded_input[i + 1]) x1 := u32(padded_input[i + 2]) x0 := u32(padded_input[i + 3]) val := (x3 << 24) | (x2 << 16) | (x1 << 8) | x0 digits[(padded_input.len - i) / 4 - 1] = val } return Integer{ digits: digits signum: config.signum } } pub fn integer_from_string(characters string) ?Integer { return integer_from_radix(characters, 10) } pub fn integer_from_radix(all_characters string, radix u32) ?Integer { if radix < 2 || radix > 36 { return error('Radix must be between 2 and 36 (inclusive)') } characters := all_characters.to_lower() validate_string(characters, radix) ? return match radix { 2 { integer_from_special_string(characters, 1) } 16 { integer_from_special_string(characters, 4) } else { integer_from_regular_string(characters, radix) } } } fn validate_string(characters string, radix u32) ? { sign_present := characters[0] == `+` || characters[0] == `-` start_index := if sign_present { 1 } else { 0 } for index := start_index; index < characters.len; index++ { digit := characters[index] value := big.digit_array.index(digit) if value == -1 { return error('Invalid character $digit') } if value >= radix { return error('Invalid character $digit for base $radix') } } } fn integer_from_special_string(characters string, chunk_size int) Integer { sign_present := characters[0] == `+` || characters[0] == `-` signum := if sign_present { if characters[0] == `-` { -1 } else { 1 } } else { 1 } start_index := if sign_present { 1 } else { 0 } mut big_digits := []u32{cap: ((characters.len * chunk_size) >> 5) + 1} mut current := u32(0) mut offset := 0 for index := characters.len - 1; index >= start_index; index-- { digit := characters[index] value := u32(big.digit_array.index(digit)) current |= value << offset offset += chunk_size if offset == 32 { big_digits << current current = u32(0) offset = 0 } } // Store the accumulated value into the digit array if current != 0 { big_digits << current } for big_digits.len > 0 && big_digits.last() == 0 { big_digits.delete_last() } return Integer{ digits: big_digits signum: if big_digits.len == 0 { 0 } else { signum } } } fn integer_from_regular_string(characters string, radix u32) Integer { sign_present := characters[0] == `+` || characters[0] == `-` signum := if sign_present { if characters[0] == `-` { -1 } else { 1 } } else { 1 } start_index := if sign_present { 1 } else { 0 } mut result := zero_int radix_int := integer_from_u32(radix) for index := start_index; index < characters.len; index++ { digit := characters[index] value := big.digit_array.index(digit) result *= radix_int result += integer_from_int(value) } return Integer{ ...result signum: result.signum * signum } } pub fn (integer Integer) abs() Integer { return if integer.signum == 0 { zero_int } else { Integer{ ...integer signum: 1 } } } pub fn (integer Integer) neg() Integer { return if integer.signum == 0 { zero_int } else { Integer{ ...integer signum: -integer.signum } } } pub fn (integer Integer) + (addend Integer) Integer { // Quick exits if integer.signum == 0 { return addend } if addend.signum == 0 { return integer } // Non-zero cases return if integer.signum == addend.signum { integer.add(addend) } else { // Unequal signs integer.subtract(addend) } } pub fn (integer Integer) - (subtrahend Integer) Integer { // Quick exits if integer.signum == 0 { return subtrahend.neg() } if subtrahend.signum == 0 { return integer } // Non-zero cases return if integer.signum == subtrahend.signum { integer.subtract(subtrahend) } else { integer.add(subtrahend) } } fn (integer Integer) add(addend Integer) Integer { a := integer.digits b := addend.digits mut storage := []u32{len: util.imax(a.len, b.len) + 1} add_digit_array(a, b, mut storage) return Integer{ ...integer digits: storage } } fn (integer Integer) subtract(subtrahend Integer) Integer { cmp := integer.abs_cmp(subtrahend) if cmp == 0 { return zero_int } a, b := if cmp > 0 { integer, subtrahend } else { subtrahend, integer } mut storage := []u32{len: a.digits.len} subtract_digit_array(a.digits, b.digits, mut storage) return Integer{ signum: cmp * a.signum digits: storage } } pub fn (integer Integer) * (multiplicand Integer) Integer { // Quick exits if integer.signum == 0 || multiplicand.signum == 0 { return zero_int } if integer == one_int { return multiplicand } if multiplicand == one_int { return integer } // The final sign is the product of the signs mut storage := []u32{len: integer.digits.len + multiplicand.digits.len} multiply_digit_array(integer.digits, multiplicand.digits, mut storage) return Integer{ signum: integer.signum * multiplicand.signum digits: storage } } pub fn (integer Integer) div_mod(divisor Integer) (Integer, Integer) { // Quick exits if divisor.signum == 0 { panic('Cannot divide by zero') } if integer.signum == 0 { return zero_int, zero_int } if divisor == one_int { return integer, zero_int } if divisor.signum == -1 { q, r := integer.div_mod(divisor.neg()) return q.neg(), r } if integer.signum == -1 { q, r := integer.neg().div_mod(divisor) if r.signum == 0 { return q.neg(), zero_int } else { return q.neg() - one_int, divisor - r } } // Division for positive integers mut q := []u32{cap: integer.digits.len - divisor.digits.len + 1} mut r := []u32{cap: integer.digits.len} divide_digit_array(integer.digits, divisor.digits, mut q, mut r) quotient := Integer{ signum: if q.len == 0 { 0 } else { 1 } digits: q } remainder := Integer{ signum: if r.len == 0 { 0 } else { 1 } digits: r } return quotient, remainder } pub fn (a Integer) / (b Integer) Integer { q, _ := a.div_mod(b) return q } pub fn (a Integer) % (b Integer) Integer { _, r := a.div_mod(b) return r } pub fn (a Integer) pow(exponent u32) Integer { if exponent == 0 { return one_int } if exponent == 1 { return a } mut n := exponent mut x := a mut y := one_int for n > 1 { if n & 1 == 1 { y *= x } x *= x n >>= 1 } return x * y } pub fn (a Integer) mod_pow(exponent u32, divisor Integer) Integer { if exponent == 0 { return one_int } if exponent == 1 { return a % divisor } mut n := exponent mut x := a % divisor mut y := one_int for n > 1 { if n & 1 == 1 { y *= x % divisor } x *= x % divisor n >>= 1 } return x * y % divisor } pub fn (mut a Integer) inc() { a = a + one_int } pub fn (mut a Integer) dec() { a = a - one_int } pub fn (a Integer) == (b Integer) bool { return a.signum == b.signum && a.digits.len == b.digits.len && a.digits == b.digits } pub fn (a Integer) abs_cmp(b Integer) int { return compare_digit_array(a.digits, b.digits) } pub fn (a Integer) < (b Integer) bool { // Quick exits based on signum value: if a.signum < b.signum { return true } if a.signum > b.signum { return false } // They have equal sign signum := a.signum if signum == 0 { // Are they both zero? return false } // If they are negative, the one with the larger absolute value is smaller cmp := a.abs_cmp(b) return if signum < 0 { cmp > 0 } else { cmp < 0 } } fn check_sign(a Integer) { if a.signum < 0 { panic('Bitwise operations are only supported for nonnegative integers') } } pub fn (a Integer) bitwise_or(b Integer) Integer { check_sign(a) check_sign(b) mut result := []u32{len: util.imax(a.digits.len, b.digits.len), init: 0} bitwise_or_digit_array(a.digits, b.digits, mut result) return Integer{ digits: result signum: if result.len == 0 { 0 } else { 1 } } } pub fn (a Integer) bitwise_and(b Integer) Integer { check_sign(a) check_sign(b) mut result := []u32{len: util.imax(a.digits.len, b.digits.len), init: 0} bitwise_and_digit_array(a.digits, b.digits, mut result) return Integer{ digits: result signum: if result.len == 0 { 0 } else { 1 } } } pub fn (a Integer) bitwise_not() Integer { check_sign(a) mut result := []u32{len: a.digits.len, init: 0} bitwise_not_digit_array(a.digits, mut result) return Integer{ digits: result signum: if result.len == 0 { 0 } else { 1 } } } pub fn (a Integer) bitwise_xor(b Integer) Integer { check_sign(a) check_sign(b) mut result := []u32{len: util.imax(a.digits.len, b.digits.len), init: 0} bitwise_xor_digit_array(a.digits, b.digits, mut result) return Integer{ digits: result signum: if result.len == 0 { 0 } else { 1 } } } pub fn (a Integer) lshift(amount u32) Integer { if a.signum == 0 { return a } if amount == 0 { return a } normalised_amount := amount & 31 digit_offset := int(amount >> 5) mut new_array := []u32{len: a.digits.len + digit_offset, init: 0} for index in 0 .. a.digits.len { new_array[index + digit_offset] = a.digits[index] } if normalised_amount > 0 { shift_digits_left(new_array, normalised_amount, mut new_array) } return Integer{ digits: new_array signum: a.signum } } pub fn (a Integer) rshift(amount u32) Integer { if a.signum == 0 { return a } if amount == 0 { return a } normalised_amount := amount & 31 digit_offset := int(amount >> 5) if digit_offset >= a.digits.len { return zero_int } mut new_array := []u32{len: a.digits.len - digit_offset, init: 0} for index in 0 .. new_array.len { new_array[index] = a.digits[index + digit_offset] } if normalised_amount > 0 { shift_digits_right(new_array, normalised_amount, mut new_array) } return Integer{ digits: new_array signum: a.signum } } pub fn (integer Integer) binary_str() string { // We have the zero integer if integer.signum == 0 { return '0' } // Add the sign if present sign_needed := integer.signum == -1 mut result_builder := strings.new_builder(integer.digits.len * 32 + if sign_needed { 1 } else { 0 }) if sign_needed { result_builder.write_string('-') } result_builder.write_string(u32_to_binary_without_lz(integer.digits[integer.digits.len - 1])) for index := integer.digits.len - 2; index >= 0; index-- { result_builder.write_string(u32_to_binary_with_lz(integer.digits[index])) } return result_builder.str() } pub fn (integer Integer) hex() string { // We have the zero integer if integer.signum == 0 { return '0' } // Add the sign if present sign_needed := integer.signum == -1 mut result_builder := strings.new_builder(integer.digits.len * 8 + if sign_needed { 1 } else { 0 }) if sign_needed { result_builder.write_string('-') } result_builder.write_string(u32_to_hex_without_lz(integer.digits[integer.digits.len - 1])) for index := integer.digits.len - 2; index >= 0; index-- { result_builder.write_string(u32_to_hex_with_lz(integer.digits[index])) } return result_builder.str() } pub fn (integer Integer) radix_str(radix u32) string { if integer.signum == 0 { return '0' } return match radix { 2 { integer.binary_str() } 16 { integer.hex() } else { integer.general_radix_str(radix) } } } fn (integer Integer) general_radix_str(radix u32) string { divisor := integer_from_u32(radix) mut rune_array := []rune{} mut current := integer.abs() mut digit := zero_int for current.signum > 0 { current, digit = current.div_mod(divisor) rune_array << big.digit_array[digit.int()] } if integer.signum == -1 { rune_array << `-` } rune_array.reverse_in_place() return rune_array.string() } pub fn (integer Integer) str() string { return integer.radix_str(10) } fn u32_to_binary_without_lz(value u32) string { return strconv.format_uint(value, 2) } fn u32_to_binary_with_lz(value u32) string { mut result_builder := strings.new_builder(32) binary_result := strconv.format_uint(value, 2) result_builder.write_string(strings.repeat(`0`, 32 - binary_result.len)) result_builder.write_string(binary_result) return result_builder.str() } fn u32_to_hex_without_lz(value u32) string { return strconv.format_uint(value, 16) } fn u32_to_hex_with_lz(value u32) string { mut result_builder := strings.new_builder(8) hex_result := strconv.format_uint(value, 16) result_builder.write_string(strings.repeat(`0`, 8 - hex_result.len)) result_builder.write_string(hex_result) return result_builder.str() } pub fn (a Integer) int() int { if a.signum == 0 { return 0 } value := int(a.digits[0] & 0x7fffffff) return value * a.signum } pub fn (a Integer) bytes() ([]byte, int) { if a.signum == 0 { return []byte{len: 0}, 0 } mut result := []byte{cap: a.digits.len * 4} mut mask := u32(0xff000000) mut offset := 24 mut non_zero_found := false for index := a.digits.len - 1; index >= 0; { value := byte((a.digits[index] & mask) >> offset) non_zero_found = non_zero_found || value != 0 if non_zero_found { result << value } mask >>= 8 offset -= 8 if offset < 0 { mask = u32(0xff000000) offset = 24 index-- } } return result, a.signum } pub fn (a Integer) gcd(b Integer) Integer { if a.signum == 0 { return b.abs() } if b.signum == 0 { return a.abs() } if a.signum < 0 { return a.neg().gcd(b) } if b.signum < 0 { return a.gcd(b.neg()) } mut x := a mut y := b mut r := x % y for r.signum != 0 { x = y y = r r = x % y } return y } pub fn (a Integer) factorial() Integer { if a.signum == 0 { return one_int } mut product := one_int mut current := a for current.signum != 0 { product *= current current.dec() } return product } // isqrt returns the closest integer square root of the given integer. pub fn (a Integer) isqrt() Integer { if a.signum < 0 { panic('Cannot obtain square root of negative integer') } if a.signum == 0 { return a } if a.digits.len == 1 && a.digits.last() == 1 { return a } mut shift := a.digits.len * 32 - bits.leading_zeros_32(a.digits.last()) if shift & 1 == 1 { shift += 1 } mut result := zero_int for shift >= 0 { result = result.lshift(1) larger := result + one_int if (larger * larger).abs_cmp(a.rshift(u32(shift))) <= 0 { result = larger } shift -= 2 } return result } [inline] fn bi_min(a Integer, b Integer) Integer { return if a < b { a } else { b } } [inline] fn bi_max(a Integer, b Integer) Integer { return if a > b { a } else { b } } [direct_array_access] fn (bi Integer) msb() u32 { for idx := 0; idx < bi.digits.len; idx += 1 { word := bi.digits[idx] if word > 0 { return u32((idx * 32) + bits.trailing_zeros_32(word)) } } return u32(32) } // Greatest-Common-Divisor https://en.wikipedia.org/wiki/Binary_GCD_algorithm // The code below follows the 2013-christmas-special by D. Lemire & R. Corderoy // https://en.algorithmica.org/hpc/analyzing-performance/gcd/ // // discussion & further info https://lemire.me/blog/2013/12/26/fastest-way-to-compute-the-greatest-common-divisor/ pub fn (x Integer) gcd_binary(y Integer) Integer { // Since standard-euclid-gcd is much faster on smaller sizes 4-8-Byte. // In such a case, one could delegate back to big.Integer.gcd() // Uncomment below and a all long-long goes to euclid-gcd. // // if x.digits.len + y.digits.len <= 4 { // return x.gcd( y ) // } if x.signum == 0 { return y.abs() } if y.signum == 0 { return x.abs() } if x.signum < 0 { return x.neg().gcd(y) } if y.signum < 0 { return x.gcd(y.neg()) } mut a := x mut b := y mut az := a.msb() bz := b.msb() shift := util.umin(az, bz) b = b.rshift(bz) for a.signum != 0 { a = a.rshift(az) diff := b - a az = diff.msb() b = bi_min(a, b) a = diff.abs() } return b.lshift(shift) }