Skip to main content

Crate vortex_onpair

Crate vortex_onpair 

Source
Expand description

Vortex string array backed by the OnPair short-string compression library, with cast and filter pushdown.

The default training preset is dict-12 (12 bits per token, dictionary capped at 4 096 entries). See onpair_compress for the entry point and OnPairArray for the resulting array type.

Structs§

Bits
Code width: the maximum dictionary size is 2^bits. Validated to 9..=16 at construction, so a Bits always holds an in-range value.
Config
Training configuration. See DEFAULT_CONFIG for a reasonable starting point.
OnPair
Zero-sized VTable marker for the OnPair encoding.
OnPairData
Inner data for an OnPair-encoded array.
OnPairMetadata
Wire-format metadata persisted alongside the OnPair buffer + slot children.
OnPairSlots
OnPairSlotsView
Borrowed view of OnPairSlots.
Threshold
Dynamic-threshold sample fraction. Validated to (0.0, 1.0] at construction, so a Threshold always holds an in-range value.

Enums§

OnPairError
Error returned by the public training and encoding API.

Constants§

DEFAULT_DICT12_CONFIG
Default OnPair training configuration: 12-bit codes (“dict-12”).

Traits§

OnPairArrayExt
Convenience methods on top of the macro-generated OnPairArraySlotsExt.
OnPairArraySlotsExt
Typed array accessors for OnPair.

Functions§

onpair_compress
Compress a byte-string accessor (typically a VarBinArray or VarBinViewArray).
onpair_compress_array
Compress any ArrayRef whose canonical form is a string array, by first canonicalising to VarBinViewArray.
onpair_compress_array_default
Convenience: build a default ExecutionCtx from LEGACY_SESSION.
onpair_compress_iter
Compress an iterable of optional byte strings via the OnPair encoder.

Type Aliases§

OnPairArray
An OnPair-encoded Vortex array.