tulip_rs 0.1.15

High-performance technical analysis library — 100+ indicators and 60+ candlestick patterns with SIMD acceleration
Documentation
use crate::common_simd::assets::validate_inputs;
use crate::indicators::ema::output_length as ema_output_length;
use crate::indicators::macd::{
    min_data, multiplier, output_length, validate_options, IndicatorState, State, INPUTS_WIDTH,
    OPTIONS_WIDTH,
};
use crate::indicators::simd_indicators::macd_simd::{calc_simd, SimdState};
use crate::indicators::simd_indicators::road_train::{Asset, Driver, PrimeMover};
use crate::types::IndicatorError;
use std::simd::Simd;

/// SIMD driver that advances the Moving Average Convergence Divergence (MACD) across `N`
/// asset lanes per scheduling epoch.
struct MacdDriver {
    multipliers: ((f64, f64), (f64, f64), (f64, f64)),
    want_optional_outputs: (bool, bool, bool),
}

impl Driver<State> for MacdDriver {
    /// Processes one epoch of bars for `N` assets simultaneously using SIMD.
    ///
    /// Reads from `inputs[asset][0]` (real), writes the MACD line to `outputs[asset][0]`,
    /// signal line to `outputs[asset][1]`, histogram to `outputs[asset][2]`, optional short
    /// EMA to `outputs[asset][3]`, optional long EMA to `outputs[asset][4]`, and updates
    /// `states[asset]` in place.
    fn next_run<const N: usize>(
        &mut self,
        inputs: Vec<Vec<&[f64]>>,
        mut outputs: Vec<Vec<&mut [f64]>>,
        mut states: Vec<&mut State>,
        _options: Vec<Option<&()>>,
    ) {
        let len = inputs[0][0].len();

        let mut state = SimdState::new(&states);

        let multipliers_simd = (
            (
                Simd::splat(self.multipliers.0 .0),
                Simd::splat(self.multipliers.0 .1),
            ),
            (
                Simd::splat(self.multipliers.1 .0),
                Simd::splat(self.multipliers.1 .1),
            ),
            (
                Simd::splat(self.multipliers.2 .0),
                Simd::splat(self.multipliers.2 .1),
            ),
        );
        let (has_optional, want_short_ema, want_long_ema) = self.want_optional_outputs;
        // Pre-compute pointers for maximum efficiency
        let input_ptrs = crate::extract_input_ptrs!(inputs, N, input_ptrs);
        let (
            macd_line_ptr,
            signal_line_ptr,
            histogram_line_ptr,
            short_ema_line_ptr,
            long_ema_line_ptr,
        ) = crate::extract_output_ptrs!(
            outputs,
            N,
            macd_line_ptr,
            signal_line_ptr,
            histogram_line_ptr,
            short_ema_line_ptr,
            long_ema_line_ptr
        );

        // Optimized main loop with minimal overhead
        for i in 0..len {
            let values = crate::extract_simd_inputs_at_index!(i, N, values @ input_ptrs);

            let (macd, signal, histogram) = calc_simd(&mut state, values, multipliers_simd);

            // Direct SIMD store if possible, otherwise individual stores
            crate::write_simd_at_indices!(N, i,
                macd_line_ptr => macd,
                signal_line_ptr => signal,
                histogram_line_ptr => histogram
            );
            if has_optional {
                crate::store_simd_optional_outputs!(i, N,
                    want_short_ema, short_ema_line_ptr => state.short_ema,
                    want_long_ema, long_ema_line_ptr => state.long_ema
                );
            }
        }

        // Update states efficiently
        state.write_states(&mut states);
    }
}

/// Calculates the Moving Average Convergence Divergence (MACD) for `N` assets simultaneously
/// using SIMD parallelism.
///
/// Uses the [`PrimeMover`] scheduler to batch assets into SIMD-width groups.
///
/// # Arguments
/// * `inputs` - An array of `N` asset input sets; `inputs[i]` is `[&[f64]; INPUTS_WIDTH]`
///   containing `[real]` for asset `i`.
/// * `options` - Shared options slice; `options[0]` is `short_period`, `options[1]` is
///   `long_period`, `options[2]` is `signal_period`.
/// * `optional_outputs` - Optional slice selecting extra outputs: index `0` = `short_ema`,
///   index `1` = `long_ema`.
///
/// # Returns
/// `Ok((outputs, states))` where `outputs[i][0]` is the MACD line, `outputs[i][1]` is the
/// signal line, `outputs[i][2]` is the histogram, `outputs[i][3]` is the optional
/// `short_ema`, `outputs[i][4]` is the optional `long_ema`, and `states[i]` is the final
/// [`IndicatorState`] for asset `i`.
/// Returns `Err(IndicatorError)` if any input slice is too short or options are invalid.
pub fn indicator_by_assets<const N: usize>(
    inputs: &[&[&[f64]; INPUTS_WIDTH]; N], //stock[ fields [ field [f64] ] ]
    options: &[f64; OPTIONS_WIDTH],
    optional_outputs: Option<&[bool]>,
) -> Result<(Vec<Vec<Vec<f64>>>, Vec<IndicatorState>), IndicatorError> {
    validate_inputs::<INPUTS_WIDTH>(inputs, min_data(options))?;
    validate_options(options)?;

    let short_period = options[0] as usize;
    let long_period = options[1] as usize;
    let signal_period = options[2] as usize;
    let multipliers = multiplier(short_period, long_period, signal_period);
    let mut output_buffers = Vec::with_capacity(N);

    let mut road_train = PrimeMover::<N, State>::new();
    let mut want_optional_outputs = (false, false, false);
    let start = long_period + signal_period - 2;
    for i in 0..N {
        let len = inputs[i][0].len();
        let (macd_capacity, signal_capacity, histogram_capacity) = output_length(len, options);

        let short_ema_capacity = ema_output_length(len, &[short_period as f64]);
        let long_ema_capacity = ema_output_length(len, &[long_period as f64]);
        // Pre-allocate the result vectors with the calculated capacities
        let mut macd_line = crate::uninit_vec!(f64, macd_capacity);
        let signal_line = crate::uninit_vec!(f64, signal_capacity);
        let histogram = crate::uninit_vec!(f64, histogram_capacity);

        let (mut short_ema_line, mut long_ema_line) = crate::init_optional_outputs!(
            optional_outputs, &[false, false],
            short_ema_line: short_ema_capacity,
            long_ema_line: long_ema_capacity
        );

        let state = State::init_state(
            inputs[i][0],
            (short_period, long_period, signal_period),
            multipliers,
            &mut macd_line,
            (&mut short_ema_line, &mut long_ema_line),
        );
        let asset_inputs = vec![inputs[i][0]];
        let mut starts = [0; 5];
        (starts[0], starts[3], starts[4]) =
            crate::slice_outputs_start!(signal_capacity, macd_line, short_ema_line, long_ema_line);

        if i == 0 {
            want_optional_outputs = crate::calc_want_flags!(short_ema_line, long_ema_line);
        }
        let mut output_buffer = vec![
            macd_line,
            signal_line,
            histogram,
            short_ema_line,
            long_ema_line,
        ];
        //let adosc_len = output_buffer[0].len();
        let mut asset_outputs = Vec::with_capacity(output_buffer.len());

        for j in 0..output_buffer.len() {
            unsafe {
                //let slice_len = output_buffer.len() - starts[j];
                // Get a mutable reference to the output buffer for this asset
                let output_buffer = &mut output_buffer[j];
                asset_outputs.push(std::slice::from_raw_parts_mut(
                    output_buffer.as_mut_ptr().add(starts[j]), //slice from
                    output_buffer.len() - starts[j],           // slice to
                ));
            }
        }
        road_train.add_asset(Asset::new(
            asset_inputs,
            asset_outputs,
            i,
            start,
            0,
            state,
            None,
        ));
        output_buffers.push(output_buffer);
    }
    let mut driver = MacdDriver {
        multipliers,
        want_optional_outputs,
    };
    let states_vec = road_train.drive(&mut driver);

    let mut states = Vec::with_capacity(N);
    for state in states_vec {
        states.push(IndicatorState::new(multipliers, state));
    }
    Ok((output_buffers, states))
}