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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
use std::ops::{BitOr, BitOrAssign};

const STORAGE_MASK_ARITY: usize = u16::BITS as usize;
const GROUP_MASK_ARITY: usize = u32::BITS as usize;

#[inline]
#[must_use]
fn first_n_bits_u16(n: usize) -> u16 {
    u16::MAX >> (u16::BITS - n as u32)
}

#[inline]
#[must_use]
fn first_n_bits_u32(n: usize) -> u32 {
    u32::MAX >> (u32::BITS - n as u32)
}

#[derive(Clone, Copy, PartialEq, Eq, Default, Debug)]
pub(crate) struct FamilyMask(u32);

impl FamilyMask {
    pub const NONE: Self = Self(0);

    #[inline]
    pub fn from_family_index(index: usize) -> Self {
        assert!(index < GROUP_MASK_ARITY);
        Self(1 << index)
    }

    #[inline]
    pub fn iter_bit_indexes(self) -> BitIndexIter {
        BitIndexIter::from(self.0)
    }
}

impl From<u32> for FamilyMask {
    #[inline]
    fn from(mask: u32) -> Self {
        Self(mask)
    }
}

impl BitOr for FamilyMask {
    type Output = Self;

    #[inline]
    fn bitor(self, rhs: Self) -> Self::Output {
        Self(self.0 | rhs.0)
    }
}

impl BitOrAssign for FamilyMask {
    #[inline]
    fn bitor_assign(&mut self, rhs: Self) {
        self.0 |= rhs.0
    }
}

#[derive(Clone, Copy, PartialEq, Eq, Default, Debug)]
pub(crate) struct GroupMask(u32);

impl GroupMask {
    pub const NONE: Self = Self(0);
    pub const ALL: Self = Self(u32::MAX);

    pub fn new(group_index: usize, group_arity: usize, family_arity: usize) -> Self {
        assert!(group_index < GROUP_MASK_ARITY);
        assert!(group_arity < GROUP_MASK_ARITY);
        assert!(family_arity < GROUP_MASK_ARITY);
        assert!(group_arity <= family_arity);

        Self(first_n_bits_u32(family_arity - group_arity + 1) << group_index)
    }

    #[inline]
    #[must_use]
    pub fn get(&self) -> u32 {
        self.0
    }
}

impl BitOr for GroupMask {
    type Output = Self;

    #[inline]
    fn bitor(self, rhs: Self) -> Self::Output {
        Self(self.0 | rhs.0)
    }
}

impl BitOrAssign for GroupMask {
    #[inline]
    fn bitor_assign(&mut self, rhs: Self) {
        self.0 |= rhs.0
    }
}

#[derive(Clone, Copy, PartialEq, Eq, Default, Debug)]
pub(crate) struct StorageMask(u16);

impl StorageMask {
    pub const NONE: Self = Self(0);

    #[inline]
    pub fn from_storage_index(index: usize) -> Self {
        assert!(index < STORAGE_MASK_ARITY);
        Self(1 << index)
    }
}

impl From<u16> for StorageMask {
    #[inline]
    fn from(mask: u16) -> Self {
        Self(mask)
    }
}

impl BitOr for StorageMask {
    type Output = Self;

    #[inline]
    fn bitor(self, rhs: Self) -> Self::Output {
        Self(self.0 | rhs.0)
    }
}

impl BitOrAssign for StorageMask {
    #[inline]
    fn bitor_assign(&mut self, rhs: Self) {
        self.0 |= rhs.0
    }
}

#[derive(Clone, Copy, PartialEq, Eq, Default, Debug)]
pub(crate) struct QueryMask {
    include: StorageMask,
    exclude: StorageMask,
}

impl QueryMask {
    pub const NONE: Self = Self {
        include: StorageMask(0),
        exclude: StorageMask(0),
    };

    #[inline]
    pub const fn new(include: StorageMask, exclude: StorageMask) -> Self {
        Self { include, exclude }
    }

    pub fn for_include_group(group_arity: usize) -> Self {
        assert!(group_arity <= STORAGE_MASK_ARITY);

        Self {
            include: StorageMask(first_n_bits_u16(group_arity)),
            exclude: StorageMask::NONE,
        }
    }

    pub fn for_exclude_group(prev_group_arity: usize, group_arity: usize) -> Self {
        assert!(prev_group_arity <= STORAGE_MASK_ARITY);
        assert!(group_arity <= STORAGE_MASK_ARITY);
        assert!(prev_group_arity < group_arity);

        if prev_group_arity == 0 {
            return Self::NONE;
        }

        let exclude_count = group_arity - prev_group_arity;

        Self {
            include: StorageMask(first_n_bits_u16(prev_group_arity)),
            exclude: StorageMask(first_n_bits_u16(exclude_count) << prev_group_arity),
        }
    }
}

#[derive(Clone, Debug)]
pub(crate) struct BitIndexIter {
    value: u32,
}

impl Iterator for BitIndexIter {
    type Item = usize;

    #[inline]
    fn next(&mut self) -> Option<Self::Item> {
        if self.value == 0 {
            return None;
        }

        let trailing_zeros = self.value.trailing_zeros();
        self.value &= !(1 << trailing_zeros);
        Some(trailing_zeros as usize)
    }
}

impl From<u32> for BitIndexIter {
    #[inline]
    fn from(value: u32) -> Self {
        Self { value }
    }
}