phf_mut 0.3.3

Perfectly hashed mutable containers
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308

// phf_mut – Perfectly hashed mutable containers
// Copyright (C) 2017  Ben Wiederhake
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

use std::clone::Clone;
use {PerfectHash, HashInverse, Map, Set};

/* === Example use case === */

#[derive(Clone)]
struct Pairs {
    n: usize,
}

impl Pairs {
    pub fn new(n: usize) -> Self {
        Pairs { n: n }
    }

    fn sort((u, v): (usize, usize)) -> (usize, usize) {
        if u > v {
            (v, u)
        } else {
            (u, v)
        }
    }

    fn size_when(n: usize) -> usize {
        (n + 1) * n / 2
    }
}

impl PerfectHash for Pairs {
    type K = (usize, usize);

    fn hash(&self, k: Self::K) -> usize {
        let (a, b) = Self::sort(k);
        a + Self::size_when(b)
    }

    fn size(&self) -> usize {
        Self::size_when(self.n)
    }
}

impl HashInverse for Pairs {
    fn invert(&self, index: usize) -> Self::K {
        assert!(index < self.size());
        /* Count down from n-1 to 0. */
        for sub in 0..self.n {
            let use_b = self.n - 1 - sub;

            let offset = Self::size_when(use_b);
            if offset <= index {
                /* Found the largest 'use_b' that results
                   in a compatible offset */
                let use_a = index - offset;
                assert!(use_a <= use_b);
                return (use_a, use_b);
            }
        }
        panic!("Unsigned integer {} appears to be strictly smaller than zero 0.",
               index);
    }
}

/* === Actual tests: default implementations === */

#[test]
fn test_domain_iter() {
    let pairs = Pairs::new(4);
    let actual = pairs.iter().collect::<Vec<_>>();
    let expected = vec![(0, 0),
                        (0, 1), (1, 1),
                        (0, 2), (1, 2), (2, 2),
                        (0, 3), (1, 3), (2, 3), (3, 3)];
    assert_eq!(actual, expected);
}

/* === Actual tests: Map === */

#[test]
fn test_map_basics() {
    let mut mymap = Map::new(Pairs::new(10));
    mymap.insert((3, 7), String::from("Hello"));
    mymap[(7, 3)].push(' ');
    mymap.insert((4, 3), String::from("lovely"));
    mymap.insert((2, 9), String::from("World!"));
    assert_eq!("Hello ", mymap.get((3, 7)));
    assert_eq!("Hello ", mymap.get((7, 3)));
    assert_eq!("", mymap.get((2, 2)));
    assert_eq!("World!", mymap[(2, 9)]);
    assert_eq!("World!", mymap[(9, 2)]);
    assert_eq!("", mymap.get((7, 4)));
    assert_eq!("", mymap.get((6, 6)));
}

#[test]
fn test_map_swap() {
    let mut mymap = Map::new(Pairs::new(10));

    mymap.insert((3, 7), String::from("Hello"));
    mymap.insert((4, 3), String::from("lovely"));
    let mut world = String::from("World!");
    assert_eq!("Hello", mymap[(3, 7)]);
    assert_eq!("", mymap[(8, 9)]);
    assert_eq!("lovely", mymap[(3, 4)]);
    assert_eq!("World!", world);

    mymap.swap((4, 3), &mut world);
    assert_eq!("Hello", mymap[(3, 7)]);
    assert_eq!("", mymap[(8, 9)]);
    assert_eq!("World!", mymap[(3, 4)]);
    assert_eq!("lovely", world);
}

#[test]
fn test_map_iter() {
    let mut mymap = Map::new(Pairs::new(3));
    mymap.insert((0, 1), 42);
    mymap.insert((1, 2), 123);
    mymap.insert((1, 1), 0xCAFE);
    mymap[(1, 0)] = 5;
    let value_vec = mymap.values().map(|x| *x).collect::<Vec<_>>();
    assert_eq!(vec![0, 5, 0xCAFE, 0, 123, 0], value_vec);
    let entry_vec = mymap.iter().map(|((a, b), &v)| (a, b, v))
                         .collect::<Vec<_>>();
    assert_eq!(vec![(0, 0, 0), (0, 1, 5),
                    (1, 1, 0xCAFE), (0, 2, 0),
                    (1, 2, 123), (2, 2, 0),], entry_vec);
}

#[test]
fn test_map_clone() {
    let mut mymap = Map::new(Pairs::new(10));
    mymap.insert((3, 7), String::from("Hello"));
    mymap[(7, 3)].push(' ');
    mymap.insert((4, 3), String::from("lovely"));
    mymap.insert((2, 9), String::from("World!"));
    let othermap = mymap.clone();
    assert_eq!("Hello ", othermap.get((3, 7)));
    assert_eq!("Hello ", othermap.get((7, 3)));
    assert_eq!("", othermap.get((2, 2)));
    assert_eq!("World!", othermap[(2, 9)]);
    assert_eq!("World!", othermap[(9, 2)]);
    assert_eq!("", othermap.get((7, 4)));
    assert_eq!("", othermap.get((6, 6)));
}

/* === Actual tests: Set === */

#[test]
fn test_set_basics() {
    let mut myset = Set::new(Pairs::new(10));
    assert_eq!(true, myset.is_empty());
    assert_eq!(false, myset.is_full());

    myset.insert((7, 6));
    myset.insert((4, 3));
    assert_eq!(false, myset.is_empty());
    assert_eq!(false, myset.is_full());
    assert_eq!(true, myset.contains((7, 6)));
    assert_eq!(true, myset.contains((6, 7)));
    assert_eq!(false, myset.contains((7, 8)));
    assert_eq!(true, myset.contains((4, 3)));
    assert_eq!(false, myset.contains((9, 8)));
    assert_eq!(false, myset.contains((1, 0)));
    assert_eq!(false, myset.contains((0, 1)));
    assert_eq!(false, myset.contains((5, 5)));

    myset.insert((1, 0));
    assert_eq!(true, myset.contains((7, 6)));
    assert_eq!(true, myset.contains((6, 7)));
    assert_eq!(false, myset.contains((7, 8)));
    assert_eq!(true, myset.contains((4, 3)));
    assert_eq!(false, myset.contains((9, 8)));
    assert_eq!(true, myset.contains((1, 0))); /* Change */
    assert_eq!(true, myset.contains((0, 1))); /* Change */
    assert_eq!(false, myset.contains((5, 5)));

    myset.erase((4, 3));
    assert_eq!(false, myset.is_empty());
    assert_eq!(false, myset.is_full());
    assert_eq!(true, myset.contains((7, 6)));
    assert_eq!(true, myset.contains((6, 7)));
    assert_eq!(false, myset.contains((7, 8)));
    assert_eq!(false, myset.contains((4, 3))); /* Change */
    assert_eq!(false, myset.contains((9, 8)));
    assert_eq!(true, myset.contains((1, 0)));
    assert_eq!(true, myset.contains((0, 1)));
    assert_eq!(false, myset.contains((5, 5)));
}

#[test]
fn test_set_fill() {
    let mut myset = Set::new(Pairs::new(4));
    assert_eq!(true, myset.is_empty());
    assert_eq!(false, myset.is_full());

    myset.insert((2, 3));
    myset.insert((1, 3));
    assert_eq!(false, myset.is_empty());
    assert_eq!(false, myset.is_full());
    assert_eq!(false, myset.contains((0, 0)));
    assert_eq!(false, myset.contains((0, 1)));
    assert_eq!(false, myset.contains((0, 2)));
    assert_eq!(false, myset.contains((0, 3)));
    assert_eq!(false, myset.contains((1, 0)));
    assert_eq!(false, myset.contains((1, 1)));
    assert_eq!(false, myset.contains((1, 2)));
    assert_eq!(true, myset.contains((1, 3)));
    assert_eq!(false, myset.contains((2, 0)));
    assert_eq!(false, myset.contains((2, 1)));
    assert_eq!(false, myset.contains((2, 2)));
    assert_eq!(true, myset.contains((2, 3)));
    assert_eq!(false, myset.contains((3, 0)));
    assert_eq!(true, myset.contains((3, 1)));
    assert_eq!(true, myset.contains((3, 2)));
    assert_eq!(false, myset.contains((3, 3)));

    myset.insert((0, 1));
    myset.insert((0, 2));
    myset.insert((0, 0));
    assert_eq!(false, myset.is_empty());
    assert_eq!(false, myset.is_full());
    assert_eq!(true, myset.contains((0, 0)));
    assert_eq!(true, myset.contains((0, 1)));
    assert_eq!(true, myset.contains((0, 2)));
    assert_eq!(false, myset.contains((0, 3)));
    assert_eq!(true, myset.contains((1, 0)));
    assert_eq!(false, myset.contains((1, 1)));
    assert_eq!(false, myset.contains((1, 2)));
    assert_eq!(true, myset.contains((1, 3)));
    assert_eq!(true, myset.contains((2, 0)));
    assert_eq!(false, myset.contains((2, 1)));
    assert_eq!(false, myset.contains((2, 2)));
    assert_eq!(true, myset.contains((2, 3)));
    assert_eq!(false, myset.contains((3, 0)));
    assert_eq!(true, myset.contains((3, 1)));
    assert_eq!(true, myset.contains((3, 2)));
    assert_eq!(false, myset.contains((3, 3)));

    myset.insert((0, 3));
    myset.insert((1, 1));
    myset.insert((2, 2));
    myset.insert((3, 3));
    myset.insert((2, 1));
    assert_eq!(false, myset.is_empty());
    assert_eq!(true, myset.is_full());
    assert_eq!(true, myset.contains((0, 0)));
    assert_eq!(true, myset.contains((0, 1)));
    assert_eq!(true, myset.contains((0, 2)));
    assert_eq!(true, myset.contains((0, 3)));
    assert_eq!(true, myset.contains((1, 0)));
    assert_eq!(true, myset.contains((1, 1)));
    assert_eq!(true, myset.contains((1, 2)));
    assert_eq!(true, myset.contains((1, 3)));
    assert_eq!(true, myset.contains((2, 0)));
    assert_eq!(true, myset.contains((2, 1)));
    assert_eq!(true, myset.contains((2, 2)));
    assert_eq!(true, myset.contains((2, 3)));
    assert_eq!(true, myset.contains((3, 0)));
    assert_eq!(true, myset.contains((3, 1)));
    assert_eq!(true, myset.contains((3, 2)));
    assert_eq!(true, myset.contains((3, 3)));
}

#[test]
fn test_set_iter() {
    let mut myset = Set::new(Pairs::new(10));
    myset.insert((7, 6));
    myset.insert((4, 3));
    myset.insert((1, 0));
    myset.insert((1, 4));
    let myset: Set<_> = myset;
    let as_vec = myset.iter().collect::<Vec<_>>();
    assert_eq!(vec![(0, 1), (1, 4), (3, 4), (6, 7)], as_vec);
}

#[test]
fn test_set_clone() {
    let mut myset = Set::new(Pairs::new(10));
    myset.insert((7, 6));
    myset.insert((4, 3));
    myset.insert((1, 0));
    let otherset = myset.clone();

    assert_eq!(true, otherset.contains((7, 6)));
    assert_eq!(true, otherset.contains((6, 7)));
    assert_eq!(false, otherset.contains((7, 8)));
    assert_eq!(true, otherset.contains((4, 3)));
    assert_eq!(false, otherset.contains((9, 8)));
    assert_eq!(true, otherset.contains((1, 0)));
    assert_eq!(true, otherset.contains((0, 1)));
    assert_eq!(false, otherset.contains((5, 5)));
}