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

/*
    Appellation: chain <module>
    Created At: 2026.01.09:11:04:36
    Contrib: @FL03
*/
use super::ChainFeatures;
use crate::LPR;
use alloc::vec::Vec;

#[derive(Clone, Debug, Default, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
pub struct Chain {
    /// Musical cost or distance metric (lower is better)
    pub(crate) cost: usize,
    /// Path features for musical analysis
    pub(crate) features: ChainFeatures,
    /// The sequence of transformations to apply
    pub(crate) path: Vec<LPR>,
}

impl Chain {
    /// initialize a new, empty transformation [`Chain`]
    pub fn new() -> Self {
        Chain {
            cost: 0,
            features: ChainFeatures::new(),
            path: Vec::new(),
        }
    }
    /// returns a new instance of the [`Chain`] using the given features
    pub fn from_features(features: ChainFeatures) -> Self {
        Chain {
            cost: 0,
            features,
            path: Vec::new(),
        }
    }
    /// returns a new instance of the [`Chain`] from an iterator over transformations
    pub fn from_path<I>(path: I) -> Self
    where
        I: IntoIterator<Item = LPR>,
    {
        let path = Vec::from_iter(path);
        Chain {
            cost: 0,
            features: ChainFeatures::new(),
            path,
        }
    }
    /// returns a copy of the cost of the transformation chain
    pub const fn cost(&self) -> usize {
        self.cost
    }
    /// returns a copy of the features of the transformation chain
    pub const fn features(&self) -> &ChainFeatures {
        &self.features
    }
    /// returns a reference to the path of transformations
    pub const fn path(&self) -> &Vec<LPR> {
        &self.path
    }
    /// update the cost of the chain
    pub fn set_cost(&mut self, cost: usize) {
        self.cost = cost;
    }
    /// update the features of the chain
    pub fn set_features(&mut self, features: ChainFeatures) {
        self.features = features
    }

    /// consumes the instance to create another with the given features
    pub fn with_features(self, features: ChainFeatures) -> Self {
        Self { features, ..self }
    }
    /// consumes the instance to create another with the given cost
    pub fn with_cost(self, cost: usize) -> Self {
        Self { cost, ..self }
    }
    /// consumes the instance to create another with the given path
    pub fn with_path<I>(self, path: I) -> Self
    where
        I: IntoIterator<Item = LPR>,
    {
        let path = Vec::from_iter(path);
        Self { path, ..self }
    }
    /// returns an iterator over the transformations in the chain
    pub fn iter(&self) -> impl Iterator<Item = &LPR> {
        self.path.iter()
    }
}

impl IntoIterator for Chain {
    type Item = LPR;
    type IntoIter = alloc::vec::IntoIter<LPR>;

    fn into_iter(self) -> Self::IntoIter {
        self.path.into_iter()
    }
}

impl<'a> IntoIterator for &'a Chain {
    type Item = &'a LPR;
    type IntoIter = core::slice::Iter<'a, LPR>;

    fn into_iter(self) -> Self::IntoIter {
        self.path.iter()
    }
}