flatarray 1.1.0

Implementation of a flattened iterator, that acts as if it still was an iterator of iterator
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

/// Small crate containing a custom datastructure. This datastructure
/// is called a `FlatArray` and is a cache-friendly alternative to a
/// Vec<Vec<T>>. Instead, a `FlatArray` is of fixed size but can be
/// iterated over as if it was a `Vec<Vec<T>>`, with the help of the
/// `iter_arrays` and `iter_arrays_mut` methods.
///
/// This crate is intended to be used by other crates, such as `named_entity` and
/// `rusev`, which explains why its API surface is so small.
mod array;
pub use self::array::FlatArray;
mod vector;
pub use self::vector::FlatVec;
mod builder;
pub use self::builder::FlatBuilder; // re-export the builder
mod iterator;
pub use self::iterator::{FlattenedCollection, Iter, IterMut};
mod str;
pub use self::str::FlatStr;

#[cfg(test)]
mod test {
    use core::panic;

    use super::*;

    fn setup_flattened_iter(
        flattened_typ: &'static str,
    ) -> (
        Box<dyn FlattenedCollection<&'static str>>,
        Vec<Vec<&'static str>>,
    ) {
        let input = vec![
            vec!["this", "is", "the", "first", "sentence"],
            vec!["this", "is", "the", "second", "sentence"],
            vec!["this", "is", "the", "second", "sentence"],
        ];
        let mut builder = FlatBuilder::default();
        for v in input.clone() {
            builder.push(v);
        }
        if flattened_typ == "vec" {
            (Box::new(builder.build_flatvec()), input)
        } else if flattened_typ == "array" {
            (Box::new(builder.build_flatarray()), input)
        } else {
            panic!("Wrong flattened collection type");
        }
    }

    #[test]
    fn test_flatvec_len() {
        let (flat_vec, expected) = setup_flattened_iter("vec");
        let vectored: Vec<_> = Iter::new(&flat_vec).collect();
        assert!(expected.len() == vectored.len())
    }

    #[test]
    fn test_flatarray_len() {
        let (flat_vec, expected) = setup_flattened_iter("array");
        let vectored: Vec<_> = Iter::new(&flat_vec).collect();
        assert!(expected.len() == vectored.len())
    }
}