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
use std::iter::{FromIterator, IntoIterator};
use std::marker::PhantomData;
use super::Bitmap;
#[derive(Clone)]
pub struct BitmapIterator<'a> {
iterator: ffi::roaring_uint32_iterator_s,
phantom: PhantomData<&'a Bitmap>,
}
unsafe impl Send for BitmapIterator<'_> {}
unsafe impl Sync for BitmapIterator<'_> {}
impl<'a> BitmapIterator<'a> {
fn new(bitmap: &'a Bitmap) -> Self {
let mut iterator = std::mem::MaybeUninit::uninit();
unsafe {
ffi::roaring_init_iterator(&bitmap.bitmap, iterator.as_mut_ptr());
}
BitmapIterator {
iterator: unsafe { iterator.assume_init() },
phantom: PhantomData,
}
}
#[inline]
fn current_value(&self) -> Option<u32> {
if self.has_value() {
Some(self.iterator.current_value)
} else {
None
}
}
#[inline]
fn has_value(&self) -> bool {
self.iterator.has_value
}
#[inline]
fn advance(&mut self) -> bool {
unsafe { ffi::roaring_advance_uint32_iterator(&mut self.iterator) }
}
/// Attempt to read many values from the iterator into `dst`
///
/// Returns the number of items read from the iterator, may be `< dst.len()` iff
/// the iterator is exhausted or `dst.len() > u32::MAX`.
///
/// This can be much more efficient than repeated iteration.
///
/// # Examples
///
/// ```
/// use croaring::Bitmap;
///
/// let mut bitmap: Bitmap = Bitmap::create();
/// bitmap.add_range(0..100);
/// bitmap.add(222);
/// bitmap.add(555);
///
/// let mut buf = [0; 100];
/// let mut iter = bitmap.iter();
/// assert_eq!(iter.next_many(&mut buf), 100);
/// // Get the first 100 items, from the original range added
/// for (i, item) in buf.iter().enumerate() {
/// assert_eq!(*item, i as u32);
/// }
/// // Calls to next_many() can be interleaved with calls to next()
/// assert_eq!(iter.next(), Some(222));
/// assert_eq!(iter.next_many(&mut buf), 1);
/// assert_eq!(buf[0], 555);
///
/// assert_eq!(iter.next(), None);
/// assert_eq!(iter.next_many(&mut buf), 0);
/// ```
///
/// ```
/// use croaring::Bitmap;
///
/// fn print_by_chunks(bitmap: &Bitmap) {
/// let mut buf = [0; 1024];
/// let mut iter = bitmap.iter();
/// loop {
/// let n = iter.next_many(&mut buf);
/// if n == 0 {
/// break;
/// }
/// println!("{:?}", &buf[..n]);
/// }
/// }
///
/// # print_by_chunks(&Bitmap::of(&[1, 2, 8, 20, 1000]));
/// ```
#[inline]
pub fn next_many(&mut self, dst: &mut [u32]) -> usize {
let count: u32 = u32::try_from(dst.len()).unwrap_or(u32::MAX);
let result = unsafe {
ffi::roaring_read_uint32_iterator(&mut self.iterator, dst.as_mut_ptr(), count)
};
debug_assert!(result <= count);
result as usize
}
/// Reset the iterator to the first value `>= val`
///
/// This can move the iterator forwards or backwards.
///
/// # Examples
/// ```
/// use croaring::Bitmap;
///
/// let mut bitmap = Bitmap::of(&[0, 1, 100, 1000, u32::MAX]);
/// let mut iter = bitmap.iter();
/// iter.reset_at_or_after(0);
/// assert_eq!(iter.next(), Some(0));
/// iter.reset_at_or_after(0);
/// assert_eq!(iter.next(), Some(0));
///
/// iter.reset_at_or_after(101);
/// assert_eq!(iter.next(), Some(1000));
/// assert_eq!(iter.next(), Some(u32::MAX));
/// assert_eq!(iter.next(), None);
/// iter.reset_at_or_after(u32::MAX);
/// assert_eq!(iter.next(), Some(u32::MAX));
/// assert_eq!(iter.next(), None);
/// ```
#[inline]
pub fn reset_at_or_after(&mut self, val: u32) {
unsafe { ffi::roaring_move_uint32_iterator_equalorlarger(&mut self.iterator, val) };
}
}
impl<'a> Iterator for BitmapIterator<'a> {
type Item = u32;
fn next(&mut self) -> Option<Self::Item> {
match self.current_value() {
Some(value) => {
self.advance();
Some(value)
}
None => None,
}
}
}
impl Bitmap {
/// Returns an iterator over each value stored in the bitmap.
/// Returned values are ordered in ascending order.
///
/// # Examples
///
/// ```
/// use croaring::Bitmap;
///
/// let mut bitmap = Bitmap::create();
/// bitmap.add(4);
/// bitmap.add(3);
/// bitmap.add(2);
/// let mut iterator = bitmap.iter();
///
/// assert_eq!(iterator.next(), Some(2));
/// assert_eq!(iterator.next(), Some(3));
/// assert_eq!(iterator.next(), Some(4));
/// assert_eq!(iterator.next(), None);
/// ```
pub fn iter(&self) -> BitmapIterator {
BitmapIterator::new(self)
}
}
impl FromIterator<u32> for Bitmap {
/// Convenience method for creating bitmap from iterator.
///
/// # Examples
///
/// ```
/// use croaring::Bitmap;
///
/// let bitmap: Bitmap = (1..3).collect();
///
/// assert!(!bitmap.is_empty());
/// assert!(bitmap.contains(1));
/// assert!(bitmap.contains(2));
/// assert_eq!(bitmap.cardinality(), 2);
/// ```
fn from_iter<I: IntoIterator<Item = u32>>(iter: I) -> Self {
Bitmap::of(&Vec::from_iter(iter))
}
}
impl Extend<u32> for Bitmap {
fn extend<T: IntoIterator<Item = u32>>(&mut self, iter: T) {
for item in iter {
self.add(item);
}
}
}