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
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
#[cfg(test)]
mod test;

mod entry;
mod into_iter;
mod iter;
mod iter_mut;
mod keys;
mod values;
mod values_mut;

pub use entry::{Entry, OccupiedEntry, VacantEntry};
pub use into_iter::IntoIter;
pub use iter::Iter;
pub use iter_mut::IterMut;
pub use keys::Keys;
pub use values::Values;
pub use values_mut::ValuesMut;

use core::{
    borrow::Borrow,
    cmp::Ord,
    fmt,
    hash::{Hash, Hasher},
    mem::{self, MaybeUninit},
    ops::Index,
    ptr,
};

/// A heapless, ord-based array map. Operates very similarly to [`BTreeMap`],
/// but maintains its keys and values as single arrays stored inside itself.
/// Sorted insertions are optimized and will be processed in constant time.
///
/// [`BTreeMap`]: https://doc.rust-lang.org/std/collections/struct.BTreeMap.html
pub struct OrdMap<K, V, const N: usize> {
    len: usize,
    keys: [MaybeUninit<K>; N],
    values: [MaybeUninit<V>; N],
}

impl<K, V, const N: usize> OrdMap<K, V, N> {
    fn insert_index(&self, key: &K) -> Result<usize, usize>
    where
        K: Ord,
    {
        let last = match self.last_key_value() {
            Some(last) => last.0,
            None => return Ok(0),
        };
        if last < key {
            Ok(self.len)
        } else {
            // We swap these, because Ok for us is an insertion point.
            match self.keys_slice().binary_search(key) {
                Ok(index) => Err(index),
                Err(index) => Ok(index),
            }
        }
    }
    pub fn keys_slice(&self) -> &[K] {
        let ptr = self.keys.as_ptr() as *const K;
        unsafe { core::slice::from_raw_parts(ptr, self.len) }
    }
    pub fn values_slice(&self) -> &[V] {
        let ptr = self.values.as_ptr() as *const V;
        unsafe { core::slice::from_raw_parts(ptr, self.len) }
    }
    pub fn values_mut_slice(&mut self) -> &mut [V] {
        let ptr = self.values.as_mut_ptr() as *mut V;
        unsafe { core::slice::from_raw_parts_mut(ptr, self.len) }
    }
    pub fn slices(&self) -> (&[K], &[V]) {
        (self.keys_slice(), self.values_slice())
    }
    pub fn slices_mut(&mut self) -> (&[K], &mut [V]) {
        let keys = {
            let ptr = self.keys.as_ptr() as *const K;
            unsafe { core::slice::from_raw_parts(ptr, self.len) }
        };
        let values = {
            let ptr = self.values.as_mut_ptr() as *mut V;
            unsafe { core::slice::from_raw_parts_mut(ptr, self.len) }
        };
        (keys, values)
    }

    pub fn new() -> Self {
        Self::default()
    }

    pub fn len(&self) -> usize {
        self.len
    }
    pub fn is_empty(&self) -> bool {
        self.len == 0
    }

    pub fn entry(&mut self, key: K) -> Entry<'_, K, V, N>
    where
        K: Ord,
    {
        match self.insert_index(&key) {
            Err(index) => Entry::occupied(self, index, key),
            Ok(index) => Entry::vacant(self, index, key),
        }
    }

    /// Insert the value into the map.  Note that the semantics of this
    /// operation are not exactly the same as for BTreeMap.  This will not
    /// replace existing values.
    ///  The possible results are:
    /// * `Ok(Some((K, V)))`: If the key already existed in the map.  The key
    ///   and value are not inserted, and they are returned back to the caller.
    /// * `Ok(None)`: If the key and value were inserted successfully without
    ///   replacement.
    /// * `Err((K, V))`: If the set was full; the and value are returned to the caller.
    pub fn insert(&mut self, key: K, value: V) -> Result<Option<(K, V)>, (K, V)>
    where
        K: Ord,
    {
        match self.insert_index(&key) {
            Err(_) => Ok(Some((key, value))),
            Ok(index) => self.insert_at(index, key, value).map(|()| None),
        }
    }

    /// A raw insert at a particular index.  The key and value are returned on a
    /// full map.
    fn insert_at(&mut self, index: usize, key: K, value: V) -> Result<(), (K, V)> {
        if self.len == N {
            Err((key, value))
        } else {
            self.keys[index..=self.len].rotate_right(1);
            self.keys[index].write(key);
            self.values[index..=self.len].rotate_right(1);
            self.values[index].write(value);
            self.len += 1;
            Ok(())
        }
    }

    /// Replace the key and value at the index and return the old ones.
    fn replace_at(&mut self, index: usize, key: K, value: V) -> (K, V) {
        let prev_key = mem::replace(&mut self.keys[index], MaybeUninit::new(key));
        let prev_value = mem::replace(&mut self.values[index], MaybeUninit::new(value));
        unsafe { (prev_key.assume_init(), prev_value.assume_init()) }
    }

    /// Insert the value into the map, replacing an existing key if found.
    ///  The possible results are:
    /// * `Ok(Some((K, V)))`: If the key already existed in the map.  The key
    ///   and value are replaced, and the previous key and value are returned
    ///   back to the caller.
    /// * `Ok(None)`: If the key and value were inserted successfully without
    ///   replacement.
    /// * `Err((K, V))`: If the set was full; the and value are returned to the caller.
    pub fn replace(&mut self, key: K, value: V) -> Result<Option<(K, V)>, (K, V)>
    where
        K: Ord,
    {
        match self.insert_index(&key) {
            Err(index) => Ok(Some(self.replace_at(index, key, value))),
            Ok(index) => self.insert_at(index, key, value).map(|()| None),
        }
    }

    pub fn get<Q>(&self, key: &Q) -> Option<&V>
    where
        K: Borrow<Q>,
        Q: Ord + ?Sized,
    {
        self.keys_slice()
            .binary_search_by(move |k| k.borrow().cmp(key))
            .ok()
            .map(|index| unsafe { self.values[index].assume_init_ref() })
    }

    pub fn get_key_value<Q>(&self, key: &Q) -> Option<(&K, &V)>
    where
        K: Borrow<Q>,
        Q: Ord + ?Sized,
    {
        self.keys_slice()
            .binary_search_by(move |k| k.borrow().cmp(key))
            .ok()
            .map(|index| unsafe {
                (
                    self.keys[index].assume_init_ref(),
                    self.values[index].assume_init_ref(),
                )
            })
    }

    pub fn get_mut<Q>(&mut self, key: &Q) -> Option<&mut V>
    where
        K: Borrow<Q>,
        Q: Ord + ?Sized,
    {
        self.keys_slice()
            .binary_search_by(move |k| k.borrow().cmp(key))
            .ok()
            .map(|index| unsafe { self.values[index].assume_init_mut() })
    }

    pub fn contains_key<Q>(&self, key: &Q) -> bool
    where
        K: Borrow<Q>,
        Q: Ord + ?Sized,
    {
        self.keys_slice()
            .binary_search_by(move |k| k.borrow().cmp(key))
            .is_ok()
    }

    /// Remove the value from the map.
    /// Returns the removed value.
    pub fn remove<Q>(&mut self, key: &Q) -> Option<(K, V)>
    where
        K: Borrow<Q>,
        Q: Ord + ?Sized,
    {
        self.keys_slice()
            .binary_search_by(move |k| k.borrow().cmp(key))
            .ok()
            .map(move |index| self.remove_at(index))
    }

    /// Remove the entry at the index.
    /// Returns the removed key and value.
    fn remove_at(&mut self, index: usize) -> (K, V) {
        self.keys[index..=self.len].rotate_left(1);
        self.values[index..=self.len].rotate_left(1);
        self.len -= 1;
        unsafe {
            (
                self.keys[self.len].assume_init_read(),
                self.values[self.len].assume_init_read(),
            )
        }
    }

    pub fn clear(&mut self) {
        if self.len == 0 {
            return;
        }

        let ptr = self.keys.as_ptr() as *mut K;
        let key_slice = ptr::slice_from_raw_parts_mut(ptr, self.len);
        let ptr = self.values.as_ptr() as *mut V;
        let value_slice = ptr::slice_from_raw_parts_mut(ptr, self.len);
        self.len = 0;
        unsafe {
            ptr::drop_in_place(key_slice);
            ptr::drop_in_place(value_slice);
        }
    }

    pub fn iter(&self) -> Iter<'_, K, V> {
        Iter::new(self.keys_slice(), self.values_slice())
    }

    pub fn iter_mut(&mut self) -> IterMut<'_, K, V> {
        let (keys, values) = self.slices_mut();
        IterMut::new(keys, values)
    }

    pub fn keys(&self) -> Keys<'_, K> {
        Keys::new(self.keys_slice())
    }
    pub fn values(&self) -> Values<'_, V> {
        Values::new(self.values_slice())
    }
    pub fn values_mut(&mut self) -> ValuesMut<'_, V> {
        ValuesMut::new(self.values_mut_slice())
    }
    pub fn first_key_value(&self) -> Option<(&K, &V)> {
        if self.len == 0 {
            None
        } else {
            let key_slot = &self.keys[0];
            let value_slot = &self.values[0];
            Some(unsafe { (key_slot.assume_init_ref(), value_slot.assume_init_ref()) })
        }
    }
    pub fn last_key_value(&self) -> Option<(&K, &V)> {
        if self.len == 0 {
            None
        } else {
            let key_slot = &self.keys[self.len - 1];
            let value_slot = &self.values[self.len - 1];
            Some(unsafe { (key_slot.assume_init_ref(), value_slot.assume_init_ref()) })
        }
    }
    pub fn pop_first(&mut self) -> Option<(K, V)> {
        if self.len == 0 {
            None
        } else {
            self.keys[..self.len].rotate_left(1);
            self.values[..self.len].rotate_left(1);
            self.len -= 1;
            let key_slot = &self.keys[self.len];
            let value_slot = &self.values[self.len];
            Some(unsafe { (key_slot.assume_init_read(), value_slot.assume_init_read()) })
        }
    }
    pub fn pop_last(&mut self) -> Option<(K, V)> {
        if self.len == 0 {
            None
        } else {
            self.len -= 1;
            let key_slot = &self.keys[self.len];
            let value_slot = &self.values[self.len];
            Some(unsafe { (key_slot.assume_init_read(), value_slot.assume_init_read()) })
        }
    }
}

impl<K, V, const N: usize> Default for OrdMap<K, V, N> {
    fn default() -> Self {
        Self {
            len: 0,
            keys: unsafe { MaybeUninit::uninit().assume_init() },
            values: unsafe { MaybeUninit::uninit().assume_init() },
        }
    }
}
impl<K, V, const N: usize> Clone for OrdMap<K, V, N>
where
    K: Clone,
    V: Clone,
{
    fn clone(&self) -> Self {
        let mut keys: [MaybeUninit<K>; N] = unsafe { MaybeUninit::uninit().assume_init() };
        let mut values: [MaybeUninit<V>; N] = unsafe { MaybeUninit::uninit().assume_init() };

        for (source, destination) in self.keys_slice().iter().zip(&mut keys[..self.len]) {
            destination.write(source.clone());
        }

        for (source, destination) in self.values_slice().iter().zip(&mut values[..self.len]) {
            destination.write(source.clone());
        }

        Self {
            keys,
            values,
            len: self.len,
        }
    }
}

impl<K, V, const N: usize> Drop for OrdMap<K, V, N> {
    fn drop(&mut self) {
        self.clear();
    }
}

impl<K, V, const N: usize> fmt::Debug for OrdMap<K, V, N>
where
    K: fmt::Debug,
    V: fmt::Debug,
{
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_map().entries(self.iter()).finish()
    }
}

impl<K, Q, V, const N: usize> Index<&Q> for OrdMap<K, V, N>
where
    K: Borrow<Q>,
    Q: Ord + ?Sized,
{
    type Output = V;

    fn index(&self, key: &Q) -> &Self::Output {
        self.get(key).unwrap()
    }
}

impl<K, V, const N: usize> IntoIterator for OrdMap<K, V, N> {
    type Item = (K, V);

    type IntoIter = IntoIter<K, V, N>;

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

impl<'a, K, V, const N: usize> IntoIterator for &'a OrdMap<K, V, N> {
    type Item = (&'a K, &'a V);

    type IntoIter = Iter<'a, K, V>;

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

impl<'a, K, V, const N: usize> IntoIterator for &'a mut OrdMap<K, V, N> {
    type Item = (&'a K, &'a mut V);

    type IntoIter = IterMut<'a, K, V>;

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

impl<K, V, const N1: usize, const N2: usize> PartialOrd<OrdMap<K, V, N2>> for OrdMap<K, V, N1>
where
    K: PartialOrd<K>,
    V: PartialOrd<V>,
{
    fn partial_cmp(&self, other: &OrdMap<K, V, N2>) -> Option<core::cmp::Ordering> {
        self.iter().partial_cmp(other.iter())
    }
}
impl<K, V, const N1: usize, const N2: usize> PartialEq<OrdMap<K, V, N2>> for OrdMap<K, V, N1>
where
    K: PartialEq<K>,
    V: PartialEq<V>,
{
    fn eq(&self, other: &OrdMap<K, V, N2>) -> bool {
        self.iter().eq(other.iter())
    }
}

impl<K, V, const N: usize> Eq for OrdMap<K, V, N>
where
    K: Eq,
    V: Eq,
{
}

impl<K, V, const N: usize> Ord for OrdMap<K, V, N>
where
    K: Ord,
    V: Ord,
{
    fn cmp(&self, other: &OrdMap<K, V, N>) -> core::cmp::Ordering {
        self.iter().cmp(other.iter())
    }
}

impl<K, V, const N: usize> Hash for OrdMap<K, V, N>
where
    K: Hash,
    V: Hash,
{
    fn hash<H: Hasher>(&self, state: &mut H) {
        state.write_usize(self.len);
        for pair in self {
            pair.hash(state);
        }
    }
}

/// Panics on overflow
impl<K, V, const N: usize> Extend<(K, V)> for OrdMap<K, V, N>
where
    K: Ord,
{
    fn extend<I>(&mut self, iter: I)
    where
        I: IntoIterator<Item = (K, V)>,
    {
        for (key, value) in iter {
            if let Err(_) = self.insert(key, value) {
                panic!("map overflowed on extend");
            }
        }
    }
}

/// Panics on overflow
impl<'a, K, V, const N: usize> Extend<(&'a K, &'a V)> for OrdMap<K, V, N>
where
    K: Ord + Copy,
    V: Copy,
{
    fn extend<I>(&mut self, iter: I)
    where
        I: IntoIterator<Item = (&'a K, &'a V)>,
    {
        for (key, value) in iter {
            if let Err(_) = self.insert(*key, *value) {
                panic!("map overflowed on extend");
            }
        }
    }
}

/// Panics on overflow
impl<K, V, const N: usize> FromIterator<(K, V)> for OrdMap<K, V, N>
where
    K: Ord,
{
    fn from_iter<I>(iter: I) -> Self
    where
        I: IntoIterator<Item = (K, V)>,
    {
        let mut map = Self::new();
        for (key, value) in iter {
            if let Err(_) = map.insert(key, value) {
                panic!("map overflowed on extend");
            }
        }
        map
    }
}

impl<K, V, const N1: usize, const N2: usize> From<[(K, V); N1]> for OrdMap<K, V, N2>
where
    K: Ord,
{
    fn from(mut value: [(K, V); N1]) -> Self {
        value.sort_unstable_by(|a, b| a.0.cmp(&b.0));
        let mut map = Self::new();
        for (key, value) in value {
            if map.len == 0 || unsafe { map.keys[map.len - 1].assume_init_ref() } < &key {
                if map.len == N2 {
                    panic!("map overflowed on extend");
                }
                map.keys[map.len].write(key);
                map.values[map.len].write(value);
                map.len += 1;
            }
        }
        map
    }
}