Int

Signed integer numbers with infinite precision (also called big integers).

:::note Most operations on integer numbers (e.g. addition) are available as built-in operators (e.g. -1 + 1). This module provides equivalent functions and Text conversion. :::

:::info Function form for higher-order use

Several arithmetic and comparison functions (e.g. add, sub, equal, less, pow) are defined in this module to enable their use as first-class function values, which is not possible with operators like +, -, ==, etc., in Motoko. This allows you to pass these operations to higher-order functions such as map, foldLeft, or sort. :::

Import from the base library to use this module.

motoko name=import
import Int "mo:base/Int";

type Int = Prim.Types.Int

Infinite precision signed integers.

public func abs(x : Int) : Nat

Returns the absolute value of x.

Example:

motoko include=import
Int.abs(-12) // => 12

public func toText(x : Int) : Text

Converts an integer number to its textual representation. Textual representation do not contain underscores to represent commas.

Example:

motoko include=import
Int.toText(-1234) // => "-1234"

public func min(x : Int, y : Int) : Int

Returns the minimum of x and y.

Example:

motoko include=import
Int.min(2, -3) // => -3

public func max(x : Int, y : Int) : Int

Returns the maximum of x and y.

Example:

motoko include=import
Int.max(2, -3) // => 2

public func hash(i : Int) : Hash.Hash

Computes a hash from the least significant 32-bits of i, ignoring other bits. @deprecated For large Int values consider using a bespoke hash function that considers all of the argument's bits.

public func hashAcc(h1 : Hash.Hash, i : Int) : Hash.Hash

Computes an accumulated hash from h1 and the least significant 32-bits of i, ignoring other bits in i.

@deprecated For large Int values consider using a bespoke hash function that considers all of the argument's bits.

public func equal(x : Int, y : Int) : Bool

Equality function for Int types. This is equivalent to x == y.

Example:

motoko include=import
Int.equal(-1, -1); // => true

Example:

motoko include=import
import Buffer "mo:base/Buffer";

let buffer1 = Buffer.Buffer<Int>(1);
buffer1.add(-3);
let buffer2 = Buffer.Buffer<Int>(1);
buffer2.add(-3);
Buffer.equal(buffer1, buffer2, Int.equal) // => true

public func notEqual(x : Int, y : Int) : Bool

Inequality function for Int types. This is equivalent to x != y.

Example:

motoko include=import
Int.notEqual(-1, -2); // => true

public func less(x : Int, y : Int) : Bool

"Less than" function for Int types. This is equivalent to x < y.

Example:

motoko include=import
Int.less(-2, 1); // => true

public func lessOrEqual(x : Int, y : Int) : Bool

"Less than or equal" function for Int types. This is equivalent to x <= y.

Example:

motoko include=import
Int.lessOrEqual(-2, 1); // => true

public func greater(x : Int, y : Int) : Bool

"Greater than" function for Int types. This is equivalent to x > y.

Example:

motoko include=import
Int.greater(1, -2); // => true

public func greaterOrEqual(x : Int, y : Int) : Bool

"Greater than or equal" function for Int types. This is equivalent to x >= y.

Example:

motoko include=import
Int.greaterOrEqual(1, -2); // => true

public func compare(x : Int, y : Int) : {#less; #equal; #greater}

General-purpose comparison function for Int. Returns the Order ( either #less, #equal, or #greater) of comparing x with y.

Example:

motoko include=import
Int.compare(-3, 2) // => #less

This function can be used as value for a high order function, such as a sort function.

Example:

motoko include=import
import Array "mo:base/Array";
Array.sort([1, -2, -3], Int.compare) // => [-3, -2, 1]

public func neg(x : Int) : Int

Returns the negation of x, -x .

Example:

motoko include=import
Int.neg(123) // => -123

public func add(x : Int, y : Int) : Int

Returns the sum of x and y, x + y.

No overflow since Int has infinite precision.

Example:

motoko include=import
Int.add(1, -2); // => -1

Example:

motoko include=import
import Array "mo:base/Array";
Array.foldLeft([1, -2, -3], 0, Int.add) // => -4

public func sub(x : Int, y : Int) : Int

Returns the difference of x and y, x - y.

No overflow since Int has infinite precision.

Example:

motoko include=import
Int.sub(1, 2); // => -1

Example:

motoko include=import
import Array "mo:base/Array";
Array.foldLeft([1, -2, -3], 0, Int.sub) // => 4

public func mul(x : Int, y : Int) : Int

Returns the product of x and y, x * y.

No overflow since Int has infinite precision.

Example:

motoko include=import
Int.mul(-2, 3); // => -6

Example:

motoko include=import
import Array "mo:base/Array";
Array.foldLeft([1, -2, -3], 1, Int.mul) // => 6

public func div(x : Int, y : Int) : Int

Returns the signed integer division of x by y, x / y. Rounds the quotient towards zero, which is the same as truncating the decimal places of the quotient.

Traps when y is zero.

Example:

motoko include=import
Int.div(6, -2); // => -3

public func rem(x : Int, y : Int) : Int

Returns the remainder of the signed integer division of x by y, x % y, which is defined as x - x / y * y.

Traps when y is zero.

Example:

motoko include=import
Int.rem(6, -4); // => 2

public func pow(x : Int, y : Int) : Int

Returns x to the power of y, x ** y.

Traps when y is negative or y > 2 ** 32 - 1. No overflow since Int has infinite precision.

Example:

motoko include=import
Int.pow(-2, 3); // => -8