Add method remove_range

Author: Ezibenroc

pyroaring/bitmap.pxi

@@ -128,3 +128,14 @@ cdef class BitMap(AbstractBitMap):
         BitMap([3, 10, 11, 13, 14])
         """
         croaring.roaring_bitmap_flip_inplace(self._c_bitmap, start, end)
+
+    def remove_range(self, uint64_t range_start, uint64_t range_end):
+        """
+        Remove a range of values from range_start (included) to range_end (excluded).
+
+        >>> bm = BitMap([5, 6, 7, 8, 9, 10])
+        >>> bm.remove_range(6, 9)
+        >>> bm
+        BitMap([5, 9, 10])
+        """
+        croaring.roaring_bitmap_remove_range(self._c_bitmap, range_start, range_end)

pyroaring/croaring.pxd

@@ -40,6 +40,7 @@ cdef extern from "roaring.h":
     void roaring_bitmap_add_many(roaring_bitmap_t *r, size_t n_args, const uint32_t *vals)
     void roaring_bitmap_add_range(roaring_bitmap_t *ra, uint64_t min, uint64_t max);
     void roaring_bitmap_remove(roaring_bitmap_t *r, uint32_t x)
+    inline void roaring_bitmap_remove_range(roaring_bitmap_t *ra, uint64_t min, uint64_t max)
     bool roaring_bitmap_remove_checked(roaring_bitmap_t *r, uint32_t x)
     bool roaring_bitmap_contains(const roaring_bitmap_t *r, uint32_t val)
     bool roaring_bitmap_contains_range(const roaring_bitmap_t *r, uint64_t range_start, uint64_t range_end)

test.py

@@ -395,6 +395,8 @@ def test_intersect(self, cls1, cls2, values1, values2, cow):
         bm2 = cls2(values2, copy_on_write=cow)
         self.assertEqual(bm1.intersect(bm2), len(bm1 & bm2) > 0)
 
+
+class RangeTest(Util):
     @given(bitmap_cls, hyp_collection, st.booleans(), uint32, uint32)
     def test_contains_range_arbitrary(self, cls, values, cow, start, end):
         bm = cls(values)
@@ -422,6 +424,32 @@ def test_contains_range(self, cls, cow, start, end):
         self.assertTrue(bm.contains_range(start, middle))
         self.assertTrue(bm.contains_range(middle+1, end))
 
+    @given(hyp_collection, st.booleans(), uint32, uint32)
+    def test_add_remove_range(self, values, cow, start, end):
+        st.assume(start < end)
+        bm = BitMap(values, copy_on_write=cow)
+        # Empty range
+        original = BitMap(bm)
+        bm.update(range(end, start))
+        self.assertEqual(bm, original)
+        bm.remove_range(end, start)
+        self.assertEqual(bm, original)
+        # Adding the range
+        bm.update(range(start, end))
+        self.assertTrue(bm.contains_range(start, end))
+        self.assertEqual(bm.intersection_cardinality(BitMap(range(start, end), copy_on_write=cow)),
+                         len(range(start, end)))
+        # Empty range (again)
+        original = BitMap(bm)
+        bm.remove_range(end, start)
+        self.assertEqual(bm, original)
+        self.assertEqual(bm.intersection_cardinality(BitMap(range(start, end), copy_on_write=cow)),
+                         len(range(start, end)))
+        # Removing the range
+        bm.remove_range(start, end)
+        self.assertFalse(bm.contains_range(start, end))
+        self.assertEqual(bm.intersection_cardinality(BitMap(range(start, end), copy_on_write=cow)), 0)
+
 
 class CardinalityTest(Util):