From cc750a01e64173cf2427504a3039ff31acb90b33 Mon Sep 17 00:00:00 2001
From: Daniel Lemire <daniel@lemire.me>
Date: Mon, 16 Dec 2024 16:52:58 -0500
Subject: [PATCH] added comments

---
 bitset.go | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/bitset.go b/bitset.go
index 291d0cd..23958ef 100644
--- a/bitset.go
+++ b/bitset.go
@@ -525,8 +525,11 @@ func (b *BitSet) DeleteAt(i uint) *BitSet {
 //
 // See also [BitSet.AsSlice] and [BitSet.NextSetMany].
 func (b *BitSet) AppendTo(buf []uint) []uint {
+	// In theory, we could overflow uint, but in practice, we will not.
 	for idx, word := range b.set {
 		for word != 0 {
+			// In theory idx<<log2WordSize could overflow, but it will not overflow
+			// in practice.
 			buf = append(buf, uint(idx<<log2WordSize+bits.TrailingZeros64(word)))
 
 			// clear the rightmost set bit
@@ -548,6 +551,8 @@ func (b *BitSet) AsSlice(buf []uint) []uint {
 	for idx, word := range b.set {
 		for ; word != 0; size++ {
 			// panics if capacity of buf is exceeded.
+			// In theory idx<<log2WordSize could overflow, but it will not overflow
+			// in practice.
 			buf[size] = uint(idx<<log2WordSize + bits.TrailingZeros64(word))
 
 			// clear the rightmost set bit
@@ -615,6 +620,7 @@ func (b *BitSet) NextSet(i uint) (uint, bool) {
 // However if Count() is large, it might be preferable to
 // use several calls to NextSetMany for memory reasons.
 func (b *BitSet) NextSetMany(i uint, buffer []uint) (uint, []uint) {
+	// In theory, we could overflow uint, but in practice, we will not.
 	capacity := cap(buffer)
 	result := buffer[:capacity]