Merge pull request #473 from TheHippo/reusable-slices

`ToArray` with pre-allocated slices: `ToExistingArray`

Author: lemire

roaring.go

@@ -421,18 +421,30 @@ func FromBitSet(bitset *bitset.BitSet) *Bitmap {
 // ToArray creates a new slice containing all of the integers stored in the Bitmap in sorted order
 func (rb *Bitmap) ToArray() []uint32 {
 	array := make([]uint32, rb.GetCardinality())
+	ar := rb.toArray(&array)
+	return *ar
+}
+
+func (rb *Bitmap) toArray(array *[]uint32) *[]uint32 {
 	pos := 0
 	pos2 := 0
 
 	for pos < rb.highlowcontainer.size() {
 		hs := uint32(rb.highlowcontainer.getKeyAtIndex(pos)) << 16
 		c := rb.highlowcontainer.getContainerAtIndex(pos)
 		pos++
-		pos2 = c.fillLeastSignificant16bits(array, pos2, hs)
+		pos2 = c.fillLeastSignificant16bits(*array, pos2, hs)
 	}
 	return array
 }
 
+// ToExistingArray stores all of the integers stored in the Bitmap in sorted order in the
+// slice that is given to ToExistingArray. It is the callers duty to make sure the slice
+// has the right size.
+func (rb *Bitmap) ToExistingArray(array *[]uint32) *[]uint32 {
+	return rb.toArray(array)
+}
+
 // GetSizeInBytes estimates the memory usage of the Bitmap. Note that this
 // might differ slightly from the amount of bytes required for persistent storage
 func (rb *Bitmap) GetSizeInBytes() uint64 {

roaring_test.go

@@ -1827,6 +1827,20 @@ func TestBitmap(t *testing.T) {
 
 		assert.True(t, valide)
 	})
+
+	t.Run("ToExistingArray-Test", func(t *testing.T) {
+		values := make([]uint32, 0, 110)
+		rb := NewBitmap()
+
+		for i := 10; i < 120; i++ {
+			values = append(values, uint32(i))
+		}
+		rb.AddMany(values)
+		assert.Equal(t, values, rb.ToArray())
+		existing := make([]uint32, len(values))
+		buf := rb.ToExistingArray(&existing)
+		assert.Equal(t, values, *buf)
+	})
 }
 
 func TestXORtest4(t *testing.T) {