Enum musictheory::types::PitchGroup

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

Pitch Group is the Y Axis on the Matrix Table

Variants

Cn

Gn

Dn

An

En

Bn

Fs

Cs

Gs

Ds

As

Fn

Methods

impl PitchGroup

pub fn all() -> [PitchGroup; 12]

Get All PitchGroups.

pub fn pitch_class(&self) -> PitchClass

Convert a PitchGroup to its equivalent PitchClass.

pub fn major_key(&self) -> Note

Get the Major key for this PitchGroup (Co5).

pub fn minor_key(&self) -> Note

Get the Minor key for this PitchGroup (Co5).

pub fn sharp_key(&self) -> Note

TODO - Deprecate?

pub fn flat_key(&self) -> Note

TODO - Deprecate?

pub fn pitch_classes(&self) -> [PitchClass; 7]

Get an unordered set of PitchClass used by this PitchGroup.

pub fn ionian(&self) -> PitchMode

Get Ionian PitchMode for this PitchGroup.

pub fn dorian(&self) -> PitchMode

Get Dorian PitchMode for this PitchGroup.

pub fn phrygian(&self) -> PitchMode

Get Phrygian PitchMode for this PitchGroup.

pub fn lydian(&self) -> PitchMode

Get Lydian PitchMode for this PitchGroup.

pub fn mixolydian(&self) -> PitchMode

Get Mixolydian PitchMode for this PitchGroup.

pub fn aeolian(&self) -> PitchMode

Get Aeolian PitchMode for this PitchGroup.

pub fn locrian(&self) -> PitchMode

Get Locrian PitchMode for this PitchGroup.

pub fn find(notes: &[Note]) -> Result<Vec<PitchGroup>, &'static str>

Find which PitchGroups a given set of provided Note belong to.

Trait Implementations

impl Clone for PitchGroup

fn clone(&self) -> PitchGroup

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for PitchGroup

impl Debug for PitchGroup

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

Formats the value using the given formatter.

impl Display for PitchGroup

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

Formats the value using the given formatter.

impl Eq for PitchGroup

impl Hash for PitchGroup

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 Ord for PitchGroup

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

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 PartialEq<PitchGroup> for PitchGroup

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<PitchGroup> for PitchGroup

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

impl StructuralPartialEq for PitchGroup