Enum ukebox::pitch_class::PitchClass

pub enum PitchClass {
    C,
    CSharp,
    D,
    DSharp,
    E,
    F,
    FSharp,
    G,
    GSharp,
    A,
    ASharp,
    B,
}

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

C

CSharp

D

DSharp

E

F

FSharp

G

GSharp

A

ASharp

B

Trait Implementations

impl Add<u8> for PitchClass

type Output = Self

The resulting type after applying the + operator.

fn add(self, n: Semitones) -> Self

Get the pitch class that is n semitones higher than the current pitch class.

impl Clone for PitchClass

fn clone(&self) -> PitchClass

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for PitchClass

impl Debug for PitchClass

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

Formats the value using the given formatter.

impl Eq for PitchClass

impl From<PitchClass> for Note

fn from(pitch_class: PitchClass) -> Self

Convert a pitch class into a note. For notes that can be sharp or flat use the sharp version.

impl From<u8> for PitchClass

fn from(n: Semitones) -> Self

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

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<PitchClass> for PitchClass

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

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

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

This method tests for !=.

impl PartialOrd<PitchClass> for PitchClass

fn partial_cmp(&self, other: &PitchClass) -> 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 StructuralEq for PitchClass

impl StructuralPartialEq for PitchClass

impl Sub<PitchClass> for PitchClass

type Output = Semitones

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Semitones

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

type Output = Self

The resulting type after applying the - operator.

fn sub(self, n: Semitones) -> Self

Get the pitch class that is n semitones lower than the current pitch class.