Struct LinearRegression

pub struct LinearRegression {
    pub slope: f64,
    pub mean_x: f64,
    pub mean_y: f64,
}

Simple linear regression from provided data.

use irox_stats::sampling::Sample;
use irox_time::epoch::UnixTimestamp;
use irox_stats::fitting::LinearRegression;

let data = &[
            Sample::new(0., UnixTimestamp::from_seconds(0)),
            Sample::new(0.5, UnixTimestamp::from_seconds_f64(0.5)),
            Sample::new(1., UnixTimestamp::from_seconds(1)),
        ];

        let reg = LinearRegression::from_data(
            data.iter(),
            |s| s.time.get_offset().as_seconds_f64(),
            |s| s.value,
        );
        assert!(reg.is_some());
        let Some(reg) = reg else {
            return;
        };
        assert_eq!(1.0, reg.slope);
        assert_eq!(0.5, reg.mean_x);
        assert_eq!(0.5, reg.mean_y);

Fields

slope: f64

mean_x: f64

mean_y: f64

Implementations

impl LinearRegression

pub fn from_data<'a, S: 'a, I: Iterator<Item = S> + Clone, X: Fn(&S) -> f64, Y: Fn(&S) -> f64>( data: I, x_accessor: X, y_accessor: Y, ) -> Option<LinearRegression>

Trait Implementations

impl Clone for LinearRegression

fn clone(&self) -> LinearRegression

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LinearRegression

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for LinearRegression

fn eq(&self, other: &LinearRegression) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for LinearRegression

impl StructuralPartialEq for LinearRegression