Doc comments for each functions

btree/btree.go

@@ -168,6 +168,7 @@ func (t *Tree[K, V]) split(h *node[K, V]) *node[K, V] {
 	return n
 }
 
+// Each calls 'fn' on every node in the tree in order.
 func (t *Tree[K, V]) Each(fn func(key K, val V)) {
 	t.each(t.root, t.height, fn)
 }

cache/cache.go

@@ -112,8 +112,8 @@ func (t *Cache[K, V]) Capacity() int {
 	return t.capacity
 }
 
-// Iter returns an iterator over all key-value pairs in the cache. It iterates
-// in order of most recently used to least recently used.
+// Each calls 'fn' on every value in the cache, from most recently used to
+// least recently used.
 func (t *Cache[K, V]) Each(fn func(key K, val V)) {
 	t.lru.Front.Each(func(kv KV[K, V]) {
 		fn(kv.Key, kv.Val)

hashmap/map.go

@@ -172,7 +172,8 @@ func (m *Map[K, V]) Copy() *Map[K, V] {
 	}
 }
 
-// Iter returns an iterator over all key-value pairs in the map.
+// Each calls 'fn' on every key-value pair in the hashmap in no particular
+// order.
 func (m *Map[K, V]) Each(fn func(key K, val V)) {
 	for _, ent := range m.entries {
 		if ent.filled {

hashset/set.go

@@ -39,6 +39,7 @@ func (s *Set[K]) Size() int {
 	return s.m.Size()
 }
 
+// Each calls 'fn' on every item in the set in no particular order.
 func (s *Set[K]) Each(fn func(key K)) {
 	s.m.Each(func(key K, v struct{}) {
 		fn(key)

interval/itree.go

@@ -72,6 +72,8 @@ func (t *Tree[V]) Get(pos int) (V, bool) {
 	return n.value, true
 }
 
+// Each calls 'fn' on every element in the tree, and its corresponding
+// interval, in order sorted by starting position.
 func (t *Tree[V]) Each(fn func(low, high int, val V)) {
 	t.root.each(fn)
 }

list/list.go

@@ -71,6 +71,7 @@ func (l *List[V]) Remove(n *Node[V]) {
 	}
 }
 
+// Each calls 'fn' on every element from this node onward in the list.
 func (n *Node[V]) Each(fn func(val V)) {
 	node := n
 	for node != nil {
@@ -79,6 +80,7 @@ func (n *Node[V]) Each(fn func(val V)) {
 	}
 }
 
+// EachReverse calls 'fn' on every element from this node backward in the list.
 func (n *Node[V]) EachReverse(fn func(val V)) {
 	node := n
 	for node != nil {

queue/queue.go

@@ -46,6 +46,8 @@ func (q *Queue[T]) Empty() bool {
 	return q.list.Front == nil
 }
 
+// Each calls 'fn' on every item in the queue, starting with the least
+// recently pushed element.
 func (q *Queue[T]) Each(fn func(t T)) {
 	q.list.Front.Each(fn)
 }