TypeSafePCA

Struct TypeSafePCA 

Source
pub struct TypeSafePCA<State: DecompositionState, const RANK: usize> {
    pub n_components: usize,
    pub center: bool,
    pub scale: bool,
    /* private fields */
}
Expand description

Type-safe PCA with compile-time rank checking

Fields§

§n_components: usize

Number of components (must match RANK)

§center: bool

Whether to center the data

§scale: bool

Whether to scale the data

Implementations§

Source§

impl<const RANK: usize> TypeSafePCA<Untrained, RANK>

Source

pub const fn new() -> Self

Create a new type-safe PCA with compile-time rank checking

Source

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

Set whether to center the data

Source

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

Set whether to scale the data

Source

pub fn fit(self, data: &Array2<Float>) -> Result<TypeSafePCA<Fitted, RANK>>

Fit the PCA model and transition to Fitted state

Source§

impl<const RANK: usize> TypeSafePCA<Fitted, RANK>

Source

pub fn transform(&self, data: &Array2<Float>) -> Result<Array2<Float>>

Transform data using the fitted components

Source

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

Get the fitted components (guaranteed to be RANK columns)

Source

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

Get explained variance (guaranteed to be RANK elements)

Source

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

Get explained variance ratios

Source

pub fn fit_transform( untrained: TypeSafePCA<Untrained, RANK>, data: &Array2<Float>, ) -> Result<(TypeSafePCA<Fitted, RANK>, Array2<Float>)>

Fit and transform in one step

Trait Implementations§

Source§

impl<State: Clone + DecompositionState, const RANK: usize> Clone for TypeSafePCA<State, RANK>

Source§

fn clone(&self) -> TypeSafePCA<State, RANK>

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<const RANK: usize> ComponentAccess<RANK> for TypeSafePCA<Fitted, RANK>

Source§

fn component<const INDEX: usize>( &self, _index: ComponentIndex<INDEX>, ) -> Result<Array1<Float>>

Get a specific component by index (runtime checked)
Source§

impl<State: Debug + DecompositionState, const RANK: usize> Debug for TypeSafePCA<State, RANK>

Source§

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

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

impl<const RANK: usize> Default for TypeSafePCA<Untrained, RANK>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<State: DecompositionState, const RANK: usize> TypeSafeDecomposition<State> for TypeSafePCA<State, RANK>

Source§

type Output = ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>

Source§

type ErrorType = SklearsError

Source§

fn state(&self) -> PhantomData<State>

Get the current state of the decomposition

Auto Trait Implementations§

§

impl<State, const RANK: usize> Freeze for TypeSafePCA<State, RANK>

§

impl<State, const RANK: usize> RefUnwindSafe for TypeSafePCA<State, RANK>
where State: RefUnwindSafe,

§

impl<State, const RANK: usize> Send for TypeSafePCA<State, RANK>
where State: Send,

§

impl<State, const RANK: usize> Sync for TypeSafePCA<State, RANK>
where State: Sync,

§

impl<State, const RANK: usize> Unpin for TypeSafePCA<State, RANK>
where State: Unpin,

§

impl<State, const RANK: usize> UnwindSafe for TypeSafePCA<State, RANK>
where State: UnwindSafe,

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