rstmt-core 0.1.0

the core modules for the rstmt framework
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

/*
    Appellation: scale <module>
    Created At: 2025.12.29:16:46:22
    Contrib: @FL03
*/
use crate::Frequency;

/// The [`Scale`] implementation uses the defined _root_ or _anchor_ frequency as the basis for
/// classfifications and other related computations.
#[derive(Clone, Copy, Debug, Default, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
pub struct Scale<T = f32> {
    pub root: Frequency<T>,
}

#[cfg(test)]
mod tests {
    use super::Scale;
    use crate::freq::Frequency;

    const A4: Frequency<f64> = Frequency(440.0);
    const C4: Frequency<f64> = Frequency(261.6255653005986);

    #[test]
    fn test_freq_converter() {
        let n: isize = -9; // C4;
        let scale = Scale::from_freq(A4); // A4

        assert! { (scale.get_freq_of_class(n) - C4).abs() < 1e-5 }
        assert_eq! { scale.classify(C4), Some(n) }
    }
}