Uint16

Utilities for working with the Uint16 type.

1

from "uint16" include Uint16

1

1uS

1

10uS

Values

Functions and constants included in the Uint16 module.

Uint16.fromNumber

1

fromNumber : (number: Number) => Uint16

Converts a Number to a Uint16.

Parameters:

Returns:

Uint16.toNumber

1

toNumber : (value: Uint16) => Number

Converts a Uint16 to a Number.

Parameters:

Returns:

Uint16.fromInt16

1

fromInt16 : (number: Int16) => Uint16

Converts an Int16 to a Uint16.

Parameters:

Returns:

Examples:

1

Uint16.fromInt16(1uS) == 1uS

1

Uint16.fromInt16(-1uS) == 65535uS

Uint16.incr

1

incr : (value: Uint16) => Uint16

Increments the value by one.

Parameters:

Returns:

Examples:

1

Uint16.incr(1uS) == 2uS

Uint16.decr

1

decr : (value: Uint16) => Uint16

Decrements the value by one.

Parameters:

Returns:

Examples:

1

Uint16.decr(1uS) == 0uS

1

Uint16.decr(0uS) == 65535uS

Uint16.(+)

1

(+) : (x: Uint16, y: Uint16) => Uint16

Computes the sum of its operands.

Parameters:

Returns:

Examples:

1
2

use Uint16.{ (+) }
assert 1uS + 1uS == 2uS

Uint16.(-)

1

(-) : (x: Uint16, y: Uint16) => Uint16

Computes the difference of its operands.

Parameters:

Returns:

Examples:

1
2

use Uint16.{ (-) }
assert 2uS - 1uS == 1uS

Uint16.(*)

1

(*) : (x: Uint16, y: Uint16) => Uint16

Computes the product of its operands.

Parameters:

Returns:

Examples:

1
2

use Uint16.{ (*) }
assert 2uS * 2uS == 4uS

Uint16.(/)

1

(/) : (x: Uint16, y: Uint16) => Uint16

Computes the quotient of its operands.

Parameters:

Returns:

Examples:

1
2

use Uint16.{ (/) }
assert 5uS / 2uS == 2uS

Uint16.rem

1

rem : (x: Uint16, y: Uint16) => Uint16

Computes the remainder of the division of its operands.

Parameters:

Returns:

Examples:

1

Uint16.rem(5uS, 2uS) == 1uS

Uint16.(<<)

1

(<<) : (value: Uint16, amount: Uint16) => Uint16

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

Parameters:

Returns:

Examples:

1
2

use Uint16.{ (<<) }
assert (5uS << 1uS) == 10uS

Uint16.(>>>)

1

(>>>) : (value: Uint16, amount: Uint16) => Uint16

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

Parameters:

Returns:

Examples:

1
2

use Uint16.{ (>>>) }
assert (5uS >>> 1uS) == 2uS

Uint16.(==)

1

(==) : (x: Uint16, y: Uint16) => Bool

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

Parameters:

Returns:

Examples:

1
2

use Uint16.{ (==) }
assert 1uS == 1uS

Uint16.(!=)

1

(!=) : (x: Uint16, y: Uint16) => Bool

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

Parameters:

Returns:

Examples:

1
2

use Uint16.{ (!=) }
assert 1uS != 3uS

Uint16.(<)

1

(<) : (x: Uint16, y: Uint16) => Bool

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

Parameters:

Returns:

Examples:

1
2

use Uint16.{ (<) }
assert 1uS < 5uS

Uint16.(>)

1

(>) : (x: Uint16, y: Uint16) => Bool

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

Parameters:

Returns:

Examples:

1
2

use Uint16.{ (>) }
assert 4uS > 2uS

Uint16.(<=)

1

(<=) : (x: Uint16, y: Uint16) => Bool

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

Parameters:

Returns:

Examples:

1
2

use Uint16.{ (<=) }
assert 1uS <= 2uS

1
2

use Uint16.{ (<=) }
assert 1uS <= 1uS

Uint16.(>=)

1

(>=) : (x: Uint16, y: Uint16) => Bool

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

Parameters:

Returns:

Examples:

1
2

use Uint16.{ (>=) }
assert 3uS >= 2uS

1
2

use Uint16.{ (>=) }
assert 1uS >= 1uS

Uint16.lnot

1

lnot : (value: Uint16) => Uint16

Computes the bitwise NOT of the given value.

Parameters:

Returns:

Examples:

1

Uint16.lnot(5uS) == 65530uS

Uint16.(&)

1

(&) : (x: Uint16, y: Uint16) => Uint16

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

Parameters:

Returns:

Examples:

1
2

use Uint16.{ (&) }
assert (3uS & 4uS) == 0uS

Uint16.(|)

1

(|) : (x: Uint16, y: Uint16) => Uint16

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

Parameters:

Returns:

Examples:

1
2

use Uint16.{ (|) }
assert (3uS | 4uS) == 7uS

Uint16.(^)

1

(^) : (x: Uint16, y: Uint16) => Uint16

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

Parameters:

Returns:

Examples:

1
2

use Uint16.{ (^) }
assert (3uS ^ 5uS) == 6uS