[−][src]Enum ukebox::note::PitchClass
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]
type Output = Self
The resulting type after applying the +
operator.
fn add(self, n: Semitones) -> Self
[src]
Get the pitch class that is n
semitones higher than the current
pitch class.
impl Clone for PitchClass
[src]
fn clone(&self) -> PitchClass
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Copy for PitchClass
[src]
impl Debug for PitchClass
[src]
impl From<u8> for PitchClass
[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 PartialEq<PitchClass> for PitchClass
[src]
fn eq(&self, other: &PitchClass) -> bool
[src]
#[must_use]
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
impl StructuralPartialEq for PitchClass
[src]
impl Sub<PitchClass> for PitchClass
[src]
type Output = Semitones
The resulting type after applying the -
operator.
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]
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> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,