tulip_rs 0.1.6

High-performance technical analysis library — 100+ indicators and 60+ candlestick patterns with SIMD acceleration
Documentation
use crate::indicators::linreg::State;
#[cfg(feature = "simd_assets")]
pub use crate::indicators::simd_indicators::by_asset::linreg::indicator_by_assets;

#[cfg(feature = "simd_options")]
pub use crate::indicators::simd_indicators::by_option::linreg::indicator_by_options;

use std::simd::{Simd, StdFloat};

/// SIMD-parallel state for computing Linear Regression across `N` assets/options simultaneously.
/// Each field is a SIMD vector where lane `i` corresponds to asset/option `i`.
pub struct SimdState<const N: usize> {
    /// Running sum of x (time-index) values — precomputed and constant for a given period.
    pub sum_x: Simd<f64, N>,
    /// Running sum of y (price) values over the current window.
    pub sum_y: Simd<f64, N>,
    /// Running sum of x*y cross-products over the current window.
    pub sum_xy: Simd<f64, N>,
    /// Precomputed denominator `1 / (period * sum_x^2 - sum_x^2)` used each bar.
    pub per: Simd<f64, N>,
}
impl<const N: usize> SimdState<N> {
    /// Gathers `N` mutable scalar [`State`] references into a single `SimdState`, packing each field into a SIMD lane.
    pub fn new_mut_ref(states: &[&mut State]) -> Self {
        let mut sum_x = [0.0; N];
        let mut sum_y = [0.0; N];
        let mut sum_xy = [0.0; N];
        let mut per = [0.0; N];

        for i in 0..N {
            sum_x[i] = states[i].sum_x;
            sum_y[i] = states[i].sum_y;
            sum_xy[i] = states[i].sum_xy;
            per[i] = states[i].per;
        }
        Self {
            sum_x: Simd::from_array(sum_x),
            sum_y: Simd::from_array(sum_y),
            sum_xy: Simd::from_array(sum_xy),
            per: Simd::from_array(per),
        }
    }
    /// Gathers `N` immutable scalar [`State`] references into a single `SimdState`, packing each field into a SIMD lane.
    pub fn new(states: &[&State]) -> Self {
        let mut sum_x = [0.0; N];
        let mut sum_y = [0.0; N];
        let mut sum_xy = [0.0; N];
        let mut per = [0.0; N];

        for i in 0..N {
            sum_x[i] = states[i].sum_x;
            sum_y[i] = states[i].sum_y;
            sum_xy[i] = states[i].sum_xy;
            per[i] = states[i].per;
        }
        Self {
            sum_x: Simd::from_array(sum_x),
            sum_y: Simd::from_array(sum_y),
            sum_xy: Simd::from_array(sum_xy),
            per: Simd::from_array(per),
        }
    }
    /// Scatters the SIMD state back into an array of `N` scalar [`State`] values.
    pub fn to_states(&self) -> [State; N] {
        let sum_x = self.sum_x.to_array();
        let sum_y = self.sum_y.to_array();
        let sum_xy = self.sum_xy.to_array();
        let per = self.per.to_array();

        let states: [State; N] =
            std::array::from_fn(|i| State::new(sum_x[i], sum_y[i], sum_xy[i], per[i]));

        states
    }
    /// Writes the SIMD state back into `N` existing mutable scalar [`State`] references in place.
    pub fn write_states(&self, states: &mut [&mut State]) {
        let sum_x = self.sum_x.to_array();
        let sum_y = self.sum_y.to_array();
        let sum_xy = self.sum_xy.to_array();

        for i in 0..N {
            states[i].sum_x = sum_x[i];
            states[i].sum_y = sum_y[i];
            states[i].sum_xy = sum_xy[i];
        }
    }
}

/// Computes one linear regression step across `N` lanes using SIMD parallelism.
///
/// Maintains running sums `sum_xy` and `sum_y` using a sliding-window update:
/// new value is added, oldest is evicted via `prev_value`. Computes slope,
/// intercept, and the end-point `linreg` value using FMA for each lane.
///
/// Returns `(linreg, slope, intercept)`.
#[inline(always)]
pub fn calc_simd<const N: usize>(
    state: &mut SimdState<N>,
    prev_value: Simd<f64, N>,
    value: Simd<f64, N>,
    period: Simd<f64, N>,
) -> (Simd<f64, N>, Simd<f64, N>, Simd<f64, N>) {
    let (sum_x, mut sum_y, mut sum_xy, per) = (state.sum_x, state.sum_y, state.sum_xy, state.per);

    // FMA: (value * period) + sum_xy
    sum_xy = value.mul_add(period, sum_xy);
    sum_y += value;

    // slope = (period * sum_xy - sum_x * sum_y) * per
    let slope = sum_x.mul_add(-sum_y, period * sum_xy) * per;

    // intercept = (sum_y - slope * sum_x) / period
    let intercept = slope.mul_add(-sum_x, sum_y) / period;

    // linreg = intercept + slope * period
    let linreg = slope.mul_add(period, intercept);

    sum_xy -= sum_y;
    sum_y -= prev_value;

    (state.sum_y, state.sum_xy) = (sum_y, sum_xy);
    (linreg, slope, intercept)
}