Struct tonal::Pitch

pub struct Pitch(pub i32);

Represents a musical pitch.

The pitch is stored as the number of half steps away from A4. It is valid to use the tuple constructor to create a pitch directly. In fact, this allows doing math on notes for programatic contruction of music.

The implementation of Default produces A4.

Implementations

impl Pitch

pub fn new(name: Name, octave: u8) -> Self

Creates a new pitch with the given note name and octave.

Examples

use tonal::*;

let a4 = Pitch::new(Name::A, 4);
assert_eq!(a4, Pitch::default());
let c3 = Pitch::new(Name::C, 3);
assert_eq!(c3, Pitch(-21));

pub fn new_from_freq(freq: f64) -> Self

Creates a new pitch from the given frequency in hertz.

Because this function uses floating point math, there is a small chance the result might be off.

Panics

Panics if freq is not greater than 0.

Examples

use tonal::*;

let a4 = Pitch::new_from_freq(440.0);
assert_eq!(a4, Pitch::new(Name::A, 4));
let c3 = Pitch::new_from_freq(130.81);
assert_eq!(c3, Pitch::new(Name::C, 3));

This example will panic when run:

use tonal::*;

let invalid = Pitch::new_from_freq(0.0);

pub fn freq(self) -> f64

Calculates the frequency in hertz.

Examples

use tonal::*;

let a4 = Pitch::default();
assert!((a4.freq() - 440.0).abs() < std::f64::EPSILON);

Trait Implementations

impl Clone for Pitch

fn clone(&self) -> Pitch

Returns a copy of the value.

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 Default for Pitch

fn default() -> Pitch

Returns the "default value" for a type.

impl Eq for Pitch

impl Hash for Pitch

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Ord for Pitch

fn cmp(&self, other: &Pitch) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

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.

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

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

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

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

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

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

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

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

impl StructuralEq for Pitch

impl StructuralPartialEq for Pitch