Struct BitPackedArray 

pub struct BitPackedArray { /* private fields */ }

Implementations

impl BitPackedArray

pub fn try_new( packed: ByteBuffer, ptype: PType, validity: Validity, patches: Option<Patches>, bit_width: u8, length: usize, offset: u16, ) -> VortexResult<Self>

A safe constructor for a BitPackedArray from its components:

• packed is ByteBuffer holding the compressed data that was packed with FastLanes bit-packing to a bit_width bits per value. length is the length of the original vector. Note that the packed is padded with zeros to the next multiple of 1024 elements if length is not divisible by 1024.
• ptype of the original data
• validity to track any nulls
• patches optionally provided for values that did not pack

Any failure in validation will result in an error.

Validation

• The ptype must be an integer
• validity must have length len
• Any patches must have any array_len equal to length
• The packed buffer must be exactly sized to hold length values of bit_width rounded up to the next multiple of 1024.

Any violation of these preconditions will result in an error.

pub fn ptype(&self) -> PType

pub fn packed(&self) -> &ByteBuffer

Underlying bit packed values as byte array

pub fn packed_slice<T: NativePType + BitPacking>(&self) -> &[T]

Access the slice of packed values as an array of T

pub fn unpacked_chunks<T: BitPacked>(&self) -> BitUnpackedChunks<T>

Accessor for bit unpacked chunks

pub fn bit_width(&self) -> u8

Bit-width of the packed values

pub fn patches(&self) -> Option<&Patches>

Access the patches array.

If present, patches MUST be a SparseArray with equal-length to this array, and whose indices indicate the locations of patches. The indices must have non-zero length.

pub fn replace_patches(&mut self, patches: Option<Patches>)

pub fn offset(&self) -> u16

pub fn encode(array: &dyn Array, bit_width: u8) -> VortexResult<Self>

Bit-pack an array of primitive integers down to the target bit-width using the FastLanes SIMD-accelerated packing kernels.

Errors

If the provided array is not an integer type, an error will be returned.

If the provided array contains negative values, an error will be returned.

If the requested bit-width for packing is larger than the array’s native width, an error will be returned.

pub fn max_packed_value(&self) -> usize

Calculate the maximum value that can be contained by this array, given its bit-width.

Note that this value need not actually be present in the array.

Trait Implementations

impl AsRef<dyn Array> for BitPackedArray

fn as_ref(&self) -> &dyn Array

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for BitPackedArray

fn clone(&self) -> BitPackedArray

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BitPackedArray

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for BitPackedArray

type Target = dyn Array

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<BitPackedArray> for ArrayRef

fn from(value: BitPackedArray) -> ArrayRef

Converts to this type from the input type.

impl IntoArray for BitPackedArray

fn into_array(self) -> ArrayRef

impl ValidityHelper for BitPackedArray

fn validity(&self) -> &Validity