Skip to content

LinReg — Linear Regression — linreg

The end-point of a least-squares linear regression line fitted to the last period bars. Often used as a low-lag trend line.

Inputs: [real] | Options: [period] | Outputs: [linreg]

Basic

use tulip_rs::indicators::linreg::indicator;

let (outputs, _) = indicator(&[close.as_slice()], &[14.0], None).unwrap();
println!("{:?}", outputs[0]);

outputs, state = tulip_rs.indicators.linreg.indicator([close], [14.0])
print(outputs[0])

import * as ti from 'tulip-rs-node';

const close = [81.59, 81.06, 82.87, 83.00, 83.61,
               83.15, 82.84, 83.99, 84.55, 84.36,
               85.53, 86.54, 86.89, 87.77, 87.29];

const [outputs, state] = ti.linreg.indicator([close], [14]);
console.log('LinReg(14):', outputs[0]);

// State continuation
const [, state2] = ti.linreg.indicator([close.slice(0, -5)], [14]);
const continued = state2.batchIndicator([close.slice(-5)]);
console.log('Continued LinReg:', continued[0]);

import { init } from 'tulip-rs-wasm';
import * as ti from 'tulip-rs-wasm';

await init(); // bundler resolves the WASM asset automatically

const close = [81.59, 81.06, 82.87, 83.00, 83.61,
               83.15, 82.84, 83.99, 84.55, 84.36,
               85.53, 86.54, 86.89, 87.77, 87.29];

const [outputs, state] = ti.linreg.indicator([close], [14]);
console.log('LinReg(14):', outputs[0]);

// State continuation
const [, state2] = ti.linreg.indicator([close.slice(0, -5)], [14]);
const continued = state2.batchIndicator([close.slice(-5)]);
console.log('Continued LinReg:', continued[0]);

Optional Outputs

linreg exposes 2 optional outputs: linregslope, linregintercept. Pass a boolean mask as the third argument — one bool per optional output, in order.

use tulip_rs::indicators::linreg::indicator;

let close = vec![81.59, 81.06, 82.87, 83.00, 83.61,
                 83.15, 82.84, 83.99, 84.55, 84.36_f64];

let mask = [true, true]; // one per optional output
let (outputs, _state) = indicator(&[close.as_slice()], &[14.0], Some(&mask)).unwrap();

let linreg          = &outputs[0]; // linreg (primary)
let linregslope     = &outputs[1]; // linregslope (optional — requested)
let linregintercept = &outputs[2]; // linregintercept (optional — requested)

import numpy as np
import tulip_rs

close = np.array([81.59, 81.06, 82.87, 83.00, 83.61,
                  83.15, 82.84, 83.99, 84.55, 84.36], dtype=np.float64)

outputs, state = tulip_rs.indicators.linreg.indicator(
    [close], [14.0],
    optional_outputs=[True, True],
)

linreg          = outputs[0]  # linreg (primary)
linregslope     = outputs[1]  # linregslope (optional — requested)
linregintercept = outputs[2]  # linregintercept (optional — requested)

linreg exposes 2 optional outputs: linregslope, linregintercept.

const [allOut] = ti.linreg.indicator([close], [14], [true, true]);
const linreg          = allOut[0]; // primary
const linregslope     = allOut[1]; // optional 0: linregslope
const linregintercept = allOut[2]; // optional 1: linregintercept

SIMD

By assets — same options, N assets in parallel:

use tulip_rs::indicators::linreg::indicator_by_assets;

let inputs: [&[&[f64]; 1]; 4] = [&[a1.as_slice()], &[a2.as_slice()], &[a3.as_slice()], &[a4.as_slice()]];
let results = indicator_by_assets::<4>(&inputs, &[14.0], None).unwrap();

By options — same asset, N option sets in parallel:

use tulip_rs::indicators::linreg::indicator_by_options;

let opts: [&[f64; 1]; 4] = [&[7.0], &[14.0], &[21.0], &[28.0]];
let results = indicator_by_options::<4>(&[close.as_slice()], &opts, None).unwrap();

By assets — same options, N assets in parallel (must be 2, 4, 8, or 16):

simd_inputs = [[a1], [a2], [a3], [a4]]
outputs_list, states = tulip_rs.indicators.linreg.simd_by_assets(simd_inputs, [14.0])

By options — same asset, N option sets in parallel:

simd_options = [[7.0], [14.0], [21.0], [28.0]]
outputs_list, states = tulip_rs.indicators.linreg.simd_by_options([close], simd_options)

By assets — same period applied to 4 assets in parallel:

const simdInputs = [[[...close]], [close.map(v => v * 1.1)], [close.map(v => v * 0.9)], [close.map(v => v * 1.02)]];
const [results] = ti.linreg.simdByAssets(simdInputs, [14]);
results.forEach((out, i) => console.log(`Asset ${i + 1}:`, out[0]));

By options — same asset, 4 different periods in parallel:

const simdOptions = [[7], [14], [21], [28]];
const [results] = ti.linreg.simdByOptions([close], simdOptions);
results.forEach((out, i) => console.log(`Period ${simdOptions[i][0]}:`, out[0]));