Struct LinearScaler

Source
pub struct LinearScaler<F: Float> { /* private fields */ }
Expand description

The result of fitting a linear scaler. Scales datasets with the parameters learned during fitting.

Implementations§

Source§

impl<F: Float> LinearScaler<F>

Source

pub fn standard() -> LinearScalerParams<F>

Initializes a Standard scaler

Source

pub fn standard_no_mean() -> LinearScalerParams<F>

Initializes a Standard scaler that does not subract the mean to the features

Source

pub fn standard_no_std() -> LinearScalerParams<F>

Initializes a Stadard scaler that does not scale the features by the inverse of the standard deviation

Source

pub fn min_max() -> LinearScalerParams<F>

Initializes a MinMax scaler with range 0..=1

Source

pub fn min_max_range(min: F, max: F) -> LinearScalerParams<F>

Initializes a MinMax scaler with the specified minimum and maximum values for the range.

If min is bigger than max then fitting will return an error on any input.

Source

pub fn max_abs() -> LinearScalerParams<F>

Initializes a MaxAbs scaler

Source§

impl<F: Float> LinearScaler<F>

Source

pub fn offsets(&self) -> &Array1<F>

Array of size n_features that contains the offset that will be subtracted to each feature

Source

pub fn scales(&self) -> &Array1<F>

Array of size n_features that contains the scale that will be applied to each feature

Source

pub fn method(&self) -> &ScalingMethod<F>

Returns the method used for fitting. Useful for printing, since ScalingMethod implements Display

Trait Implementations§

Source§

impl<F: Clone + Float> Clone for LinearScaler<F>

Source§

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

Returns a copy 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 + Float> Debug for LinearScaler<F>

Source§

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

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

impl<F: PartialEq + Float> PartialEq for LinearScaler<F>

Source§

fn eq(&self, other: &LinearScaler<F>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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<F: Float> Transformer<ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>> for LinearScaler<F>

Source§

fn transform(&self, x: Array2<F>) -> Array2<F>

Scales an array of size (nsamples, nfeatures) according to the scaler’s offsets and scales. Panics if the shape of the input array is not compatible with the shape of the dataset used for fitting.

Source§

impl<F: Float, D: Data<Elem = F>, T: AsTargets> Transformer<DatasetBase<ArrayBase<D, Dim<[usize; 2]>>, T>, DatasetBase<ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>, T>> for LinearScaler<F>

Source§

fn transform( &self, x: DatasetBase<ArrayBase<D, Ix2>, T>, ) -> DatasetBase<Array2<F>, T>

Substitutes the records of the dataset with their scaled version. Panics if the shape of the records is not compatible with the shape of the dataset used for fitting.

Source§

impl<F: Eq + Float> Eq for LinearScaler<F>

Source§

impl<F: Float> StructuralPartialEq for LinearScaler<F>

Auto Trait Implementations§

§

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

§

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

§

impl<F> Send for LinearScaler<F>

§

impl<F> Sync for LinearScaler<F>

§

impl<F> Unpin for LinearScaler<F>

§

impl<F> UnwindSafe for LinearScaler<F>

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<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

unsafe fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.
§

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

§

fn vzip(self) -> V