Nat8.md

Nat8

8-bit unsigned integers with checked arithmetic

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

Type Nat8

type Nat8 = Prim.Types.Nat8

8-bit natural numbers.

Value toNat

let toNat : Nat8 -> Nat

Conversion.

Value fromNat

let fromNat : Nat -> Nat8

Conversion. Traps on overflow/underflow.

Value fromIntWrap

let fromIntWrap : Int -> Nat8

Conversion. Wraps on overflow/underflow.

Function toText

func toText(x : Nat8) : Text

Returns the Text representation of x.

Function min

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

Returns the minimum of x and y.

Function max

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

Returns the maximum of x and y.

Function equal

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

Returns x == y.

Function notEqual

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

Returns x != y.

Function less

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

Returns x < y.

Function lessOrEqual

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

Returns x <= y.

Function greater

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

Returns x > y.

Function greaterOrEqual

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

Returns x >= y.

Function compare

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

Returns the order of x and y.

Function add

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

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

Function sub

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

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

Function mul

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

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

Function div

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

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

Function rem

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

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

Function pow

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

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

Function bitnot

func bitnot(x : Nat8, y : Nat8) : Nat8

Returns the bitwise negation of x, ^x.

Function bitand

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

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

Function bitor

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

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

Function bitxor

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

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

Function bitshiftLeft

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

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

Function bitshiftRight

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

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

Function bitrotLeft

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

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

Function bitrotRight

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

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

Function bittest

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

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

Function bitset

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

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

Function bitclear

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

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

Function bitflip

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

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

Value bitcountNonZero

let bitcountNonZero : (x : Nat8) -> Nat8

Returns the count of non-zero bits in x.

Value bitcountLeadingZero

let bitcountLeadingZero : (x : Nat8) -> Nat8

Returns the count of leading zero bits in x.

Value bitcountTrailingZero

let bitcountTrailingZero : (x : Nat8) -> Nat8

Returns the count of trailing zero bits in x.

Function addWrap

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

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

Function subWrap

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

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

Function mulWrap

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

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

Function powWrap

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

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