Struct FactorAnalysis 

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

Factor Analysis configuration.

Calling Fit::fit fits the EM algorithm and returns a FittedFactorAnalysis.

Type Parameters

• F: The floating-point scalar type.

Implementations

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

pub fn new(n_components: usize) -> Self

Create a new FactorAnalysis with n_components factors.

Defaults: max_iter = 1000, tol = 1e-3, no fixed random seed.

pub fn with_max_iter(self, max_iter: usize) -> Self

Set the maximum number of EM iterations.

pub fn with_tol(self, tol: f64) -> Self

Set the convergence tolerance.

pub fn with_random_state(self, seed: u64) -> Self

Set the random seed for reproducibility.

pub fn n_components(&self) -> usize

Return the number of latent factors.

Trait Implementations

impl<F: Clone> Clone for FactorAnalysis<F>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for FactorAnalysis<F>

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

Formats the value using the given formatter.

impl<F: Float + Send + Sync + 'static> Default for FactorAnalysis<F>

fn default() -> Self

Returns the “default value” for a type.

impl<F: Float + Send + Sync + 'static> Fit<ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>, ()> for FactorAnalysis<F>

fn fit( &self, x: &Array2<F>, _y: &(), ) -> Result<FittedFactorAnalysis<F>, FerroError>

Fit the Factor Analysis model using the EM algorithm.

Errors

• FerroError::InvalidParameter if n_components is zero or exceeds n_features.
• FerroError::InsufficientSamples if fewer than 2 samples are provided.

type Fitted = FittedFactorAnalysis<F>

The fitted model type returned by fit.

type Error = FerroError

The error type returned by fit.

impl<F: Float + Send + Sync + 'static> PipelineTransformer<F> for FactorAnalysis<F>

fn fit_pipeline( &self, x: &Array2<F>, _y: &Array1<F>, ) -> Result<Box<dyn FittedPipelineTransformer<F>>, FerroError>

Fit using the pipeline interface (ignores y).

Errors

Propagates errors from Fit::fit.