Struct vortex_runend::RunEndArray

pub struct RunEndArray(/* private fields */);

Implementations

impl RunEndArray

pub fn maybe_from(data: impl AsRef<ArrayData>) -> Option<Self>

Optionally downcast an ArrayData instance to a specific encoding.

Preferred in cases where a backtrace isn’t needed, like when trying multiple encoding to go down different code paths.

impl RunEndArray

pub fn try_new(ends: ArrayData, values: ArrayData) -> 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<Vec<usize>>

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: ArrayData) -> 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) -> ArrayData

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) -> ArrayData

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 AsRef<ArrayData> for RunEndArray

fn as_ref(&self) -> &ArrayData

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

impl BinaryNumericFn<RunEndArray> for RunEndEncoding

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

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: &ArrayData, operator: Operator, ) -> VortexResult<Option<ArrayData>>

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<ArrayData>

impl FilterFn<RunEndArray> for RunEndEncoding

fn filter( &self, array: &RunEndArray, mask: FilterMask, ) -> VortexResult<ArrayData>

Filter an array by the provided predicate.

impl IntoArrayData for RunEndArray

fn into_array(self) -> ArrayData

impl IntoCanonical for RunEndArray

fn into_canonical(self) -> VortexResult<Canonical>

fn into_arrow(self) -> Result<Arc<dyn Array>, VortexError>

where Self: Sized,

impl InvertFn<RunEndArray> for RunEndEncoding

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

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

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<ArrayData>

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 StatisticsVTable<RunEndArray> for RunEndEncoding

fn compute_statistics( &self, array: &RunEndArray, stat: Stat, ) -> VortexResult<StatsSet>

Compute the requested statistic. Can return additional stats.

impl TakeFn<RunEndArray> for RunEndEncoding

fn take( &self, array: &RunEndArray, indices: &ArrayData, ) -> VortexResult<ArrayData>

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

unsafe fn take_unchecked( &self, array: &Array, indices: &ArrayData, ) -> Result<ArrayData, VortexError>

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

impl<'a> TryFrom<&'a ArrayData> for &'a RunEndArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(data: &'a ArrayData) -> VortexResult<Self>

Performs the conversion.

impl TryFrom<ArrayData> for RunEndArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(data: ArrayData) -> VortexResult<Self>

Performs the conversion.

impl ValidityVTable<RunEndArray> for RunEndEncoding

fn is_valid(&self, array: &RunEndArray, index: usize) -> bool

fn logical_validity(&self, array: &RunEndArray) -> LogicalValidity

impl VariantsVTable<RunEndArray> for RunEndEncoding

fn as_bool_array<'a>( &self, array: &'a RunEndArray, ) -> Option<&'a dyn BoolArrayTrait>

fn as_primitive_array<'a>( &self, array: &'a RunEndArray, ) -> Option<&'a dyn PrimitiveArrayTrait>

fn as_null_array<'a>(&self, _array: &'a Array) -> Option<&'a dyn NullArrayTrait>

fn as_utf8_array<'a>(&self, _array: &'a Array) -> Option<&'a dyn Utf8ArrayTrait>

fn as_binary_array<'a>( &self, _array: &'a Array, ) -> Option<&'a dyn BinaryArrayTrait>

fn as_struct_array<'a>( &self, _array: &'a Array, ) -> Option<&'a dyn StructArrayTrait>

fn as_list_array<'a>(&self, _array: &'a Array) -> Option<&'a dyn ListArrayTrait>

fn as_extension_array<'a>( &self, _array: &'a Array, ) -> Option<&'a dyn ExtensionArrayTrait>

impl VisitorVTable<RunEndArray> for RunEndEncoding

fn accept( &self, array: &RunEndArray, visitor: &mut dyn ArrayVisitor, ) -> VortexResult<()>

impl ArrayTrait for RunEndArray

impl BoolArrayTrait for RunEndArray