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

/// Order of parallel iteration, which might be:
/// * in the order of the input as in regular sequential iterators, or
/// * arbitrary.
///
/// This is important for certain computations:
///
/// * [`collect`] will return exactly the same result of its sequential counterpart
///   when `Ordered` is used. However, the elements might (but not necessarily)
///   be in arbitrary order when `Arbitrary` is used.
/// * [`first`] returns the first element of the iterator when `Ordered`, might
///   return any element when `Arbitrary`.
/// * [`find`] returns the first element satisfying the predicate when `Ordered`,
///   might return any element satisfying the predicate when `Arbitrary`
///   (sometimes this method is called `find_any`).
///
/// [`collect`]: crate::Par::collect
/// [`first`]: crate::Par::first
/// [`find`]: crate::Par::find
#[derive(Clone, Copy, Debug, PartialEq, Eq, Default)]
pub enum IterationOrder {
    /// The iteration is allowed to be in arbitrary order when it might improve performance,
    /// but not necessarily.
    Arbitrary,
    /// ***Default ordering***.
    ///
    /// The iteration will be in an order consistent with the input of the collection,
    /// and hence, the outputs will always be equivalent to the sequential counterpart.
    #[default]
    Ordered,
}