ESC
No recent searches
Search by
Standard Library  /  BigInt

Grain Docs

Welcome to Grain! Editor Setup Getting Grain

The Guide

Hello World The Basics Conditionals Functions Shadowing and Mutation Loops Lists and arrays Custom Data Types Modules Pattern Matching

Reference

Building for Production Built-in Types The Grain CLI Graindoc

Standard Library

Pervasives BigInt Array Buffer Bytes Char Exception Float32 Float64 Hash Int16 Int32 Int64 Int8 Json List Map Marshal Number Option Path PriorityQueue Queue Random Range Rational Regex Result Stack Set String Uint16 Uint32 Uint64 Uint8 Uri wasi / File wasi / Process wasi / Random wasi / Time

BigInt

Utilities for working with the BigInt type.

Edit on GitHub
Added in 0.5.0 No other changes yet. 
from "bigint" include Bigint
9223372036854775809t
0t
-9223372036854775809t

Values

Functions and constants included in the BigInt module.

BigInt.fromNumber

Added in 0.5.0 No other changes yet. 
fromNumber : (number: Number) => BigInt

Converts a Number to a BigInt.

Parameters:

number: The value to convert

Returns:

BigInt: The Number represented as a BigInt

BigInt.toNumber

Added in 0.5.0 No other changes yet. 
toNumber : (num: BigInt) => Number

Converts a BigInt to a Number.

Parameters:

num: The value to convert

Returns:

Number: The BigInt represented as a Number

BigInt.incr

Added in 0.5.0 No other changes yet. 
incr : (num: BigInt) => BigInt

Increments the value by one.

Parameters:

num: The value to increment

Returns:

BigInt: The incremented value

Examples:

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

BigInt.decr

Added in 0.5.0 No other changes yet. 
decr : (num: BigInt) => BigInt

Decrements the value by one.

Parameters:

num: The value to decrement

Returns:

BigInt: The decremented value

Examples:

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

BigInt.neg

Added in 0.5.0 No other changes yet. 
neg : (num: BigInt) => BigInt

Negates the given operand.

Parameters:

num: The operand

Returns:

BigInt: The negated operand

Examples:

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

BigInt.abs

Added in 0.5.0 No other changes yet. 
abs : (num: BigInt) => BigInt

Returns the absolute value of the given operand.

Parameters:

num: The operand

Returns:

BigInt: The operand’s absolute value

Examples:

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

BigInt.(+)

Added in 0.6.0
versionchanges
0.5.0Originally named `add`
 
(+) : (num1: BigInt, num2: BigInt) => BigInt

Computes the sum of its operands.

Parameters:

num1: The first operand
num2: The second operand

Returns:

BigInt: The sum of the two operands

Examples:

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

BigInt.(-)

Added in 0.6.0
versionchanges
0.5.0Originally named `sub`
 
(-) : (num1: BigInt, num2: BigInt) => BigInt

Computes the difference of its operands.

Parameters:

num1: The first operand
num2: The second operand

Returns:

BigInt: The difference of the two operands

Examples:

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

BigInt.(*)

Added in 0.6.0
versionchanges
0.5.0Originally named `mul`
 
(*) : (num1: BigInt, num2: BigInt) => BigInt

Computes the product of its operands.

Parameters:

num1: The first operand
num2: The second operand

Returns:

BigInt: The product of the two operands

Examples:

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

BigInt.(/)

Added in 0.6.0
versionchanges
0.5.0Originally named `div`
 
(/) : (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:

num1: The first operand
num2: The second operand

Returns:

BigInt: The quotient of its operands

Examples:

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

BigInt.rem

Added in 0.5.0 No other changes yet. 
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:

num1: The first operand
num2: The second operand

Returns:

BigInt: The remainder of its operands

Examples:

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

BigInt.quotRem

Added in 0.5.0 No other changes yet. 
quotRem : (num1: BigInt, num2: BigInt) => (BigInt, BigInt)

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

Parameters:

num1: The first operand
num2: The second operand

Returns:

(BigInt, BigInt): The quotient and remainder of its operands

Examples:

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

BigInt.gcd

Added in 0.5.0 No other changes yet. 
gcd : (num1: BigInt, num2: BigInt) => BigInt

Computes the greatest common divisior of the two operands.

Parameters:

num1: The first operand
num2: The second operand

Returns:

BigInt: The greatest common divisor of its operands

Examples:

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

BigInt.(<<)

Added in 0.6.0
versionchanges
0.5.0Originally named `shl`
 
(<<) : (num: BigInt, places: Int32) => BigInt

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

Parameters:

num: The value to shift
places: The number of bits to shift by

Returns:

BigInt: The shifted value

Examples:

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

BigInt.(>>)

Added in 0.6.0
versionchanges
0.5.0Originally named `shr`
 
(>>) : (num: BigInt, places: Int32) => BigInt

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

Parameters:

num: The value to shift
places: The amount to shift by

Returns:

BigInt: The shifted value

Examples:

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

BigInt.eqz

Added in 0.5.0 No other changes yet. 
eqz : (num: BigInt) => Bool

Checks if the given value is equal to zero.

Parameters:

num: The value to inspect

Returns:

Bool: true if the first value is equal to zero or false otherwise

Examples:

assert BigInt.eqz(0t) == true
assert BigInt.eqz(1t) == false

BigInt.(==)

Added in 0.6.0
versionchanges
0.5.0Originally named `eq`
 
(==) : (num1: BigInt, num2: BigInt) => Bool

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

Parameters:

num1: The first value
num2: The second value

Returns:

Bool: true if the first value is equal to the second value or false otherwise

Examples:

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

BigInt.(!=)

Added in 0.6.0
versionchanges
0.5.0Originally named `ne`
 
(!=) : (num1: BigInt, num2: BigInt) => Bool

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

Parameters:

num1: The first value
num2: The second value

Returns:

Bool: true if the first value is not equal to the second value or false otherwise

Examples:

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

BigInt.(<)

Added in 0.6.0
versionchanges
0.5.0Originally named `lt`
 
(<) : (num1: BigInt, num2: BigInt) => Bool

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

Parameters:

num1: The first value
num2: The second value

Returns:

Bool: true if the first value is less than the second value or false otherwise

Examples:

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

BigInt.(<=)

Added in 0.6.0
versionchanges
0.5.0Originally named `lte`
 
(<=) : (num1: BigInt, num2: BigInt) => Bool

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

Parameters:

num1: The first value
num2: The second value

Returns:

Bool: true if the first value is less than or equal to the second value or false otherwise

Examples:

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

BigInt.(>)

Added in 0.6.0
versionchanges
0.5.0Originally named `gt`
 
(>) : (num1: BigInt, num2: BigInt) => Bool

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

Parameters:

num1: The first value
num2: The second value

Returns:

Bool: true if the first value is greater than the second value or false otherwise

Examples:

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

BigInt.(>=)

Added in 0.6.0
versionchanges
0.5.0Originally named `gte`
 
(>=) : (num1: BigInt, num2: BigInt) => Bool

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

Parameters:

num1: The first value
num2: The second value

Returns:

Bool: true if the first value is greater than or equal to the second value or false otherwise

Examples:

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

BigInt.lnot

Added in 0.5.0 No other changes yet. 
lnot : (num: BigInt) => BigInt

Computes the bitwise NOT of the given value.

Parameters:

num: The given value

Returns:

BigInt: Containing the inverted bits of the given value

Examples:

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

BigInt.(&)

Added in 0.6.0
versionchanges
0.5.0Originally named `land`
 
(&) : (num1: BigInt, num2: BigInt) => BigInt

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

Parameters:

num1: The first operand
num2: The second operand

Returns:

BigInt: Containing a 1 in each bit position for which the corresponding bits of both operands are 1

Examples:

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

BigInt.(|)

Added in 0.6.0
versionchanges
0.5.0Originally named `lor`
 
(|) : (num1: BigInt, num2: BigInt) => BigInt

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

Parameters:

num1: The first operand
num2: The second operand

Returns:

BigInt: Containing a 1 in each bit position for which the corresponding bits of either or both operands are 1

Examples:

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

BigInt.(^)

Added in 0.6.0
versionchanges
0.5.0Originally named `lxor`
 
(^) : (num1: BigInt, num2: BigInt) => BigInt

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

Parameters:

num1: The first operand
num2: The second operand

Returns:

BigInt: Containing a 1 in each bit position for which the corresponding bits of either but not both operands are 1

Examples:

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

BigInt.clz

Added in 0.5.0 No other changes yet. 
clz : (num: BigInt) => Int32

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

Parameters:

num: The value to inspect

Returns:

Int32: The amount of leading zeros

Examples:

BigInt.clz(5t) == 2147483647t

BigInt.ctz

Added in 0.5.0 No other changes yet. 
ctz : (num: BigInt) => Int64

Counts the number of trailing zero bits in the value.

Parameters:

num: The value to inspect

Returns:

Int64: The amount of trailing zeros

Examples:

BigInt.ctz(14t) == 1t

BigInt.popcnt

Added in 0.5.0 No other changes yet. 
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:

num: The value to inspect

Returns:

Option<Int64>: The amount of 1-bits in its operand

Examples:

BigInt.popcnt(14t) == 1t

BigInt.toString

Added in 0.5.0 No other changes yet. 
toString : (num: BigInt) => String

Converts the given operand to a string.

Parameters:

num: The operand

Returns:

String: The operand, as a string

Examples:

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

Sign up for farm-to-inbox developer news

You can unsubscribe at any time. Read our privacy policy.

Copyright © 2024 The Grain Programming Language