vita-core 0.1.0

Zero-dependency primitives for atomistic and molecular computation.
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
130
131
132
133
134
135
136
137
138
139

use crate::{Element, HasSites, SiteId};

/// Per-site chemical identity: the [`Element`] occupying each site.
///
/// Access is by lookup: [`element`](HasElements::element) maps a [`SiteId`] to its
/// element. [`elements`](HasElements::elements) iterates every `(site, element)` pair;
/// a site together with its element constitutes an atom.
///
/// # Contract
///
/// [`element`](HasElements::element) is total over [`sites`](HasSites::sites): every site
/// has exactly one element.
pub trait HasElements: HasSites {
    /// Returns the element occupying `site`.
    ///
    /// # Panics
    ///
    /// Panics if `site` is not in [`sites`](HasSites::sites).
    fn element(&self, site: SiteId) -> Element;

    /// Returns an iterator over every `(site, element)` pair.
    ///
    /// Each element is yielded with its [`SiteId`]. The default implementation looks up
    /// [`element`](HasElements::element) per site; override it when the pairs can be
    /// produced directly.
    #[inline]
    fn elements(&self) -> impl Iterator<Item = (SiteId, Element)> + '_ {
        self.sites().map(move |site| (site, self.element(site)))
    }
}

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

    fn site(n: u32) -> SiteId {
        SiteId::new(n).unwrap()
    }

    fn hydrogen() -> Element {
        Element::new(1).unwrap()
    }

    fn oxygen() -> Element {
        Element::new(8).unwrap()
    }

    struct Bare {
        sites: Vec<SiteId>,
        elements: Vec<Element>,
    }
    impl HasSites for Bare {
        fn sites(&self) -> impl Iterator<Item = SiteId> + '_ {
            self.sites.iter().copied()
        }
    }
    impl HasElements for Bare {
        fn element(&self, site: SiteId) -> Element {
            let i = self.sites.iter().position(|&s| s == site).unwrap();
            self.elements[i]
        }
    }

    struct Columnar {
        sites: Vec<SiteId>,
        elements: Vec<Element>,
    }
    impl HasSites for Columnar {
        fn sites(&self) -> impl Iterator<Item = SiteId> + '_ {
            self.sites.iter().copied()
        }
    }
    impl HasElements for Columnar {
        fn element(&self, site: SiteId) -> Element {
            let i = self.sites.iter().position(|&s| s == site).unwrap();
            self.elements[i]
        }

        fn elements(&self) -> impl Iterator<Item = (SiteId, Element)> + '_ {
            self.sites
                .iter()
                .copied()
                .zip(self.elements.iter().copied())
        }
    }

    fn water() -> Bare {
        Bare {
            sites: vec![site(1), site(2), site(3)],
            elements: vec![oxygen(), hydrogen(), hydrogen()],
        }
    }

    #[test]
    fn element() {
        let mol = water();
        assert_eq!(mol.element(site(1)), oxygen());
        assert_eq!(mol.element(site(2)), hydrogen());
    }

    #[test]
    fn elements() {
        let mol = water();
        assert_eq!(
            mol.elements().collect::<Vec<_>>(),
            vec![
                (site(1), oxygen()),
                (site(2), hydrogen()),
                (site(3), hydrogen())
            ]
        );
    }

    #[test]
    fn elements_empty() {
        let mol = Bare {
            sites: vec![],
            elements: vec![],
        };
        assert_eq!(mol.elements().count(), 0);
    }

    #[test]
    fn override_matches_default() {
        use std::collections::BTreeMap;

        let sites = vec![site(1), site(2), site(3)];
        let elements = vec![oxygen(), hydrogen(), hydrogen()];
        let bare = Bare {
            sites: sites.clone(),
            elements: elements.clone(),
        };
        let columnar = Columnar { sites, elements };

        let bare_elems: BTreeMap<_, _> = bare.elements().collect();
        let columnar_elems: BTreeMap<_, _> = columnar.elements().collect();
        assert_eq!(bare_elems, columnar_elems);
    }
}