Skip to main content

SparsityMetrics

Struct SparsityMetrics 

Source
pub struct SparsityMetrics;
Expand description

Metrics for quantifying signal sparsity and dictionary coherence.

Implementations§

Source§

impl SparsityMetrics

Source

pub fn l0_norm(x: &[f64], threshold: f64) -> usize

Count the number of elements whose absolute value exceeds threshold (ℓ₀ norm).

Source

pub fn l1_norm(x: &[f64]) -> f64

Compute the ℓ₁ norm (sum of absolute values).

Source

pub fn l2_norm(x: &[f64]) -> f64

Compute the ℓ₂ norm.

Source

pub fn gini(x: &[f64]) -> f64

Compute the Gini coefficient of |x| as a sparsity measure.

Returns a value in [0, 1]; 1 = maximally sparse, 0 = maximally spread.

Source

pub fn coherence(a: &[Vec<f64>]) -> f64

Compute the mutual coherence of a matrix a.

Defined as the maximum normalised inner product between distinct columns: μ(A) = max_{i≠j} |a_i^T a_j| / (||a_i|| ||a_j||).

Source

pub fn babel_function(a: &[Vec<f64>], k: usize) -> f64

Compute the Babel function μ_1(k) of a dictionary.

μ_1(k) = max_i sum_{j in S, |S|=k, j≠i} |a_i^T a_j| / (||a_i|| ||a_j||). A small Babel function implies better sparse recovery guarantees.

Auto Trait Implementations§

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.