Skip to main content

Nat64

64-bit unsigned integers with checked arithmetic

Most operations are available as built-in operators (e.g. 1 + 1).

Type Nat64​

type Nat64 = Prim.Types.Nat64

64-bit natural numbers.

Value toNat​

let toNat : Nat64 -> Nat

Conversion.

Value fromNat​

let fromNat : Nat -> Nat64

Conversion. Traps on overflow/underflow.

Value fromIntWrap​

let fromIntWrap : Int -> Nat64

Conversion. Wraps on overflow/underflow.

Function toText​

func toText(x : Nat64) : Text

Returns the Text representation of x.

Function min​

func min(x : Nat64, y : Nat64) : Nat64

Returns the minimum of x and y.

Function max​

func max(x : Nat64, y : Nat64) : Nat64

Returns the maximum of x and y.

Function equal​

func equal(x : Nat64, y : Nat64) : Bool

Returns x == y.

Function notEqual​

func notEqual(x : Nat64, y : Nat64) : Bool

Returns x != y.

Function less​

func less(x : Nat64, y : Nat64) : Bool

Returns x < y.

Function lessOrEqual​

func lessOrEqual(x : Nat64, y : Nat64) : Bool

Returns x <= y.

Function greater​

func greater(x : Nat64, y : Nat64) : Bool

Returns x > y.

Function greaterOrEqual​

func greaterOrEqual(x : Nat64, y : Nat64) : Bool

Returns x >= y.

Function compare​

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

Returns the order of x and y.

Function add​

func add(x : Nat64, y : Nat64) : Nat64

Returns the sum of x and y, x + y. Traps on overflow.

Function sub​

func sub(x : Nat64, y : Nat64) : Nat64

Returns the difference of x and y, x - y. Traps on underflow.

Function mul​

func mul(x : Nat64, y : Nat64) : Nat64

Returns the product of x and y, x * y. Traps on overflow.

Function div​

func div(x : Nat64, y : Nat64) : Nat64

Returns the division of x by y, x / y. Traps when y is zero.

Function rem​

func rem(x : Nat64, y : Nat64) : Nat64

Returns the remainder of x divided by y, x % y. Traps when y is zero.

Function pow​

func pow(x : Nat64, y : Nat64) : Nat64

Returns x to the power of y, x ** y. Traps on overflow.

Function bitnot​

func bitnot(x : Nat64) : Nat64

Returns the bitwise negation of x, ^x.

Function bitand​

func bitand(x : Nat64, y : Nat64) : Nat64

Returns the bitwise and of x and y, x & y.

Function bitor​

func bitor(x : Nat64, y : Nat64) : Nat64

Returns the bitwise or of x and y, x \| y.

Function bitxor​

func bitxor(x : Nat64, y : Nat64) : Nat64

Returns the bitwise exclusive or of x and y, x ^ y.

Function bitshiftLeft​

func bitshiftLeft(x : Nat64, y : Nat64) : Nat64

Returns the bitwise shift left of x by y, x << y.

Function bitshiftRight​

func bitshiftRight(x : Nat64, y : Nat64) : Nat64

Returns the bitwise shift right of x by y, x >> y.

Function bitrotLeft​

func bitrotLeft(x : Nat64, y : Nat64) : Nat64

Returns the bitwise rotate left of x by y, x <<> y.

Function bitrotRight​

func bitrotRight(x : Nat64, y : Nat64) : Nat64

Returns the bitwise rotate right of x by y, x <>> y.

Function bittest​

func bittest(x : Nat64, p : Nat) : Bool

Returns the value of bit p mod 64 in x, (x & 2^(p mod 64)) == 2^(p mod 64).

Function bitset​

func bitset(x : Nat64, p : Nat) : Nat64

Returns the value of setting bit p mod 64 in x to 1.

Function bitclear​

func bitclear(x : Nat64, p : Nat) : Nat64

Returns the value of clearing bit p mod 64 in x to 0.

Function bitflip​

func bitflip(x : Nat64, p : Nat) : Nat64

Returns the value of flipping bit p mod 64 in x.

Value bitcountNonZero​

let bitcountNonZero : (x : Nat64) -> Nat64

Returns the count of non-zero bits in x.

Value bitcountLeadingZero​

let bitcountLeadingZero : (x : Nat64) -> Nat64

Returns the count of leading zero bits in x.

Value bitcountTrailingZero​

let bitcountTrailingZero : (x : Nat64) -> Nat64

Returns the count of trailing zero bits in x.

Function addWrap​

func addWrap(x : Nat64, y : Nat64) : Nat64

Returns the sum of x and y, x +% y. Wraps on overflow.

Function subWrap​

func subWrap(x : Nat64, y : Nat64) : Nat64

Returns the difference of x and y, x -% y. Wraps on underflow.

Function mulWrap​

func mulWrap(x : Nat64, y : Nat64) : Nat64

Returns the product of x and y, x *% y. Wraps on overflow.

Function powWrap​

func powWrap(x : Nat64, y : Nat64) : Nat64

Returns x to the power of y, x **% y. Wraps on overflow.