rstmt-nrt 0.1.0

this crate focuses on providing support for the neo-riemannian theory of music
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201

/*
    Appellation: triad_kind <module>
    Created At: 2025.12.23:14:15:46
    Contrib: @FL03
*/
use crate::Triads;
/// The [`Relative`] trait is used to define a relationship between two distinct triad
/// classifications
pub trait Relative {
    type Rel;

    private! {}

    fn rel(&self) -> Self::Rel;
}

/// The [`TriadType`] trait is used to represent the various classifications of a triad
/// considered by the Neo-Riemannian theory.
pub trait TriadType
where
    Self: 'static + Copy + Relative + Send + Sync + core::fmt::Debug + core::fmt::Display,
{
    private! {}

    fn new() -> Self
    where
        Self: Sized;

    fn root(&self) -> usize;

    fn fifth(&self) -> usize;

    fn third(&self) -> usize;
    /// consumes the instance, returning a variant of the [`TriadClass`] enum
    fn dynamic(&self) -> crate::Triads {
        if self.is_major() {
            Triads::Major
        } else if self.is_minor() {
            Triads::Minor
        } else if self.is_augmented() {
            Triads::Augmented
        } else if self.is_diminished() {
            Triads::Diminished
        } else {
            unreachable!("invalid triad type")
        }
    }

    fn is_major(&self) -> bool {
        false
    }

    fn is_minor(&self) -> bool {
        false
    }

    fn is_augmented(&self) -> bool {
        false
    }

    fn is_diminished(&self) -> bool {
        false
    }
}

pub trait RelTriad: TriadType + Relative
where
    Self::Rel: TriadType,
{
    private! {}

    fn relative(&self) -> Self::Rel;
}

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

impl<A, B> RelTriad for A
where
    A: TriadType + Relative<Rel = B>,
    B: TriadType,
{
    seal! {}

    fn relative(&self) -> B {
        <B>::new()
    }
}

impl Relative for Triads {
    type Rel = Triads;

    seal! {}

    fn rel(&self) -> Self::Rel {
        self.relative()
    }
}

impl TriadType for Triads {
    seal! {}

    fn new() -> Self {
        Self::default()
    }

    fn is_major(&self) -> bool {
        matches!(self, Triads::Major)
    }

    fn is_minor(&self) -> bool {
        matches!(self, Triads::Minor)
    }

    fn is_augmented(&self) -> bool {
        matches!(self, Triads::Augmented)
    }

    fn is_diminished(&self) -> bool {
        matches!(self, Triads::Diminished)
    }

    fn root(&self) -> usize {
        self.root()
    }

    fn fifth(&self) -> usize {
        self.fifth()
    }

    fn third(&self) -> usize {
        self.third()
    }
}

macro_rules! triad_kind {
    (impl $trait:ident for {$($($name:ident)::*<Rel = $rel:ty>::<[$($v:literal),* $(,)?]> $({$($rest:tt)*})?),* $(,)?}) => {
        $(triad_kind! { @impl $trait for $($name)::*<Rel = $rel>::<[$($v),*]> $({$($rest)*})? })*
    };
    (@impl $trait:ident for $($name:ident)::* <Rel = $rel:ty>::<[$r:literal, $f:literal, $t:literal]> $({$($rest:tt)*})?) => {
        impl $trait for $($name)::* {
            // type Rel = $rel;

            seal! {}

            fn new() -> Self {
                Self::default()
            }

            fn root(&self) -> usize {
                $r
            }

            fn fifth(&self) -> usize {
                $f
            }

            fn third(&self) -> usize {
                $t
            }

            $($($rest)*)?
        }

        impl Relative for $($name)::* {
            type Rel = $rel;

            seal! {}

            fn rel(&self) -> Self::Rel {
                <$rel>::default()
            }
        }
    };
}

triad_kind! {
    impl TriadType for {
        rstmt_core::Augmented<Rel = rstmt_core::Diminished>::<[4, 8, 4]> {
            fn is_augmented(&self) -> bool {
                true
            }
        },
        rstmt_core::Diminished<Rel = rstmt_core::Augmented>::<[3, 6, 3]> {
            fn is_diminished(&self) -> bool {
                true
            }
        },
        rstmt_core::Major<Rel = rstmt_core::Minor>::<[4, 7, 3]> {
            fn is_major(&self) -> bool {
                true
            }
        },
        rstmt_core::Minor<Rel = rstmt_core::Major>::<[3, 7, 4]> {
            fn is_minor(&self) -> bool {
                true
            }
        }
    }
}