Skip to main content

SimpleImputer

Struct SimpleImputer 

Source
pub struct SimpleImputer<F> { /* private fields */ }
Expand description

An unfitted simple imputer.

Calling Fit::fit computes the per-column fill values according to the chosen ImputeStrategy and returns a FittedSimpleImputer that can transform new data by replacing NaN values with those fill values.

NaN values are ignored when computing statistics during fitting — e.g. the Mean strategy computes the mean of only the non-NaN elements.

§Examples

use ferrolearn_preprocess::imputer::{SimpleImputer, ImputeStrategy};
use ferrolearn_core::traits::{Fit, Transform};
use ndarray::array;

let imputer = SimpleImputer::<f64>::new(ImputeStrategy::Mean);
let x = array![[1.0, f64::NAN], [3.0, 4.0], [5.0, 6.0]];
let fitted = imputer.fit(&x, &()).unwrap();
let out = fitted.transform(&x).unwrap();
// NaN in column 1 row 0 is replaced with the mean of column 1 = (4+6)/2 = 5.0
assert!((out[[0, 1]] - 5.0).abs() < 1e-10);

Implementations§

Source§

impl<F: Float + Send + Sync + 'static> SimpleImputer<F>

Source

pub fn new(strategy: ImputeStrategy<F>) -> Self

Create a new SimpleImputer with the given strategy.

Source

pub fn strategy(&self) -> &ImputeStrategy<F>

Return the imputation strategy.

Trait Implementations§

Source§

impl<F: Clone> Clone for SimpleImputer<F>

Source§

fn clone(&self) -> SimpleImputer<F>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<F: Debug> Debug for SimpleImputer<F>

Source§

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

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

impl<F: Float + Send + Sync + 'static> Fit<ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>, ()> for SimpleImputer<F>

Source§

fn fit( &self, x: &Array2<F>, _y: &(), ) -> Result<FittedSimpleImputer<F>, FerroError>

Fit the imputer by computing per-column fill values.

NaN values are excluded from the statistic computation. Columns that are entirely NaN at fit time are filled with F::zero() for Mean and Median, and F::zero() for MostFrequent.

§Errors

Returns FerroError::InsufficientSamples if the input has zero rows.

Source§

type Fitted = FittedSimpleImputer<F>

The fitted model type returned by fit.
Source§

type Error = FerroError

The error type returned by fit.
Source§

impl<F: Float + Send + Sync + 'static> FitTransform<ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>> for SimpleImputer<F>

Source§

fn fit_transform(&self, x: &Array2<F>) -> Result<Array2<F>, FerroError>

Fit the imputer on x and return the imputed output in one step.

§Errors

Returns an error if fitting fails (e.g. zero rows).

Source§

type FitError = FerroError

The error type for the combined fit-transform operation.
Source§

impl PipelineTransformer<f64> for SimpleImputer<f64>

Source§

fn fit_pipeline( &self, x: &Array2<f64>, _y: &Array1<f64>, ) -> Result<Box<dyn FittedPipelineTransformer<f64>>, FerroError>

Fit the imputer using the pipeline interface.

The y argument is ignored; it exists only for API compatibility.

§Errors

Propagates errors from Fit::fit.

Source§

impl<F: Float + Send + Sync + 'static> Transform<ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>> for SimpleImputer<F>

Implement Transform on the unfitted imputer to satisfy the FitTransform: Transform supertrait bound. Always returns an error.

Source§

fn transform(&self, _x: &Array2<F>) -> Result<Array2<F>, FerroError>

Always returns an error — the imputer must be fitted first.

Use Fit::fit to produce a FittedSimpleImputer, then call Transform::transform on that.

Source§

type Output = ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>

The transformed output type.
Source§

type Error = FerroError

The error type returned by transform.

Auto Trait Implementations§

§

impl<F> Freeze for SimpleImputer<F>
where F: Freeze,

§

impl<F> RefUnwindSafe for SimpleImputer<F>
where F: RefUnwindSafe,

§

impl<F> Send for SimpleImputer<F>
where F: Send,

§

impl<F> Sync for SimpleImputer<F>
where F: Sync,

§

impl<F> Unpin for SimpleImputer<F>
where F: Unpin,

§

impl<F> UnsafeUnpin for SimpleImputer<F>
where F: UnsafeUnpin,

§

impl<F> UnwindSafe for SimpleImputer<F>
where F: UnwindSafe,

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

Source§

fn by_ref(&self) -> &T

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> DistributionExt for T
where T: ?Sized,

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,