Skip to main content

LinearModel

Struct LinearModel 

Source
pub struct LinearModel { /* private fields */ }
Expand description

A fitted linear model: an intercept plus one slope per predictor column.

Fields are private so the fitted parameters stay an invariant pair (the intercept and slopes always come from the same fit); read them through LinearModel::intercept and LinearModel::coefficients, and evaluate the model with LinearModel::predict / LinearModel::r_squared.

Implementations§

Source§

impl LinearModel

Source

pub const fn intercept(&self) -> f64

Returns the fitted intercept term (β₀).

Source

pub fn coefficients(&self) -> &[f64]

Returns the fitted slope coefficients, one per predictor column in input column order.

Source

pub fn predict(&self, row: &[f64]) -> f64

Predicts the target for a single observation row.

Computes β₀ + Σ_j β_j x_j. Coordinates of row beyond the fitted slope count are ignored, and missing coordinates contribute zero, so a row whose length differs from the training width still yields a finite prediction (callers are responsible for passing rows of the fitted dimension).

§Arguments
  • row — the predictor values for one observation, in fitted column order.
§Returns

The model’s scalar prediction ŷ for row.

Source

pub fn r_squared(&self, x: &[Vec<f64>], y: &[f64]) -> f64

Computes the coefficient of determination of the model on x/y.

R² = 1 − SS_res / SS_tot, where SS_res = Σ(yᵢ − ŷᵢ)² and SS_tot = Σ(yᵢ − ȳ)². Matches scikit-learn’s score: when SS_tot is zero (a constant target) the result is 1.0 if the residuals also vanish, else 0.0. can be negative when the model fits worse than the mean.

§Arguments
  • x — design matrix to score against, one inner slice per observation.
  • y — observed targets, one per row of x.
§Returns

The score in (−∞, 1.0]. An empty y yields 0.0.

Trait Implementations§

Source§

impl Clone for LinearModel

Source§

fn clone(&self) -> LinearModel

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LinearModel

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for LinearModel

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for LinearModel

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.