quantedge-ta 0.20.0

A streaming technical analysis library for Rust
Documentation

quantedge-ta

CI codecov crates.io License wasm

A streaming technical analysis library for Rust. Correct, tested, documented.

Features

Type-safe convergence

Indicators return Option<Self::Output>. No value until there's enough data. No silent NaN, no garbage early values. The type system enforces correctness. For indicators with infinite memory (EMA), full_convergence() reports how many bars are needed for the seed's influence to decay below 1%.

Plain-struct bar input

Indicators take &Ohlcv, a Copy struct with six public fields (open, high, low, close, open_time, volume). Build one per kline with a struct literal or a From conversion from your own kline type — no trait impl required, no generic parameters on compute.

O(1) incremental updates

Indicators maintain running state and update in constant time per tick. No re-scanning the window.

WASM compatible

Works in WebAssembly environments. The library compiles for wasm32-unknown-unknown (browser) and wasm32-wasip1 (WASI runtimes). Zero dependencies, no filesystem or OS calls in the library itself. CI verifies WASM compatibility on every commit.

Live repainting

Indicators track bar boundaries using open_time. A kline with a new open_time advances the window; same open_time replaces the current value. Useful for trading terminals and real-time systems that need indicator values on forming bars.

Typed outputs

Each indicator defines its own output type via an associated type on the Indicator trait. SMA, EMA, RSI, and ATR return f64. Bollinger Bands returns BbValue { upper, middle, lower }. MACD returns MacdValue { macd, signal, histogram }. Stochastic returns StochValue { k, d }. Stochastic RSI returns StochRsiValue { k, d }. Keltner Channel returns KcValue { upper, middle, lower }. Donchian Channel returns DcValue { upper, middle, lower }. ADX returns AdxValue { adx, plus_di, minus_di }. Ichimoku Cloud returns IchimokuValue { tenkan, kijun, senkou_a, senkou_b, chikou_close }. VWAP returns VwapValue { vwap, band_1, band_2, band_3 }. Supertrend returns SupertrendValue { value, is_bullish }. Parabolic SAR returns ParabolicSarValue { sar, is_long }. Williams %R, CCI, CHOP, and OBV return f64. No downcasting, no enums, full type safety.

Usage

use quantedge_ta::{Sma, SmaConfig};
use std::num::NonZero;

let mut sma = Sma::new(SmaConfig::close(NonZero::new(20).unwrap()));

for kline in stream {
    if let Some(value) = sma.compute(&kline) {
        println!("SMA(20): {value}");
    }
    // None = not enough data yet
}

Bollinger Bands returns a struct with public fields:

use quantedge_ta::{Bb, BbConfig};
use std::num::NonZero;

let config = BbConfig::builder()
    .length(NonZero::new(20).unwrap())
    .build();
let mut bb = Bb::new(config);

for kline in stream {
    if let Some(value) = bb.compute(&kline) {
        println!("BB upper: {}, middle: {}, lower: {}",
            value.upper, value.middle, value.lower);
    }
}

Custom standard deviation multiplier:

use quantedge_ta::{BbConfig, Multiplier};
use std::num::NonZero;

let config = BbConfig::builder()
    .length(NonZero::new(20).unwrap())
    .std_dev(Multiplier::new(1.5))
    .build();

Derive a new config from an existing one with to_builder():

use quantedge_ta::{SmaConfig, PriceSource};
use std::num::NonZero;

let sma_close = SmaConfig::close(NonZero::new(20).unwrap());

// Change only the price source, keep the same length
let sma_hl2 = sma_close.to_builder().source(PriceSource::HL2).build();

Live data with repainting:

// Open kline arrives (open_time = 1000)
sma.compute(&open_kline);    // computes with current bar

// Same bar, new trade (open_time = 1000, updated close)
sma.compute(&updated_kline); // replaces current bar value

// Next bar (open_time = 2000)
sma.compute(&next_kline);    // advances the window

The caller controls bar boundaries. The library handles the rest.

Indicator Trait

Each indicator defines its output type. No downcasting needed:

trait Indicator: Sized + Clone + Display + Debug {
    type Config: IndicatorConfig<Output = Self::Output>;
    type Output: 'static + Copy + Send + Sync + Display + Debug;

    fn new(config: Self::Config) -> Self;
    fn compute(&mut self, kline: &Ohlcv) -> Option<Self::Output>;
    fn value(&self) -> Option<Self::Output>;
}

// Sma:   Output = f64
// Ema:   Output = f64
// Rsi:   Output = f64
// Bb:    Output = BbValue { upper: f64, middle: f64, lower: f64 }
// Macd:  Output = MacdValue { macd: f64, signal: Option<f64>, histogram: Option<f64> }
// Stoch: Output = StochValue { k: f64, d: Option<f64> }
// Atr:   Output = f64
// Kc:    Output = KcValue { upper: f64, middle: f64, lower: f64 }
// Dc:    Output = DcValue { upper: f64, middle: f64, lower: f64 }
// Adx:      Output = AdxValue { adx: f64, plus_di: f64, minus_di: f64 }
// Ichimoku: Output = IchimokuValue { tenkan: f64, kijun: f64, senkou_a: f64, senkou_b: f64, chikou_close: f64 }
// WillR:    Output = f64
// Cci:      Output = f64
// Chop:      Output = f64
// StochRsi:  Output = StochRsiValue { k: f64, d: Option<f64> }
// Obv:       Output = f64
// Vwap:       Output = VwapValue { vwap: f64, band_1: Option<VwapBand>, band_2: Option<VwapBand>, band_3: Option<VwapBand> }
// Supertrend:    Output = SupertrendValue { value: f64, is_bullish: bool }
// ParabolicSar:  Output = ParabolicSarValue { sar: f64, is_long: bool }

Ohlcv Struct

Ohlcv is a plain Copy struct — build one per bar and pass it by reference to compute(). Convert from your own kline type with a field-wise copy:

use quantedge_ta::Ohlcv;

struct MyKline { o: f64, h: f64, l: f64, c: f64, v: f64, t: u64 }

impl From<&MyKline> for Ohlcv {
    fn from(k: &MyKline) -> Self {
        Ohlcv {
            open: k.o,
            high: k.h,
            low: k.l,
            close: k.c,
            volume: k.v,
            open_time: k.t,
        }
    }
}

// let bar: Ohlcv = (&my_kline).into();
// indicator.compute(&bar);

Timestamp is recommended to be microseconds since Unix epoch, monotonically increasing. This is required for the VWAP indicator, which uses timestamps to detect session boundaries. volume has no implicit default: set it to a real figure for OBV and VWAP, or 0.0 when feeding indicators that ignore it.

Convergence

Every indicator config exposes convergence() — the number of bars that compute() must process before it starts returning Some. During backtesting this defines the warm-up (seeding) phase: bars where the indicator is stabilising and should not drive trading decisions.

use quantedge_ta::{SmaConfig, RsiConfig, MacdConfig};
use std::num::NonZero;

let sma = SmaConfig::close(NonZero::new(20).unwrap());
let rsi = RsiConfig::close(NonZero::new(14).unwrap());
let macd = MacdConfig::default_close(); // MACD(12, 26, 9)

// The slowest indicator determines the warm-up length
let warmup = sma.convergence()   // 20
    .max(rsi.convergence())      // 15
    .max(macd.convergence());    // 26
// → skip the first 26 bars before acting on signals

SMA and BB converge as soon as the window fills (length bars). EMA and RSI use exponential smoothing with infinite memory; the SMA seed influences all subsequent values. RSI output begins at bar length + 1. For EMA, EmaConfig provides full_convergence() — the number of bars until the seed's contribution decays below 1% (e.g. 63 for EMA(20) = 3 × (20 + 1)).

Price Sources

Each indicator is configured with a PriceSource that determines which value to extract from the Ohlcv input:

Source Formula
Close close
Open open
High high
Low low
HL2 (high + low) / 2
HLC3 (high + low + close) / 3
OHLC4 (open + high + low + close) / 4
HLCC4 (high + low + close + close) / 4
TrueRange max(high - low, |high - prev_close|, |low - prev_close|)

Indicators

Indicator Output Description
SMA f64 Simple Moving Average
EMA f64 Exponential Moving Average
RSI f64 Relative Strength Index (Wilder's smoothing)
BB BbValue Bollinger Bands (upper, mid, lower)
MACD MacdValue Moving Average Convergence Divergence
ATR f64 Average True Range
Stoch StochValue Stochastic Oscillator (%K, %D)
KC KcValue Keltner Channel (upper, mid, lower)
DC DcValue Donchian Channel (upper, mid, lower)
ADX AdxValue Average Directional Index (+DI, −DI, ADX)
WillR f64 Williams %R
CCI f64 Commodity Channel Index
CHOP f64 Choppiness Index
Ichimoku IchimokuValue Ichimoku Cloud (tenkan, kijun, senkou A/B, chikou)
StochRSI StochRsiValue Stochastic RSI (%K, %D)
OBV f64 On-Balance Volume
VWAP VwapValue Volume Weighted Average Price
Supertrend SupertrendValue Supertrend (trend line + direction)
Parabolic SAR ParabolicSarValue Parabolic Stop and Reverse (SAR + direction)

Benchmarks

Measured with Criterion.rs on 744 BTC/USDT 1-hour bars from Binance, split into a 349-bar warm-up seed and 395 measured bars so every group times steady-state work.

Stream measures end-to-end throughput over the 395 post-warmup bars from a pre-converged seed. Tick isolates steady-state per-bar cost on a fully converged indicator. Repaint measures single-tick repaint cost (same open_time, perturbed close) on a converged indicator. Repaint Stream measures end-to-end throughput with 3 ticks per bar (open → mid → final), 1185 total observations on a pre-converged seed.

Hardware: Apple M5 Max (18 cores), 128 GB RAM, macOS 26.4.1, rustc 1.93.1, --release profile.

Stream — process 395 post-warmup bars

Indicator Period Time (median) Throughput
SMA 20 411 ns 960 Melem/s
SMA 200 432 ns 915 Melem/s
EMA 20 865 ns 457 Melem/s
EMA 200 861 ns 459 Melem/s
BB 20 491 ns 804 Melem/s
BB 200 506 ns 780 Melem/s
RSI 14 913 ns 433 Melem/s
RSI 140 909 ns 434 Melem/s
MACD 12/26/9 957 ns 413 Melem/s
MACD 120/260/90 957 ns 413 Melem/s
ATR 14 734 ns 538 Melem/s
ATR 140 732 ns 539 Melem/s
Stoch 14/3/3 3.42 µs 115 Melem/s
Stoch 140/30/30 6.75 µs 58.5 Melem/s
KC 20/10 1.00 µs 393 Melem/s
KC 200/100 1.00 µs 393 Melem/s
DC 20 2.40 µs 165 Melem/s
DC 200 8.57 µs 46.1 Melem/s
ADX 14 2.07 µs 190 Melem/s
ADX 140 2.08 µs 190 Melem/s
WillR 14 2.46 µs 161 Melem/s
WillR 140 6.04 µs 65.4 Melem/s
CCI 20 1.42 µs 278 Melem/s
CCI 200 19.59 µs 20.2 Melem/s
CHOP 14 3.63 µs 109 Melem/s
CHOP 140 7.01 µs 56.3 Melem/s
Ichimoku 9/26/52/26 8.31 µs 47.5 Melem/s
Ichimoku 36/104/208/104 16.62 µs 23.8 Melem/s
StochRSI 14/14/3/3 4.11 µs 96.1 Melem/s
StochRSI 140/140/30/30 6.26 µs 63.1 Melem/s
Supertrend 20 1.28 µs 309 Melem/s
Supertrend 200 1.29 µs 307 Melem/s
OBV 530 ns 746 Melem/s
VWAP Day 654 ns 604 Melem/s
Parabolic SAR 0.02/0.2 3.42 µs 116 Melem/s
Parabolic SAR 0.01/0.4 3.40 µs 116 Melem/s

Tick — single compute() on a converged indicator

Indicator Period Time (median)
SMA 20 11.41 ns
SMA 200 26.26 ns
EMA 20 1.88 ns
EMA 200 1.88 ns
BB 20 14.09 ns
BB 200 30.72 ns
RSI 14 5.23 ns
RSI 140 5.00 ns
MACD 12/26/9 8.28 ns
MACD 120/260/90 8.59 ns
ATR 14 2.09 ns
ATR 140 2.04 ns
Stoch 14/3/3 41.75 ns
Stoch 140/30/30 121 ns
KC 20/10 4.56 ns
KC 200/100 4.36 ns
DC 20 27.35 ns
DC 200 58.99 ns
ADX 14 11.43 ns
ADX 140 11.70 ns
WillR 14 19.07 ns
WillR 140 65.02 ns
CCI 20 13.67 ns
CCI 200 68.32 ns
CHOP 14 31.51 ns
CHOP 140 78.72 ns
Ichimoku 9/26/52/26 86.25 ns
Ichimoku 36/104/208/104 236 ns
StochRSI 14/14/3/3 44.97 ns
StochRSI 140/140/30/30 127 ns
Supertrend 20 9.29 ns
Supertrend 200 9.01 ns
OBV 1.29 ns
VWAP Day 7.06 ns
Parabolic SAR 0.02/0.2 9.36 ns
Parabolic SAR 0.01/0.4 9.15 ns

Repaint — single compute() repaint on a converged indicator

Indicator Period Time (median)
SMA 20 11.19 ns
SMA 200 25.30 ns
EMA 20 1.85 ns
EMA 200 2.12 ns
BB 20 13.67 ns
BB 200 29.29 ns
RSI 14 3.97 ns
RSI 140 3.85 ns
MACD 12/26/9 7.72 ns
MACD 120/260/90 8.45 ns
ATR 14 2.04 ns
ATR 140 2.00 ns
Stoch 14/3/3 40.34 ns
Stoch 140/30/30 122 ns
KC 20/10 4.35 ns
KC 200/100 4.45 ns
DC 20 19.15 ns
DC 200 55.46 ns
ADX 14 10.84 ns
ADX 140 10.35 ns
WillR 14 18.58 ns
WillR 140 55.87 ns
CCI 20 13.36 ns
CCI 200 68.92 ns
CHOP 14 29.57 ns
CHOP 140 77.78 ns
Ichimoku 9/26/52/26 83.30 ns
Ichimoku 36/104/208/104 234 ns
StochRSI 14/14/3/3 42.55 ns
StochRSI 140/140/30/30 126 ns
Supertrend 20 7.55 ns
Supertrend 200 7.75 ns
OBV 1.16 ns
VWAP Day 6.63 ns
Parabolic SAR 0.02/0.2 5.74 ns
Parabolic SAR 0.01/0.4 5.54 ns

Repaint Stream — process 395 bars × 3 ticks post-warmup

Indicator Period Time (median) Throughput
SMA 20 1.28 µs 928 Melem/s
SMA 200 1.31 µs 908 Melem/s
EMA 20 1.95 µs 607 Melem/s
EMA 200 1.95 µs 607 Melem/s
BB 20 1.70 µs 696 Melem/s
BB 200 1.70 µs 699 Melem/s
RSI 14 2.83 µs 419 Melem/s
RSI 140 2.85 µs 416 Melem/s
MACD 12/26/9 1.66 µs 716 Melem/s
MACD 120/260/90 1.66 µs 716 Melem/s
ATR 14 1.11 µs 1.07 Gelem/s
ATR 140 1.11 µs 1.07 Gelem/s
Stoch 14/3/3 7.29 µs 163 Melem/s
Stoch 140/30/30 10.72 µs 111 Melem/s
KC 20/10 2.54 µs 466 Melem/s
KC 200/100 2.57 µs 461 Melem/s
DC 20 4.10 µs 289 Melem/s
DC 200 10.06 µs 118 Melem/s
ADX 14 5.24 µs 226 Melem/s
ADX 140 5.24 µs 226 Melem/s
WillR 14 4.19 µs 283 Melem/s
WillR 140 7.60 µs 156 Melem/s
CCI 20 4.25 µs 279 Melem/s
CCI 200 60.16 µs 19.7 Melem/s
CHOP 14 7.53 µs 157 Melem/s
CHOP 140 10.76 µs 110 Melem/s
Ichimoku 9/26/52/26 14.75 µs 80.3 Melem/s
Ichimoku 36/104/208/104 22.66 µs 52.3 Melem/s
StochRSI 14/14/3/3 9.66 µs 123 Melem/s
StochRSI 140/140/30/30 11.52 µs 103 Melem/s
Supertrend 20 2.91 µs 408 Melem/s
Supertrend 200 2.93 µs 404 Melem/s
OBV 1.72 µs 687 Melem/s
VWAP Day 1.53 µs 772 Melem/s
Parabolic SAR 0.02/0.2 5.48 µs 216 Melem/s
Parabolic SAR 0.01/0.4 5.48 µs 216 Melem/s

Run locally:

cargo bench                    # all benchmarks
cargo bench -- stream          # stream only
cargo bench -- tick            # single-tick only
cargo bench -- repaint$        # single-repaint only
cargo bench -- repaint_stream  # repaint stream only

Minimum Supported Rust Version

1.93

Licence

Licensed under either of:

at your option.

Contributing

Contributions welcome. Please open an issue before submitting large changes.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 licence, shall be dual-licensed as above, without any additional terms or conditions.