Struct DictionaryLearning 

pub struct DictionaryLearning { /* private fields */ }

Dictionary Learning for sparse representation

Finds a dictionary matrix D and sparse code matrix Alpha such that X ≈ D * Alpha, where Alpha is sparse. This is solved by alternating between sparse coding and dictionary update steps.

Implementations

impl DictionaryLearning

pub fn new(ncomponents: usize, alpha: f64) -> Self

Creates a new DictionaryLearning instance

Arguments

• n_components - Number of dictionary elements to extract
• alpha - Sparsity controlling parameter

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

Set maximum iterations

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

Set tolerance

pub fn with_transform_algorithm(self, algorithm: &str) -> Self

Set transform algorithm

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

Set random state

pub fn with_shuffle(self, shuffle: bool) -> Self

Set whether to shuffle data

pub fn fit<S>(&mut self, x: &ArrayBase<S, Ix2>) -> Result<()>

where S: Data, S::Elem: Float + NumCast,

Fit the dictionary learning model

Arguments

• x - Input data matrix

Returns

• Result<()> - Ok if successful, Err otherwise

pub fn transform<S>(&self, x: &ArrayBase<S, Ix2>) -> Result<Array2<f64>>

where S: Data, S::Elem: Float + NumCast,

Transform data to sparse codes

Arguments

• x - Input data matrix

Returns

• Result<Array2<f64>> - Sparse codes

pub fn fit_transform<S>(&mut self, x: &ArrayBase<S, Ix2>) -> Result<Array2<f64>>

where S: Data, S::Elem: Float + NumCast,

Fit and transform in one step

Arguments

• x - Input data matrix

Returns

• Result<Array2<f64>> - Sparse codes

pub fn dictionary(&self) -> Option<&Array2<f64>>

Get the learned dictionary

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

Get number of iterations run

pub fn inverse_transform( &self, sparsecodes: &Array2<f64>, ) -> Result<Array2<f64>>

Reconstruct data from sparse codes

Trait Implementations

impl Clone for DictionaryLearning

fn clone(&self) -> DictionaryLearning

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DictionaryLearning

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

Formats the value using the given formatter.