Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

API reference

This user guide is the narrative documentation — concepts, model definitions, worked examples, and plots. The complete, per-function API reference (every public type, method, field, and free function, with signatures and doc comments) is the generated rustdoc.

  • Online: once a crate is published, its reference lives at https://docs.rs/<crate> — for example docs.rs/solow-regression. The docs.rs build is automatic; every release is rendered there.

  • Locally: build it from the source tree with

    cargo doc --no-deps --workspace --open
    

    This produces the same reference under target/doc/ and opens it in your browser. The whole workspace documents with zero warnings.

Each guide page ends with a Module reference table listing that area's key public items; the links below take you to the full rustdoc for the crate behind each area.

Crates by area

Foundational crates

These underpin everything above and are usually used indirectly:

CrateRoleAPI reference
solowUmbrella crate re-exporting the stackdocs.rs
solow-coreShared error type and data toolsdocs.rs
solow-linalgFrom-scratch linear algebra (SVD, eigh, QR, Cholesky)docs.rs
solow-vizDependency-light SVG plotting backenddocs.rs