BigInt

Utilities for working with the BigInt type.

1

from "bigint" include Bigint

1

9223372036854775809t

1

0t

1

-9223372036854775809t

Values

Functions and constants included in the BigInt module.

BigInt.fromNumber

1

fromNumber : (number: Number) => BigInt

Converts a Number to a BigInt.

Parameters:

Returns:

BigInt.toNumber

1

toNumber : (num: BigInt) => Number

Converts a BigInt to a Number.

Parameters:

Returns:

BigInt.incr

1

incr : (num: BigInt) => BigInt

Increments the value by one.

Parameters:

Returns:

Examples:

1

BigInt.incr(1t) == 2t

1

BigInt.incr(-2t) == -1t

BigInt.decr

1

decr : (num: BigInt) => BigInt

Decrements the value by one.

Parameters:

Returns:

Examples:

1

BigInt.decr(2t) == 1t

1

BigInt.decr(-2t) == -3t

BigInt.neg

1

neg : (num: BigInt) => BigInt

Negates the given operand.

Parameters:

Returns:

Examples:

1

BigInt.neg(1t) == -1t

1

BigInt.neg(-1t) == 1t

BigInt.abs

1

abs : (num: BigInt) => BigInt

Returns the absolute value of the given operand.

Parameters:

Returns:

Examples:

1

BigInt.abs(1t) == 1t

1

BigInt.abs(-1t) == 1t

BigInt.(+)

1

(+) : (num1: BigInt, num2: BigInt) => BigInt

Computes the sum of its operands.

Parameters:

Returns:

Examples:

1
2

use BigInt.{ (+) }
assert 1t + 1t == 2t

BigInt.(-)

1

(-) : (num1: BigInt, num2: BigInt) => BigInt

Computes the difference of its operands.

Parameters:

Returns:

Examples:

1
2

use BigInt.{ (-) }
assert 3t - 1t == 2t

BigInt.(*)

1

(*) : (num1: BigInt, num2: BigInt) => BigInt

Computes the product of its operands.

Parameters:

Returns:

Examples:

1
2

use BigInt.{ (*) }
assert 3t * 3t == 9t

BigInt.(/)

1

(/) : (num1: BigInt, num2: BigInt) => BigInt

Computes the quotient of its operands using signed (truncated) division (in which the quotient is always rounded towards zero).

Parameters:

Returns:

Examples:

1
2

use BigInt.{ (/) }
assert 9t / 3t == 3t

BigInt.rem

1

rem : (num1: BigInt, num2: BigInt) => BigInt

Computes the remainder of the division of its operands using signed (truncated) division (in which the quotient is always rounded towards zero).

Parameters:

Returns:

Examples:

1

BigInt.rem(3t, 2t) == 1t

BigInt.quotRem

1

quotRem : (num1: BigInt, num2: BigInt) => (BigInt, BigInt)

Computes the quotient and remainder of its operands using signed (truncated) division.

Parameters:

Returns:

Examples:

1

BigInt.quotRem(7t, 2t) == (3t, 1t))

BigInt.gcd

1

gcd : (num1: BigInt, num2: BigInt) => BigInt

Computes the greatest common divisior of the two operands.

Parameters:

Returns:

Examples:

1

BigInt.gcd(36t, 24t) == 12t

BigInt.(<<)

1

(<<) : (num: BigInt, places: Int32) => BigInt

Shifts the bits of the value left by the given number of bits.

Parameters:

Returns:

Examples:

1
2

use BigInt.{ (<<) }
assert (10t << 2l) == 40t

BigInt.(>>)

1

(>>) : (num: BigInt, places: Int32) => BigInt

Shifts the bits of the value right by the given number of bits, preserving the sign bit.

Parameters:

Returns:

Examples:

1
2

use BigInt.{ (>>) }
assert (9999t >> 2l) == 2499t

BigInt.eqz

1

eqz : (num: BigInt) => Bool

Checks if the given value is equal to zero.

Parameters:

Returns:

Examples:

1

assert BigInt.eqz(0t) == true

1

assert BigInt.eqz(1t) == false

BigInt.(==)

1

(==) : (num1: BigInt, num2: BigInt) => Bool

Checks if the first value is equal to the second value.

Parameters:

Returns:

Examples:

1
2

use BigInt.{ (==) }
assert 1t == 1t

1
2

use BigInt.{ (==) }
assert -10t == -10t

BigInt.(!=)

1

(!=) : (num1: BigInt, num2: BigInt) => Bool

Checks if the first value is not equal to the second value.

Parameters:

Returns:

Examples:

1
2

use BigInt.{ (!=) }
assert 1t != 2t

1
2

use BigInt.{ (!=) }
assert -10t != -20t

BigInt.(<)

1

(<) : (num1: BigInt, num2: BigInt) => Bool

Checks if the first value is less than the second value.

Parameters:

Returns:

Examples:

1
2

use BigInt.{ (<) }
assert 1t < 2t

1
2

use BigInt.{ (<) }
assert -10t < 0t

BigInt.(<=)

1

(<=) : (num1: BigInt, num2: BigInt) => Bool

Checks if the first value is less than or equal to the second value.

Parameters:

Returns:

Examples:

1
2

use BigInt.{ (<=) }
assert 1t <= 1t

1
2

use BigInt.{ (<=) }
assert -10t <= 0t

1
2

use BigInt.{ (<=) }
assert 2t <= 3t

BigInt.(>)

1

(>) : (num1: BigInt, num2: BigInt) => Bool

Checks if the first value is greater than the second value.

Parameters:

Returns:

Examples:

1
2

use BigInt.{ (>) }
assert 2t > 1t

1
2

use BigInt.{ (>) }
assert 0t > -10t

BigInt.(>=)

1

(>=) : (num1: BigInt, num2: BigInt) => Bool

Checks if the first value is greater than or equal to the second value.

Parameters:

Returns:

Examples:

1
2

use BigInt.{ (>=) }
assert 1t >= 1t

1
2

use BigInt.{ (>=) }
assert 0t >= -10t

1
2

use BigInt.{ (>=) }
assert 3t >= 2t

BigInt.lnot

1

lnot : (num: BigInt) => BigInt

Computes the bitwise NOT of the given value.

Parameters:

Returns:

Examples:

1

BigInt.lnot(91234t) == -91235t

BigInt.(&)

1

(&) : (num1: BigInt, num2: BigInt) => BigInt

Computes the bitwise AND (&) on the given operands.

Parameters:

Returns:

Examples:

1
2

use BigInt.{ (&) }
assert (4t & 3t) == 0t

BigInt.(|)

1

(|) : (num1: BigInt, num2: BigInt) => BigInt

Computes the bitwise OR (|) on the given operands.

Parameters:

Returns:

Examples:

1
2

use BigInt.{ (|) }
assert (5t | 3t) == 7t

BigInt.(^)

1

(^) : (num1: BigInt, num2: BigInt) => BigInt

Computes the bitwise XOR (^) on the given operands.

Parameters:

Returns:

Examples:

1
2

use BigInt.{ (^) }
assert (5t ^ 3t) == 6t

BigInt.clz

1

clz : (num: BigInt) => Int32

Counts the number of leading zero bits in the value. Will return the maximum integer for negative numbers.

Parameters:

Returns:

Examples:

1

BigInt.clz(5t) == 2147483647t

BigInt.ctz

1

ctz : (num: BigInt) => Int64

Counts the number of trailing zero bits in the value.

Parameters:

Returns:

Examples:

1

BigInt.ctz(14t) == 1t

BigInt.popcnt

1

popcnt : (num: BigInt) => Option<Int64>

Counts the number of bits set to 1 in the value, also known as a population count. Will return the None if given a negative integer

Parameters:

Returns:

Examples:

1

BigInt.popcnt(14t) == 1t

BigInt.toString

1

toString : (num: BigInt) => String

Converts the given operand to a string.

Parameters:

Returns:

Examples:

1

BigInt.toString(1t) == "1"

1

BigInt.toString(-1t) == "-1"