Enum ukebox::pitch_class::PitchClass [−][src]
pub enum PitchClass { C, CSharp, D, DSharp, E, F, FSharp, G, GSharp, A, ASharp, B, }
Expand description
A pitch class is “a set of all pitches that are a whole number of octaves apart, e.g., the pitch class C consists of the Cs in all octaves.” https://en.wikipedia.org/wiki/Pitch_class
Our 12 pitch classes are represented with integers from 0 to 11. Values > 11 will be used to model retrieval of the same pitch class in a higher octave. For example, pitch class 12 is the same as pitch class 0 and corresponds to the pitch class of C.
Variants
Trait Implementations
impl Add<u8> for PitchClass
[src]
impl Add<u8> for PitchClass
[src]impl Clone for PitchClass
[src]
impl Clone for PitchClass
[src]fn clone(&self) -> PitchClass
[src]
fn clone(&self) -> PitchClass
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
impl Debug for PitchClass
[src]
impl Debug for PitchClass
[src]impl From<PitchClass> for Note
[src]
impl From<PitchClass> for Note
[src]fn from(pitch_class: PitchClass) -> Self
[src]
fn from(pitch_class: PitchClass) -> Self
[src]Convert a pitch class into a note. For notes that can be sharp or flat use the sharp version.
impl From<u8> for PitchClass
[src]
impl From<u8> for PitchClass
[src]fn from(n: Semitones) -> Self
[src]
fn from(n: Semitones) -> Self
[src]Convert an integer into a pitch class.
To model the fact that e.g. all instances of the note C
in different
octaves belong to the same pitch class, each integer is placed in the
range of potential pitch classes (between 0 and 11).
For example, 12, 24, 36, etc. all correspond to pitch class 0.
impl Ord for PitchClass
[src]
impl Ord for PitchClass
[src]impl PartialEq<PitchClass> for PitchClass
[src]
impl PartialEq<PitchClass> for PitchClass
[src]impl PartialOrd<PitchClass> for PitchClass
[src]
impl PartialOrd<PitchClass> for PitchClass
[src]fn partial_cmp(&self, other: &PitchClass) -> Option<Ordering>
[src]
fn partial_cmp(&self, other: &PitchClass) -> Option<Ordering>
[src]This method returns an ordering between self
and other
values if one exists. Read more
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]This method tests less than (for self
and other
) and is used by the <
operator. Read more
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
impl Sub<PitchClass> for PitchClass
[src]
impl Sub<PitchClass> for PitchClass
[src]fn sub(self, other: Self) -> Semitones
[src]
fn sub(self, other: Self) -> Semitones
[src]Get the difference between two pitch classes in number of frets or semitones.
self
is assumed to always be higher as other
with a difference
of at most one octave.
Examples:
- D - C: both pitch classes are assumed to be in the same octave, D being higher than C. The difference is 2.
- D - A: D is higher than A, the difference is 5.
impl Sub<u8> for PitchClass
[src]
impl Sub<u8> for PitchClass
[src]impl Copy for PitchClass
[src]
impl Eq for PitchClass
[src]
impl StructuralEq for PitchClass
[src]
impl StructuralPartialEq for PitchClass
[src]
Auto Trait Implementations
impl RefUnwindSafe for PitchClass
impl Send for PitchClass
impl Sync for PitchClass
impl Unpin for PitchClass
impl UnwindSafe for PitchClass
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
[src]
impl<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
[src]pub fn equivalent(&self, key: &K) -> bool
[src]
pub fn equivalent(&self, key: &K) -> bool
[src]Compare self to key
and return true
if they are equal.
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more