package
10.0.1
Repository: https://github.com/apache/arrow.git
Documentation: pkg.go.dev

# Functions

GenerateBits writes sequential bits to a bitmap.
GenerateBitsUnrolled is like GenerateBits but unrolls its main loop for higher performance.
IsMultipleOf64 returns whether v is a multiple of 64.
LeastSignificantBitMask returns a bit mask to return the least significant bits for a value starting from the bit index passed in.
NewBinaryBitBlockCounter constructs a binary bit block counter for computing the popcounts on the results of operations between the passed in bitmaps, with their respective offsets.
NewBitBlockCounter returns a BitBlockCounter for the passed bitmap starting at startOffset of length nbits.
NewBitRunReader returns a reader for the given bitmap, offset and length that grabs runs of the same value bit at a time for easy iteration.
NewOptionalBitBlockCounter constructs and returns a new bit block counter that can properly handle the case when a bitmap is null, if it is guaranteed that the the bitmap is not nil, then prefer NewBitBlockCounter here.
NewReverseSetBitRunReader returns a SetBitRunReader like NewSetBitRunReader, except it will return runs starting from the end of the bitmap until it reaches startOffset rather than starting at startOffset and reading from there.
NewSetBitRunReader returns a SetBitRunReader for the bitmap starting at startOffset which will read numvalues bits.
VisitBitBlocks is a utility for easily iterating through the blocks of bits in a bitmap, calling the appropriate visitValid/visitInvalid function as we iterate through the bits.
VisitBitBlocks is a utility for easily iterating through the blocks of bits in a bitmap, calling the appropriate visitValid/visitInvalid function as we iterate through the bits.
VisitSetBitRuns is just a convenience function for calling NewSetBitRunReader and then VisitSetBitRuns.

# Structs

BinaryBitBlockCounter computes popcounts on the result of bitwise operations between two bitmaps, 64 bits at a time.
BitBlockCount is returned by the various bit block counter utilities in order to return a length of bits and the population count of that slice of bits.
BitBlockCounter is a utility for grabbing chunks of a bitmap at a time and efficiently counting the number of bits which are 1.
BitRun represents a run of bits with the same value of length Len with Set representing if the group of bits were 1 or 0.
OptionalBitBlockCounter is a useful counter to iterate through a possibly non-existent validity bitmap to allow us to write one code path for both the with-nulls and no-nulls cases without giving up a lot of performance.
SetBitRun describes a run of contiguous set bits in a bitmap with Pos being the starting position of the run and Length being the number of bits.

# Interfaces

BitRunReader is an interface that is usable by multiple callers to provide multiple types of bit run readers such as a reverse reader and so on.
SetBitRunReader is an interface for reading groups of contiguous set bits from a bitmap.

# Type aliases

VisitFn is a callback function for visiting runs of contiguous bits.