Stdlib module math/number_theory.vitl
This page is a wiki-style reference for one concrete stdlib file. It explains what the file owns, where it fits in the family, and how to decide whether this is the right surface to depend on.
math/number_theory.vitl.Family: math
Kind: public stdlib surface
Page style: this reference follows the same “encyclopedic card + portrait + usage contract” logic as the keyword pages, but for stdlib modules.
Summary
- Overview
- Purpose
- Taxonomy
- Implementation profile
- Top-level API inventory
- Position in family
- Declaration map
- Representative signatures
- How to use this module
- User example
- Keyword coverage
- Source shape
- Source landmarks
- Source organization
- Complete API catalog
- Integration boundaries
- Composition guidance
- Relationship table
- Neighbor modules
Overview
| Field | Value |
|---|---|
| Path | math/number_theory.vitl |
| Family | math |
| Kind | public stdlib surface |
| Line count | 492 |
| Declared procedures | 40 |
| Declared forms/picks | 0 |
`math/number_theory.vitl` is a public stdlib surface inside the `math` family. It should be read as one focused slice of the broader family responsibility: Arithmetic, algebra, comparison, calculus, geometry, modular arithmetic, number theory, probability, statistics, matrix, and vector helpers.
Purpose
This file should be chosen because of responsibility, not because its name “sounds close enough”. Inside the math family, it carries one focused part of the contract and keeps that responsibility separate from neighboring concerns.
- A scoring engine can compute aggregates in `math` while keeping I/O and transport elsewhere.
- A statistics or matrix chapter should explain the workflow around the computation, not just a single formula.
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.
- Minimal top-level dependencies: the module reads as mostly self-contained from its opening declarations.
- Explicit export surface: the file ends with visible export declarations instead of relying only on implicit namespace discovery.
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.
| Signal | Count | What it suggests |
|---|---|---|
if | 39 | Branching density and local decision-making. |
while | 18 | Loop-heavy or iterative implementation style. |
for | 0 | Collection-style traversal at source level. |
match | 0 | Variant-driven branching or grammar-style decoding. |
let | 56 | Local state and intermediate value density. |
give | 70 | Number of explicit exit points and result shaping. |
Top-level API inventory
| Surface | Items |
|---|---|
| Procedures | abs_int, min_int, max_int, reverse_copy, is_even, is_odd, is_multiple_of, divides, gcd, lcm, are_coprime, gcd_many |
| Forms | none declared at top level |
| Picks | none declared at top level |
| Constants | none declared at top level |
| Exports | * |
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 12 of 21 in the math family when ordered by path. By procedure count it ranks 16, and by line count it ranks 12. 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.
| Line | Name | Kind | Role |
|---|---|---|---|
| 1 | vitte/stdlib/math/number_theory | space | Declares the namespace that anchors this file in the stdlib tree. |
| 7 | abs_int | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 15 | min_int | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 23 | max_int | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 31 | reverse_copy | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 43 | is_even | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 47 | is_odd | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 51 | is_multiple_of | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 59 | divides | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 63 | gcd | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 76 | lcm | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 87 | are_coprime | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 91 | gcd_many | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 107 | lcm_many | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 126 | is_prime | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 151 | is_composite | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 155 | next_prime | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 172 | prev_prime | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 192 | nth_prime | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 208 | primes_up_to | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 226 | prime_count | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 230 | prime_factors | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 260 | distinct_prime_factors | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 279 | prime_factor_count | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 283 | distinct_prime_factor_count | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 287 | smallest_prime_factor | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 296 | largest_prime_factor | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 305 | divisors | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 328 | proper_divisors | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 348 | divisors_count | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 352 | sum_of_divisors | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 365 | proper_divisors_sum | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 378 | totient | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 398 | mobius | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 425 | is_perfect_number | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 433 | is_abundant_number | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 441 | is_deficient_number | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 449 | coprime | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 453 | number_theory_version | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 457 | number_theory_ready | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 461 | number_theory_selftest | proc | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
The table is exhaustive for top-level declarations of the selected kinds. This file declares 41 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.
proc abs_int(value: int) -> int {(line 7)proc min_int(a: int, b: int) -> int {(line 15)proc max_int(a: int, b: int) -> int {(line 23)proc reverse_copy(values: [int]) -> [int] {(line 31)proc is_even(value: int) -> bool {(line 43)proc is_odd(value: int) -> bool {(line 47)proc is_multiple_of(value: int, divisor: int) -> bool {(line 51)proc divides(divisor: int, value: int) -> bool {(line 59)proc gcd(a: int, b: int) -> int {(line 63)proc lcm(a: int, b: int) -> int {(line 76)proc are_coprime(a: int, b: int) -> bool {(line 87)proc gcd_many(values: [int]) -> int {(line 91)proc lcm_many(values: [int]) -> int {(line 107)proc is_prime(value: int) -> bool {(line 126)proc is_composite(value: int) -> bool {(line 151)proc next_prime(value: int) -> int {(line 155)proc prev_prime(value: int) -> int {(line 172)proc nth_prime(index: int) -> int {(line 192)
The list is intentionally capped here; the source file declares 40 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.
- Read
spaceand top-level imports first so the ownership boundary ofmath/number_theory.vitlis explicit. - Traverse procedures in source order; the early helpers usually explain the naming and numeric conventions used later.
- Use the source landmarks section below as a table of contents when the file is large.
- 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/math_number_theory
proc run_example() -> string {
let entries = reverse_copy([1, 2, 3])
let ready: bool = is_even(1)
let failed: bool = false
let stable: bool = ready and true
let fallback: bool = ready or false
let idx: int = 0
let count: int = 0
while idx < entries.len {
set count = count + 1
set idx = idx + 1
}
if not ready {
give "not-ready"
} else {
give "ok"
}
}
export run_example
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.
| Keyword | Present in module source | Used in generated user example |
|---|---|---|
space | yes | yes |
proc | yes | yes |
let | yes | yes |
set | yes | yes |
if | yes | yes |
else | yes | yes |
while | yes | yes |
give | yes | yes |
export | yes | yes |
true | yes | yes |
false | yes | yes |
and | yes | yes |
or | yes | yes |
not | yes | yes |
The generated snippet exercises every detected Vitte keyword used by this module.
Source shape
space vitte/stdlib/math/number_theory
proc abs_int(value: int) -> int {
if value < 0 {
give 0 - value
} else {
give value
}
}
proc min_int(a: int, b: int) -> int {
if a < b {
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.
- Number Theory — integer divisibility and prime helpers
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.
Opening declarations
Top-level items: 1. Procedures: 0. Data surfaces: 0. Constants: 0.
First visible names: vitte/stdlib/math/number_theory
Number Theory — integer divisibility and prime helpers
Top-level items: 41. Procedures: 40. Data surfaces: 0. Constants: 0.
First visible names: abs_int, min_int, max_int, reverse_copy, is_even, is_odd, is_multiple_of, divides, gcd, lcm
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.
Procedures
| Line | Name | Signature | Role |
|---|---|---|---|
| 7 | abs_int | proc abs_int(value: int) -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 15 | min_int | proc min_int(a: int, b: int) -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 23 | max_int | proc max_int(a: int, b: int) -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 31 | reverse_copy | proc reverse_copy(values: [int]) -> [int] { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 43 | is_even | proc is_even(value: int) -> bool { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 47 | is_odd | proc is_odd(value: int) -> bool { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 51 | is_multiple_of | proc is_multiple_of(value: int, divisor: int) -> bool { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 59 | divides | proc divides(divisor: int, value: int) -> bool { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 63 | gcd | proc gcd(a: int, b: int) -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 76 | lcm | proc lcm(a: int, b: int) -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 87 | are_coprime | proc are_coprime(a: int, b: int) -> bool { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 91 | gcd_many | proc gcd_many(values: [int]) -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 107 | lcm_many | proc lcm_many(values: [int]) -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 126 | is_prime | proc is_prime(value: int) -> bool { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 151 | is_composite | proc is_composite(value: int) -> bool { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 155 | next_prime | proc next_prime(value: int) -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 172 | prev_prime | proc prev_prime(value: int) -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 192 | nth_prime | proc nth_prime(index: int) -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 208 | primes_up_to | proc primes_up_to(limit: int) -> [int] { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 226 | prime_count | proc prime_count(limit: int) -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 230 | prime_factors | proc prime_factors(value: int) -> [int] { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 260 | distinct_prime_factors | proc distinct_prime_factors(value: int) -> [int] { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 279 | prime_factor_count | proc prime_factor_count(value: int) -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 283 | distinct_prime_factor_count | proc distinct_prime_factor_count(value: int) -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 287 | smallest_prime_factor | proc smallest_prime_factor(value: int) -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 296 | largest_prime_factor | proc largest_prime_factor(value: int) -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 305 | divisors | proc divisors(value: int) -> [int] { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 328 | proper_divisors | proc proper_divisors(value: int) -> [int] { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 348 | divisors_count | proc divisors_count(value: int) -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 352 | sum_of_divisors | proc sum_of_divisors(value: int) -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 365 | proper_divisors_sum | proc proper_divisors_sum(value: int) -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 378 | totient | proc totient(value: int) -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 398 | mobius | proc mobius(value: int) -> int { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 425 | is_perfect_number | proc is_perfect_number(value: int) -> bool { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 433 | is_abundant_number | proc is_abundant_number(value: int) -> bool { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 441 | is_deficient_number | proc is_deficient_number(value: int) -> bool { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 449 | coprime | proc coprime(a: int, b: int) -> bool { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 453 | number_theory_version | proc number_theory_version() -> string { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 457 | number_theory_ready | proc number_theory_ready() -> bool { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
| 461 | number_theory_selftest | proc number_theory_selftest() -> bool { | Represents one top-level surface in the file contract and should be read as part of the module boundary. |
Exports
| Line | Name | Signature | Role |
|---|---|---|---|
| 492 | * | export * | Re-exports surfaces that the module wants to expose as part of its public boundary. |
Integration boundaries
Within math, 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: Arithmetic, algebra, comparison, calculus, geometry, modular arithmetic, number theory, probability, statistics, matrix, and vector helpers.
- Family architecture role: Use `math` when the transformation itself is the feature. This family exists so algorithmic intent stays visible and testable.
Composition guidance
Choose this module when
- Choose
math/number_theory.vitlwhen the main question is owned by this module rather than by transport, storage, orchestration, or user-interface code. - A scoring engine can compute aggregates in `math` while keeping I/O and transport elsewhere.
- A statistics or matrix chapter should explain the workflow around the computation, not just a single formula.
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
math. - Check nearby modules such as
math/algebra.vitl,math/arithmetic.vitl,math/arrays.vitlbefore 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 | Procedures | Data surfaces | Why compare it |
|---|---|---|---|
math/algebra.vitl | 14 | 0 | Shares the same family boundary but carries a distinct slice of responsibility. |
math/arithmetic.vitl | 72 | 2 | Shares the same family boundary but carries a distinct slice of responsibility. |
math/arrays.vitl | 83 | 2 | Shares the same family boundary but carries a distinct slice of responsibility. |
math/calculus.vitl | 56 | 3 | Shares the same family boundary but carries a distinct slice of responsibility. |
math/comparison.vitl | 47 | 0 | Shares the same family boundary but carries a distinct slice of responsibility. |
math/complex.vitl | 49 | 0 | Shares the same family boundary but carries a distinct slice of responsibility. |
math/geometry.vitl | 72 | 0 | Shares the same family boundary but carries a distinct slice of responsibility. |
math/logic.vitl | 20 | 0 | Shares the same family boundary but carries a distinct slice of responsibility. |