package bitpack

Import Path
	github.com/parquet-go/parquet-go/internal/bitpack (on go.dev)

Dependency Relation
	imports 3 packages, and imported by 3 packages

Involved Source Files

	  d bitpack.go
		Package bitpack implements efficient bit packing and unpacking routines for
		integers of various bit widths.

	    pack.go
	    unpack.go
	    unpack_int32_amd64.go
	    unpack_int32_le.go
	    unpack_int64_amd64.go
	    masks_int32_amd64.s
	    unpack_int32_amd64.s
	    unpack_int64_amd64.s
Package-Level Functions (total 5)

	 func ByteCount(bitCount uint) int
		ByteCount returns the number of bytes needed to hold the given bit count.

	 func PackInt32(dst []byte, src []int32, bitWidth uint)
		PackInt32 packs values from src to dst, each value is packed into the given
		bit width regardless of how many bits are needed to represent it.
		
		The function panics if dst is too short to hold the bit packed values.

	 func PackInt64(dst []byte, src []int64, bitWidth uint)
		PackInt64 packs values from src to dst, each value is packed into the given
		bit width regardless of how many bits are needed to represent it.
		
		The function panics if dst is too short to hold the bit packed values.

	 func UnpackInt32(dst []int32, src []byte, bitWidth uint)
		UnpackInt32 unpacks 32 bit integers from src to dst.
		
		The function unpacked len(dst) integers, it panics if src is too short to
		contain len(dst) values of the given bit width.

	 func UnpackInt64(dst []int64, src []byte, bitWidth uint)
		UnpackInt64 unpacks 64 bit integers from src to dst.
		
		The function unpacked len(dst) integers, it panics if src is too short to
		contain len(dst) values of the given bit width.


Package-Level Constants (total 2)

	const PaddingInt32 = 16
		PaddingInt32 is the padding expected to exist after the end of input buffers
		for the UnpackInt32 algorithm to avoid reading beyond the end of the input.

	const PaddingInt64 = 32
		PaddingInt64 is the padding expected to exist after the end of input buffers
		for the UnpackInt32 algorithm to avoid reading beyond the end of the input.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.