More comments

bowei · Aug 8, 2014 · c82a6ff · c82a6ff
1 parent 36e3a87
commit c82a6ff
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/fastaggregation.go b/fastaggregation.go
@@ -11,6 +11,7 @@ func (p rblist) Swap(i, j int)      { p[i], p[j] = p[j], p[i] }
 func (p rblist) Len() int           { return len(p) }
 func (p rblist) Less(i, j int) bool { return p[i].getSizeInBytes() > p[j].getSizeInBytes() }
 
+// FastAnd computes the intersection between many bitmaps quickly
 func FastAnd(bitmaps ...*RoaringBitmap) *RoaringBitmap {
 	if len(bitmaps) == 0 {
 		return NewRoaringBitmap()
@@ -27,6 +28,7 @@ func FastAnd(bitmaps ...*RoaringBitmap) *RoaringBitmap {
 	}
 	return answer
 }
+// FastOr computes the union between many bitmaps quickly
 func FastOr(bitmaps ...*RoaringBitmap) *RoaringBitmap {
 	if len(bitmaps) == 0 {
 		return NewRoaringBitmap()
@@ -46,6 +48,7 @@ func FastOr(bitmaps ...*RoaringBitmap) *RoaringBitmap {
 	return heap.Pop(&pq).(*Item).value
 }
 
+// FastXor computes the intersection between many bitmaps quickly
 func FastXor(bitmaps ...*RoaringBitmap) *RoaringBitmap {
 	if len(bitmaps) == 0 {
 		return NewRoaringBitmap()

diff --git a/roaring.go b/roaring.go
@@ -10,7 +10,7 @@ import (
 	"strconv"
 )
 
-// Roaring represents a compressed bitmap where you can add integers.
+// RoaringBitmap represents a compressed bitmap where you can add integers.
 type RoaringBitmap struct {
 	highlowcontainer roaringArray
 }