o3 0.23.0

shared-nothing primitives
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
100
101
102
103
104
105
106
107

use std::{cell, marker, slice};

use crate::depot::index::{bitmap, bitmap::entry::Row, set};

pub(in crate::depot) struct View<S, Tag, Raw, const N: usize, K = ()> {
    pub(in crate::depot::index::set) source: S,
    tag: Domain<Tag, Raw, K>,
}

impl<S, Tag, Raw, const N: usize, K> View<S, Tag, Raw, N, K> {
    pub(in crate::depot) const fn new(source: S) -> Self {
        Self {
            source,
            tag: marker::PhantomData,
        }
    }
}

impl<S: Copy, Tag, Raw, const N: usize, K> Clone for View<S, Tag, Raw, N, K> {
    fn clone(&self) -> Self {
        *self
    }
}

impl<S: Copy, Tag, Raw, const N: usize, K> Copy for View<S, Tag, Raw, N, K> {}

/// Retains one nonempty packed set, including its cursor header and all planes.
pub(in crate::depot::index::set) struct NonEmpty<'a, Tag, Raw, const N: usize, M> {
    state: &'a set::State<Tag, Raw, N, M>,
}

impl<'a, Tag, Raw, const N: usize, M> NonEmpty<'a, Tag, Raw, N, M> {
    pub(in crate::depot::index::set) fn new(state: &'a set::State<Tag, Raw, N, M>) -> Option<Self> {
        if state.block.extent().shape().bits() == 0 {
            return None;
        }
        Some(Self { state })
    }

    /// Advances the original source plane from its retained bounded row.
    pub(in crate::depot::index::set) fn advance<S, K>(
        row: &'a Row<View<S, Tag, Raw, N, K>, set::Id<N>>,
    ) where
        S: set::Storage<Tag, Raw, N, K, Mode = M>,
    {
        let state = row.source().source.state();
        let next = row.index() + 1;
        Self { state }
            .cursor(row.plane())
            .set(if next == state.block.extent().shape().bits() {
                0
            } else {
                next
            });
    }

    /// The retained nonempty allocation includes all N initialized cursors.
    pub(in crate::depot::index::set) fn cursor(&self, plane: set::Id<N>) -> &'a cell::Cell<usize> {
        // SAFETY: Extent::try_allocate initializes N cursor cells before the
        // planes whenever bits != 0. NonEmpty retains that exact allocation,
        // and Id can only be constructed for an offset strictly below N.
        unsafe { &*self.state.block.as_ptr().add(plane.offset()) }
    }

    fn words(&self, plane: set::Id<N>) -> &'a [bitmap::Word] {
        let shape = self.state.block.extent().shape();
        // SAFETY: this exact nonempty packed allocation contains every bounded plane.
        unsafe {
            slice::from_raw_parts(
                self.state
                    .block
                    .as_ptr()
                    .add(N + plane.offset() * shape.words())
                    .cast(),
                shape.words(),
            )
        }
    }
}

// SAFETY: the retained source owns every initialized plane in one immutable domain.
unsafe impl<S, Tag, Raw, const N: usize, K> crate::depot::raw::Words for View<S, Tag, Raw, N, K>
where
    S: set::Storage<Tag, Raw, N, K>,
{
    type Plane = set::Id<N>;
    type Size = u32;

    fn shape(&self) -> bitmap::Shape {
        self.source.state().block.extent().shape()
    }

    fn words(&self, plane: Self::Plane) -> &[bitmap::Word] {
        let Some(view) = NonEmpty::new(self.source.state()) else {
            return &[];
        };
        view.words(plane)
    }
    fn row(entry: Row<&Self>, plane: Self::Plane) -> &[bitmap::Word] {
        NonEmpty {
            state: entry.source().source.state(),
        }
        .words(plane)
    }
}

type Domain<Tag, Raw, K> = marker::PhantomData<fn(Tag, Raw, K) -> (Tag, Raw, K)>;