What problem does it solve?
The Rust conventions and math-documentation standards guide ensures consistent module structure, coordinate conventions, doc comments, and math.tex cross-references across crates/ and experiments/ Rust code, reducing ambiguity and improving maintainability and correctness.
Core Features & Use Cases
- Module structure guidance for a single crate with clearly delineated modules and submodules (geom, algorithms, kkt, constants, random, dataset).
- Coordinate and math-code conventions to prevent common mistakes and ensure 1:1 mapping between mathematical concepts and Rust representations.
- Documentation discipline including doc comments, math.tex references, and frontmatter-driven metadata to support tooling and verification.
- Use Case: when creating or reviewing Rust code for polytopes, Lagrangian products, and capacity algorithms, apply these conventions to ensure consistency and traceability.
Quick Start
Apply these conventions when editing crates/ and experiments/ Rust code to ensure consistent structure and documentation.