kestrel-chartkit 0.11.3

High-performance Rust technical analysis library for indicator math, market regime classification, composite scoring, and SVG visualization.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

//! On-demand analytical snapshots over chronological OHLCV bars.
//! These are pure computations: no provider, persistence, strategy scheduling or UI dependencies.
//! Callers provide finite input bars and applicable volume data. Timestamp values are not inspected.
//! Output enums/fields preserve the existing consumer wire representation with the serde feature.

mod activity;
mod cheat_sheet;
mod fear_gauge;
mod fear_greed;
mod price;
mod regime;
mod seasonality;
mod trend;
mod trend_persistence;

pub use activity::{activity_reading, ActivityReading};
pub use cheat_sheet::{
    cheat_sheet, CheatSheetLevel, CheatSheetLevelKind, CheatSheetLevelSide, CheatSheetReading,
};
pub use fear_gauge::{fear_gauge_reading, FearGaugeReading, FearGaugeState};
pub use fear_greed::{fear_greed_reading, FearGreedDriver, FearGreedReading, FearGreedState};
pub use price::{price_summary, PriceSummary};
pub use regime::{classify_regime as classify_trend_regime, RegimeReading, RegimeState};
pub use seasonality::{monthly_seasonality, MonthStatistics, MonthlyReturn, SeasonalityReport};
pub use trend::{trend_reading, MarketPhase, TrendDirection, TrendReading};
pub use trend_persistence::{
    trend_persistence_reading, TrendPersistenceDirection, TrendPersistenceReading,
    TrendPersistenceSensor, TrendPersistenceState,
};

/// True range for a bar given the previous bar's close: the full
/// three-term form, or high−low on the very first bar. Shared by the
/// regime (Choppiness) and price (ATR) read-outs.
fn true_range(bar: &crate::Bar, prev_close: Option<f64>) -> f64 {
    match prev_close {
        None => bar.high - bar.low,
        Some(prev) => (bar.high - bar.low)
            .max((bar.high - prev).abs())
            .max((bar.low - prev).abs()),
    }
}

/// Kaufman Efficiency Ratio over the last `n` price changes (needs `n`+1
/// closes): net move ÷ summed absolute moves, 0 = pure chop, 1 = a perfectly
/// straight move. Shared by `regime` (regime vote) and `trend_persistence`
/// (one of its four trend sensors) — same formula, same window shape.
fn efficiency_ratio(bars: &[crate::Bar], n: usize) -> Option<f64> {
    if bars.len() < n + 1 {
        return None;
    }
    let closes = &bars[bars.len() - n - 1..];
    let net = (closes[closes.len() - 1].close - closes[0].close).abs();
    let mut volatility = 0.0;
    for pair in closes.windows(2) {
        volatility += (pair[1].close - pair[0].close).abs();
    }
    if volatility <= 0.0 {
        return None;
    }
    Some(net / volatility)
}

mod position;
pub use position::{atr_distance, position_alignment, PositionAlignment};