Struct LDA 

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

Linear Discriminant Analysis configuration.

Holds hyperparameters. Calling Fit::fit computes the discriminant directions and returns a FittedLDA.

Type Parameters

• F: The floating-point scalar type (f32 or f64).

Implementations

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

pub fn new(n_components: Option<usize>) -> Self

Create a new LDA.

• n_components: number of discriminant directions to retain. Pass None to use min(n_classes - 1, n_features).

pub fn n_components(&self) -> Option<usize>

Return the configured number of components (may be None).

Trait Implementations

impl<F: Clone> Clone for LDA<F>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for LDA<F>

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

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

fn fit( &self, x: &Array2<F>, y: &Array1<usize>, ) -> Result<FittedLDA<F>, FerroError>

Fit the LDA model.

Errors

• FerroError::InsufficientSamples if fewer than 2 samples are provided.
• FerroError::InvalidParameter if n_components is zero or exceeds the maximum allowed (min(n_classes - 1, n_features)).
• FerroError::ShapeMismatch if x and y have different numbers of rows.
• FerroError::NumericalInstability if Sw is singular.
• FerroError::ConvergenceFailure if eigendecomposition does not converge.

type Fitted = FittedLDA<F>

The fitted model type returned by fit.

type Error = FerroError

The error type returned by fit.

impl PipelineEstimator<f64> for LDA<f64>

fn fit_pipeline( &self, x: &Array2<f64>, y: &Array1<f64>, ) -> Result<Box<dyn FittedPipelineEstimator<f64>>, FerroError>

Fit LDA using the pipeline interface.

Errors

Propagates errors from Fit::fit.