melinoe 0.10.0

Zero-sized, branded, multi-token phantom capabilities for compile-time data-access and thread-synchronization proofs (a generalized evolution of GhostCell) for the Mnemosyne memory ecosystem.
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

//! Shared-slice partition drivers: split a plain `&[T]` into disjoint shared
//! sub-slices and run a closure on each concurrently.
//!
//! The read-only counterpart to [`super::map`]. It shares the same engine
//! ([`driver_core::drive`]); the only difference is the per-index task builds a
//! shared `&[T]` sub-slice instead of a mutable [`WriterShard`].

use std::vec::Vec;

use super::driver_core::drive;
use super::plan::PartitionPlan;
use crate::region::partition_count;

/// Split `slice` into `parts` disjoint shared shards and run `f` on each concurrently,
/// returning the per-shard results in partition order.
pub fn partition_read_map<T, R, F>(slice: &[T], parts: usize, f: F) -> Vec<R>
where
    T: Sync,
    R: Send,
    F: Fn(usize, &[T]) -> R + Sync,
{
    partition_read_map_with(slice, PartitionPlan::parts(parts), f)
}

/// Split `slice` according to `plan` and run `f` on each disjoint shared shard
/// concurrently, returning per-shard results in partition order.
///
/// If a custom parallel executor is registered, it will be used instead of
/// spawning raw OS threads.
#[inline]
pub fn partition_read_map_with<T, R, F>(slice: &[T], plan: PartitionPlan, f: F) -> Vec<R>
where
    T: Sync,
    R: Send,
    F: Fn(usize, &[T]) -> R + Sync,
{
    let chunk = plan.resolve(slice.len());
    let chunk_size = chunk.max(1);
    let slice_len = slice.len();
    let num_chunks = partition_count(slice_len, chunk_size);
    if num_chunks == 0 {
        return Vec::new();
    }

    drive(num_chunks, |index| {
        let start = index * chunk_size;
        let end = (start + chunk_size).min(slice_len);
        // `drive` runs each `index` in `0..num_chunks` at most once, and
        // `num_chunks = ceil(slice_len / chunk_size)`, so `start < slice_len` and
        // the ranges tile `0..slice_len` disjointly. A shared `&[T]` sub-slice
        // needs no unsafe: ordinary slicing yields the disjoint view directly.
        f(start, &slice[start..end])
    })
}

/// Split `slice` using the process's reported hardware parallelism and run `f`
/// on each disjoint shared shard concurrently, returning the per-shard results.
#[inline]
pub fn partition_read_map_available<T, R, F>(slice: &[T], f: F) -> Vec<R>
where
    T: Sync,
    R: Send,
    F: Fn(usize, &[T]) -> R + Sync,
{
    partition_read_map_with(slice, PartitionPlan::available_parallelism(), f)
}

/// Split `slice` into `parts` disjoint shared shards and run `f` on each concurrently,
/// discarding results.
#[inline]
pub fn partition_read_for_each<T, F>(slice: &[T], parts: usize, f: F)
where
    T: Sync,
    F: Fn(usize, &[T]) + Sync,
{
    partition_read_map(slice, parts, f);
}

/// Split `slice` according to `plan` and run `f` on each disjoint shared shard
/// concurrently, discarding results.
#[inline]
pub fn partition_read_for_each_with<T, F>(slice: &[T], plan: PartitionPlan, f: F)
where
    T: Sync,
    F: Fn(usize, &[T]) + Sync,
{
    partition_read_map_with(slice, plan, f);
}

/// Split `slice` using the process's reported hardware parallelism and run `f`
/// on each disjoint shared shard concurrently, discarding results.
#[inline]
pub fn partition_read_for_each_available<T, F>(slice: &[T], f: F)
where
    T: Sync,
    F: Fn(usize, &[T]) + Sync,
{
    partition_read_map_available(slice, f);
}