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
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

#![doc = include_str!("../README.md")]
#![warn(
    missing_docs,
    clippy::unwrap_in_result,
    clippy::unwrap_used,
    clippy::panic,
    clippy::panic_in_result_fn,
    clippy::float_cmp,
    clippy::float_cmp_const,
    clippy::missing_panics_doc,
    clippy::todo
)]
#![no_std]

extern crate alloc;

#[cfg(any(test, feature = "std"))]
extern crate std;

mod collect_into;
/// Module containing variants of parallel iterators.
pub mod computational_variants;
mod default_fns;
mod env;
/// Module defining the parallel runner trait and the default parallel runner.
pub mod executor;
mod generic_values;
mod heap_sort;
mod into_par_iter;
/// Module for creating special iterators.
pub mod iter;
mod iter_into_par_iter;
mod par_iter;
mod par_iter_option;
mod par_iter_result;
mod par_thread_pool;
mod parallel_drainable;
mod parallelizable;
mod parallelizable_collection;
mod parallelizable_collection_mut;
mod parameters;
/// ParallelRunner for parallel execution and managing threads.
pub mod runner;
mod special_type_sets;
/// Module defining parallel iterators with mutable access to values distributed to each thread.
pub mod using;

/// Module defining the GenericIterator which is a generalization over
/// sequential iterator, rayon's parallel iterator and orx-parallel's
/// parallel iterator.
/// This is particularly useful for running experiments and comparing
/// results of computations with different methods.
#[cfg(feature = "generic_iterator")]
pub mod generic_iterator;

/// Module with utility methods for testing.
#[cfg(test)]
mod test_utils;

// re-export
pub use orx_concurrent_recursive_iter::Queue;

// export

pub use collect_into::ParCollectInto;
pub use executor::{DefaultExecutor, ParallelExecutor, ThreadExecutor};
pub use into_par_iter::IntoParIter;
pub use iter::IntoParIterRec;
pub use iter_into_par_iter::IterIntoParIter;
pub use par_iter::ParIter;
pub use par_iter_option::ParIterOption;
pub use par_iter_result::ParIterResult;
pub use par_thread_pool::ParThreadPool;
pub use parallel_drainable::ParallelDrainableOverSlice;
pub use parallelizable::Parallelizable;
pub use parallelizable_collection::ParallelizableCollection;
pub use parallelizable_collection_mut::ParallelizableCollectionMut;
pub use parameters::{ChunkSize, IterationOrder, NumThreads, Params};
pub use runner::{DefaultPool, DefaultRunner, ParallelRunner, RunnerWithPool, SequentialPool};
pub use special_type_sets::Sum;
pub use using::ParIterUsing;

#[cfg(feature = "std")]
pub use executor::ParallelExecutorWithDiagnostics;

#[cfg(feature = "pond")]
pub use runner::PondPool;
#[cfg(feature = "std")]
pub use runner::StdDefaultPool;
#[cfg(feature = "yastl")]
pub use runner::YastlPool;