PCA

Struct PCA 

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

Principal Component Analysis (PCA) for dimensionality reduction.

PCA reduces dimensionality by projecting data onto principal components (directions of maximum variance).

§Example

use aprender::preprocessing::PCA;
use aprender::traits::Transformer;
use aprender::primitives::Matrix;

let data = Matrix::from_vec(4, 3, vec![
    1.0, 2.0, 3.0,
    4.0, 5.0, 6.0,
    7.0, 8.0, 9.0,
    10.0, 11.0, 12.0,
]).expect("valid matrix dimensions");

let mut pca = PCA::new(2); // Reduce to 2 components
let transformed = pca.fit_transform(&data).expect("fit_transform should succeed");
assert_eq!(transformed.shape(), (4, 2));

Implementations§

Source§

impl PCA

Source

pub fn new(n_components: usize) -> Self

Creates a new PCA transformer.

§Arguments
  • n_components - Number of principal components to keep
Source

pub fn explained_variance(&self) -> Option<&[f32]>

Returns the variance explained by each component.

Source

pub fn explained_variance_ratio(&self) -> Option<&[f32]>

Returns the ratio of variance explained by each component.

Source

pub fn components(&self) -> Option<&Matrix<f32>>

Returns the principal components.

Source

pub fn inverse_transform(&self, x: &Matrix<f32>) -> Result<Matrix<f32>>

Reconstructs data from principal component space.

§Errors

Returns error if PCA is not fitted.

Trait Implementations§

Source§

impl Clone for PCA

Source§

fn clone(&self) -> PCA

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 PCA

Source§

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

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

impl Transformer for PCA

Source§

fn fit(&mut self, x: &Matrix<f32>) -> Result<()>

Fits the transformer to data. Read more
Source§

fn transform(&self, x: &Matrix<f32>) -> Result<Matrix<f32>>

Transforms data using fitted parameters. Read more
Source§

fn fit_transform(&mut self, x: &Matrix<f32>) -> Result<Matrix<f32>>

Fits and transforms in one step. Read more

Auto Trait Implementations§

§

impl Freeze for PCA

§

impl RefUnwindSafe for PCA

§

impl Send for PCA

§

impl Sync for PCA

§

impl Unpin for PCA

§

impl UnwindSafe for PCA

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, 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