Struct CycleComponentSummary 

#[non_exhaustive]
pub struct CycleComponentSummary {
    pub component_index: Option<usize>,
    pub period_span: Option<usize>,
    pub amplitude: f64,
    pub energy_share_pct: f64,
}

Product cycle-component summary.

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.

component_index: Option<usize>

Zero-based detail/IMF index selected as dominant cycle component.

period_span: Option<usize>

Approximate cycle period in input observations when estimable.

amplitude: f64

Peak-to-peak half range of the selected cycle component.

energy_share_pct: f64

Percentage of transform component energy represented by the cycle.

Trait Implementations

impl Clone for CycleComponentSummary

fn clone(&self) -> CycleComponentSummary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CycleComponentSummary

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

Formats the value using the given formatter.

impl PartialEq for CycleComponentSummary

fn eq(&self, other: &CycleComponentSummary) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CycleComponentSummary