pub struct SparseSignal;Expand description
Utility for generating and manipulating synthetic sparse signals.
Implementations§
Source§impl SparseSignal
impl SparseSignal
Sourcepub fn generate(n: usize, k: usize, amplitude: f64) -> Vec<f64>
pub fn generate(n: usize, k: usize, amplitude: f64) -> Vec<f64>
Generate a k-sparse signal of length n with random support and values.
Non-zero coefficients are drawn uniformly from [-amplitude, amplitude].
Sourcepub fn add_noise(signal: &[f64], sigma: f64) -> Vec<f64>
pub fn add_noise(signal: &[f64], sigma: f64) -> Vec<f64>
Add Gaussian noise with standard deviation sigma to a signal.
Sourcepub fn support_error(truth: &[f64], recovered: &[f64], threshold: f64) -> f64
pub fn support_error(truth: &[f64], recovered: &[f64], threshold: f64) -> f64
Compute the support error between two signals (fraction of mismatched support).
A value of 0 means the non-zero patterns are identical.
Sourcepub fn relative_error(truth: &[f64], recovered: &[f64]) -> f64
pub fn relative_error(truth: &[f64], recovered: &[f64]) -> f64
Compute the relative reconstruction error ||x - x_hat||_2 / ||x||_2.
Auto Trait Implementations§
impl Freeze for SparseSignal
impl RefUnwindSafe for SparseSignal
impl Send for SparseSignal
impl Sync for SparseSignal
impl Unpin for SparseSignal
impl UnsafeUnpin for SparseSignal
impl UnwindSafe for SparseSignal
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
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
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
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.