making unset iterator 'closed'

Author: lemire

iter.go

@@ -28,11 +28,31 @@ func Backward(b *Bitmap) func(func(uint32) bool) {
 	}
 }
 
-// Unset creates an iterator that yields values in the range [min, max] that are NOT contained in the bitmap.
+// UnsetClosed creates an iterator that yields values in the range [min, max] that are NOT contained in the bitmap.
 // The iterator becomes invalid if the bitmap is modified (e.g., with Add or Remove).
-func Unset(b *Bitmap, min, max uint32) func(func(uint32) bool) {
+func UnsetClosed(b *Bitmap, min, max uint32) func(func(uint32) bool) {
 	return func(yield func(uint32) bool) {
-		it := b.UnsetIterator(min, max)
+		it := b.UnsetIteratorClosed(min, max)
+		for it.HasNext() {
+			if !yield(it.Next()) {
+				return
+			}
+		}
+	}
+}
+
+// Unset creates an iterator that yields values in the range [rangeStart, rangeEnd) that are NOT contained in the bitmap.
+// The iterator becomes invalid if the bitmap is modified (e.g., with Add or Remove).
+func Unset(b *Bitmap, rangeStart, rangeEnd uint64) func(func(uint32) bool) {
+	if rangeEnd > MaxUint32+1 {
+		panic("rangeEnd > MaxUint32+1")
+	}
+	if rangeStart > MaxUint32+1 {
+		panic("rangeStart > MaxUint32+1")
+	}
+
+	return func(yield func(uint32) bool) {
+		it := b.UnsetIterator(uint32(rangeStart), uint32(rangeEnd-1))
 		for it.HasNext() {
 			if !yield(it.Next()) {
 				return

iter_test.go

@@ -309,13 +309,13 @@ func TestUnset(t *testing.T) {
 	})
 }
 
-func TestUnsetIteratorPeekable(t *testing.T) {
+func TestUnsetIteratorClosedPeekable(t *testing.T) {
 	t.Run("peek next", func(t *testing.T) {
 		b := New()
 		b.AddInt(5)
 		b.AddInt(8)
 
-		it := b.UnsetIterator(3, 10)
+		it := b.UnsetIteratorClosed(3, 10)
 
 		// First value should be 3
 		assert.True(t, it.HasNext())
@@ -357,7 +357,7 @@ func TestUnsetIteratorPeekable(t *testing.T) {
 		b.AddInt(8)
 		b.AddInt(12)
 
-		it := b.UnsetIterator(1, 15)
+		it := b.UnsetIteratorClosed(1, 15)
 
 		// Skip to values >= 7
 		it.AdvanceIfNeeded(7)
@@ -394,7 +394,7 @@ func TestUnsetIteratorPeekable(t *testing.T) {
 		b := New()
 		b.AddInt(5)
 
-		it := b.UnsetIterator(10, 15)
+		it := b.UnsetIteratorClosed(10, 15)
 
 		// Try to advance to a value before our range start
 		it.AdvanceIfNeeded(5)
@@ -408,7 +408,7 @@ func TestUnsetIteratorPeekable(t *testing.T) {
 		b := New()
 		b.AddInt(5)
 
-		it := b.UnsetIterator(10, 15)
+		it := b.UnsetIteratorClosed(10, 15)
 
 		// Advance beyond our range
 		it.AdvanceIfNeeded(20)
@@ -420,7 +420,7 @@ func TestUnsetIteratorPeekable(t *testing.T) {
 	t.Run("advance if needed on current value", func(t *testing.T) {
 		b := New()
 		b.AddRange(0, 0x10000)
-		iter := b.UnsetIterator(0, 0x10002)
+		iter := b.UnsetIteratorClosed(0, 0x10002)
 		var got []uint32
 		prev := uint32(0)
 		for len(got) < 10 {
@@ -439,7 +439,7 @@ func TestUnsetIteratorPeekable(t *testing.T) {
 		b := New()
 		b.AddInt(5) // Set bit in middle of range
 
-		it := b.UnsetIterator(5, 5) // Range contains only the set bit
+		it := b.UnsetIteratorClosed(5, 5) // Range contains only the set bit
 
 		// Should have no values
 		assert.False(t, it.HasNext())
@@ -454,7 +454,7 @@ func TestUnsetIteratorPeekable(t *testing.T) {
 		b := New()
 		b.Add(4294967294) // Set the value before max
 
-		it := b.UnsetIterator(4294967294, 4294967295)
+		it := b.UnsetIteratorClosed(4294967294, 4294967295)
 
 		// Should have 4294967295 (max uint32) as it's unset
 		assert.True(t, it.HasNext())
@@ -469,7 +469,7 @@ func TestUnsetIteratorPeekable(t *testing.T) {
 		b := New()
 		b.Add(4294967295) // Set max uint32
 
-		it := b.UnsetIterator(4294967294, 4294967295)
+		it := b.UnsetIteratorClosed(4294967294, 4294967295)
 
 		// Should have 4294967294 as it's unset, but not 4294967295
 		assert.True(t, it.HasNext())

roaring.go

@@ -915,14 +915,28 @@ func (rb *Bitmap) ManyIterator() ManyIntIterable {
 	return p
 }
 
-// UnsetIterator creates a new IntPeekable to iterate over values in the range [min, max] that are NOT contained in the bitmap.
+// UnsetIteratorClosed creates a new IntPeekable to iterate over values in the range [min, max] that are NOT contained in the bitmap.
 // The iterator becomes invalid if the bitmap is modified (e.g., with Add or Remove).
-func (rb *Bitmap) UnsetIterator(min, max uint32) IntPeekable {
+func (rb *Bitmap) UnsetIteratorClosed(min, max uint32) IntPeekable {
 	p := new(unsetIterator)
 	p.Initialize(rb, min, max)
 	return p
 }
 
+// UnsetIterator creates a new IntPeekable to iterate over values in the range [rangeStart, rangeEnd) that are NOT contained in the bitmap.
+// The iterator becomes invalid if the bitmap is modified (e.g., with Add or Remove).
+func (rb *Bitmap) UnsetIterator(rangeStart, rangeEnd uint64) IntPeekable {
+	if rangeEnd > MaxUint32+1 {
+		panic("rangeEnd > MaxUint32+1")
+	}
+	if rangeStart > MaxUint32+1 {
+		panic("rangeStart > MaxUint32+1")
+	}
+	p := new(unsetIterator)
+	p.Initialize(rb, uint32(rangeStart), uint32(rangeEnd-1))
+	return p
+}
+
 // Clone creates a copy of the Bitmap
 func (rb *Bitmap) Clone() *Bitmap {
 	ptr := new(Bitmap)