README
¶
Package cloudeng.io/algo/container/bitmap
import cloudeng.io/algo/container/bitmap
Types
Type Contiguous
type Contiguous struct {
// contains filtered or unexported fields
}
Contiguous supports following the tail of contiguous sub-range of a bitmap as it is updated. Clients use the Notify method to obtain a channel that is closed whenever the tail of the the tracked contiguous sub-range is extended. Contiguous is not thread-safe and callers must ensure appropriate synchronization when using it concurrently.
Functions
func NewContiguous(start, size int) *Contiguous
NewContiguous creates an instance of Contiguous of the given size with the tracked ranged starting at the given 'start' index.
func NewContiguousWithBitmap(bm T, start, size int) *Contiguous
NewContiguousWithBitmap is like NewContiguous, but is initialized with the supplied bitmap. The bitmap is not copied. Updates must be made to the bitmap using the Set method of the Contiguous type.
Methods
func (c *Contiguous) Notify() <-chan struct{}
Notify can be used to notify the caller of an extension in the contiguous sub-range of the bitmap. It returns a channel that will be closed whenever the tail of the contiguous sub-range is extended. Closing a channel is used as the notification mechanism (rather than sending updates on the channel) because it allows for multiple listeners and avoids the need for any synchronization between the contiguous bitmap implementation and the listeners. Expected usage is of the form:
ch := cb.Notify()
<-ch
end := cb.Tail()
Note that if the range has already reached the end of the bitmap, the returned channel will have already been closed.
func (c *Contiguous) Set(i int)
Set sets the bit at index i in the bitmap to 1. If i is out of bounds, the function does nothing.
func (c *Contiguous) Tail() int
Tail returns the last index in the contiguous subrange that has been set, or -1 if no bits have been set. The value of the returned value will be that of the last index in the bitmap if entire range has been set.
Type T
type T []uint64
T is a bitmap type that represents a set of bits using a slice of uint64.
Functions
func New(size int) T
New creates a new bitmap of the specified size in bits. The size must be greater than zero. The bitmap is represented as a slice of uint64. The caller must keep track of size if it cares that the size of the bitmap is rounded up to the nearest multiple of 64 bits.
Methods
func (b T) AllClear(start, size int) iter.Seq[int]
AllClear returns an iterator over all clear bits in the bitmap starting from the specified index and never exceeding the specified size or size of the bitmap itself.
func (b T) AllSet(start, size int) iter.Seq[int]
AllSet returns an iterator over all set bits in the bitmap starting from the specified index and never exceeding the specified size or size of the bitmap itself.
func (b T) Clear(i int)
Clear clears the bit at index i in the bitmap, setting it to 0. If i is out of bounds, the function does nothing.
func (b T) ClearUnsafe(i int)
ClearUnsafe clears the bit at index i in the bitmap without bounds checking.
func (b T) IsSet(i int) bool
IsSet checks if the bit at index i in the bitmap is set (1). If i is out of bounds, it returns false.
func (b T) IsSetUnsafe(i int) bool
IsSetUnsafe checks if the bit at index i in the bitmap is set (1) without bounds checking.
func (b T) MarshalJSON() ([]byte, error)
func (b T) NextClear(start, size int) int
NextClear returns the index of the next clear bit in the bitmap starting from the specified index and never exceeding the specified size or size of the bitmap itself.
func (b T) NextSet(start, size int) int
NextSet returns the index of the next set bit in the bitmap starting from the specified index and never exceeding the specified size or size of the bitmap itself.
func (b T) Set(i int)
Set sets the bit at index i in the bitmap to 1. If i is out of bounds, the function does nothing.
func (b T) SetUnsafe(i int)
SetUnsafe sets the bit at index i in the bitmap to 1 without bounds checking.
func (b *T) UnmarshalJSON(data []byte) error
Documentation
¶
Index ¶
- type Contiguous
- type T
- func (b T) AllClear(start, size int) iter.Seq[int]
- func (b T) AllSet(start, size int) iter.Seq[int]
- func (b T) Clear(i int)
- func (b T) ClearUnsafe(i int)
- func (b T) IsSet(i int) bool
- func (b T) IsSetUnsafe(i int) bool
- func (b T) MarshalJSON() ([]byte, error)
- func (b T) NextClear(start, size int) int
- func (b T) NextSet(start, size int) int
- func (b T) Set(i int)
- func (b T) SetUnsafe(i int)
- func (b *T) UnmarshalJSON(data []byte) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Contiguous ¶
type Contiguous struct {
// contains filtered or unexported fields
}
Contiguous supports following the tail of contiguous sub-range of a bitmap as it is updated. Clients use the Notify method to obtain a channel that is closed whenever the tail of the the tracked contiguous sub-range is extended. Contiguous is not thread-safe and callers must ensure appropriate synchronization when using it concurrently.
func NewContiguous ¶
func NewContiguous(start, size int) *Contiguous
NewContiguous creates an instance of Contiguous of the given size with the tracked ranged starting at the given 'start' index.
func NewContiguousWithBitmap ¶
func NewContiguousWithBitmap(bm T, start, size int) *Contiguous
NewContiguousWithBitmap is like NewContiguous, but is initialized with the supplied bitmap. The bitmap is not copied. Updates must be made to the bitmap using the Set method of the Contiguous type.
func (*Contiguous) Notify ¶
func (c *Contiguous) Notify() <-chan struct{}
Notify can be used to notify the caller of an extension in the contiguous sub-range of the bitmap. It returns a channel that will be closed whenever the tail of the contiguous sub-range is extended. Closing a channel is used as the notification mechanism (rather than sending updates on the channel) because it allows for multiple listeners and avoids the need for any synchronization between the contiguous bitmap implementation and the listeners. Expected usage is of the form:
ch := cb.Notify() <-ch end := cb.Tail()
Note that if the range has already reached the end of the bitmap, the returned channel will have already been closed.
func (*Contiguous) Set ¶
func (c *Contiguous) Set(i int)
Set sets the bit at index i in the bitmap to 1. If i is out of bounds, the function does nothing.
func (*Contiguous) Tail ¶
func (c *Contiguous) Tail() int
Tail returns the last index in the contiguous subrange that has been set, or -1 if no bits have been set. The value of the returned value will be that of the last index in the bitmap if entire range has been set.
type T ¶
type T []uint64
T is a bitmap type that represents a set of bits using a slice of uint64.
func New ¶
New creates a new bitmap of the specified size in bits. The size must be greater than zero. The bitmap is represented as a slice of uint64. The caller must keep track of size if it cares that the size of the bitmap is rounded up to the nearest multiple of 64 bits.
func (T) AllClear ¶
AllClear returns an iterator over all clear bits in the bitmap starting from the specified index and never exceeding the specified size or size of the bitmap itself.
func (T) AllSet ¶
AllSet returns an iterator over all set bits in the bitmap starting from the specified index and never exceeding the specified size or size of the bitmap itself.
func (T) Clear ¶
Clear clears the bit at index i in the bitmap, setting it to 0. If i is out of bounds, the function does nothing.
func (T) ClearUnsafe ¶
ClearUnsafe clears the bit at index i in the bitmap without bounds checking.
func (T) IsSet ¶
IsSet checks if the bit at index i in the bitmap is set (1). If i is out of bounds, it returns false.
func (T) IsSetUnsafe ¶
IsSetUnsafe checks if the bit at index i in the bitmap is set (1) without bounds checking.
func (T) MarshalJSON ¶
func (T) NextClear ¶
NextClear returns the index of the next clear bit in the bitmap starting from the specified index and never exceeding the specified size or size of the bitmap itself.
func (T) NextSet ¶
NextSet returns the index of the next set bit in the bitmap starting from the specified index and never exceeding the specified size or size of the bitmap itself.
func (T) Set ¶
Set sets the bit at index i in the bitmap to 1. If i is out of bounds, the function does nothing.
Source Files