Skip to main content

Dgrdl

Struct Dgrdl 

Source
pub struct Dgrdl<T> { /* private fields */ }
Expand description

Main DGRDL implementation

Implements the Dual Graph Regularized Dictionary Learning algorithm which learns a sparse dictionary representation while preserving local geometric structure in both sample and feature spaces through graph regularization.

§Fields

  • params - Configuration parameters for the algorithm

Implementations§

Source§

impl<T: BixverseFloat> Dgrdl<T>

Source

pub fn new(params: DgrdlParams<T>) -> Self

Create a new DGRDL instance

§Params
  • params - Configuration parameters for the algorithm
§Returns

New DGRDL instance ready for training

Source

pub fn fit( &mut self, data: &MatRef<'_, T>, seed: usize, verbose: bool, ) -> DgrdlResults<T>

Run DGRDL algorithm on input data (with initial hyper parameters)

Implements the main optimization loop alternating between sparse coding and dictionary update steps. The algorithm minimizes: ||Y - DX||²_F + α·tr(D^T·D·L_s) + β·tr(X·L_f·X^T) + sparsity constraint where Y is data, D is dictionary, X is coefficients, L_s and L_f are sample and feature Laplacians respectively.

§Params
  • data - Input data matrix of size n_samples × n_features
  • seed - Seed for dictionary initialisation.
  • verbose - Whether to print iteration progress
§Returns

DgrdlResults containing the learned dictionary, coefficients, and Laplacians

Source

pub fn fit_with_params( &mut self, data: &MatRef<'_, T>, params: DgrdlParams<T>, seed: usize, verbose: bool, ) -> DgrdlResults<T>

Run DGRDL algorithm on input data (with provided hyperparameters)

Implements the main optimization loop alternating between sparse coding and dictionary update steps. The algorithm minimizes: ||Y - DX||²_F + α·tr(D^T·D·L_s) + β·tr(X·L_f·X^T) + sparsity constraint where Y is data, D is dictionary, X is coefficients, L_s and L_f are sample and feature Laplacians respectively.

§Params
  • data - Input data matrix of size n_samples × n_features
  • params - The DgrdlParams containing the parameters you wish to use.
  • seed - Seed for dictionary initialisation.
  • verbose - Whether to print iteration progress
§Returns

DgrdlResults containing the learned dictionary, coefficients, and Laplacians

Run a hyperparameter search over DGRDL

Helper function to sweep over a set of hyperparameters and return different objectives from the algorithm for subsequent visualisation.

§Params
  • data - Input data matrix of size n_samples × n_features
  • dict_sizes - Slice of different dictionary sizes you wish to test for.
  • k_neighbours_iters - Slice of different k neighbours to iterate over.
  • seeds - Slice of random initialisations to test.
  • verbose - Controls verbosity of the function
§Returns

DgrdlResults containing the learned dictionary, coefficients, and Laplacians

Trait Implementations§

Source§

impl<T: Debug> Debug for Dgrdl<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for Dgrdl<T>

§

impl<T> RefUnwindSafe for Dgrdl<T>

§

impl<T> Send for Dgrdl<T>

§

impl<T> Sync for Dgrdl<T>

§

impl<T> Unpin for Dgrdl<T>

§

impl<T> UnsafeUnpin for Dgrdl<T>

§

impl<T> UnwindSafe for Dgrdl<T>

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> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> DistributionExt for T
where T: ?Sized,

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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