generational-arena 0.2.9

A safe arena allocator that supports deletion without suffering from the ABA problem by using generational indices.
Documentation
extern crate generational_arena;
#[macro_use]
extern crate quickcheck;

use generational_arena::Arena;
use std::collections::BTreeSet;
use std::iter::FromIterator;

quickcheck! {
    fn always_contains_inserted_elements(elems: Vec<usize>) -> bool {
        let mut arena = Arena::new();
        let indices: Vec<_> = elems.into_iter().map(|e| arena.insert(e)).collect();
        indices.into_iter().all(|i| arena.contains(i))
    }
}

quickcheck! {
    fn never_contains_deleted_elements(elems: Vec<usize>) -> bool {
        let mut arena = Arena::new();
        let indices: Vec<_> = elems.into_iter().map(|e| arena.insert(e)).collect();
        for i in indices.iter().cloned() {
            arena.remove(i).unwrap();
        }
        indices.into_iter().all(|i| !arena.contains(i))
    }
}

quickcheck! {
    fn insert_delete_insert(elems: Vec<usize>) -> bool {
        let mut arena = Arena::new();

        let indices: Vec<_> = elems.iter().cloned().map(|e| arena.insert(e)).collect();
        for (i, idx) in indices.iter().cloned().enumerate() {
            if arena.remove(idx).unwrap() != elems[i] {
                return false;
            }
        }

        let new_indices: Vec<_> = elems.iter().cloned().map(|e| arena.insert(e)).collect();
        new_indices.into_iter().enumerate().all(|(i, idx)| {
            !arena.contains(indices[i]) && arena.remove(idx).unwrap() == elems[i]
        })
    }
}

quickcheck! {
    fn interp(ops: Vec<(bool, usize)>) -> () {
        let mut arena = Arena::new();
        let mut live_indices = vec![];
        let mut dead_indices = vec![];

        for (delete, i) in ops {
            if delete && !live_indices.is_empty() {
                let i = i % live_indices.len();
                let (idx, expected) = live_indices.remove(i);
                assert_eq!(arena.remove(idx).unwrap(), expected);
                dead_indices.push(idx);
            } else {
                live_indices.push((arena.insert(i), i));
            }

            // All live indices always have the expected value.
            for (live, expected) in live_indices.iter().cloned() {
                assert_eq!(*arena.get(live).unwrap(), expected);
            }

            // All dead indices are never contained in the arena.
            for dead in dead_indices.iter().cloned() {
                assert!(!arena.contains(dead));
            }
        }

        // All the remaining values are expected.
        let remaining: Vec<_> = arena.into_iter().collect();
        assert_eq!(remaining.len(), live_indices.len());
        for rem in remaining {
            let i = live_indices.iter().position(|&(_, v)| v == rem).unwrap();
            live_indices.remove(i);
        }
    }
}

quickcheck! {
    fn iter(elems: BTreeSet<usize>) -> bool {
        let arena = Arena::from_iter(elems.clone());
        arena.iter().all(|(idx, value)| {
            elems.contains(value) && arena.get(idx) == Some(value)
        })
    }
}

quickcheck! {
    fn iter_mut(elems: BTreeSet<usize>) -> bool {
        let mut arena = Arena::from_iter(elems.clone());
        for (_, value) in &mut arena {
            *value += 1;
        }
        arena.iter().all(|(idx, value)| {
            let orig_value = value - 1;
            elems.contains(&orig_value) && arena.get(idx) == Some(value)
        })
    }
}

quickcheck! {
    fn unknown_gen_consistency(values: Vec<(usize, bool)>) -> bool {
        let mut arena = Arena::new();

        let inserted_indices: Vec<_> = values.iter().map(|(e, _)| arena.insert(e)).collect();
        let unknown_gen_indices: Vec<_> = inserted_indices.iter().map(|idx| idx.into_raw_parts().0).collect();

        // remove a couple elements at random
        for (i, arena_index) in inserted_indices.iter().enumerate() {
            if let Some((_, true)) = values.get(i) {
                arena.remove(*arena_index);
            }
        }

        // check that the results from get_unknown_gen() match get()
        let first_batch = unknown_gen_indices.iter().enumerate().all(|(i, unknown_gen_idx)| {
            let shared_check = if let Some((_, idx)) = arena.get_unknown_gen(*unknown_gen_idx) {
                arena.get(idx).is_some() && inserted_indices[i] == idx
            } else {
                true
            };
            let mut_check = if let Some((_, idx)) = arena.get_unknown_gen_mut(*unknown_gen_idx) {
                arena.get_mut(idx).is_some() && inserted_indices[i] == idx
            } else {
                true
            };
            shared_check && mut_check
        });
        if !first_batch {
            // if the first batch didn't succeed, there is no reason to keep going with the test
            return false
        }

        // check that the results from get() match get_unknown_check()
        inserted_indices.iter().enumerate().all(|(i, idx)| {
            let shared_check = if let Some(_) = arena.get(*idx) {
                let internal_index = idx.into_raw_parts().0;
                arena.get_unknown_gen(internal_index).is_some() && unknown_gen_indices[i] == internal_index
            } else {
                true
            };
            let mut_check = if let Some(_) = arena.get_mut(*idx) {
                let internal_index = idx.into_raw_parts().0;
                arena.get_unknown_gen_mut(internal_index).is_some() && unknown_gen_indices[i] == internal_index
            } else {
                true
            };
            shared_check && mut_check
        })
    }
}

quickcheck! {
    fn from_iter_into_iter(elems: BTreeSet<usize>) -> bool {
        let arena = Arena::from_iter(elems.clone());
        arena.into_iter().collect::<BTreeSet<_>>() == elems
    }
}

quickcheck! {
    fn retain(elems: Vec<bool>) -> () {
        let mut arena = Arena::new();
        let mut live_indices = vec![];
        let mut dead_indices = vec![];

        for elem in elems {
            let idx = arena.insert(elem);
            if elem {
                live_indices.push(idx);
            } else {
                dead_indices.push(idx);
            }
        }

        arena.retain(|_, &mut b| b);
        
        for live in live_indices.iter().cloned() {
            assert!(arena.contains(live));
        }

        for dead in dead_indices.iter().cloned() {
            assert!(!arena.contains(dead));
        }

        arena.retain(|_, &mut b| !b);

        for live in live_indices.iter().cloned() {
            assert!(!arena.contains(live));
        }
    }
}