container/ring provides an efficient queue data structure intended to be used in performance-sensitive contexts with usage patterns that have:
- a similar rate of pushes and pops
- bursts of pushes followed by bursts of pops
As an example, this is a good place to store pending nodes during a breadth-first traversal of a graph. It will allocate only if a node has more direct children than capacity in the queue. For example, given a hypothetical tree structure:
var pending ring.Q[Node]
pending.Push(root)
for !pending.Empty() {
current := pending.Pop()
visit(current)
for _, child := range current.Children {
pending.Push(child)
}
}See API Reference for more details.
I often find myself needing a queue in projects.
In a hurry, I reach for container/list or a slice.
However, they are both allocation-heavy (depending on usage pattern).
This repository largely exists so that there's a known working version of a more efficient queue implementation (for specific usage patterns) that I can use or copy-paste directly where I need. Feel free to use it in the same way if it meets your needs.
This software is made available under the BSD3 license.