kingchenc
b228a70d7d
Deepens the **Moving Averages** family with seven widely-used variants (396 → 403 indicators), the first batch of Part B (family deepening). All are scalar `f64 → f64`: | Indicator | Binding | Notes | |-----------|---------|-------| | `SineWeightedMa` | `SWMA` | symmetric half-cycle sine-weighted window | | `GeometricMa` | `GMA` | rolling geometric mean (log-space average) | | `Ehma` | `EHMA` | exponential Hull MA (Hull construction over EMAs) | | `MedianMa` | `MedianMA` | rolling median, robust to single outliers | | `AdaptiveLaguerreFilter` | `AdaptiveLaguerre` | Ehlers' adaptive Laguerre filter (median-of-normalised-error γ) | | `GeneralizedDema` | `GD` | Tillson's volume-factor double EMA; `v=1` is DEMA, `v=0` is EMA | | `HoltWinters` | `HoltWinters` | Holt's linear double exponential smoothing (level + trend) | LSMA was dropped from the planned set: it already ships as `LinearRegression` (TA-Lib `LINEARREG`, the rolling least-squares endpoint). The five single-period filters use the generated scalar macro bindings; `GeneralizedDema` (period, v) and `HoltWinters` (alpha, beta) use hand-written node/python bindings with the typed wasm macro (precedent `T3` / `Alma`). Full coverage: core modules with per-branch unit tests (100% intent), mod/lib catalogue, FAMILIES group + assert, README + docs counters, CHANGELOG, all three bindings (regenerated `index.d.ts` / `index.js`), fuzz drivers, and the python/node test registries. Local verification: `cargo test -p wickra-core` (lib 3255 + doc 361), `cargo clippy --workspace --all-targets --all-features -D warnings` clean, node `npm run build && npm test` (478), python `pytest` (791).
32 lines
1.5 KiB
Markdown
32 lines
1.5 KiB
Markdown
# Documentation
|
|
|
|
Wickra's full documentation lives at **[docs.wickra.org](https://docs.wickra.org)**.
|
|
|
|
That includes:
|
|
|
|
- **Quickstarts** for [Rust](https://docs.wickra.org/Quickstart-Rust),
|
|
[Python](https://docs.wickra.org/Quickstart-Python),
|
|
[Node](https://docs.wickra.org/Quickstart-Node), and
|
|
[WASM](https://docs.wickra.org/Quickstart-WASM).
|
|
- A per-indicator deep dive for every one of the **403 indicators** across
|
|
the sixteen families (Moving Averages, Momentum Oscillators, Trend &
|
|
Directional, Price Oscillators, Volatility & Bands, Bands & Channels,
|
|
Trailing Stops, Volume, Price Statistics, Ehlers / Cycle DSP, Pivots &
|
|
S/R, DeMark, Ichimoku & Charts, Candlestick Patterns, Market Profile,
|
|
Risk / Performance) — see the
|
|
[indicators overview](https://docs.wickra.org/Indicators-Overview).
|
|
- **Reference pages**: [warmup periods](https://docs.wickra.org/Warmup-Periods),
|
|
[streaming vs batch](https://docs.wickra.org/Streaming-vs-Batch),
|
|
[indicator chaining](https://docs.wickra.org/Indicator-Chaining), and the
|
|
[data layer](https://docs.wickra.org/Data-Layer).
|
|
- **Guides**: [Cookbook](https://docs.wickra.org/Cookbook),
|
|
[TA-Lib migration](https://docs.wickra.org/TA-Lib-Migration),
|
|
[FAQ](https://docs.wickra.org/FAQ).
|
|
|
|
## Editing the docs
|
|
|
|
The documentation site is a separate git repository at
|
|
`https://github.com/wickra-lib/wickra-docs`. Open a pull request there to
|
|
propose changes; the site is built with VitePress and deploys to
|
|
`docs.wickra.org`.
|