Struct tune::tuning::ConcertPitch

pub struct ConcertPitch { /* private fields */ }

A ConcertPitch enables Notes to sound at a Pitch different to what would be expected in 440 Hz standard tuning.

To access the full potential of ConcertPitches have a look at the Tuning and PitchedNote traits.

Implementations

impl ConcertPitch

pub fn from_a4_pitch(a4_pitch: impl Pitched) -> Self

Creates a ConcertPitch with the given a4_pitch.

pub fn from_note_and_pitch(note: Note, pitched: impl Pitched) -> Self

Creates a ConcertPitch from the given note and pitched value.

Examples

let c4 = NoteLetter::C.in_octave(4);
let fixed_c4_tuning = ConcertPitch::from_note_and_pitch(c4, Pitch::from_hz(260.0));
assert_approx_eq!(fixed_c4_tuning.a4_pitch().as_hz(), 437.266136);

pub fn a4_pitch(self) -> Pitch

Returns the Pitch of A4.

Trait Implementations

impl Clone for ConcertPitch

fn clone(&self) -> ConcertPitch

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConcertPitch

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

Formats the value using the given formatter.

impl Default for ConcertPitch

The default ConcertPitch is A4 sounding at 440 Hz.

Examples

assert_approx_eq!(ConcertPitch::default().a4_pitch().as_hz(), 440.0);

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq<ConcertPitch> for ConcertPitch

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

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

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

This method tests for !=.

impl PartialOrd<ConcertPitch> for ConcertPitch

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

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

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

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

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

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

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

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

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 Tuning<Note> for ConcertPitch

A ConcertPitch maps Notes to Pitches and is considered a Tuning.

Examples

use tune::tuning::Tuning;

let c4 = NoteLetter::C.in_octave(4);
let a4 = NoteLetter::A.in_octave(4);

let standard_tuning = ConcertPitch::default();
assert_approx_eq!(standard_tuning.pitch_of(c4).as_hz(), 261.625565);
assert_approx_eq!(standard_tuning.pitch_of(a4).as_hz(), 440.0);

let healing_tuning = ConcertPitch::from_a4_pitch(Pitch::from_hz(432.0));
assert_approx_eq!(healing_tuning.pitch_of(c4).as_hz(), 256.868737);
assert_approx_eq!(healing_tuning.pitch_of(a4).as_hz(), 432.0);

fn pitch_of(&self, note: Note) -> Pitch

Returns the Pitch of the given key or note K in the current Tuning.

fn find_by_pitch(&self, pitch: Pitch) -> Approximation<Note>

Finds a closest key or note Approximation for the given Pitch in the current Tuning.

fn as_linear_mapping(self) -> LinearMapping<Self> where
    Self: Sized, 

Wraps self in a type adapter s.t. it can be used in functions that are generic over KeyboardMapping<K>.

impl Copy for ConcertPitch

impl StructuralPartialEq for ConcertPitch