ring-seq guide
Tutorial-style documentation for ring-seq, in three languages.
v1 placeholder. The full
ring-seq
tutorial lands in v2. For now, the per-language READMEs are the
canonical references:
Scala,
Rust,
Python.
The full guide will cover:
- Installation — three tabs: Scala (sbt / Mill / Scala-CLI), Rust (cargo), Python (pip / uv).
- Core concept — what a ring sequence is and why operations on it differ from a plain sequence. One illustrated example that runs on all three languages.
- The operations — grouped: rotation (left, right, by index), reflection, palindrome detection, sliding windows, equivalence under rotation. Each operation in all three languages, side-by-side.
- Use cases — short worked examples: detecting equivalent vertex configurations, finding rotational palindromes in necklaces, sliding-window analysis on a ring buffer.
- Cross-language consistency — how the three ports are kept in sync.
- Performance notes — one paragraph per language on complexity.
- Links to per-language API docs.