ESC
No recent searches
Search by
Standard Library  /  Uint16

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

Uint16

Utilities for working with the Uint16 type.

Edit on GitHub
Added in 0.6.0 No other changes yet. 
from "uint16" include Uint16
1uS
10uS

Values

Functions and constants included in the Uint16 module.

Uint16.fromNumber

Added in 0.6.0 No other changes yet. 
fromNumber : (number: Number) => Uint16

Converts a Number to a Uint16.

Parameters:

number: The value to convert

Returns:

Uint16: The Number represented as a Uint16

Uint16.toNumber

Added in 0.6.0 No other changes yet. 
toNumber : (value: Uint16) => Number

Converts a Uint16 to a Number.

Parameters:

value: The value to convert

Returns:

Number: The Uint16 represented as a Number

Uint16.fromInt16

Added in 0.6.0 No other changes yet. 
fromInt16 : (number: Int16) => Uint16

Converts an Int16 to a Uint16.

Parameters:

number: The value to convert

Returns:

Uint16: The Int16 represented as a Uint16

Examples:

Uint16.fromInt16(1uS) == 1uS
Uint16.fromInt16(-1uS) == 65535uS

Uint16.incr

Added in 0.6.0 No other changes yet. 
incr : (value: Uint16) => Uint16

Increments the value by one.

Parameters:

value: The value to increment

Returns:

Uint16: The incremented value

Examples:

Uint16.incr(1uS) == 2uS

Uint16.decr

Added in 0.6.0 No other changes yet. 
decr : (value: Uint16) => Uint16

Decrements the value by one.

Parameters:

value: The value to decrement

Returns:

Uint16: The decremented value

Examples:

Uint16.decr(1uS) == 0uS
Uint16.decr(0uS) == 65535uS

Uint16.(+)

Added in 0.6.0 No other changes yet. 
(+) : (x: Uint16, y: Uint16) => Uint16

Computes the sum of its operands.

Parameters:

x: The first operand
y: The second operand

Returns:

Uint16: The sum of the two operands

Examples:

use Uint16.{ (+) }
assert 1uS + 1uS == 2uS

Uint16.(-)

Added in 0.6.0 No other changes yet. 
(-) : (x: Uint16, y: Uint16) => Uint16

Computes the difference of its operands.

Parameters:

x: The first operand
y: The second operand

Returns:

Uint16: The difference of the two operands

Examples:

use Uint16.{ (-) }
assert 2uS - 1uS == 1uS

Uint16.(*)

Added in 0.6.0 No other changes yet. 
(*) : (x: Uint16, y: Uint16) => Uint16

Computes the product of its operands.

Parameters:

x: The first operand
y: The second operand

Returns:

Uint16: The product of the two operands

Examples:

use Uint16.{ (*) }
assert 2uS * 2uS == 4uS

Uint16.(/)

Added in 0.6.0 No other changes yet. 
(/) : (x: Uint16, y: Uint16) => Uint16

Computes the quotient of its operands.

Parameters:

x: The first operand
y: The second operand

Returns:

Uint16: The quotient of its operands

Examples:

use Uint16.{ (/) }
assert 5uS / 2uS == 2uS

Uint16.rem

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

Computes the remainder of the division of its operands.

Parameters:

x: The first operand
y: The second operand

Returns:

Uint16: The remainder of its operands

Examples:

Uint16.rem(5uS, 2uS) == 1uS

Uint16.(<<)

Added in 0.6.0 No other changes yet. 
(<<) : (value: Uint16, amount: Uint16) => Uint16

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:

Uint16: The shifted value

Examples:

use Uint16.{ (<<) }
assert (5uS << 1uS) == 10uS

Uint16.(>>>)

Added in 0.6.0 No other changes yet. 
(>>>) : (value: Uint16, amount: Uint16) => Uint16

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

Parameters:

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

Returns:

Uint16: The shifted value

Examples:

use Uint16.{ (>>>) }
assert (5uS >>> 1uS) == 2uS

Uint16.(==)

Added in 0.6.0 No other changes yet. 
(==) : (x: Uint16, y: Uint16) => 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 Uint16.{ (==) }
assert 1uS == 1uS

Uint16.(!=)

Added in 0.6.0 No other changes yet. 
(!=) : (x: Uint16, y: Uint16) => 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 Uint16.{ (!=) }
assert 1uS != 3uS

Uint16.(<)

Added in 0.6.0 No other changes yet. 
(<) : (x: Uint16, y: Uint16) => 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 Uint16.{ (<) }
assert 1uS < 5uS

Uint16.(>)

Added in 0.6.0 No other changes yet. 
(>) : (x: Uint16, y: Uint16) => 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 Uint16.{ (>) }
assert 4uS > 2uS

Uint16.(<=)

Added in 0.6.0 No other changes yet. 
(<=) : (x: Uint16, y: Uint16) => 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 Uint16.{ (<=) }
assert 1uS <= 2uS
use Uint16.{ (<=) }
assert 1uS <= 1uS

Uint16.(>=)

Added in 0.6.0 No other changes yet. 
(>=) : (x: Uint16, y: Uint16) => 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 Uint16.{ (>=) }
assert 3uS >= 2uS
use Uint16.{ (>=) }
assert 1uS >= 1uS

Uint16.lnot

Added in 0.6.0 No other changes yet. 
lnot : (value: Uint16) => Uint16

Computes the bitwise NOT of the given value.

Parameters:

value: The given value

Returns:

Uint16: Containing the inverted bits of the given value

Examples:

Uint16.lnot(5uS) == 65530uS

Uint16.(&)

Added in 0.6.0 No other changes yet. 
(&) : (x: Uint16, y: Uint16) => Uint16

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

Parameters:

x: The first operand
y: The second operand

Returns:

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

Examples:

use Uint16.{ (&) }
assert (3uS & 4uS) == 0uS

Uint16.(|)

Added in 0.6.0 No other changes yet. 
(|) : (x: Uint16, y: Uint16) => Uint16

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

Parameters:

x: The first operand
y: The second operand

Returns:

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

Examples:

use Uint16.{ (|) }
assert (3uS | 4uS) == 7uS

Uint16.(^)

Added in 0.6.0 No other changes yet. 
(^) : (x: Uint16, y: Uint16) => Uint16

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

Parameters:

x: The first operand
y: The second operand

Returns:

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

Examples:

use Uint16.{ (^) }
assert (3uS ^ 5uS) == 6uS
String Uint32

Sign up for farm-to-inbox developer news

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

Copyright © 2024 The Grain Programming Language