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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
use alloc::vec::{self, Vec};
use core::iter::{self, FromIterator};
use core::slice;
use super::container::Container;
use crate::{NonSortedIntegers, RoaringBitmap};
/// An iterator for `RoaringBitmap`.
pub struct Iter<'a> {
inner: iter::Flatten<slice::Iter<'a, Container>>,
size_hint: u64,
}
/// An iterator for `RoaringBitmap`.
pub struct IntoIter {
inner: iter::Flatten<vec::IntoIter<Container>>,
size_hint: u64,
}
impl Iter<'_> {
fn new(containers: &[Container]) -> Iter {
let size_hint = containers.iter().map(|c| c.len()).sum();
Iter { inner: containers.iter().flatten(), size_hint }
}
}
impl IntoIter {
fn new(containers: Vec<Container>) -> IntoIter {
let size_hint = containers.iter().map(|c| c.len()).sum();
IntoIter { inner: containers.into_iter().flatten(), size_hint }
}
}
impl Iterator for Iter<'_> {
type Item = u32;
fn next(&mut self) -> Option<u32> {
self.size_hint = self.size_hint.saturating_sub(1);
self.inner.next()
}
fn size_hint(&self) -> (usize, Option<usize>) {
if self.size_hint < usize::MAX as u64 {
(self.size_hint as usize, Some(self.size_hint as usize))
} else {
(usize::MAX, None)
}
}
}
impl DoubleEndedIterator for Iter<'_> {
fn next_back(&mut self) -> Option<Self::Item> {
self.size_hint = self.size_hint.saturating_sub(1);
self.inner.next_back()
}
}
#[cfg(target_pointer_width = "64")]
impl ExactSizeIterator for Iter<'_> {
fn len(&self) -> usize {
self.size_hint as usize
}
}
impl Iterator for IntoIter {
type Item = u32;
fn next(&mut self) -> Option<u32> {
self.size_hint = self.size_hint.saturating_sub(1);
self.inner.next()
}
fn size_hint(&self) -> (usize, Option<usize>) {
if self.size_hint < usize::MAX as u64 {
(self.size_hint as usize, Some(self.size_hint as usize))
} else {
(usize::MAX, None)
}
}
}
impl DoubleEndedIterator for IntoIter {
fn next_back(&mut self) -> Option<Self::Item> {
self.size_hint = self.size_hint.saturating_sub(1);
self.inner.next_back()
}
}
#[cfg(target_pointer_width = "64")]
impl ExactSizeIterator for IntoIter {
fn len(&self) -> usize {
self.size_hint as usize
}
}
impl RoaringBitmap {
/// Iterator over each value stored in the RoaringBitmap, guarantees values are ordered by value.
///
/// # Examples
///
/// ```rust
/// use roaring::RoaringBitmap;
/// use core::iter::FromIterator;
///
/// let bitmap = (1..3).collect::<RoaringBitmap>();
/// let mut iter = bitmap.iter();
///
/// assert_eq!(iter.next(), Some(1));
/// assert_eq!(iter.next(), Some(2));
/// assert_eq!(iter.next(), None);
/// ```
pub fn iter(&self) -> Iter {
Iter::new(&self.containers)
}
}
impl<'a> IntoIterator for &'a RoaringBitmap {
type Item = u32;
type IntoIter = Iter<'a>;
fn into_iter(self) -> Iter<'a> {
self.iter()
}
}
impl IntoIterator for RoaringBitmap {
type Item = u32;
type IntoIter = IntoIter;
fn into_iter(self) -> IntoIter {
IntoIter::new(self.containers)
}
}
impl<const N: usize> From<[u32; N]> for RoaringBitmap {
fn from(arr: [u32; N]) -> Self {
RoaringBitmap::from_iter(arr)
}
}
impl FromIterator<u32> for RoaringBitmap {
fn from_iter<I: IntoIterator<Item = u32>>(iterator: I) -> RoaringBitmap {
let mut rb = RoaringBitmap::new();
rb.extend(iterator);
rb
}
}
impl<'a> FromIterator<&'a u32> for RoaringBitmap {
fn from_iter<I: IntoIterator<Item = &'a u32>>(iterator: I) -> RoaringBitmap {
let mut rb = RoaringBitmap::new();
rb.extend(iterator);
rb
}
}
impl Extend<u32> for RoaringBitmap {
fn extend<I: IntoIterator<Item = u32>>(&mut self, iterator: I) {
for value in iterator {
self.insert(value);
}
}
}
impl<'a> Extend<&'a u32> for RoaringBitmap {
fn extend<I: IntoIterator<Item = &'a u32>>(&mut self, iterator: I) {
for value in iterator {
self.insert(*value);
}
}
}
impl RoaringBitmap {
/// Create the set from a sorted iterator. Values must be sorted and deduplicated.
///
/// The values of the iterator must be ordered and strictly greater than the greatest value
/// in the set. If a value in the iterator doesn't satisfy this requirement, it is not added
/// and the append operation is stopped.
///
/// Returns `Ok` with the requested `RoaringBitmap`, `Err` with the number of elements
/// that were correctly appended before failure.
///
/// # Example: Create a set from an ordered list of integers.
///
/// ```rust
/// use roaring::RoaringBitmap;
///
/// let mut rb = RoaringBitmap::from_sorted_iter(0..10).unwrap();
///
/// assert!(rb.iter().eq(0..10));
/// ```
///
/// # Example: Try to create a set from a non-ordered list of integers.
///
/// ```rust
/// use roaring::RoaringBitmap;
///
/// let integers = 0..10u32;
/// let error = RoaringBitmap::from_sorted_iter(integers.rev()).unwrap_err();
///
/// assert_eq!(error.valid_until(), 1);
/// ```
pub fn from_sorted_iter<I: IntoIterator<Item = u32>>(
iterator: I,
) -> Result<RoaringBitmap, NonSortedIntegers> {
let mut rb = RoaringBitmap::new();
rb.append(iterator).map(|_| rb)
}
/// Extend the set with a sorted iterator.
///
/// The values of the iterator must be ordered and strictly greater than the greatest value
/// in the set. If a value in the iterator doesn't satisfy this requirement, it is not added
/// and the append operation is stopped.
///
/// Returns `Ok` with the number of elements appended to the set, `Err` with
/// the number of elements we effectively appended before an error occurred.
///
/// # Examples
///
/// ```rust
/// use roaring::RoaringBitmap;
///
/// let mut rb = RoaringBitmap::new();
/// assert_eq!(rb.append(0..10), Ok(10));
///
/// assert!(rb.iter().eq(0..10));
/// ```
pub fn append<I: IntoIterator<Item = u32>>(
&mut self,
iterator: I,
) -> Result<u64, NonSortedIntegers> {
// Name shadowed to prevent accidentally referencing the param
let mut iterator = iterator.into_iter();
let mut prev = match (iterator.next(), self.max()) {
(None, _) => return Ok(0),
(Some(first), Some(max)) if first <= max => {
return Err(NonSortedIntegers { valid_until: 0 })
}
(Some(first), _) => first,
};
// It is now guaranteed that so long as the values of the iterator are
// monotonically increasing they must also be the greatest in the set.
self.push_unchecked(prev);
let mut count = 1;
for value in iterator {
if value <= prev {
return Err(NonSortedIntegers { valid_until: count });
} else {
self.push_unchecked(value);
prev = value;
count += 1;
}
}
Ok(count)
}
}