Skip to main content

Pca

Struct Pca 

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

A principal component analysis awaiting estimation.

Construct with Pca::new (which mirrors the reference defaults: standardize = true, demean = true, normalize = true, all components), optionally adjust the builder options, then call Pca::fit.

Implementations§

Source§

impl Pca

Source

pub fn new(data: Array2<f64>) -> Self

A PCA on data (an nobs × nvar matrix) with the reference defaults: standardized columns, all components, normalized factors.

Source

pub fn ncomp(self, ncomp: usize) -> Self

Set the number of components to retain. Defaults to min(nobs, nvar).

Source

pub fn standardize(self, standardize: bool) -> Self

Whether to standardize each column to unit variance (population, ddof 0) before decomposition. When true, this implies demeaning. Default true.

Source

pub fn demean(self, demean: bool) -> Self

Whether to subtract each column’s mean before decomposition. Ignored when standardize is true (standardizing already demeans). Default true.

Source

pub fn normalize(self, normalize: bool) -> Self

Whether to normalize the factors to unit inner product, scaling the coefficients by sqrt(eigenvalue). Default true.

Source

pub fn fit(&self) -> Result<PcaResults>

Estimate the PCA via SVD.

Trait Implementations§

Source§

impl Clone for Pca

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · 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

Auto Trait Implementations§

§

impl Freeze for Pca

§

impl RefUnwindSafe for Pca

§

impl Send for Pca

§

impl Sync for Pca

§

impl Unpin for Pca

§

impl UnsafeUnpin 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> 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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.