rstmt-core 0.0.2

This crate focuses on building a music theory library that can be used to generate music theory data structures and algorithms.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

/*
    Appellation: notable <module>
    Contrib: FL03 <jo3mccain@icloud.com>
*/
use crate::pitch::{Pitch, Pitches};
use crate::Octave;

/// The American Standard Pitch Notation (ASPN) is a system popularized for its
/// ability to simplify the representation of musical notes, combining the
/// traditional symbols or pitch classes used to describe a particular pitch
/// as well as leverging a subscript to denote the octave of the given pitch.
///
///
/// the existing symbolic framework described by the [Pitch](crate::Pitch) and
/// [Octave](crate::Octave) types.
pub trait ASPN {
    fn aspn(&self) -> String {
        format!("{}.{}", self.pitch_class(), self.octave())
    }

    fn octave(&self) -> Octave;

    fn pitch(&self) -> Pitch;

    fn pitch_class(&self) -> Pitches {
        self.pitch().class()
    }
}

/// [Notable] is used to describe objects capable of being represented as a pitch
pub trait Notable: Copy + Sized + core::fmt::Display {
    /// Find the modular index of the given pitch
    fn pitch(&self) -> Pitch;
    /// Classify the pitch into a pitch class
    fn pitch_class(&self) -> Pitches {
        self.pitch().class()
    }
}

/*
 ************* Implementations *************
*/

impl Notable for Pitch {
    fn pitch_class(&self) -> Pitches {
        self.class()
    }

    fn pitch(&self) -> Pitch {
        *self
    }
}

impl Notable for Pitches {
    fn pitch_class(&self) -> Pitches {
        *self
    }

    fn pitch(&self) -> Pitch {
        Pitch(self.pitch_class().value())
    }
}

impl Notable for crate::Note {
    fn pitch(&self) -> Pitch {
        *self.pitch()
    }
}

impl Notable for crate::PitchTy {
    fn pitch(&self) -> Pitch {
        Pitch(*self)
    }
}