Skip to main content

VarianceThreshold

Struct VarianceThreshold 

Source
#[non_exhaustive]
pub struct VarianceThreshold { /* private fields */ }
Expand description

Remove features whose variance falls below a threshold.

By default, removes only constant features (threshold = 0.0). Useful as a lightweight first step before expensive feature selectors.

§Examples

use scry_learn::dataset::Dataset;
use scry_learn::preprocess::Transformer;
use scry_learn::feature_selection::VarianceThreshold;

let mut data = Dataset::new(
    vec![
        vec![1.0, 2.0, 3.0],  // variable
        vec![5.0, 5.0, 5.0],  // constant — will be removed
    ],
    vec![0.0, 1.0, 0.0],
    vec!["a".into(), "b".into()],
    "target",
);

let mut vt = VarianceThreshold::new();
vt.fit_transform(&mut data).unwrap();
assert_eq!(data.n_features(), 1); // only "a" remains

Implementations§

Source§

impl VarianceThreshold

Source

pub fn new() -> Self

Create a new selector with threshold 0.0 (remove only constants).

Source

pub fn threshold(self, t: f64) -> Self

Set the variance threshold.

Features with variance ≤ this value are removed.

Source

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

Per-feature variances computed during fit.

§Panics

Panics if called before VarianceThreshold::fit.

Source

pub fn get_support(&self) -> &[bool]

Boolean mask of selected features.

true at index j means feature j was kept.

Trait Implementations§

Source§

impl Clone for VarianceThreshold

Source§

fn clone(&self) -> VarianceThreshold

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 VarianceThreshold

Source§

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

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

impl Default for VarianceThreshold

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Transformer for VarianceThreshold

Source§

fn fit(&mut self, data: &Dataset) -> Result<()>

Learn parameters from the training data.
Source§

fn transform(&self, data: &mut Dataset) -> Result<()>

Apply the learned transformation to a dataset (in-place).
Source§

fn inverse_transform(&self, _data: &mut Dataset) -> Result<()>

Reverse the transformation (if invertible).
Source§

fn fit_transform(&mut self, data: &mut Dataset) -> Result<()>

Convenience: fit + transform in one call.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.