sim-lib-pitch-serial 0.1.0

Strict twelve-tone rows, total row operations, and explicit label conventions for SIM.
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

//! The canonical chromatic pitch-class alphabet.

use sim_lib_pitch_core::PitchClass;
use sim_lib_serial_core::{AlphabetError, AlphabetId, FiniteAlphabet, SerialAlphabet};

const CANONICAL_CLASSES: [PitchClass; 12] = [
    PitchClass::C,
    PitchClass::CS,
    PitchClass::D,
    PitchClass::DS,
    PitchClass::E,
    PitchClass::F,
    PitchClass::FS,
    PitchClass::G,
    PitchClass::GS,
    PitchClass::A,
    PitchClass::AS,
    PitchClass::B,
];

/// The stable twelve-symbol alphabet of canonical [`PitchClass`] values.
///
/// Construction delegates uniqueness and stable-id validation to
/// [`FiniteAlphabet`]. The order is the canonical numeric order `C = 0` through
/// `B = 11`; no spelling aliases or private pitch representation are introduced.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct PitchClassAlphabet {
    inner: FiniteAlphabet<PitchClass>,
}

impl PitchClassAlphabet {
    /// Constructs the canonical pitch-class alphabet.
    pub fn try_new() -> Result<Self, AlphabetError> {
        Ok(Self {
            inner: FiniteAlphabet::try_new(
                AlphabetId::try_new("pitch-class/12tet-v1")?,
                CANONICAL_CLASSES.to_vec(),
            )?,
        })
    }

    /// Returns the stable alphabet identity.
    pub fn id(&self) -> &AlphabetId {
        self.inner.id()
    }

    /// Returns all twelve canonical classes in numeric order.
    pub fn classes(&self) -> &[PitchClass] {
        self.inner.symbols()
    }
}

impl SerialAlphabet for PitchClassAlphabet {
    type Symbol = PitchClass;

    fn id(&self) -> &AlphabetId {
        self.inner.id()
    }

    fn symbols(&self) -> &[Self::Symbol] {
        self.inner.symbols()
    }
}