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

mod computation_kind;
mod implementations;
mod num_spawned;
mod parallel_runner;

pub(crate) use parallel_runner::{SharedStateOf, ThreadRunnerOf};

pub use computation_kind::ComputationKind;
pub use implementations::{RunnerWithPool, SequentialPool};
pub use num_spawned::NumSpawned;
pub use parallel_runner::ParallelRunner;

#[cfg(feature = "pond")]
pub use implementations::PondPool;

#[cfg(feature = "std")]
pub use implementations::StdDefaultPool;

#[cfg(feature = "yastl")]
pub use implementations::YastlPool;

// DEFAULT

/// Default pool used by orx-parallel computations:
///
/// * [`StdDefaultPool`] when "std" feature is enabled,
/// * [`SequentialPool`] otherwise.
#[cfg(feature = "std")]
pub type DefaultPool = StdDefaultPool;
/// Default pool used by orx-parallel computations:
///
/// * `StdDefaultPool` when "std" feature is enabled,
/// * [`SequentialPool`] otherwise.
#[cfg(not(feature = "std"))]
pub type DefaultPool = SequentialPool;

/// Default runner used by orx-parallel computations, using the [`DefaultPool`]:
///
/// * [`RunnerWithPool`] with [`StdDefaultPool`] when "std" feature is enabled,
/// * [`RunnerWithPool`] with [`SequentialPool`] otherwise.
pub type DefaultRunner = RunnerWithPool<DefaultPool>;