orx-parallel 4.0.0

Performant parallel computations with an expressive iterator API.
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

use crate::infallible_use::XapUse;
use crate::sizes::SizePair;
use crate::use_var::Use;
use core::iter::Fuse;

/// Sequential iterator for a two-stage optional `XapUse` pipeline.
#[must_use = "iterators are lazy and do nothing unless consumed"]
pub struct XapUseOptionIter<U, I, M, X1, X2, S>
where
    U: Use,
    I: Iterator,
    X1: XapUse<U = U::Item, I = I::Item, O = Option<M>>,
    X2: XapUse<U = U::Item, I = M>,
    S: SizePair<S1 = X1::Size, S2 = X2::Size>,
{
    _using: U,
    iter: Fuse<I>,
    x1: X1,
    x2: X2,
    values: Option<<S::XapUseOptResult<M, X1, X2> as IntoIterator>::IntoIter>,
    use_ptr: *mut U::Item,
}

impl<U, I, M, X1, X2, S> XapUseOptionIter<U, I, M, X1, X2, S>
where
    U: Use,
    I: Iterator,
    X1: XapUse<U = U::Item, I = I::Item, O = Option<M>>,
    X2: XapUse<U = U::Item, I = M>,
    S: SizePair<S1 = X1::Size, S2 = X2::Size>,
{
    /// Creates a sequential iterator for an optional parallel pipeline.
    pub fn new(using: U, iter: I, x1: X1, x2: X2) -> Self {
        // SAFETY: the pointer is kept with `using` for the iterator's lifetime.
        let use_ptr = unsafe { using.init_get(0) } as *mut U::Item;
        Self {
            _using: using,
            iter: iter.fuse(),
            x1,
            x2,
            values: None,
            use_ptr,
        }
    }
}

impl<U, I, M, X1, X2, S> Iterator for XapUseOptionIter<U, I, M, X1, X2, S>
where
    U: Use,
    I: Iterator,
    X1: XapUse<U = U::Item, I = I::Item, O = Option<M>>,
    X2: XapUse<U = U::Item, I = M>,
    S: SizePair<S1 = X1::Size, S2 = X2::Size>,
{
    type Item = Option<X2::O>;

    #[inline]
    fn next(&mut self) -> Option<Self::Item> {
        loop {
            if let Some(values) = &mut self.values
                && let Some(value) = values.next()
            {
                return Some(value);
            }
            self.values = None;
            let input = self.iter.next()?;
            self.values = Some(S::xap_use_opt(self.use_ptr, self.x1, self.x2, input).into_iter());
        }
    }

    #[inline]
    fn size_hint(&self) -> (usize, Option<usize>) {
        let current = self
            .values
            .as_ref()
            .map_or((0, Some(0)), Iterator::size_hint);
        let remaining = <S as SizePair>::transformed_size_hint(self.iter.size_hint());
        (
            current.0.saturating_add(remaining.0),
            current
                .1
                .and_then(|a| remaining.1.and_then(|b| a.checked_add(b))),
        )
    }

    #[inline]
    fn fold<B, F>(self, init: B, mut f: F) -> B
    where
        B: Sized,
        F: FnMut(B, Self::Item) -> B,
    {
        let mut result = init;
        if let Some(values) = self.values {
            result = values.fold(result, &mut f);
        }
        for input in self.iter {
            result = S::xap_use_opt(self.use_ptr, self.x1, self.x2, input)
                .into_iter()
                .fold(result, &mut f);
        }
        result
    }
}