Struct Correlation 

pub struct Correlation(/* private fields */);

A Pearson correlation from -1.0 to 1.0 inclusive, such as the correlation of two stereo channels.

use sound_to_patch::units::Correlation;

let mono = Correlation::new(1.0)?;
assert!(Correlation::new(-1.5).is_err());

Implementations

impl Correlation

pub fn new(value: f64) -> Result<Correlation, RangeError>

Checks the value against the range of the type.

Errors

Returns a RangeError for NaN, an infinity or a value outside the range.

pub fn get(self) -> f64

Returns the inner value.

Trait Implementations

impl Clone for Correlation

fn clone(&self) -> Correlation

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<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Correlation

fn deserialize<__D>( __deserializer: __D, ) -> Result<Correlation, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Correlation

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Correlation

fn partial_cmp(&self, other: &Correlation) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Correlation

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Spread for Correlation

impl StructuralPartialEq for Correlation

impl TryFrom<f64> for Correlation

type Error = RangeError

The type returned in the event of a conversion error.

fn try_from(value: f64) -> Result<Correlation, RangeError>

Performs the conversion.