README
¶
⚡ BitSet ⚡
This is a simple, though very fast, bitset implementation in Go derived from the yourbasic/bit package.
Installation
go get github.com/KernelPryanic/bitset
Usage
Creating BitSets
// Create an empty bitset
empty := bitset.New()
// Create a bitset with initial values
set := bitset.New(1, 3, 5, 7)
Basic Operations
// Add elements
set.Add(9) // Add single element
set.AddRange(2, 5) // Add range [2,3,4]
// Check membership
exists := set.Contains(3) // true
absent := set.Contains(6) // false
// Remove elements
set.Delete(3) // Remove single element
set.DeleteRange(2, 5) // Remove range [2,3,4]
// Get set information
size := set.Size() // Number of elements
isEmpty := set.Empty() // Check if set is empty
max := set.Max() // Get maximum element
// Iterate through elements
set.Visit(func(n int) bool {
fmt.Printf("%d ", n)
return false // Return true to stop iteration
})
Set Operations
set1 := bitset.New(1, 2, 3, 4, 5)
set2 := bitset.New(4, 5, 6, 7, 8)
// Create new sets from operations
intersection := bitset.And(set1, set2) // Elements in both sets
union := bitset.Or(set1, set2) // Elements in either set
symDiff := bitset.Xor(set1, set2) // Elements in one set but not both
diff := bitset.AndNot(set1, set2) // Elements in set1 but not in set2
// Modify existing sets
set1.And(set2) // Keep only elements present in both sets
set1.Or(set2) // Add all elements from set2
set1.Xor(set2) // Keep elements present in one set but not both
set1.AndNot(set2) // Remove all elements present in set2
Navigation
set := bitset.New(1, 3, 5, 7, 9)
// Find next/previous elements
next := set.Next(4) // Returns 5 (next element after 4)
prev := set.Prev(6) // Returns 5 (previous element before 6)
// Copy sets
copy := set.Copy() // Create a new copy
set2 := bitset.New()
set2.Set(set) // Replace contents of set2 with set
String Representation
set := bitset.New(1, 2, 3, 5, 7, 8, 9, 10)
fmt.Println(set) // Outputs: {1..3 5 7..10}
Documentation
¶
Index ¶
- type BitSet
- func (bs *BitSet) Add(n int)
- func (bs *BitSet) AddRange(m, n int)
- func (bs *BitSet) And(other BitSet)
- func (bs *BitSet) AndNot(other BitSet)
- func (bs BitSet) Contains(n int) bool
- func (bs BitSet) Copy() BitSet
- func (bs *BitSet) Delete(n int)
- func (bs *BitSet) DeleteRange(m, n int)
- func (bs BitSet) Empty() bool
- func (bs BitSet) Equal(other BitSet) bool
- func (bs BitSet) Max() int
- func (bs BitSet) Next(m int) int
- func (bs *BitSet) Or(other BitSet)
- func (bs BitSet) Prev(m int) int
- func (bs *BitSet) Reset()
- func (bs *BitSet) Set(other BitSet)
- func (bs BitSet) Size() int
- func (bs BitSet) String() string
- func (bs BitSet) Subset(other BitSet) bool
- func (bs BitSet) Visit(do func(n int) bool) (aborted bool)
- func (bs BitSet) VisitAll(do func(n int))
- func (bs *BitSet) Xor(other BitSet)
- type Word
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BitSet ¶
type BitSet []uint64
BitSet is a set of non-negative integers represented as a slice of uint64 words, where each bit i in word w corresponds to the integer 64*n + i. The words are kept in ascending order, and the set is trimmed to remove trailing zero words.
func New ¶
New creates a new set with the given non-negative elements. If all n are negative, an empty set is created. The elements are stored in ascending order. The zero value of BitSet is an empty set.
func (*BitSet) DeleteRange ¶
DeleteRange removes all integers from m to n-1 (no-op if m>=n).
func (BitSet) Max ¶
Max returns the maximum element of the bitset. If the set is empty, -1 is returned.
func (BitSet) Next ¶
Next returns the next element n, n > m, in the set, or -1 if there is no such element.
func (BitSet) Prev ¶
Prev returns the previous element n, n < m, in the set, or -1 if there is no such element.
func (BitSet) String ¶
String returns a string representation of the set. The elements are listed in ascending order.
Example: {0 2 4..7 9 11 13 15}
func (BitSet) Visit ¶
Visit calls the do function for each element of s in numerical order. If do returns true, Visit returns immediately, skipping any remaining elements, and returns true. It is safe for do to add or delete elements e, e ≤ n. The behavior of Visit is undefined if do changes the set in any other way.
Source Files