Int8

Utilities for working with the Int8 type.

1

from "int8" include Int8

1

1s

1

-1s

Values

Functions and constants included in the Int8 module.

Int8.fromNumber

1

fromNumber : (number: Number) => Int8

Converts a Number to an Int8.

Parameters:

Returns:

Int8.toNumber

1

toNumber : (value: Int8) => Number

Converts an Int8 to a Number.

Parameters:

Returns:

Int8.fromUint8

1

fromUint8 : (number: Uint8) => Int8

Converts a Uint8 to an Int8.

Parameters:

Returns:

Examples:

1

Int8.fromUint8(1us) == 1s

Int8.incr

1

incr : (value: Int8) => Int8

Increments the value by one.

Parameters:

Returns:

Examples:

1

Int8.incr(1s) == 2s

1

Int8.incr(-2s) == -1s

Int8.decr

1

decr : (value: Int8) => Int8

Decrements the value by one.

Parameters:

Returns:

Examples:

1

Int8.decr(2s) == 1s

1

Int8.decr(0s) == -1s

Int8.(+)

1

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

Computes the sum of its operands.

Parameters:

Returns:

Examples:

1
2

use Int8.{ (+) }
assert 1s + 1s == 2s

Int8.(-)

1

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

Computes the difference of its operands.

Parameters:

Returns:

Examples:

1
2

use Int8.{ (-) }
assert 2s - 1s == 1s

Int8.(*)

1

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

Computes the product of its operands.

Parameters:

Returns:

Examples:

1
2

use Int8.{ (*) }
assert 2s * 2s == 4s

Int8.(/)

1

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

Computes the quotient of its operands using signed division.

Parameters:

Returns:

Examples:

1
2

use Int8.{ (/) }
assert 8s / 2s == 4s

Int8.rem

1

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

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

Parameters:

Returns:

Examples:

1

Int8.rem(8s, 3s) == 2s

Int8.(%)

1

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

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 Int8.{ (%) }
assert -5s % 3s == 1s

Int8.(<<)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int8.{ (<<) }
assert (5s << 1s) == 10s

Int8.(>>)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int8.{ (>>) }
assert (5s >> 1s) == 2s

Int8.(==)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int8.{ (==) }
assert 1s == 1s

Int8.(!=)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int8.{ (!=) }
assert 1s != 2s

Int8.(<)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int8.{ (<) }
assert 1s < 2s

Int8.(>)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int8.{ (>) }
assert 2s > 1s

Int8.(<=)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int8.{ (<=) }
assert 1s <= 2s

1
2

use Int8.{ (<=) }
assert 1s <= 1s

Int8.(>=)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int8.{ (>=) }
assert 2s >= 1s

1
2

use Int8.{ (>=) }
assert 1s >= 1s

Int8.lnot

1

lnot : (value: Int8) => Int8

Computes the bitwise NOT of the given value.

Parameters:

Returns:

Examples:

1

Int.lnot(-5s) == 4s

Int8.(&)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int8.{ (&) }
assert (3s & 4s) == 0s

Int8.(|)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int8.{ (|) }
assert (3s | 4s) == 7s

Int8.(^)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int8.{ (^) }
assert (3s ^ 5s) == 6s