sim-lib-pitch-serial 0.1.1

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
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

//! Row-class reports that retain aliases, stabilizers, and invariance evidence.

use crate::{
    AllIntervalReport, CombinatorialPartner, DerivationReport, OrderedIntervalString, RowFamilySet,
    RowOperation, SegmentInvariant, ToneRow, analyze_all_interval, analyze_derivation,
    analyze_invariance,
};

/// One alias entry in a [`RowClassReport`].
#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
pub struct RowClassAlias {
    /// The represented row-family operation.
    pub operation: RowOperation,
    /// The index of the corresponding row in [`RowClassReport::distinct_forms`].
    pub distinct_form_index: usize,
}

/// One distinct form together with the operations and invariance facts that realize it.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct FormEquivalence {
    /// The deduplicated form index.
    pub distinct_form_index: usize,
    /// The distinct row value.
    pub row: ToneRow,
    /// Every alias operation that realizes `row`.
    pub operations: Vec<RowOperation>,
    /// Whole-row invariance facts comparing the source row to `row`.
    pub invariant: SegmentInvariant,
}

/// Ordered, symmetric, and equivalence evidence for one strict tone row.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct RowClassReport {
    /// The analyzed source row.
    pub row: ToneRow,
    /// The source row's directed ordered-interval string.
    pub ordered_intervals: OrderedIntervalString,
    /// Generator-cell derivation evidence over supported equal contiguous partitions.
    pub derivation: DerivationReport,
    /// All-interval evidence over the source row's adjacent directed intervals.
    pub all_interval: AllIntervalReport,
    /// Prime, inversional, retrograde, and retrograde-inversional combinatorial partners.
    pub combinatoriality: Vec<CombinatorialPartner>,
    /// Every operation alias paired with its deduplicated row index.
    pub aliases: Vec<RowClassAlias>,
    /// The deduplicated row values in first-alias order.
    pub distinct_forms: Vec<ToneRow>,
    /// Operations that stabilize the source row exactly.
    pub stabilizers: Vec<RowOperation>,
    /// Distinct forms grouped with their alias and invariance evidence.
    pub form_equivalences: Vec<FormEquivalence>,
}

/// Analyzes one row's ordered intervals, symmetry stabilizers, and form equivalences.
pub fn analyze_row_class(row: &ToneRow) -> RowClassReport {
    let family = RowFamilySet::of(row);
    let aliases = family
        .aliases()
        .iter()
        .map(|alias| RowClassAlias {
            operation: alias.operation,
            distinct_form_index: alias.distinct_form_index(),
        })
        .collect::<Vec<_>>();
    let distinct_forms = family.distinct_forms().to_vec();
    let stabilizers = family
        .aliases()
        .iter()
        .filter(|alias| alias.form.row() == row)
        .map(|alias| alias.operation)
        .collect::<Vec<_>>();
    let left = row
        .indexed_segment(&(0..row.classes().len()).collect::<Vec<_>>())
        .expect("full-row indexed segment is valid");
    let form_equivalences = distinct_forms
        .iter()
        .enumerate()
        .map(|(distinct_form_index, form)| {
            let right = form
                .indexed_segment(&(0..form.classes().len()).collect::<Vec<_>>())
                .expect("full-row indexed segment is valid");
            let operations = family
                .aliases_for_distinct_form(distinct_form_index)
                .map(|alias| alias.operation)
                .collect::<Vec<_>>();
            FormEquivalence {
                distinct_form_index,
                row: form.clone(),
                operations,
                invariant: analyze_invariance(&left, &right),
            }
        })
        .collect();

    RowClassReport {
        row: row.clone(),
        ordered_intervals: row.ordered_intervals(),
        derivation: analyze_derivation(row),
        all_interval: analyze_all_interval(row),
        combinatoriality: crate::analyze_combinatoriality(row).partners,
        aliases,
        distinct_forms,
        stabilizers,
        form_equivalences,
    }
}