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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

/*
    Appellation: path <module>
    Contrib: @FL03
*/
use super::{Chain, ChainFeatures};
use crate::LPR;
use crate::triad::DynTriad;
use alloc::vec::Vec;
use rshyper::EdgeId;

/// An extended transformation chain that records the visited triads and path features
#[derive(Clone, Debug, Default, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
pub struct Visited<T = isize, Ix = usize> {
    pub(crate) chain: Chain,
    pub(crate) edges: Vec<EdgeId<Ix>>,
    /// The sequence of triads visited
    pub(crate) visited: Vec<DynTriad<T>>,
}

/*
 ************* Implementations *************
*/

impl<T, Ix> Visited<T, Ix> {
    pub fn new(path: Vec<LPR>, visited: Vec<DynTriad<T>>) -> Self {
        Visited {
            chain: Chain::from_path(path),
            edges: Vec::new(),
            visited,
        }
    }
    /// returns a new transformation chain using the visited triads
    pub fn from_visited<I>(visited: I) -> Self
    where
        I: IntoIterator<Item = DynTriad<T>>,
    {
        let visited = Vec::from_iter(visited);
        Visited::new(Vec::new(), visited)
    }
    /// returns a reference to the chain
    pub const fn chain(&self) -> &Chain {
        &self.chain
    }
    /// returns a mutable reference to the chain
    pub const fn chain_mut(&mut self) -> &mut Chain {
        &mut self.chain
    }
    /// returns a copy of the cost of the transformation chain
    pub const fn cost(&self) -> usize {
        self.chain().cost()
    }
    /// returns a copy of the features of the transformation chain
    pub const fn features(&self) -> &ChainFeatures {
        self.chain().features()
    }
    /// returns a reference to the edges
    pub const fn edges(&self) -> &Vec<EdgeId<Ix>> {
        &self.edges
    }
    /// returns a reference to the path of transformations
    pub const fn path(&self) -> &Vec<LPR> {
        self.chain().path()
    }
    /// returns an immutable reference to the visited triads
    pub const fn visited(&self) -> &Vec<DynTriad<T>> {
        &self.visited
    }
    /// returns an iterator over the transformations in the chain
    pub fn iter_path(&self) -> impl Iterator<Item = &LPR> {
        self.path().iter()
    }
}

impl<T, Ix> AsRef<Chain> for Visited<T, Ix> {
    fn as_ref(&self) -> &Chain {
        self.chain()
    }
}

impl<T, Ix> AsMut<Chain> for Visited<T, Ix> {
    fn as_mut(&mut self) -> &mut Chain {
        self.chain_mut()
    }
}

impl<T, Ix> core::borrow::Borrow<Chain> for Visited<T, Ix> {
    fn borrow(&self) -> &Chain {
        self.chain()
    }
}

impl<T, Ix> core::borrow::BorrowMut<Chain> for Visited<T, Ix> {
    fn borrow_mut(&mut self) -> &mut Chain {
        self.chain_mut()
    }
}

impl<T, Ix> core::ops::Deref for Visited<T, Ix> {
    type Target = Chain;

    fn deref(&self) -> &Self::Target {
        self.chain()
    }
}

impl<T, Ix> core::ops::DerefMut for Visited<T, Ix> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        self.chain_mut()
    }
}

impl<T, Ix> IntoIterator for Visited<T, Ix> {
    type Item = LPR;
    type IntoIter = alloc::vec::IntoIter<LPR>;

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

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

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