octive-lean/README.md
Maximus Gorog 23162fb93a
Some checks failed
Lean Action CI / build (push) Has been cancelled
Add README, CONTRIBUTING, editorconfig, gitattributes, justfile
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-29 09:44:24 -06:00

1.5 KiB

octive-lean

A Lean 4 reimplementation of GNU Octave — the MATLAB-compatible numerical language — aiming to be more versatile than upstream.

Build

lake build

Requires the Lean toolchain pinned in lean-toolchain. elan will pick it up automatically.

Run

# REPL
lake exe octive-lean

# Run an .m script
lake exe octive-lean path/to/script.m

# Verify the corpus against expected outputs
lake build corpus-check
lake exe corpus-check

Layout

Path What's there
OctiveLean/ Library: Lexer, Parser, AST, Eval, Builtins, REPL, BigStep, PlotSVG, …
Main.lean Entry point — REPL or file runner
CorpusCheck.lean Test driver for corpus/
corpus/ .m test cases paired with .expected outputs
NumericalTutorial.lean, RosettaStone.lean Lean-side tutorials and Octave⇄Lean translations
PlotDemo.lean, widget/ Plotting via ProofWidgets + SVG
octave-upstream/ Shallow clone of GNU Octave (gitignored, used as reference)

Status

Working interpreter: matrices, arithmetic, control flow, functions (incl. recursion, closures, anonymous @(x)), cell arrays, structs, printf-family, REPL, file execution. See corpus/ for what's covered.

Tests

lake build && lake exe corpus-check

Pass --update to regenerate .expected files after intentional behavior changes.