orx-parallel 3.4.0

High performance, configurable and expressive parallel computation library.
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

use crate::{Params, computational_variants::Par, runner::DefaultRunner};
use core::ops::RangeBounds;
use orx_concurrent_iter::ConcurrentDrainableOverSlice;

/// A type which can create a parallel draining iterator over any of its sub-slices.
///
/// * Created draining iterator takes out and returns all elements of the slice defined by the `range`.
/// * The slice defined by this `range` will be removed from the original collection.
///
/// If the iterator is dropped before being fully consumed, it drops the remaining removed elements.
///
/// If the complete range is provided (`..` or `0..self.len()`), self will remain empty.
///
/// # Examples
///
/// ```
/// use orx_parallel::*;
///
/// let mut v = vec![1, 2, 3];
/// let u: Vec<_> = v.par_drain(1..).num_threads(2).collect();
///
/// assert_eq!(v, &[1]);
/// assert_eq!(u, &[2, 3]);
/// ```
pub trait ParallelDrainableOverSlice: ConcurrentDrainableOverSlice {
    /// Creates a parallel draining iterator over the slice defined by the given `range`.
    ///
    /// * Created draining iterator takes out and returns all elements of the slice defined by the `range`.
    /// * The slice defined by this `range` will be removed from the original collection.
    ///
    /// If the iterator is dropped before being fully consumed, it drops the remaining removed elements.
    ///
    /// If the complete range is provided (`..` or `0..self.len()`), self will remain empty.
    ///
    /// # Examples
    ///
    /// ```
    /// use orx_parallel::*;
    ///
    /// let mut v = vec![1, 2, 3];
    /// let u: Vec<_> = v.par_drain(1..).num_threads(2).collect();
    ///
    /// assert_eq!(v, &[1]);
    /// assert_eq!(u, &[2, 3]);
    /// ```
    fn par_drain<R>(
        &mut self,
        range: R,
    ) -> Par<<Self as ConcurrentDrainableOverSlice>::DrainingIter<'_>, DefaultRunner>
    where
        R: RangeBounds<usize>,
    {
        Par::new(Default::default(), Params::default(), self.con_drain(range))
    }
}

impl<I> ParallelDrainableOverSlice for I where I: ConcurrentDrainableOverSlice {}