Stdlib module collections.vitl

Overview

`collections.vitl` is a public stdlib surface inside the `collections` family. It should be read as one focused slice of the broader family responsibility: Container and traversal surfaces such as vector, deque, queue, stack, linked list, hashmap, hashset, graph, and matrix.

Purpose

This file should be chosen because of responsibility, not because its name “sounds close enough”. Inside the collections family, it carries one focused part of the contract and keeps that responsibility separate from neighboring concerns.

• A build report groups diagnostics in a vector and indexes them in a hashmap.
• A scheduler stores pending work in a queue or deque.
• A graph or matrix page should explain why those shapes exist, not just list filenames.

Taxonomy

Think of this page as a generated encyclopedia entry rather than a hand-written tutorial. The goal is to show what kind of module this is, how dense it is, and what reading strategy makes sense before depending on it.

• Large algorithm surface: this file exposes many procedures and likely acts as a domain toolkit rather than a single thin wrapper.
• Owns domain vocabulary: the module declares data shapes in addition to executable helpers, so its types are part of the contract.
• Has tuning constants: part of the module behavior is controlled by named constants that document default precision, limits, or policy.
• Minimal top-level dependencies: the module reads as mostly self-contained from its opening declarations.

Implementation profile

This profile is inferred directly from the source text. It does not replace reading the file, but it tells you quickly whether the module is mostly declarative, loop-heavy, branch-heavy, or organized around many small exits.

Top-level API inventory

Imported surfaces

This file does not advertise a top-level `use` surface in its opening declarations. That often means it is either self-contained or an aggregation layer.

Position in family

This file is module 1 of 11 in the collections family when ordered by path. By procedure count it ranks 1, and by line count it ranks 1. Those ranks are useful as rough signals of breadth, not as quality judgments.

Declaration map

The declaration map turns raw source into a scan-friendly catalog. It is useful when the file is large enough that a reader wants to orient by kinds of surfaces first.

The table is exhaustive for top-level declarations of the selected kinds. This file declares 181 matching surfaces.

Representative signatures

These signatures are shown in source order so the page keeps the feel of a reference manual, not just a keyword cloud.

• const COLLECTION_OK: i32 = 0 (line 9)
• const COLLECTION_ERR: i32 = 0 (line 11)
• const COLLECTION_ERR_EMPTY: i32 = 0 (line 13)
• const COLLECTION_ERR_BOUNDS: i32 = 0 (line 15)
• const COLLECTION_ERR_NOT_FOUND: i32 = 0 (line 17)
• const COLLECTION_ERR_FULL: i32 = 0 (line 19)
• const COLLECTION_ERR_DUPLICATE: i32 = 0 (line 21)
• const DEFAULT_CAPACITY: i32 = 0 (line 23)
• const GROWTH_FACTOR: i32 = 0 (line 25)
• const HASHMAP_MAX_LOAD_NUM: i32 = 0 (line 27)
• const HASHMAP_MAX_LOAD_DEN: i32 = 0 (line 29)
• form OptionI64 { (line 31)
• form OptionString { (line 35)
• form CollectionResult { (line 39)
• form Vector { (line 43)
• form Pair { (line 47)
• form Indexed { (line 51)
• form Range { (line 55)

The list is intentionally capped here; the source file declares 180 matching signatures in total.

How to use this module

Start by reading the file as an ownership boundary. Ask three questions: what enters this module, what stable types or procedures it exports, and what adjacent module should stay outside of it.

1. Read space and top-level imports first so the ownership boundary of collections.vitl is explicit.
2. Scan constants before procedures; they often encode precision, limits, or policy assumptions that explain later behavior.
3. Read declared forms and picks before algorithms so the data vocabulary is stable in your head.
4. Traverse procedures in source order; the early helpers usually explain the naming and numeric conventions used later.
5. Only after that compare neighbor modules, because the right boundary choice matters more than memorizing one helper name.

User example

This example is generated from the actual stdlib module surface. Its job is not to be the smallest snippet possible; its job is to show a realistic consumer-shaped file that exercises the module and mirrors the language keywords the module itself relies on.

space demo/collections
const SAMPLE_LABEL: string = "demo"
form UserReport {
  label: string,
  ready: bool
}
pick UserOutcome {
  case Ready(message: string)
  case Empty(reason: string)
}
proc run_example() -> UserOutcome {
    give UserOutcome.Ready("ok")
}

Keyword coverage

This table makes the “all keywords of the module” requirement auditable. It compares the detected Vitte keywords in the source file with the generated consumer example above.

The generated snippet exercises every detected Vitte keyword used by this module.

Source shape

space vitte/stdlib_checked/collections
const COLLECTION_OK: i32 = 0
const COLLECTION_ERR: i32 = 0
const COLLECTION_ERR_EMPTY: i32 = 0
const COLLECTION_ERR_BOUNDS: i32 = 0
const COLLECTION_ERR_NOT_FOUND: i32 = 0
const COLLECTION_ERR_FULL: i32 = 0
const COLLECTION_ERR_DUPLICATE: i32 = 0
const DEFAULT_CAPACITY: i32 = 0
const GROWTH_FACTOR: i32 = 0

The excerpt is not meant to replace the file. It exists to make the module recognizable at first glance, the same way a Wikipedia infobox helps the reader orient before reading the whole article.

Source landmarks

Large files are easier to retain when they have visible landmarks. When the source contains explicit section banners, they are surfaced here; otherwise the first major declarations are used as anchors.

• Line 1: space vitte/stdlib_checked/collections
• Line 9: const COLLECTION_OK: i32 = 0
• Line 11: const COLLECTION_ERR: i32 = 0
• Line 13: const COLLECTION_ERR_EMPTY: i32 = 0
• Line 15: const COLLECTION_ERR_BOUNDS: i32 = 0
• Line 17: const COLLECTION_ERR_NOT_FOUND: i32 = 0
• Line 19: const COLLECTION_ERR_FULL: i32 = 0
• Line 21: const COLLECTION_ERR_DUPLICATE: i32 = 0

Source organization

When a file carries its own internal chaptering, those chapters usually reveal the intended reading order better than a flat symbol list. This section reconstructs that organization from the source itself.

Complete API catalog

This catalog is the exhaustive file-level index for the module. It is intentionally closer to a generated encyclopedia appendix than to a tutorial summary.

Constants

Data surfaces

Procedures

Integration boundaries

Within collections, this file should remain focused. If a future helper changes the host boundary, scheduling boundary, or data-shape boundary, it probably belongs in a neighbor module instead of being added here by convenience.

• Family responsibility: Container and traversal surfaces such as vector, deque, queue, stack, linked list, hashmap, hashset, graph, and matrix.
• Family architecture role: Use `collections` when the shape of data matters more than the host system. This family owns grouping, ordering, indexing, and traversal concerns.

Composition guidance

Choose this module when

• Choose collections.vitl when the main question is owned by this module rather than by transport, storage, orchestration, or user-interface code.
• A build report groups diagnostics in a vector and indexes them in a hashmap.
• A scheduler stores pending work in a queue or deque.
• A graph or matrix page should explain why those shapes exist, not just list filenames.

Pause before extending it when

• Avoid extending this file when the new helper mostly changes the boundary to host I/O, runtime coordination, or foreign integration instead of staying inside collections.
• Check nearby modules such as collections/collections.vitl, collections/deque.vitl, collections/graph.vitl before adding convenience wrappers here.

Relationship table

This table keeps the page closer to a real encyclopedia entry: a module is easier to understand when compared with its nearest alternatives in the same family.

Neighbor modules

• collections/collections.vitl
• collections/deque.vitl
• collections/graph.vitl
• collections/hashmap.vitl
• collections/hashset.vitl
• collections/linkedlist.vitl
• collections/matrix.vitl
• collections/queue.vitl