Skip to main content

RecurrenceAnalysis

oxiphysics_core::ergodic_theory

Struct RecurrenceAnalysis 

Source 
pub struct RecurrenceAnalysis {
    pub recurrence_rate: f64,
    pub determinism: f64,
    pub mean_diagonal_length: f64,
    pub max_diagonal_length: usize,
    pub diagonal_entropy: f64,
    pub laminarity: f64,
    pub trapping_time: f64,
}
Expand description

Recurrence quantification analysis (RQA) results.

Summarises the statistical structure of a recurrence plot via standard RQA measures.

Fields§

§recurrence_rate: f64

Recurrence rate (RR): fraction of recurrent points.

§determinism: f64

Determinism (DET): fraction of recurrent points on diagonal lines ≥ min_line.

§mean_diagonal_length: f64

Mean diagonal line length (L_mean).

§max_diagonal_length: usize

Longest diagonal line length (L_max).

§diagonal_entropy: f64

Entropy of diagonal line-length distribution (Shannon).

§laminarity: f64

Laminarity (LAM): fraction of recurrent points on vertical lines ≥ min_line.

§trapping_time: f64

Trapping time (TT): mean vertical line length.

Implementations§

Source§

impl RecurrenceAnalysis

Source

pub fn compute(rp: &RecurrencePlot, min_line: usize) -> Self

Compute full RQA from a recurrence plot with minimum line length min_line.

min_line is the minimum length (≥ 1) for a line to be counted.

Trait Implementations§

Source§

impl Clone for RecurrenceAnalysis

Source§

fn clone(&self) -> RecurrenceAnalysis

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RecurrenceAnalysis

Source§

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

Formats the value using the given formatter. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.