Int32

Utilities for working with the Int32 type.

1

from "int32" include Int32

1

1l

1

-1l

Values

Functions and constants included in the Int32 module.

Int32.fromNumber

1

fromNumber : (number: Number) => Int32

Converts a Number to an Int32.

Parameters:

Returns:

Int32.toNumber

1

toNumber : (value: Int32) => Number

Converts an Int32 to a Number.

Parameters:

Returns:

Int32.fromUint32

1

fromUint32 : (number: Uint32) => Int32

Converts a Uint32 to an Int32.

Parameters:

Returns:

Examples:

1

Int32.fromUint32(1ul) == 1l

Int32.incr

1

incr : (value: Int32) => Int32

Increments the value by one.

Parameters:

Returns:

Examples:

1

Int32.incr(1l) == 2l

1

Int32.incr(-2l) == -1l

Int32.decr

1

decr : (value: Int32) => Int32

Decrements the value by one.

Parameters:

Returns:

Examples:

1

Int32.decr(2l) == 1l

1

Int32.decr(0l) == -1l

Int32.(+)

1

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

Computes the sum of its operands.

Parameters:

Returns:

Examples:

1
2

use Int32.{ (+) }
assert 1l + 1l == 2l

Int32.(-)

1

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

Computes the difference of its operands.

Parameters:

Returns:

Examples:

1
2

use Int32.{ (-) }
assert 2l - 1l == 1l

Int32.(*)

1

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

Computes the product of its operands.

Parameters:

Returns:

Examples:

1
2

use Int32.{ (*) }
assert 2l * 2l == 4l

Int32.(/)

1

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

Computes the quotient of its operands using signed division.

Parameters:

Returns:

Examples:

1
2

use Int32.{ (/) }
assert 8l / 2l == 4l

Int32.rem

1

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

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

Parameters:

Returns:

Examples:

1

Int32.rem(8l, 3l) == 2l

Int32.(%)

1

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

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

Int32.rotl

1

rotl : (value: Int32, amount: Int32) => Int32

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

Parameters:

Returns:

Examples:

1

Int32.rotl(1l, 1l) == 2l

1

Int32.rotl(1l, 2l) == 4l

Int32.rotr

1

rotr : (value: Int32, amount: Int32) => Int32

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

Parameters:

Returns:

Examples:

1

Int32.rotr(2l, 1l) == 1l

1

Int32.rotr(4l, 2l) == 1l

Int32.(<<)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int32.{ (<<) }
assert (5l << 1l) == 10l

Int32.(>>)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int32.{ (>>) }
assert (5l >> 1l) == 2l

Int32.(==)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int32.{ (==) }
assert 1l == 1l

Int32.(!=)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int32.{ (!=) }
assert 1l != 2l

Int32.eqz

1

eqz : (value: Int32) => Bool

Checks if the given value is equal to zero.

Parameters:

Returns:

Examples:

1

Int32.eqz(0l) == true

1

Int32.eqz(1l) == false

Int32.(<)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int32.{ (<) }
assert 1l < 2l

Int32.(>)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int32.{ (>) }
assert 2l > 1l

Int32.(<=)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int32.{ (<=) }
assert 1l <= 2l

1
2

use Int32.{ (<=) }
assert 1l <= 1l

Int32.(>=)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int32.{ (>=) }
assert 2l >= 1l

1
2

use Int32.{ (>=) }
assert 1l >= 1l

Int32.lnot

1

lnot : (value: Int32) => Int32

Computes the bitwise NOT of the given value.

Parameters:

Returns:

Examples:

1

Int32.lnot(-5l) == 4l

Int32.(&)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int32.{ (&) }
assert (3l & 4l) == 0l

Int32.(|)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int32.{ (|) }
assert (3l | 4l) == 7l

Int32.(^)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int32.{ (^) }
assert (3l ^ 5l) == 6l

Int32.clz

1

clz : (value: Int32) => Int32

Counts the number of leading zero bits in the value.

Parameters:

Returns:

Examples:

1

Int32.clz(1l) == 31l

1

Int32.clz(4l) == 29l

Int32.ctz

1

ctz : (value: Int32) => Int32

Counts the number of trailing zero bits in the value.

Parameters:

Returns:

Examples:

1

Int32.ctz(1l) == 0l

1

Int32.ctz(4l) == 2l

Int32.popcnt

1

popcnt : (value: Int32) => Int32

Counts the number of bits set to 1 in the value, also known as a population count.

Parameters:

Returns:

Examples:

1

Int32.popcnt(1l) == 1l

1

Int32.popcnt(3l) == 2l

Int32.(**)

1

(**) : (base: Int32, power: Int32) => Int32

Computes the exponentiation of the given base and power.

Parameters:

Returns:

Examples:

1
2

from Int32 use { (**) }
assert 2l ** 3l == 8l