Struct linfa_preprocessing::whitening::FittedWhitener
source · pub struct FittedWhitener<F: Float> { /* private fields */ }
Expand description
Struct that can be used to whiten data. Data will be scaled according to the whitening matrix learned during fitting. Obtained by fitting a Whitener.
Transforming the data used during fitting will yield a scaled data matrix with unit diagonal covariance matrix.
Example
use linfa::traits::{Fit, Transformer};
use linfa_preprocessing::whitening::Whitener;
// Load dataset
let dataset = linfa_datasets::diabetes();
// Learn whitening parameters
let whitener = Whitener::pca().fit(&dataset).unwrap();
// transform dataset according to whitening parameters
let dataset = whitener.transform(dataset);
Implementations§
source§impl<F: Float> FittedWhitener<F>
impl<F: Float> FittedWhitener<F>
sourcepub fn transformation_matrix(&self) -> ArrayView2<'_, F>
pub fn transformation_matrix(&self) -> ArrayView2<'_, F>
The matrix used for scaling the data
sourcepub fn mean(&self) -> ArrayView1<'_, F>
pub fn mean(&self) -> ArrayView1<'_, F>
The means that will be subtracted to the features before scaling the data
Trait Implementations§
source§impl<F: Clone + Float> Clone for FittedWhitener<F>
impl<F: Clone + Float> Clone for FittedWhitener<F>
source§fn clone(&self) -> FittedWhitener<F>
fn clone(&self) -> FittedWhitener<F>
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl<F: PartialEq + Float> PartialEq for FittedWhitener<F>
impl<F: PartialEq + Float> PartialEq for FittedWhitener<F>
source§fn eq(&self, other: &FittedWhitener<F>) -> bool
fn eq(&self, other: &FittedWhitener<F>) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.source§impl<F: Float> Transformer<ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>> for FittedWhitener<F>
impl<F: Float> Transformer<ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>> for FittedWhitener<F>
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 FittedWhitener<F>
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 FittedWhitener<F>
fn transform( &self, x: DatasetBase<ArrayBase<D, Ix2>, T> ) -> DatasetBase<Array2<F>, T>
impl<F: Eq + Float> Eq for FittedWhitener<F>
impl<F: Float> StructuralEq for FittedWhitener<F>
impl<F: Float> StructuralPartialEq for FittedWhitener<F>
Auto Trait Implementations§
impl<F> RefUnwindSafe for FittedWhitener<F>where
F: RefUnwindSafe,
impl<F> Send for FittedWhitener<F>
impl<F> Sync for FittedWhitener<F>
impl<F> Unpin for FittedWhitener<F>
impl<F> UnwindSafe for FittedWhitener<F>where
F: RefUnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key
and return true
if they are equal.