ferro_ta_core 1.1.0

Pure Rust core indicator library — no PyO3, no numpy dependency
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

//! Futures curve and term-structure analytics.

use super::basis;

/// Curve summary metrics.
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct CurveSummary {
    pub front_basis: f64,
    pub average_basis: f64,
    pub slope: f64,
    pub is_contango: bool,
}

fn regression_slope(xs: &[f64], ys: &[f64]) -> f64 {
    if xs.len() != ys.len() || xs.len() < 2 {
        return f64::NAN;
    }
    let n = xs.len() as f64;
    let mean_x = xs.iter().sum::<f64>() / n;
    let mean_y = ys.iter().sum::<f64>() / n;
    let mut cov = 0.0;
    let mut var = 0.0;
    for (&x, &y) in xs.iter().zip(ys.iter()) {
        cov += (x - mean_x) * (y - mean_y);
        var += (x - mean_x) * (x - mean_x);
    }
    if var == 0.0 {
        f64::NAN
    } else {
        cov / var
    }
}

/// Calendar spreads between adjacent contracts.
pub fn calendar_spreads(futures_prices: &[f64]) -> Vec<f64> {
    futures_prices.windows(2).map(|w| w[1] - w[0]).collect()
}

/// Curve slope across tenor buckets.
pub fn curve_slope(tenors: &[f64], futures_prices: &[f64]) -> f64 {
    regression_slope(tenors, futures_prices)
}

/// Summary statistics for a forward curve.
pub fn curve_summary(spot: f64, tenors: &[f64], futures_prices: &[f64]) -> CurveSummary {
    if futures_prices.is_empty() || tenors.len() != futures_prices.len() {
        return CurveSummary {
            front_basis: f64::NAN,
            average_basis: f64::NAN,
            slope: f64::NAN,
            is_contango: false,
        };
    }
    let bases: Vec<f64> = futures_prices
        .iter()
        .map(|&price| basis::basis(spot, price))
        .collect();
    let average_basis = bases.iter().sum::<f64>() / bases.len() as f64;
    let is_contango = futures_prices.windows(2).all(|w| w[1] >= w[0]);
    CurveSummary {
        front_basis: basis::basis(spot, futures_prices[0]),
        average_basis,
        slope: curve_slope(tenors, futures_prices),
        is_contango,
    }
}

#[cfg(test)]
mod tests {
    use super::{calendar_spreads, curve_slope, curve_summary};

    #[test]
    fn calendar_spreads_are_correct() {
        assert_eq!(calendar_spreads(&[100.0, 101.0, 103.0]), vec![1.0, 2.0]);
    }

    #[test]
    fn curve_summary_detects_contango() {
        let summary = curve_summary(100.0, &[0.1, 0.5, 1.0], &[101.0, 102.0, 104.0]);
        assert!(summary.is_contango);
        assert!(curve_slope(&[0.1, 0.5, 1.0], &[101.0, 102.0, 104.0]) > 0.0);
    }
}