Struct RunEndArray

pub struct RunEndArray { /* private fields */ }

Implementations

impl RunEndArray

pub fn try_new(ends: ArrayRef, values: ArrayRef) -> VortexResult<Self>

pub fn find_physical_index(&self, index: usize) -> VortexResult<usize>

Convert the given logical index to an index into the values array

pub fn find_physical_indices( &self, indices: &[usize], ) -> VortexResult<Buffer<u64>>

Convert a batch of logical indices into an index for the values. Expects indices to be adjusted by offset unlike Self::find_physical_index

See: find_physical_index.

pub fn encode(array: ArrayRef) -> VortexResult<Self>

Run the array through run-end encoding.

pub fn offset(&self) -> usize

The offset that the ends is relative to.

This is generally zero for a “new” array, and non-zero after a slicing operation.

pub fn ends(&self) -> &ArrayRef

The encoded “ends” of value runs.

The i-th element indicates that there is a run of the same value, beginning at ends[i] (inclusive) and terminating at ends[i+1] (exclusive).

pub fn values(&self) -> &ArrayRef

The scalar values.

The i-th element is the scalar value for the i-th repeated run. The run begins at ends[i] (inclusive) and terminates at ends[i+1] (exclusive).

Trait Implementations

impl ArrayCanonicalImpl for RunEndArray

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

Returns the canonical representation of the array.

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

Writes the array into the canonical builder.

impl ArrayComputeImpl for RunEndArray

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 RunEndArray

type Encoding = RunEndEncoding

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 RunEndArray

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

impl ArrayValidityImpl for RunEndArray

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 RunEndArray

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_null_typed(&self) -> Option<&dyn NullArrayTrait>

Downcasts the array for null-specific behavior.

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_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<RunEndMetadata>> for RunEndArray

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

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

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

fn _nbuffers(&self) -> usize

fn _nchildren(&self) -> usize

impl BinaryNumericFn<&RunEndArray> for RunEndEncoding

fn binary_numeric( &self, array: &RunEndArray, rhs: &dyn Array, op: BinaryNumericOperator, ) -> VortexResult<Option<ArrayRef>>

impl Clone for RunEndArray

fn clone(&self) -> RunEndArray

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CompareFn<&RunEndArray> for RunEndEncoding

fn compare( &self, lhs: &RunEndArray, 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 RunEndArray

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

Formats the value using the given formatter.

impl FillNullFn<&RunEndArray> for RunEndEncoding

fn fill_null( &self, array: &RunEndArray, fill_value: Scalar, ) -> VortexResult<ArrayRef>

impl InvertFn<&RunEndArray> for RunEndEncoding

fn invert(&self, array: &RunEndArray) -> VortexResult<ArrayRef>

Logically invert a boolean array. Converts true -> false, false -> true, null -> null.

impl IsSortedFn<&RunEndArray> for RunEndEncoding

fn is_sorted(&self, array: &RunEndArray) -> VortexResult<bool>

Preconditions

fn is_strict_sorted(&self, array: &RunEndArray) -> VortexResult<bool>

impl MinMaxFn<&RunEndArray> for RunEndEncoding

fn min_max(&self, array: &RunEndArray) -> VortexResult<Option<MinMaxResult>>

impl PrimitiveArrayTrait for RunEndArray

fn ptype(&self) -> PType

The logical primitive type of the array.

impl ScalarAtFn<&RunEndArray> for RunEndEncoding

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

impl SliceFn<&RunEndArray> for RunEndEncoding

fn slice( &self, array: &RunEndArray, 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<&RunEndArray> for RunEndEncoding

fn take( &self, array: &RunEndArray, 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: A, indices: &dyn Array, builder: &mut dyn ArrayBuilder, ) -> Result<(), VortexError>

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

impl TakeFromFn<&RunEndArray> for RunEndEncoding

fn take_from( &self, indices: &RunEndArray, source: &dyn Array, ) -> VortexResult<Option<ArrayRef>>

Takes values from the source array using run-end encoded indices.

Arguments

• indices - Run-end encoded indices
• source - Array to take values from

Returns

• Ok(Some(source)) - If successful
• Ok(None) - If the source array has an unsupported dtype

impl TryFrom<Arc<dyn Array>> for RunEndArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: ArrayRef) -> Result<Self, Self::Error>

Performs the conversion.

impl BoolArrayTrait for RunEndArray