Skip to main content

ElasticNet

Struct ElasticNet 

Source
pub struct ElasticNet {
    pub coef: Array1<f64>,
    pub intercept: f64,
    pub alpha: f64,
    pub l1_ratio: f64,
    pub fit_intercept: bool,
    pub n_iter: usize,
    pub converged: bool,
}
Expand description

Elastic-net penalised linear regression by coordinate descent.

l1_ratio ∈ [0, 1] mixes the two penalties: α · (l1_ratio · ‖β‖₁ + ½ · (1 − l1_ratio) · ‖β‖²). l1_ratio = 1 reduces to Lasso; l1_ratio = 0 reduces to Ridge (though the dedicated Ridge implementation is faster for that case).

Fields§

§coef: Array1<f64>

Fitted coefficients.

§intercept: f64

Fitted intercept.

§alpha: f64

Penalty strength.

§l1_ratio: f64

L¹ vs L² mixing.

§fit_intercept: bool

Whether the fit included an intercept.

§n_iter: usize

Number of outer coordinate-descent sweeps that ran.

§converged: bool

Whether the final sweep’s max coordinate change fell below tol.

Implementations§

Source§

impl ElasticNet

Source

pub fn fit( y: ArrayView1<'_, f64>, x: ArrayView2<'_, f64>, alpha: f64, l1_ratio: f64, fit_intercept: bool, ) -> Result<Self>

Fit with default settings.

Source

pub fn fit_with( y: ArrayView1<'_, f64>, x: ArrayView2<'_, f64>, alpha: f64, l1_ratio: f64, fit_intercept: bool, max_iter: usize, tol: f64, ) -> Result<Self>

Full-configuration fit.

§Convergence

Coordinate descent on the ElasticNet objective is provably convergent for alpha ≥ 0, l1_ratio ∈ [0, 1]. Convergence is monitored via the maximum absolute change in any coordinate across a full sweep; the fit terminates when this falls below tol or max_iter sweeps have run (whichever first).

Source

pub fn predict(&self, x: ArrayView2<'_, f64>) -> Result<Array1<f64>>

Predict.

Trait Implementations§

Source§

impl Clone for ElasticNet

Source§

fn clone(&self) -> Self

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 ElasticNet

Source§

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

Formats the value using the given formatter. Read more

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.