Nat16
16-bit unsigned integers with checked arithmetic
Most operations are available as built-in operators (e.g. 1 + 1).
Type Nat16
type Nat16 = Prim.Types.Nat16
16-bit natural numbers.
Value toNat
let toNat : Nat16 -> Nat
Conversion.
Value fromNat
let fromNat : Nat -> Nat16
Conversion. Traps on overflow/underflow.
Value fromIntWrap
let fromIntWrap : Int -> Nat16
Conversion. Wraps on overflow/underflow.
Function toText
func toText(x : Nat16) : Text
Returns the Text representation of x.
Function min
func min(x : Nat16, y : Nat16) : Nat16
Returns the minimum of x and y.
Function max
func max(x : Nat16, y : Nat16) : Nat16
Returns the maximum of x and y.
Function equal
func equal(x : Nat16, y : Nat16) : Bool
Returns x == y.
Function notEqual
func notEqual(x : Nat16, y : Nat16) : Bool
Returns x != y.
Function less
func less(x : Nat16, y : Nat16) : Bool
Returns x < y.
Function lessOrEqual
func lessOrEqual(x : Nat16, y : Nat16) : Bool
Returns x <= y.
Function greater
func greater(x : Nat16, y : Nat16) : Bool
Returns x > y.
Function greaterOrEqual
func greaterOrEqual(x : Nat16, y : Nat16) : Bool
Returns x >= y.
Function compare
func compare(x : Nat16, y : Nat16) : {#less; #equal; #greater}
Returns the order of x and y.
Function add
func add(x : Nat16, y : Nat16) : Nat16
Returns the sum of x and y, x + y. Traps on overflow.
Function sub
func sub(x : Nat16, y : Nat16) : Nat16
Returns the difference of x and y, x - y. Traps on underflow.
Function mul
func mul(x : Nat16, y : Nat16) : Nat16
Returns the product of x and y, x * y. Traps on overflow.
Function div
func div(x : Nat16, y : Nat16) : Nat16
Returns the division of x by y, x / y.
Traps when y is zero.
Function rem
func rem(x : Nat16, y : Nat16) : Nat16
Returns the remainder of x divided by y, x % y.
Traps when y is zero.
Function pow
func pow(x : Nat16, y : Nat16) : Nat16
Returns x to the power of y, x ** y. Traps on overflow.
Function bitnot
func bitnot(x : Nat16, y : Nat16) : Nat16
Returns the bitwise negation of x, ^x.
Function bitand
func bitand(x : Nat16, y : Nat16) : Nat16
Returns the bitwise and of x and y, x & y.
Function bitor
func bitor(x : Nat16, y : Nat16) : Nat16
Returns the bitwise or of x and y, x \| y.
Function bitxor
func bitxor(x : Nat16, y : Nat16) : Nat16
Returns the bitwise exclusive or of x and y, x ^ y.
Function bitshiftLeft
func bitshiftLeft(x : Nat16, y : Nat16) : Nat16
Returns the bitwise shift left of x by y, x << y.
Function bitshiftRight
func bitshiftRight(x : Nat16, y : Nat16) : Nat16
Returns the bitwise shift right of x by y, x >> y.
Function bitrotLeft
func bitrotLeft(x : Nat16, y : Nat16) : Nat16
Returns the bitwise rotate left of x by y, x <<> y.
Function bitrotRight
func bitrotRight(x : Nat16, y : Nat16) : Nat16
Returns the bitwise rotate right of x by y, x <>> y.
Function bittest
func bittest(x : Nat16, p : Nat) : Bool
Returns the value of bit p mod 16 in x, (x & 2^(p mod 16)) == 2^(p mod 16).
Function bitset
func bitset(x : Nat16, p : Nat) : Nat16
Returns the value of setting bit p mod 16 in x to 1.
Function bitclear
func bitclear(x : Nat16, p : Nat) : Nat16
Returns the value of clearing bit p mod 16 in x to 0.
Function bitflip
func bitflip(x : Nat16, p : Nat) : Nat16
Returns the value of flipping bit p mod 16 in x.
Value bitcountNonZero
let bitcountNonZero : (x : Nat16) -> Nat16
Returns the count of non-zero bits in x.
Value bitcountLeadingZero
let bitcountLeadingZero : (x : Nat16) -> Nat16
Returns the count of leading zero bits in x.
Value bitcountTrailingZero
let bitcountTrailingZero : (x : Nat16) -> Nat16
Returns the count of trailing zero bits in x.
Function addWrap
func addWrap(x : Nat16, y : Nat16) : Nat16
Returns the sum of x and y, x +% y. Wraps on overflow.
Function subWrap
func subWrap(x : Nat16, y : Nat16) : Nat16
Returns the difference of x and y, x -% y. Wraps on underflow.
Function mulWrap
func mulWrap(x : Nat16, y : Nat16) : Nat16
Returns the product of x and y, x *% y. Wraps on overflow.
Function powWrap
func powWrap(x : Nat16, y : Nat16) : Nat16
Returns x to the power of y, x **% y. Wraps on overflow.