orx-concurrent-iter 3.3.0

A thread-safe and ergonomic concurrent iterator trait and efficient lock-free implementations.
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

use orx_concurrent_bag::*;
use orx_concurrent_iter::*;
use orx_iterable::Collection;
use std::fmt::Debug;
use test_case::test_matrix;

#[cfg(not(miri))]
const LEN: [usize; 4] = [1, 4, 1024, 4 * 1024];
#[cfg(miri)]
const LEN: [usize; 4] = [1, 4, 32, 4 * 32];

fn concurrent_iter<I>(num_threads: usize, batch: usize, con_iter: I) -> Vec<I::Item>
where
    I: ConcurrentIter + Sync,
    I::Item: Send + Clone + Copy + Debug + PartialEq,
    I::Item: Sync, // TODO: requirement is due to ConcurrentBag
{
    let collected = ConcurrentBag::new();
    let bag = &collected;

    let iter = &con_iter;

    std::thread::scope(|s| {
        for _ in 0..num_threads {
            s.spawn(move || match batch == 1 {
                true => {
                    while let Some((idx, value)) = iter.next_with_idx() {
                        bag.push((idx, value));
                    }
                }
                false => {
                    let mut puller = iter.chunk_puller(batch);
                    while let Some((begin_idx, chunk)) = puller.pull_with_idx() {
                        for (i, value) in chunk.enumerate() {
                            bag.push((begin_idx + i, value));
                        }
                    }
                }
            });
        }
    });

    let mut vec: Vec<_> = collected.into_inner().iter().copied().collect();
    vec.sort_by_key(|x| x.0);
    vec.iter().map(|x| x.1).collect()
}

fn concurrent_iter_exact_len<I: ConcurrentIter>(iter: I, expected_len: usize, batch: usize) {
    assert_eq!(iter.try_get_len(), Some(expected_len));
    let mut remaining = expected_len;

    match batch == 1 {
        true => {
            while let Some(_) = iter.next() {
                remaining -= 1;
                assert_eq!(iter.try_get_len(), Some(remaining));
            }
            assert_eq!(iter.try_get_len(), Some(0));
            _ = iter.next();
            assert_eq!(iter.try_get_len(), Some(0));
        }
        false => {
            let mut puller = iter.chunk_puller(batch);
            while let Some(chunk) = puller.pull() {
                remaining -= chunk.len();
                assert_eq!(iter.try_get_len(), Some(remaining));
            }
            assert_eq!(iter.try_get_len(), Some(0));
            _ = puller.pull();
            assert_eq!(iter.try_get_len(), Some(0));
        }
    }
}

#[test_matrix(
    [1, 2, 8],
    [1, 4, 64, 1024]
)]
fn con_iter_slice(num_threads: usize, batch: usize) {
    for len in LEN {
        let source: Vec<_> = (0..len).collect();

        let clone = source.clone();
        let slice = clone.as_slice();

        let collected: Vec<&usize> = concurrent_iter(num_threads, batch, slice.con_iter());
        assert_eq!(source, collected.into_iter().copied().collect::<Vec<_>>());

        concurrent_iter_exact_len(clone.clone().as_slice().con_iter(), len, 1);
        concurrent_iter_exact_len(clone.clone().as_slice().con_iter(), len, 32);
        concurrent_iter_exact_len(clone.clone().as_slice().con_iter(), len, 33);
    }
}

#[test_matrix(
    [1, 2, 8],
    [1, 4, 64, 1024]
)]
fn con_iter_vec(num_threads: usize, batch: usize) {
    for len in LEN {
        let source: Vec<usize> = (0..len).collect();

        let collected: Vec<usize> =
            concurrent_iter(num_threads, batch, source.clone().into_con_iter());
        assert_eq!(source, collected.into_iter().collect::<Vec<_>>());

        concurrent_iter_exact_len(source.clone().into_con_iter(), len, 1);
        concurrent_iter_exact_len(source.clone().into_con_iter(), len, 32);
        concurrent_iter_exact_len(source.clone().into_con_iter(), len, 33);
    }
}

#[test_matrix(
    [1, 2, 8],
    [1, 4, 64, 1024]
)]
fn con_iter_iter(num_threads: usize, batch: usize) {
    for len in LEN {
        let source: Vec<_> = (0..len).collect();

        let clone = source.clone();

        let collected: Vec<&usize> =
            concurrent_iter(num_threads, batch, clone.iter().iter_into_con_iter());
        assert_eq!(source, collected.into_iter().copied().collect::<Vec<_>>());

        concurrent_iter_exact_len(clone.iter().iter_into_con_iter(), len, 1);
        concurrent_iter_exact_len(clone.iter().iter_into_con_iter(), len, 32);
        concurrent_iter_exact_len(clone.iter().iter_into_con_iter(), len, 33);
        concurrent_iter_exact_len(clone.iter().map(|x| x * 2).iter_into_con_iter(), len, 1);
        concurrent_iter_exact_len(clone.iter().map(|x| x * 2).iter_into_con_iter(), len, 32);
        concurrent_iter_exact_len(clone.iter().map(|x| x * 2).iter_into_con_iter(), len, 33);
    }
}