Skip to main content

FittedPCA

ferrolearn_decomp::pca

Struct FittedPCA 

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

A fitted PCA model holding the learned principal components and statistics.

Created by calling Fit::fit on a PCA. Implements Transform<Array2<F>> to project new data, and provides inverse_transform to reconstruct approximate original data.

Implementations§

Source§

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

Source

pub fn components(&self) -> &Array2<F>

Principal components, shape (n_components, n_features).

Source

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

Explained variance per component (eigenvalues).

Source

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

Explained variance ratio per component.

Source

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

Per-feature mean learned during fitting.

Source

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

Singular values corresponding to each component.

Source

pub fn inverse_transform( &self, x_reduced: &Array2<F>, ) -> Result<Array2<F>, FerroError>

Reconstruct approximate original data from the reduced representation.

Computes X_approx = X_reduced @ components + mean.

§Errors

Returns FerroError::ShapeMismatch if the number of columns in x_reduced does not equal n_components.

Trait Implementations§

Source§

impl<F: Clone> Clone for FittedPCA<F>

Source§

fn clone(&self) -> FittedPCA<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 FittedPCA<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> FittedPipelineTransformer<F> for FittedPCA<F>

Source§

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

Transform data using the pipeline interface.

§Errors

Propagates errors from Transform::transform.

Source§

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

Source§

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

Project data onto the principal components: (X - mean) @ components^T.

§Errors

Returns FerroError::ShapeMismatch if the number of columns does not match the number of features seen during fitting.

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 FittedPCA<F>

§

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

§

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

§

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

§

impl<F> Unpin for FittedPCA<F>

§

impl<F> UnsafeUnpin for FittedPCA<F>

§

impl<F> UnwindSafe for FittedPCA<F>
where F: RefUnwindSafe,

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,