Enum musictheory::types::PitchClass

pub enum PitchClass {
    Cn,
    Cs,
    Dn,
    Ds,
    En,
    Fn,
    Fs,
    Gn,
    Gs,
    An,
    As,
    Bn,
}

PitchClass is the unified representation of the 12 semitone harmonics used in western music.

X Axis on Note Table and the Matrix.

Variants

Cn

C Neutral

Cs

C Semitone

Dn

D Neutral

Ds

D Semitone

En

E Natural

Fn

F Natural

Fs

F Semitone

Gn

G Natural

Gs

G Semitone

An

A Natural

As

A Semitone

Bn

B Natural

Methods

impl PitchClass

pub fn wholetone(&self) -> bool

Is this PitchClass a wholetone.

pub fn semitone(&self) -> bool

Is this PitchClass a semitone.

pub fn name(&self, n: Note) -> Option<Note>

Get Note for a given PitchClass if available.

pub fn names(&self) -> &'static [Note]

Get a slice of Notes for a given PitchClass.

pub fn tones(&self) -> &'static [Pitch]

Get an slice of Pitches for a given PitchClasses.

pub fn group(&self) -> PitchGroup

Get PitchGroup this PitchClasses is the root of.

pub fn groups(&self) -> [PitchGroup; 7]

Get an unordered array of PitchGroups this PitchClass is a member of.

pub fn advance(&self) -> PitchClass

Advance to the next PitchClass.

pub fn distance(&self, other: &PitchClass) -> Steps

Get the distance between two PitchClasses.

Trait Implementations

impl Add<Interval> for PitchClass

type Output = Self

The resulting type after applying the + operator.

fn add(self, interval: Interval) -> Self::Output

Performs the + operation.

impl Add<Steps> for PitchClass

type Output = Self

The resulting type after applying the + operator.

fn add(self, steps: Steps) -> Self::Output

Performs the + operation.

impl Clone for PitchClass

fn clone(&self) -> PitchClass

Returns a copy of the value.

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 Display for PitchClass

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

Formats the value using the given formatter.

impl Hash for PitchClass

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 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] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<PitchClass> for PitchGroup

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

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

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

This method tests for !=.

impl PartialEq<PitchGroup> for PitchClass

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

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

#[must_use] 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] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] 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] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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 StructuralPartialEq for PitchClass

impl Sub<Interval> for PitchClass

type Output = Self

The resulting type after applying the - operator.

fn sub(self, interval: Interval) -> Self::Output

Performs the - operation.

impl Sub<Steps> for PitchClass

type Output = Self

The resulting type after applying the - operator.

fn sub(self, steps: Steps) -> Self::Output

Performs the - operation.