Int16

Utilities for working with the Int16 type.

1

from "int16" include Int16

1

1S

1

-1S

Values

Functions and constants included in the Int16 module.

Int16.fromNumber

1

fromNumber : (number: Number) => Int16

Converts a Number to an Int16.

Parameters:

Returns:

Int16.toNumber

1

toNumber : (value: Int16) => Number

Converts an Int16 to a Number.

Parameters:

Returns:

Int16.fromUint16

1

fromUint16 : (number: Uint16) => Int16

Converts a Uint16 to an Int16.

Parameters:

Returns:

Examples:

1

Int16.fromUint16(1uS) == 1S

Int16.incr

1

incr : (value: Int16) => Int16

Increments the value by one.

Parameters:

Returns:

Examples:

1

Int16.incr(1S) == 2S

1

Int16.incr(-2S) == -1S

Int16.decr

1

decr : (value: Int16) => Int16

Decrements the value by one.

Parameters:

Returns:

Examples:

1

Int16.decr(2S) == 1S

1

Int16.decr(0S) == -1S

Int16.(+)

1

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

Computes the sum of its operands.

Parameters:

Returns:

Examples:

1
2

use Int16.{ (+) }
assert 1S + 1S == 2S

Int16.(-)

1

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

Computes the difference of its operands.

Parameters:

Returns:

Examples:

1
2

use Int16.{ (-) }
assert 2S - 1S == 1S

Int16.(*)

1

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

Computes the product of its operands.

Parameters:

Returns:

Examples:

1
2

use Int16.{ (*) }
assert 2S * 2S == 4S

Int16.(/)

1

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

Computes the quotient of its operands using signed division.

Parameters:

Returns:

Examples:

1
2

use Int16.{ (/) }
assert 8S / 2S == 4S

Int16.rem

1

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

Computes the remainder of the division of its operands using signed division.

Parameters:

Returns:

Examples:

1

Int16.rem(8S, 3S) == 2S

Int16.(%)

1

(%) : (x: Int16, y: Int16) => Int16

Computes the remainder of the division of the first operand by the second. The result will have the sign of the second operand.

Parameters:

Returns:

Throws:

ModuloByZero

• When y is zero

Examples:

1
2

use Int16.{ (%) }
assert -5S % 3S == 1S

Int16.(<<)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int16.{ (<<) }
assert (5S << 1S) == 10S

Int16.(>>)

1

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

Shifts the bits of the value right by the given number of bits, preserving the sign bit.

Parameters:

Returns:

Examples:

1
2

use Int16.{ (>>) }
assert (5S >> 1S) == 2S

Int16.(==)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int16.{ (==) }
assert 1S == 1S

Int16.(!=)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int16.{ (!=) }
assert 1S != 2S

Int16.(<)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int16.{ (<) }
assert 1S < 2S

Int16.(>)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int16.{ (>) }
assert 2S > 1S

Int16.(<=)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int16.{ (<=) }
assert 1S <= 2S

1
2

use Int16.{ (<=) }
assert 1S <= 1S

Int16.(>=)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int16.{ (>=) }
assert 2S >= 1S

1
2

use Int16.{ (>=) }
assert 1S >= 1S

Int16.lnot

1

lnot : (value: Int16) => Int16

Computes the bitwise NOT of the given value.

Parameters:

Returns:

Examples:

1

Int16.lnot(-5S) == 4S

Int16.(&)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int16.{ (&) }
assert (3S & 4S) == 0S

Int16.(|)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int16.{ (|) }
assert (3S | 4S) == 7S

Int16.(^)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int16.{ (^) }
assert (3S ^ 5S) == 6S