Int64

Utilities for working with the Int64 type.

1

from "int64" include Int64

1

1L

1

-1L

Values

Functions and constants included in the Int64 module.

Int64.fromNumber

1

fromNumber : (number: Number) => Int64

Converts a Number to an Int64.

Parameters:

Returns:

Int64.toNumber

1

toNumber : (value: Int64) => Number

Converts an Int64 to a Number.

Parameters:

Returns:

Int64.fromUint64

1

fromUint64 : (number: Uint64) => Int64

Converts a Uint64 to an Int64.

Parameters:

Returns:

Examples:

1

Int64.fromUint64(1uL) == 1L

Int64.incr

1

incr : (value: Int64) => Int64

Increments the value by one.

Parameters:

Returns:

Examples:

1

Int64.incr(1L) == 2L

1

Int64.incr(-2L) == -1L

Int64.decr

1

decr : (value: Int64) => Int64

Decrements the value by one.

Parameters:

Returns:

Examples:

1

Int64.decr(2L) == 1L

1

Int64.decr(0L) == -1L

Int64.(+)

1

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

Computes the sum of its operands.

Parameters:

Returns:

Examples:

1
2

use Int64.{ (+) }
assert 1L + 1L == 2L

Int64.(-)

1

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

Computes the difference of its operands.

Parameters:

Returns:

Examples:

1
2

use Int64.{ (-) }
assert 2L - 1L == 1L

Int64.(*)

1

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

Computes the product of its operands.

Parameters:

Returns:

Examples:

1
2

use Int64.{ (*) }
assert 2L * 2L == 4L

Int64.(/)

1

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

Computes the quotient of its operands using signed division.

Parameters:

Returns:

Examples:

1
2

use Int64.{ (/) }
assert 8L / 2L == 4L

Int64.rem

1

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

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

Parameters:

Returns:

Examples:

1

Int64.rem(8L, 3L) == 2L

Int64.(%)

1

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

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

Int64.rotl

1

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

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

Parameters:

Returns:

Examples:

1

Int64.rotl(1L, 1L) == 2L

1

Int64.rotl(1L, 2L) == 4L

Int64.rotr

1

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

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

Parameters:

Returns:

Examples:

1

Int64.rotr(2L, 1L) == 1L

1

Int64.rotr(4L, 2L) == 1L

Int64.(<<)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int64.{ (<<) }
assert (5L << 1L) == 10L

Int64.(>>)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int64.{ (>>) }
assert (5L >> 1L) == 2L

Int64.(==)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int64.{ (==) }
assert 1L == 1L

Int64.(!=)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int64.{ (!=) }
assert 1L != 2L

Int64.eqz

1

eqz : (value: Int64) => Bool

Checks if the given value is equal to zero.

Parameters:

Returns:

Examples:

1

Int64.eqz(0L) == true

1

Int64.eqz(1L) == false

Int64.(<)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int64.{ (<) }
assert 1L < 2L

Int64.(>)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int64.{ (>) }
assert 2L > 1L

Int64.(<=)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int64.{ (<=) }
assert 1L <= 2L

1
2

use Int64.{ (<=) }
assert 1L <= 1L

Int64.(>=)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int64.{ (>=) }
assert 2L >= 1L

1
2

use Int64.{ (>=) }
assert 1L >= 1L

Int64.lnot

1

lnot : (value: Int64) => Int64

Computes the bitwise NOT of the given value.

Parameters:

Returns:

Examples:

1

Int64.lnot(-5L) == 4L

Int64.(&)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int64.{ (&) }
assert (3L & 4L) == 0L

Int64.(|)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int64.{ (|) }
assert (3L | 4L) == 7L

Int64.(^)

1

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

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

Parameters:

Returns:

Examples:

1
2

use Int64.{ (^) }
assert (3L ^ 5L) == 6L

Int64.clz

1

clz : (value: Int64) => Int64

Counts the number of leading zero bits in the value.

Parameters:

Returns:

Examples:

1

Int64.clz(1L) == 63L

1

Int64.clz(4L) == 61L

Int64.ctz

1

ctz : (value: Int64) => Int64

Counts the number of trailing zero bits in the value.

Parameters:

Returns:

Examples:

1

Int64.ctz(1L) == 0L

1

Int64.ctz(4L) == 2L

Int64.popcnt

1

popcnt : (value: Int64) => Int64

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

Parameters:

Returns:

Examples:

1

Int64.popcnt(1L) == 1L

1

Int64.popcnt(3L) == 2L

Int64.(**)

1

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

Computes the exponentiation of the given base and power.

Parameters:

Returns:

Examples:

1
2

from Int64 use { (**) }
assert 2L ** 3L == 8L