BigInt

Utilities for working with the BigInt type.

1

import BigInt from "bigint"

Conversions

Functions for converting between Numbers and the BigInt type.

BigInt.fromNumber

1

fromNumber : Number -> BigInt

Converts a Number to a BigInt.

Parameters:

Returns:

BigInt.toNumber

1

toNumber : BigInt -> Number

Converts a BigInt to a Number.

Parameters:

Returns:

Operations

Mathematical operations for BigInt values.

BigInt.incr

1

incr : BigInt -> BigInt

Increments the value by one.

Parameters:

Returns:

BigInt.decr

1

decr : BigInt -> BigInt

Decrements the value by one.

Parameters:

Returns:

BigInt.neg

1

neg : BigInt -> BigInt

Negates the given operand.

Parameters:

Returns:

BigInt.abs

1

abs : BigInt -> BigInt

Returns the absolute value of the given operand.

Parameters:

Returns:

BigInt.add

1

add : (BigInt, BigInt) -> BigInt

Computes the sum of its operands.

Parameters:

Returns:

BigInt.sub

1

sub : (BigInt, BigInt) -> BigInt

Computes the difference of its operands.

Parameters:

Returns:

BigInt.mul

1

mul : (BigInt, BigInt) -> BigInt

Computes the product of its operands.

Parameters:

Returns:

BigInt.div

1

div : (BigInt, BigInt) -> BigInt

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

Parameters:

Returns:

BigInt.rem

1

rem : (BigInt, 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:

BigInt.quotRem

1

quotRem : (BigInt, BigInt) -> (BigInt, BigInt)

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

Parameters:

Returns:

BigInt.gcd

1

gcd : (BigInt, BigInt) -> BigInt

Computes the greatest common divisior of the two operands.

Parameters:

Returns:

Bitwise operations

Functions for operating on bits of BigInt values.

BigInt.shl

1

shl : (BigInt, Int32) -> BigInt

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

Parameters:

Returns:

BigInt.shr

1

shr : (BigInt, Int32) -> BigInt

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

Parameters:

Returns:

Comparisons

Functions for comparing BigInt values.

BigInt.eqz

1

eqz : BigInt -> Bool

Checks if the given value is equal to zero.

Parameters:

Returns:

BigInt.eq

1

eq : (BigInt, BigInt) -> Bool

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

Parameters:

Returns:

BigInt.ne

1

ne : (BigInt, BigInt) -> Bool

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

Parameters:

Returns:

BigInt.lt

1

lt : (BigInt, BigInt) -> Bool

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

Parameters:

Returns:

BigInt.lte

1

lte : (BigInt, BigInt) -> Bool

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

Parameters:

Returns:

BigInt.gt

1

gt : (BigInt, BigInt) -> Bool

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

Parameters:

Returns:

BigInt.gte

1

gte : (BigInt, BigInt) -> Bool

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

Parameters:

Returns:

Bitwise logic

Boolean operations on the bits of BigInt values.

BigInt.lnot

1

lnot : BigInt -> BigInt

Computes the bitwise NOT of the given value.

Parameters:

Returns:

BigInt.land

1

land : (BigInt, BigInt) -> BigInt

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

Parameters:

Returns:

BigInt.lor

1

lor : (BigInt, BigInt) -> BigInt

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

Parameters:

Returns:

BigInt.lxor

1

lxor : (BigInt, BigInt) -> BigInt

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

Parameters:

Returns:

BigInt.clz

1

clz : BigInt -> Int32

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

Parameters:

Returns:

BigInt.ctz

1

ctz : BigInt -> Int64

Counts the number of trailing zero bits in the value.

Parameters:

Returns:

BigInt.popcnt

1

popcnt : 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:

Other

Other functions on BigInts.

BigInt.toString

1

toString : BigInt -> String

Converts the given operand to a string.

Parameters:

Returns: