Struct FSSTArray

pub struct FSSTArray { /* private fields */ }

Implementations

impl FSSTArray

pub fn try_new( dtype: DType, symbols: Buffer<Symbol>, symbol_lengths: Buffer<u8>, codes: VarBinArray, uncompressed_lengths: ArrayRef, ) -> VortexResult<Self>

Build an FSST array from a set of symbols and codes.

Symbols are 8-bytes and can represent short strings, each of which is assigned a code.

The codes array is a Binary array where each binary datum is a sequence of 8-bit codes. Each code corresponds either to a symbol, or to the “escape code”, which tells the decoder to emit the following byte without doing a table lookup.

pub fn symbols(&self) -> &Buffer<Symbol>

Access the symbol table array

pub fn symbol_lengths(&self) -> &Buffer<u8>

Access the symbol table array

pub fn codes(&self) -> &VarBinArray

Access the codes array

pub fn codes_dtype(&self) -> &DType

Get the DType of the codes array

pub fn uncompressed_lengths(&self) -> &ArrayRef

Get the uncompressed length for each element in the array.

pub fn uncompressed_lengths_dtype(&self) -> &DType

Get the DType of the uncompressed lengths array

Trait Implementations

impl ArrayCanonicalImpl for FSSTArray

fn _to_canonical(&self) -> VortexResult<Canonical>

Returns the canonical representation of the array.

fn _append_to_builder(&self, builder: &mut dyn ArrayBuilder) -> VortexResult<()>

Writes the array into the canonical builder.

impl ArrayComputeImpl for FSSTArray

const FILTER: Option<KernelRef>

fn _find_kernel( &self, _compute_fn: &dyn ComputeFn, ) -> Option<ArcRef<dyn Kernel>>

Fallback implementation to lookup compute kernels at runtime.

impl ArrayImpl for FSSTArray

type Encoding = FSSTEncoding

fn _len(&self) -> usize

fn _dtype(&self) -> &DType

fn _vtable(&self) -> VTableRef

fn _with_children(&self, children: &[ArrayRef]) -> VortexResult<Self>

Replace the children of this array with the given arrays.

impl ArrayStatisticsImpl for FSSTArray

fn _stats_ref(&self) -> StatsSetRef<'_>

impl ArrayValidityImpl for FSSTArray

fn _is_valid(&self, index: usize) -> VortexResult<bool>

Returns whether the index item is valid.

fn _all_valid(&self) -> VortexResult<bool>

Returns whether the array is all valid.

fn _all_invalid(&self) -> VortexResult<bool>

Returns whether the array is all invalid.

fn _validity_mask(&self) -> VortexResult<Mask>

Returns the canonical validity mask for the array.

fn _valid_count(&self) -> Result<usize, VortexError>

Returns the number of valid elements in the array.

fn _invalid_count(&self) -> Result<usize, VortexError>

Returns the number of invalid elements in the array.

impl ArrayVariantsImpl for FSSTArray

fn _as_utf8_typed(&self) -> Option<&dyn Utf8ArrayTrait>

Downcasts the array for utf8-specific behavior.

fn _as_binary_typed(&self) -> Option<&dyn BinaryArrayTrait>

Downcasts the array for binary-specific behavior.

fn _as_null_typed(&self) -> Option<&dyn NullArrayTrait>

Downcasts the array for null-specific behavior.

fn _as_bool_typed(&self) -> Option<&dyn BoolArrayTrait>

Downcasts the array for bool-specific behavior.

fn _as_primitive_typed(&self) -> Option<&dyn PrimitiveArrayTrait>

Downcasts the array for primitive-specific behavior.

fn _as_struct_typed(&self) -> Option<&dyn StructArrayTrait>

Downcasts the array for struct-specific behavior.

fn _as_list_typed(&self) -> Option<&dyn ListArrayTrait>

Downcasts the array for list-specific behavior.

fn _as_extension_typed(&self) -> Option<&dyn ExtensionArrayTrait>

Downcasts the array for extension-specific behavior.

impl ArrayVisitorImpl<SerdeMetadata<FSSTMetadata>> for FSSTArray

fn _visit_buffers(&self, visitor: &mut dyn ArrayBufferVisitor)

fn _visit_children(&self, visitor: &mut dyn ArrayChildVisitor)

fn _metadata(&self) -> SerdeMetadata<FSSTMetadata>

fn _nbuffers(&self) -> usize

fn _nchildren(&self) -> usize

impl Clone for FSSTArray

fn clone(&self) -> FSSTArray

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CompareFn<&FSSTArray> for FSSTEncoding

fn compare( &self, lhs: &FSSTArray, rhs: &dyn Array, operator: Operator, ) -> VortexResult<Option<ArrayRef>>

Compares two arrays and returns a new boolean array with the result of the comparison. Or, returns None if comparison is not supported for these arrays.

impl Debug for FSSTArray

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

Formats the value using the given formatter.

impl ScalarAtFn<&FSSTArray> for FSSTEncoding

fn scalar_at(&self, array: &FSSTArray, index: usize) -> VortexResult<Scalar>

impl SliceFn<&FSSTArray> for FSSTEncoding

fn slice( &self, array: &FSSTArray, start: usize, stop: usize, ) -> VortexResult<ArrayRef>

Return a zero-copy slice of an array, between start (inclusive) and end (exclusive). If start >= stop, returns an empty array of the same type as self. Assumes that start or stop are out of bounds, may panic otherwise.

impl TakeFn<&FSSTArray> for FSSTEncoding

fn take(&self, array: &FSSTArray, indices: &dyn Array) -> VortexResult<ArrayRef>

Create a new array by taking the values from the array at the given indices.

fn take_into( &self, array: &FSSTArray, indices: &dyn Array, builder: &mut dyn ArrayBuilder, ) -> VortexResult<()>

Has the same semantics as Self::take but materializes the result into the provided builder.

impl BinaryArrayTrait for FSSTArray

impl Utf8ArrayTrait for FSSTArray