temperaments 1.0.2

Calculate frequency tables of a wide variety of musical temperaments and calculate cent offsets.
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

//! Cent is a measure of musical interval on a logarithmic scale. An octave consists of 1200 cents.

use std::{fmt::Display, ops};

#[derive(Copy, Clone, PartialEq, PartialOrd, Debug, serde::Serialize, serde::Deserialize)]
pub struct Cent(pub f64);

impl Cent {
    pub(crate) fn abs(&self) -> Self {
        Cent(self.0.abs())
    }
}

impl Display for Cent {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        std::fmt::Display::fmt(&self.0, f)?;
        f.write_str(" cents")
    }
}

impl ops::Add for Cent {
    type Output = Self;
    fn add(self, rhs: Self) -> Self::Output {
        Cent(self.0.add(rhs.0))
    }
}

impl ops::Add<f64> for Cent {
    type Output = Self;
    fn add(self, rhs: f64) -> Self::Output {
        Self(self.0 + rhs)
    }
}

impl ops::Sub<f64> for Cent {
    type Output = Self;
    fn sub(self, rhs: f64) -> Self::Output {
        Self(self.0 - rhs)
    }
}

impl ops::Div<u32> for Cent {
    type Output = Self;
    fn div(self, rhs: u32) -> Self::Output {
        Self(self.0 / (rhs as f64))
    }
}

impl ops::Div<f64> for Cent {
    type Output = Self;
    fn div(self, rhs: f64) -> Self::Output {
        Self(self.0 / rhs)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn check_adding_cents_with_cents() {
        assert_eq!(Cent(0.0) + Cent(1.0), Cent(1.0));
        assert_eq!(Cent(1.0) + Cent(0.0), Cent(1.0));
        assert_eq!(Cent(1.0) + Cent(2.0), Cent(3.0));
        assert_eq!(Cent(-1.0) + Cent(2.0), Cent(1.0));
        assert_eq!(Cent(1.0) + Cent(2.0), Cent(3.0));
        assert_eq!(Cent(-1.0) + Cent(-1.0), Cent(-2.0));
    }

    #[test]
    fn check_adding_cents_with_float() {
        assert_eq!(Cent(0.0) + 1.0, Cent(1.0));
        assert_eq!(Cent(1.0) + 0.0, Cent(1.0));
        assert_eq!(Cent(1.0) + 2.0, Cent(3.0));
        assert_eq!(Cent(-1.0) + 2.0, Cent(1.0));
        assert_eq!(Cent(1.0) + 2.0, Cent(3.0));
        assert_eq!(Cent(-1.0) + -1.0, Cent(-2.0));
    }

    #[test]
    fn check_subtractinging_cents_with_float() {
        assert_eq!(Cent(0.0) - 1.0, Cent(-1.0));
        assert_eq!(Cent(1.0) - 0.0, Cent(1.0));
        assert_eq!(Cent(1.0) - 2.0, Cent(-1.0));
        assert_eq!(Cent(-1.0) - 2.0, Cent(-3.0));
        assert_eq!(Cent(1.0) - 2.0, Cent(-1.0));
        assert_eq!(Cent(-1.0) - -1.0, Cent(0.0));
    }
}