Struct Correlation 

pub struct Correlation {
    pub cross: C64,
    pub energy_a: f64,
    pub energy_b: f64,
}

The cross-correlation of two sequences and their energies (see the module).

Fields

cross: C64

$\sum_{k} a_{k} b_{k}^{*}$.

energy_a: f64

$\sum_{k} |a_{k}|^{2}$.

energy_b: f64

$\sum_{k} |b_{k}|^{2}$.

Implementations

impl Correlation

pub fn between(a: &[C64], b: &[C64]) -> Correlation

The correlation of a with b (the pairs of the shorter of the two).

pub fn rho(&self) -> f64

The normalised correlation $\rho = |c| / \sqrt{E_{a} E_{b}}$, 0 when a sequence has no energy.

pub fn rho_squared(&self) -> f64

Its square $\rho^{2} = |c|^{2} / (E_{a} E_{b})$ (computed as such, not as the square of Correlation::rho), 0 when a sequence has no energy.

Trait Implementations

impl Clone for Correlation

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Correlation

impl Debug for Correlation

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

Formats the value using the given formatter.

impl PartialEq for Correlation

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Correlation