kingchenc
3ebcb3f758
Adds a `throughput` benchmark to every target and closes two small test-coverage documentation/QA gaps. One PR, no merge of binding code beyond the additive benchmarks and one C test. ## 1. Per-binding throughput benchmarks (all 9 targets) Each benchmark feeds a deterministic synthetic OHLCV series through three indicators chosen by **FFI call-signature archetype** (not algorithm — the same Rust core runs underneath all bindings): - `SMA(20)` — 1-in → 1-out (baseline boundary cost) - `ATR(14)` — multi-in → 1-out (input marshalling) - `MACD(12,26,9)` — 1-in → multi-out (output marshalling) Streaming is timed for all three; batch for the single-output SMA and ATR (median of 3 runs, after a warmup pass). New: Python (PyO3), WASM, C (CMake), C# (Stopwatch), Go, Java (FFM), R, and the Rust core baseline (`examples/rust/.../throughput.rs`, **no FFI** — the ceiling the bindings are measured against and the value their batch paths converge towards). Node already had `throughput.js`. **Not a speed claim:** there is no comparable streaming TA library for C, C#, Go, Java, R or WASM to compare against, so these are raw per-binding throughput numbers documenting each language's FFI overhead — see BENCHMARKS.md §3. The "Wickra is fast" claim still lives in §1/§2 (Rust core + the Python/Rust cross-library runs). ## 2. README `## Testing`: C# and C bullets The section listed every layer except C# and C, even though both have suites. Adds the two missing bullets. ## 3. C archetype ctest `examples/c/archetypes.c` drives one indicator per FFI archetype through the real C boundary (scalar + batch==streaming, multi-output, bars, profile, array input) plus reset, invalid-parameter and NULL-safety — the C counterpart of the Go/R/Java archetype suites. Runs on three OSes via the existing CMake/ctest. ## Notes - Benchmarks are not CI-gated (manual-run scripts, like the existing `throughput.js`); no `ci.yml`/`release.yml` changes. - Docs: BENCHMARKS.md §3, a `## Benchmark` section in every binding README, a CHANGELOG entry. - Verified locally by running: Rust, Python, C, C#, Go, Java (real numbers); the C archetype ctest with `-Wall -Wextra -Wpedantic -Werror`. WASM and R are API-correct and syntax-checked but need their own toolchains to run.
63 lines
1.1 KiB
Plaintext
63 lines
1.1 KiB
Plaintext
# Rust
|
|
/target/
|
|
**/target/
|
|
Cargo.lock.bak
|
|
*.pdb
|
|
|
|
# Python
|
|
__pycache__/
|
|
*.py[cod]
|
|
*$py.class
|
|
*.so
|
|
*.pyd
|
|
*.egg-info/
|
|
.pytest_cache/
|
|
.venv/
|
|
venv/
|
|
.python-version
|
|
dist/
|
|
build/
|
|
wheels/
|
|
*.whl
|
|
|
|
# Editor / OS
|
|
.idea/
|
|
.vscode/
|
|
*.swp
|
|
.DS_Store
|
|
Thumbs.db
|
|
|
|
# Maturin
|
|
target/wheels/
|
|
|
|
# Benchmarks
|
|
criterion/
|
|
|
|
# Coverage
|
|
*.profraw
|
|
lcov.info
|
|
tarpaulin-report.html
|
|
|
|
# Local config that should not be committed
|
|
*.local.toml
|
|
|
|
# Node binding artifacts
|
|
**/node_modules/
|
|
bindings/node/*.node
|
|
bindings/node/npm-debug.log*
|
|
# index.js + index.d.ts are generated by `napi build` but committed (a matched
|
|
# pair) so consumers and the repo get TypeScript types; CONTRIBUTING requires
|
|
# regenerating both when a binding's public API changes.
|
|
# package-lock.json is committed for the tracked Node packages — bindings/node/
|
|
# and examples/node/ — so contributors get reproducible npm installs. There is
|
|
# no top-level npm package, and the ghost-ignored site/ keeps its lockfile local.
|
|
# See CONTRIBUTING.md "Lockfile policy" for the full per-component breakdown.
|
|
|
|
# WASM build output
|
|
bindings/wasm/pkg/
|
|
bindings/wasm/pkg-node/
|
|
|
|
# Python venv
|
|
.venv/
|
|
venv/
|