Struct tune::pitch::Pitch

pub struct Pitch { /* fields omitted */ }

Struct representing the frequency of a pitch.

You can retrieve the absolute frequency of a Pitch in Hz via Pitch::as_hz. Alternatively, Pitches can interact with Ratios using Ratio::between_pitches or the Mul/Div operators.

Implementations

impl Pitch

pub fn of(pitched: impl Pitched) -> Pitch

A more intuitive replacement for Pitched::pitch.

Examples

use tune::pitch::Pitched;

let note = NoteLetter::C.in_octave(4);
assert_approx_eq!(Pitch::of(note).as_hz(), note.pitch().as_hz());

pub fn from_hz(hz: f64) -> Pitch

pub fn as_hz(self) -> f64

Trait Implementations

impl Clone for Pitch

fn clone(&self) -> Pitch

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Pitch

impl Debug for Pitch

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

Formats the value using the given formatter.

impl Div<Ratio> for Pitch

Lower a Pitch by a given Ratio.

Examples

assert_approx_eq!((Pitch::from_hz(330.0) / Ratio::from_float(1.5)).as_hz(), 220.0);

type Output = Pitch

The resulting type after applying the / operator.

fn div(self, rhs: Ratio) -> Self::Output

Performs the / operation.

impl FromStr for Pitch

type Err = String

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Mul<Ratio> for Pitch

Raise a Pitch by a given Ratio.

Examples

assert_approx_eq!((Pitch::from_hz(220.0) * Ratio::from_float(1.5)).as_hz(), 330.0);

type Output = Pitch

The resulting type after applying the * operator.

fn mul(self, rhs: Ratio) -> Self::Output

Performs the * operation.

impl PartialEq<Pitch> for Pitch

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Pitch> for Pitch

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl Pitched for Pitch

fn pitch(&self) -> Pitch

Retrieves the Pitch of the Pitched object.

fn find_in_tuning<K, T: Tuning<K>>(&self, tuning: T) -> Approximation<K>

Finds a key or note for any Pitched object in the given tuning.

impl StructuralPartialEq for Pitch