oxihuman-core 0.1.2

Core data structures, algorithms, and asset management for OxiHuman
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
140
141
142
143
144
145
146
147
148

#![allow(dead_code)]

use std::collections::BTreeSet;

/// An ordered set of unique indices.
#[allow(dead_code)]
#[derive(Debug, Clone)]
pub struct IndexSet {
    set: BTreeSet<usize>,
}

/// Creates a new empty index set.
#[allow(dead_code)]
pub fn new_index_set() -> IndexSet {
    IndexSet {
        set: BTreeSet::new(),
    }
}

/// Inserts an index. Returns true if it was new.
#[allow(dead_code)]
pub fn index_set_insert(iset: &mut IndexSet, index: usize) -> bool {
    iset.set.insert(index)
}

/// Checks if the set contains an index.
#[allow(dead_code)]
pub fn index_set_contains(iset: &IndexSet, index: usize) -> bool {
    iset.set.contains(&index)
}

/// Removes an index. Returns true if it was present.
#[allow(dead_code)]
pub fn index_set_remove(iset: &mut IndexSet, index: usize) -> bool {
    iset.set.remove(&index)
}

/// Returns the number of indices.
#[allow(dead_code)]
pub fn index_set_len(iset: &IndexSet) -> usize {
    iset.set.len()
}

/// Returns all indices as a sorted Vec.
#[allow(dead_code)]
pub fn index_set_to_vec(iset: &IndexSet) -> Vec<usize> {
    iset.set.iter().copied().collect()
}

/// Clears the set.
#[allow(dead_code)]
pub fn index_set_clear(iset: &mut IndexSet) {
    iset.set.clear();
}

/// Returns the union of two index sets.
#[allow(dead_code)]
pub fn index_set_union(a: &IndexSet, b: &IndexSet) -> IndexSet {
    IndexSet {
        set: a.set.union(&b.set).copied().collect(),
    }
}

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

    #[test]
    fn test_new_index_set() {
        let iset = new_index_set();
        assert_eq!(index_set_len(&iset), 0);
    }

    #[test]
    fn test_insert() {
        let mut iset = new_index_set();
        assert!(index_set_insert(&mut iset, 5));
        assert!(!index_set_insert(&mut iset, 5));
    }

    #[test]
    fn test_contains() {
        let mut iset = new_index_set();
        index_set_insert(&mut iset, 3);
        assert!(index_set_contains(&iset, 3));
        assert!(!index_set_contains(&iset, 4));
    }

    #[test]
    fn test_remove() {
        let mut iset = new_index_set();
        index_set_insert(&mut iset, 10);
        assert!(index_set_remove(&mut iset, 10));
        assert!(!index_set_contains(&iset, 10));
    }

    #[test]
    fn test_len() {
        let mut iset = new_index_set();
        index_set_insert(&mut iset, 1);
        index_set_insert(&mut iset, 2);
        assert_eq!(index_set_len(&iset), 2);
    }

    #[test]
    fn test_to_vec() {
        let mut iset = new_index_set();
        index_set_insert(&mut iset, 3);
        index_set_insert(&mut iset, 1);
        index_set_insert(&mut iset, 2);
        assert_eq!(index_set_to_vec(&iset), vec![1, 2, 3]);
    }

    #[test]
    fn test_clear() {
        let mut iset = new_index_set();
        index_set_insert(&mut iset, 1);
        index_set_clear(&mut iset);
        assert_eq!(index_set_len(&iset), 0);
    }

    #[test]
    fn test_union() {
        let mut a = new_index_set();
        index_set_insert(&mut a, 1);
        index_set_insert(&mut a, 2);
        let mut b = new_index_set();
        index_set_insert(&mut b, 2);
        index_set_insert(&mut b, 3);
        let u = index_set_union(&a, &b);
        assert_eq!(index_set_to_vec(&u), vec![1, 2, 3]);
    }

    #[test]
    fn test_remove_nonexistent() {
        let mut iset = new_index_set();
        assert!(!index_set_remove(&mut iset, 99));
    }

    #[test]
    fn test_duplicates() {
        let mut iset = new_index_set();
        index_set_insert(&mut iset, 5);
        index_set_insert(&mut iset, 5);
        index_set_insert(&mut iset, 5);
        assert_eq!(index_set_len(&iset), 1);
    }
}