Skip to main content

MinMaxScaler

Struct MinMaxScaler 

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

Streaming min-max scaler – incremental feature scaling to a configurable range.

Tracks per-feature running minimum and maximum values, scaling features to a target range (default [0, 1]). Each call to update_and_transform incorporates a new sample in O(n_features) time with zero allocations (after the first sample initializes internal buffers).

Scaling formula:

scaled = (x - min) / (max - min) * (range_high - range_low) + range_low

When max - min < f64::EPSILON for a feature (zero range), the scaler outputs the midpoint of the target range to avoid division by zero.

§Example

use irithyll::preprocessing::MinMaxScaler;
use irithyll::pipeline::StreamingPreprocessor;

let mut scaler = MinMaxScaler::new();

// Feed samples one at a time.
scaler.update_and_transform(&[0.0, 100.0]);
scaler.update_and_transform(&[10.0, 0.0]);

// Transform a new observation using running min/max.
let scaled = scaler.transform(&[5.0, 50.0]);
assert!((scaled[0] - 0.5).abs() < 1e-9);
assert!((scaled[1] - 0.5).abs() < 1e-9);

Implementations§

Source§

impl MinMaxScaler

Source

pub fn new() -> Self

Create a scaler with the default target range [0, 1].

The number of features is inferred from the first call to update_and_transform.

use irithyll::preprocessing::MinMaxScaler;
let scaler = MinMaxScaler::new();
Source

pub fn with_range(low: f64, high: f64) -> Self

Create a scaler with a custom output range [low, high].

§Panics

Panics if low >= high.

use irithyll::preprocessing::MinMaxScaler;
let scaler = MinMaxScaler::with_range(-1.0, 1.0);
Source

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

Per-feature running minimums observed so far.

Empty until the first sample has been incorporated.

Source

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

Per-feature running maximums observed so far.

Empty until the first sample has been incorporated.

Source

pub fn range(&self) -> (f64, f64)

The configured output range as (low, high).

Source

pub fn count(&self) -> u64

Number of samples incorporated so far.

Trait Implementations§

Source§

impl Clone for MinMaxScaler

Source§

fn clone(&self) -> MinMaxScaler

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 Debug for MinMaxScaler

Source§

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

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

impl Default for MinMaxScaler

Source§

fn default() -> Self

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

impl StreamingPreprocessor for MinMaxScaler

Source§

fn update_and_transform(&mut self, features: &[f64]) -> Vec<f64>

Update running min/max from this sample and return scaled features.

On the first call, initializes internal buffers from the sample. Since min == max for every feature after a single sample, all outputs will be the midpoint of the target range.

Source§

fn transform(&self, features: &[f64]) -> Vec<f64>

Scale features using current min/max without updating statistics.

If no samples have been seen yet (no min/max stats), features pass through unscaled.

Source§

fn output_dim(&self) -> Option<usize>

Number of output features, or None if unknown until the first sample.

Source§

fn reset(&mut self)

Reset to initial (untrained) state.

Clears mins, maxs, sets n_features to None, and resets count to 0. Preserves the configured output range.

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

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,