Skip to main content Module array Copy item path Source accessor aggregate_fn Aggregate function vtable machinery. arrays All the built-in encoding schemes and arrays. arrow Utilities to work with Arrow data and types. buffer builders Builders for Vortex arrays. builtins A collection of built-in common scalar functions. compute display dtype A type system for Vortex expr Vortex’s expression language. extension Extension types. flatbuffers Re-exported autogenerated code from the core Vortex flatbuffer definitions. iter Iterator over slices of an array, and related utilities. kernel Parent kernels: child-driven fused execution of parent arrays. mask matcher memory Session-scoped memory allocation for host-side buffers. normalize optimizer The optimizer applies metadata-only rewrite rules (reduce and reduce_parent) in a
fixpoint loop until no more transformations are possible. patches scalar Scalar values and types for the Vortex system. scalar_fn Scalar function vtable machinery. search_sorted serde session stats Traits and utilities to compute and access array statistics. stream validity Array validity and nullability behavior, used by arrays and compute functions. variants This module defines extension functionality specific to each Vortex DType. vtable This module contains the VTable definitions for a Vortex encoding. field_path A helpful constructor for creating FieldPaths to nested
struct fields of the format field_path!(x.y.z) match_each_decimal_value Matches over each decimal value variant, binding the inner value to a variable. match_each_decimal_value_type Macro to match over each decimal value type, binding the corresponding native type (from
DecimalType) match_each_float_ptype Macro to match over each floating point type, binding the corresponding native type (from NativePType) match_each_integer_ptype Macro to match over each integer PType, binding the corresponding native type (from NativePType) match_each_native_ptype Macro to match over each PType, binding the corresponding native type (from NativePType) match_each_native_simd_ptype Macro to match over each SIMD capable PType, binding the corresponding native type (from NativePType) match_each_pvalue Utility macro that makes it easy to write expressions generic over the different PValue
variants. match_each_signed_integer_ptype Macro to match over each signed integer type, binding the corresponding native type (from NativePType) match_each_unsigned_integer_ptype Macro to match over each unsigned integer type, binding the corresponding native type (from NativePType) match_smallest_offset_type Macro to match the smallest offset type for a given value require_child Require that a child array matches $M. If the child already matches, returns the same
array unchanged. Otherwise, early-returns an ExecutionResult$idx until it matches $M. require_opt_child Like require_child!None, this is a no-op.
If the child is Some but does not match $M, early-returns an ExecutionResult$idx. require_patches Require that patch slots (indices, values, and optionally chunk_offsets) are Primitive.
If no patches are present (slots are None), this is a no-op. require_validity Require that the validity slot is a BoolNonNullable or AllValid), this is a no-op. If it is array-backed but
not Bool, early-returns an ExecutionResult AnyCanonical A matcher for any canonical array type. AnyColumnar Array A typed owned handle to an array. ArrayParts Construction parameters for typed arrays. ArrayRef A reference-counted pointer to a type-erased array. ArrayView A lightweight, Copy-able typed view into an ArrayRef CanonicalValidity Recursively execute the array until it reaches canonical form along with its validity. DepthFirstArrayIterator A depth-first pre-order iterator over an Array. EmptyArrayData Empty array metadata struct for encodings with no per-array metadata. EmptyMetadata Empty array metadata ExecutionCtx Execution context for batch CPU compute. ExecutionResult The result of a single execution step on an array encoding. MaskFuture A future that resolves to a mask. NotSupported Placeholder type used to indicate when a particular vtable is not supported by the encoding. ProstMetadata A utility wrapper for Prost metadata serialization. RawMetadata A utility wrapper for raw metadata serialization. This delegates the serialiation step
to the arrays’ vtable. RecursiveCanonical Recursively execute the array until all of its children are canonical. ValidityVTableFromChild An implementation of the ValidityVTable ValidityVTableFromChildSliceHelper An implementation of the ValidityVTable Canonical An enum capturing the default uncompressed encodings for each Vortex type . CanonicalView A view into a canonical array type. Columnar Represents a columnnar array of data, either in canonical form or as a constant array. ColumnarView ExecutionStep Metadata-only step indicator returned alongside an array in ExecutionResult Precision The precision level for structural equality and hashing of arrays. LEGACY_SESSION ArrayEq An equality trait for arrays that represents structural equality with a configurable level of
precision. This trait is used primarily to implement common subtree elimination and other
array-based caching mechanisms. ArrayHash A hash trait for arrays that represents structural equality with a configurable level of
precision. This trait is used primarily to implement common subtree elimination and other
array-based caching mechanisms. ArrayPlugin Registry trait for ID-based deserialization of arrays. ArrayVTable The array VTable DeserializeMetadata Trait for deserializing Vortex metadata from a vector of unaligned bytes. DynArrayEq A dynamic version of ArrayEq DynArrayHash A dynamic version of ArrayHash Executable Marker trait for types that an ArrayRef IntoArray Trait for converting a type into a Vortex ArrayRef OperationsVTable SerializeMetadata Trait for serializing Vortex metadata to a vector of unaligned bytes. ToCanonical Trait for types that can be converted from an owned type into an owned array variant. TypedArrayRef Shared bound for helpers that should work over both owned Array<V>ArrayView<V> VTable The array VTable ValidityChild ValidityChildSliceHelper ValidityVTable VortexSessionExecute Extension trait for creating an execution context from a session. child_to_validity Reconstruct a Validity patches_child Returns the child at the given index within a patches component. patches_child_name Returns the name of the child at the given index within a patches component. patches_nchildren Returns the number of children produced by patches. validity_nchildren Returns 1 if validity produces a child, 0 otherwise. validity_to_child Returns the validity as a child array if it produces one. ArrayContext ArrayId ArrayId is a globally unique name for the array’s vtable. ArrayPluginRef Reference-counted array plugin. DonePredicate A predicate that determines when an array has reached a desired form during execution. array_slots Generate slot index constants, a borrowed view struct, and a typed ext trait
from a slot struct definition.