This module contains type aliases used throughout the NumberLink codebase.

numberlink.types

Type Aliases

type numberlink.types.RenderMode

Canonical type: Literal["rgb_array", "ansi", "human"]

Rendering mode for the environment. Can be "rgb_array", "ansi", or "human".

type numberlink.types.Coord

Canonical type: tuple[int, int]

A coordinate pair (row, column) representing a grid position.

type numberlink.types.Lane

Canonical type: Literal["n", "v", "h"]

Lane indicator for bridge cells. "n" marks a normal cell, "v" marks the vertical lane, and "h" marks the horizontal lane.

type numberlink.types.CellLane

Canonical type: tuple[int, int, Lane]

A cell coordinate and the active lane encoded as (row, column, lane).

type numberlink.types.RGBInt

Canonical type: tuple[int, int, int]

An RGB color stored as three integers (red, green, blue).

type numberlink.types.ActType

Canonical type: numpy.integer | int

Action type for the environment. Accepts numpy integer scalars or built-in int values.

type numberlink.types.ObsType

Canonical type: numpy.typing.NDArray[numpy.uint8]

Observation type for the environment as an RGB image array.

Utility Functions

numberlink.types.select_signed_dtype(min_value: int, max_value: int) → type[signedinteger]

Return the smallest signed numpy integer dtype that covers a range.

Inspect the absolute bounds of min_value and max_value and return one of numpy.int8, numpy.int16, numpy.int32, or numpy.int64 depending on which type can represent the full range.

Parameters:

• min_value (int) – Minimum value in the range.

• max_value (int) – Maximum value in the range.

Returns:

Appropriate numpy signed integer dtype type.

Return type:

type[numpy.signedinteger]

numberlink.types.select_unsigned_dtype(max_value: int) → type[unsignedinteger]

Return the smallest unsigned numpy integer dtype that covers 0..``max_value``.

Select among numpy.uint8, numpy.uint16, numpy.uint32, and numpy.uint64 based on the provided maximum value. Values below 0 are clamped to 0 before selection.

Parameters:

max_value (int) – Maximum value in the range.

Returns:

Appropriate numpy unsigned integer dtype type.

Return type:

type[numpy.unsignedinteger]

Typed dicts

class numberlink.types.Snapshot

Runtime snapshot captured by numberlink.viewer.NumberLinkViewer._snapshot_state().

The snapshot contains internal environment arrays and viewer selection state used to restore a previous runtime configuration via numberlink.viewer.NumberLinkViewer._restore_state().