Struct FittedNMF 

pub struct FittedNMF<F> { /* private fields */ }

A fitted NMF model holding the learned components and reconstruction error.

Created by calling Fit::fit on an NMF. Implements Transform<Array2<F>> to project new data onto the learned components.

Implementations

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

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

Learned components (H matrix), shape (n_components, n_features).

pub fn reconstruction_err(&self) -> F

Frobenius norm of the reconstruction error ||X - W*H||_F.

pub fn n_iter(&self) -> usize

Number of iterations performed during fitting.

Trait Implementations

impl<F: Clone> Clone for FittedNMF<F>

fn clone(&self) -> FittedNMF<F>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<F: Debug> Debug for FittedNMF<F>

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

Formats the value using the given formatter.

impl<F: Float + Send + Sync + 'static> FittedPipelineTransformer<F> for FittedNMF<F>

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

Transform data using the pipeline interface.

Errors

Propagates errors from Transform::transform.

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

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

Project data onto the learned NMF components.

Solves for W in X ~ W * H using multiplicative updates with H fixed to the learned components.

Errors

• FerroError::ShapeMismatch if the number of columns does not match the number of features seen during fitting.
• FerroError::InvalidParameter if any entry of X is negative.

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

The transformed output type.

type Error = FerroError

The error type returned by transform.