ESC
No recent searches
Search by
Standard Library  /  Int32

Grain Docs

Welcome to Grain! Editor Setup Getting Grain

The Guide

Hello World The Basics Conditionals Functions Shadowing and Mutation Loops Lists and arrays Custom Data Types Modules Pattern Matching

Reference

Building for Production Built-in Types The Grain CLI Graindoc

Standard Library

Pervasives BigInt Array Buffer Bytes Char Exception Float32 Float64 Hash Int16 Int32 Int64 Int8 Json List Map Marshal Number Option Path PriorityQueue Queue Random Range Rational Regex Result Stack Set String Uint16 Uint32 Uint64 Uint8 Uri wasi / File wasi / Process wasi / Random wasi / Time

Int32

Utilities for working with the Int32 type.

Edit on GitHub
Added in 0.2.0 No other changes yet. 
from "int32" include Int32
1l
-1l

Values

Functions and constants included in the Int32 module.

Int32.fromNumber

Added in 0.2.0 No other changes yet. 
fromNumber : (number: Number) => Int32

Converts a Number to an Int32.

Parameters:

number: The value to convert

Returns:

Int32: The Number represented as an Int32

Int32.toNumber

Added in 0.2.0 No other changes yet. 
toNumber : (value: Int32) => Number

Converts an Int32 to a Number.

Parameters:

value: The value to convert

Returns:

Number: The Int32 represented as a Number

Int32.fromUint32

Added in 0.6.0 No other changes yet. 
fromUint32 : (number: Uint32) => Int32

Converts a Uint32 to an Int32.

Parameters:

number: The value to convert

Returns:

Int32: The Uint32 represented as an Int32

Examples:

Int32.fromUint32(1ul) == 1l

Int32.incr

Added in 0.2.0 No other changes yet. 
incr : (value: Int32) => Int32

Increments the value by one.

Parameters:

value: The value to increment

Returns:

Int32: The incremented value

Examples:

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

Int32.decr

Added in 0.2.0 No other changes yet. 
decr : (value: Int32) => Int32

Decrements the value by one.

Parameters:

value: The value to decrement

Returns:

Int32: The decremented value

Examples:

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

Int32.(+)

Added in 0.6.0
versionchanges
0.2.0Originally named `add`
 
(+) : (x: Int32, y: Int32) => Int32

Computes the sum of its operands.

Parameters:

x: The first operand
y: The second operand

Returns:

Int32: The sum of the two operands

Examples:

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

Int32.(-)

Added in 0.6.0
versionchanges
0.2.0Originally named `sub`
 
(-) : (x: Int32, y: Int32) => Int32

Computes the difference of its operands.

Parameters:

x: The first operand
y: The second operand

Returns:

Int32: The difference of the two operands

Examples:

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

Int32.(*)

Added in 0.6.0
versionchanges
0.2.0Originally named `mul`
 
(*) : (x: Int32, y: Int32) => Int32

Computes the product of its operands.

Parameters:

x: The first operand
y: The second operand

Returns:

Int32: The product of the two operands

Examples:

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

Int32.(/)

Added in 0.6.0
versionchanges
0.2.0Originally named `div`
 
(/) : (x: Int32, y: Int32) => Int32

Computes the quotient of its operands using signed division.

Parameters:

x: The first operand
y: The second operand

Returns:

Int32: The quotient of its operands

Examples:

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

Int32.rem

Added in 0.2.0 No other changes yet. 
rem : (x: Int32, y: Int32) => Int32

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

Parameters:

x: The first operand
y: The second operand

Returns:

Int32: The remainder of its operands

Examples:

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

Int32.(%)

Added in 0.6.0
versionchanges
0.2.0Originally named `mod`
 
(%) : (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:

x: The first operand
y: The second operand

Returns:

Int32: The modulus of its operands

Throws:

ModuloByZero

  • When y is zero

Examples:

use Int32.{ (%) }
assert -5l % 3l == 1l

Int32.rotl

Added in 0.4.0 No other changes yet. 
rotl : (value: Int32, amount: Int32) => Int32

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

Parameters:

value: The value to rotate
amount: The number of bits to rotate by

Returns:

Int32: The rotated value

Examples:

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

Int32.rotr

Added in 0.4.0 No other changes yet. 
rotr : (value: Int32, amount: Int32) => Int32

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

Parameters:

value: The value to rotate
amount: The number of bits to rotate by

Returns:

Int32: The rotated value

Examples:

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

Int32.(<<)

Added in 0.6.0
versionchanges
0.2.0Originally named `shl`
 
(<<) : (value: Int32, amount: Int32) => Int32

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

Parameters:

value: The value to shift
amount: The number of bits to shift by

Returns:

Int32: The shifted value

Examples:

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

Int32.(>>)

Added in 0.6.0
versionchanges
0.2.0Originally named `shr`
 
(>>) : (value: Int32, amount: Int32) => Int32

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

Parameters:

value: The value to shift
amount: The amount to shift by

Returns:

Int32: The shifted value

Examples:

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

Int32.(==)

Added in 0.6.0
versionchanges
0.4.0Originally named `eq`
 
(==) : (x: Int32, y: Int32) => Bool

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

Parameters:

x: The first value
y: The second value

Returns:

Bool: true if the first value is equal to the second value or false otherwise

Examples:

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

Int32.(!=)

Added in 0.6.0
versionchanges
0.4.0Originally named `ne`
 
(!=) : (x: Int32, y: Int32) => Bool

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

Parameters:

x: The first value
y: The second value

Returns:

Bool: true if the first value is not equal to the second value or false otherwise

Examples:

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

Int32.eqz

Added in 0.4.0 No other changes yet. 
eqz : (value: Int32) => Bool

Checks if the given value is equal to zero.

Parameters:

value: The value to inspect

Returns:

Bool: true if the first value is equal to zero or false otherwise

Examples:

Int32.eqz(0l) == true
Int32.eqz(1l) == false

Int32.(<)

Added in 0.6.0
versionchanges
0.2.0Originally named `lt`
 
(<) : (x: Int32, y: Int32) => Bool

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

Parameters:

x: The first value
y: The second value

Returns:

Bool: true if the first value is less than the second value or false otherwise

Examples:

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

Int32.(>)

Added in 0.6.0
versionchanges
0.2.0Originally named `gt`
 
(>) : (x: Int32, y: Int32) => Bool

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

Parameters:

x: The first value
y: The second value

Returns:

Bool: true if the first value is greater than the second value or false otherwise

Examples:

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

Int32.(<=)

Added in 0.6.0
versionchanges
0.2.0Originally named `lte`
 
(<=) : (x: Int32, y: Int32) => Bool

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

Parameters:

x: The first value
y: The second value

Returns:

Bool: true if the first value is less than or equal to the second value or false otherwise

Examples:

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

Int32.(>=)

Added in 0.6.0
versionchanges
0.2.0Originally named `gte`
 
(>=) : (x: Int32, y: Int32) => Bool

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

Parameters:

x: The first value
y: The second value

Returns:

Bool: true if the first value is greater than or equal to the second value or false otherwise

Examples:

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

Int32.lnot

Added in 0.2.0 No other changes yet. 
lnot : (value: Int32) => Int32

Computes the bitwise NOT of the given value.

Parameters:

value: The given value

Returns:

Int32: Containing the inverted bits of the given value

Examples:

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

Int32.(&)

Added in 0.6.0
versionchanges
0.2.0Originally named `land`
 
(&) : (x: Int32, y: Int32) => Int32

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

Parameters:

x: The first operand
y: The second operand

Returns:

Int32: Containing a 1 in each bit position for which the corresponding bits of both operands are 1

Examples:

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

Int32.(|)

Added in 0.6.0
versionchanges
0.2.0Originally named `lor`
 
(|) : (x: Int32, y: Int32) => Int32

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

Parameters:

x: The first operand
y: The second operand

Returns:

Int32: Containing a 1 in each bit position for which the corresponding bits of either or both operands are 1

Examples:

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

Int32.(^)

Added in 0.6.0
versionchanges
0.2.0Originally named `lxor`
 
(^) : (x: Int32, y: Int32) => Int32

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

Parameters:

x: The first operand
y: The second operand

Returns:

Int32: Containing a 1 in each bit position for which the corresponding bits of either but not both operands are 1

Examples:

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

Int32.clz

Added in 0.4.0 No other changes yet. 
clz : (value: Int32) => Int32

Counts the number of leading zero bits in the value.

Parameters:

value: The value to inspect

Returns:

Int32: The amount of leading zeros

Examples:

Int32.clz(1l) == 31l
Int32.clz(4l) == 29l

Int32.ctz

Added in 0.4.0 No other changes yet. 
ctz : (value: Int32) => Int32

Counts the number of trailing zero bits in the value.

Parameters:

value: The value to inspect

Returns:

Int32: The amount of trailing zeros

Examples:

Int32.ctz(1l) == 0l
Int32.ctz(4l) == 2l

Int32.popcnt

Added in 0.4.0 No other changes yet. 
popcnt : (value: Int32) => Int32

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

Parameters:

value: The value to inspect

Returns:

Int32: The amount of 1-bits in its operand

Examples:

Int32.popcnt(1l) == 1l
Int32.popcnt(3l) == 2l

Int32.(**)

Added in 0.6.0 No other changes yet. 
(**) : (base: Int32, power: Int32) => Int32

Computes the exponentiation of the given base and power.

Parameters:

base: The base number
power: The exponent number

Returns:

Int32: The base raised to the given power

Examples:

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

Sign up for farm-to-inbox developer news

You can unsubscribe at any time. Read our privacy policy.

Copyright © 2024 The Grain Programming Language