Struct Frequency 

pub struct Frequency(pub f64);

A positive frequency in hertz.

Examples

use sim_lib_sound_core::Frequency;

let a4 = Frequency::new(440.0).unwrap();
let a5 = Frequency::new(880.0).unwrap();
assert!((a5.cents_above(a4) - 1200.0).abs() < 1e-9);
assert!(Frequency::new(0.0).is_err());

Tuple Fields

0: f64

Implementations

impl Frequency

pub fn new(hz: f64) -> Result<Self, SoundCoreError>

Builds a frequency, returning SoundCoreError::InvalidFrequency when hz is not a positive, finite value.

pub fn ratio(self, other: Frequency) -> f64

Returns the linear ratio of this frequency to other.

pub fn cents_above(self, other: Frequency) -> f64

Returns the interval from other to this frequency, measured in cents.

pub fn shift_cents(self, cents: f64) -> Frequency

Returns this frequency shifted by cents (positive raises, negative lowers).

Trait Implementations

impl Clone for Frequency

fn clone(&self) -> Frequency

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Frequency

impl Debug for Frequency

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

Formats the value using the given formatter.

impl PartialEq for Frequency

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Frequency

fn partial_cmp(&self, other: &Frequency) -> 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 StructuralPartialEq for Frequency