Struct VMDResult 

#[non_exhaustive]
pub struct VMDResult {
    pub imfs: Vec<IMF>,
    pub center_frequencies: Vec<f64>,
    pub mode_energies: Vec<f64>,
    pub iterations: usize,
    pub converged: bool,
}

Result of a vmd decomposition.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

imfs: Vec<IMF>

K band-limited modes, sorted by ascending center frequency.

center_frequencies: Vec<f64>

Center frequencies ω_k in normalized frequency (cycles/sample, [0, 0.5]), ascending — matches the ordering of imfs.

mode_energies: Vec<f64>

Per-mode time-domain L² energy Σ_t u_k(t)². Useful as one of three inputs to VMDResult::redundancy.

iterations: usize

Number of ADMM iterations executed.

converged: bool

true if the ADMM convergence criterion was satisfied before max_iterations.

Implementations

impl VMDResult

pub fn reconstruct(&self) -> Vec<f64>

Sum of the extracted modes: Σ_k u_k(t).

Compare against the input signal to measure reconstruction quality: ‖x − reconstruct()‖² / ‖x‖² is the relative residual energy. With the default τ = 0 this is approximate (~1e-4 on the paper signal); set τ > 0 to drive it toward zero via dual ascent.

pub fn redundancy(&self) -> VmdRedundancy

Compute pairwise redundancy diagnostics. See VmdRedundancy.

Trait Implementations

impl Clone for VMDResult

fn clone(&self) -> VMDResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VMDResult

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

Formats the value using the given formatter.