Type Alias ArrayRef 

pub type ArrayRef = Arc<dyn Array>;

A reference counted pointer to a dynamic Array trait object.

Aliased Type

pub struct ArrayRef { /* private fields */ }

Trait Implementations

impl ArrayBuiltins for ArrayRef

fn cast(&self, dtype: DType) -> VortexResult<ArrayRef>

Cast to the given data type.

fn fill_null(&self, fill_value: impl Into<Scalar>) -> VortexResult<ArrayRef>

Replace null values with the given fill value.

fn get_item(&self, field_name: impl Into<FieldName>) -> VortexResult<ArrayRef>

Get item by field name (for struct types).

fn is_null(&self) -> VortexResult<ArrayRef>

Is null check.

fn mask(self, mask: ArrayRef) -> VortexResult<ArrayRef>

Mask the array using the given boolean mask. The resulting array’s validity is the intersection of the original array’s validity and the mask’s validity.

fn not(&self) -> VortexResult<ArrayRef>

Boolean negation.

fn zip(&self, if_false: ArrayRef, mask: ArrayRef) -> VortexResult<ArrayRef>

Conditional selection: result[i] = if mask[i] then self[i] else if_false[i].

fn between( self, lower: ArrayRef, upper: ArrayRef, options: BetweenOptions, ) -> VortexResult<ArrayRef>

Compare a values between lower </<= value </<= upper

impl ArrayEq for ArrayRef

fn array_eq(&self, other: &Self, precision: Precision) -> bool

impl ArrayHash for ArrayRef

fn array_hash<H: Hasher>(&self, state: &mut H, precision: Precision)

impl ArrayOptimizer for ArrayRef

fn optimize(&self) -> VortexResult<ArrayRef>

Optimize the root array node only.

fn optimize_recursive(&self) -> VortexResult<ArrayRef>

Optimize the entire array tree recursively.

impl ArrowArrayExecutor for ArrayRef

fn execute_arrow( self, data_type: Option<&DataType>, ctx: &mut ExecutionCtx, ) -> VortexResult<ArrowArrayRef>

Execute the array to produce an Arrow array.

fn execute_record_batches( self, schema: &Schema, ctx: &mut ExecutionCtx, ) -> VortexResult<Vec<RecordBatch>>

Execute the array to produce Arrow RecordBatch’s with the given schema.

fn execute_record_batch( self, schema: &Schema, ctx: &mut ExecutionCtx, ) -> VortexResult<RecordBatch>

Execute the array to produce an Arrow RecordBatch with the given schema.

impl Executable for ArrayRef

Executing an ArrayRef into an ArrayRef is the atomic execution loop within Vortex.

It attempts to take the smallest possible step of execution such that the returned array is incrementally more “executed” than the input array. In other words, it is closer to becoming a canonical array.

The execution steps are as follows: 0. Check for canonical.

1. Attempt to call reduce_parent on each child.
2. Attempt to reduce the array with metadata-only optimizations.
3. Attempt to call execute_parent on each child.
4. Call execute on the array itself.

Most users will not call this method directly, instead preferring to specify an executable target such as crate::Columnar, Canonical, or any of the canonical array types (such as crate::arrays::PrimitiveArray).

fn execute(array: ArrayRef, ctx: &mut ExecutionCtx) -> VortexResult<Self>

impl From<ArrowArray> for ArrayRef

fn from(value: ArrowArray) -> ArrayRef

Converts to this type from the input type.

impl From<BoolArray> for ArrayRef

fn from(value: BoolArray) -> ArrayRef

Converts to this type from the input type.

impl From<Canonical> for ArrayRef

fn from(value: Canonical) -> Self

Converts to this type from the input type.

impl From<ChunkedArray> for ArrayRef

fn from(value: ChunkedArray) -> ArrayRef

Converts to this type from the input type.

impl From<ConstantArray> for ArrayRef

fn from(value: ConstantArray) -> ArrayRef

Converts to this type from the input type.

impl From<DecimalArray> for ArrayRef

fn from(value: DecimalArray) -> ArrayRef

Converts to this type from the input type.

impl From<DictArray> for ArrayRef

fn from(value: DictArray) -> ArrayRef

Converts to this type from the input type.

impl From<ExtensionArray> for ArrayRef

fn from(value: ExtensionArray) -> ArrayRef

Converts to this type from the input type.

impl From<FilterArray> for ArrayRef

fn from(value: FilterArray) -> ArrayRef

Converts to this type from the input type.

impl From<FixedSizeListArray> for ArrayRef

fn from(value: FixedSizeListArray) -> ArrayRef

Converts to this type from the input type.

impl From<ListArray> for ArrayRef

fn from(value: ListArray) -> ArrayRef

Converts to this type from the input type.

impl From<ListViewArray> for ArrayRef

fn from(value: ListViewArray) -> ArrayRef

Converts to this type from the input type.

impl From<MaskedArray> for ArrayRef

fn from(value: MaskedArray) -> ArrayRef

Converts to this type from the input type.

impl From<NullArray> for ArrayRef

fn from(value: NullArray) -> ArrayRef

Converts to this type from the input type.

impl From<PrimitiveArray> for ArrayRef

fn from(value: PrimitiveArray) -> ArrayRef

Converts to this type from the input type.

impl From<ScalarFnArray> for ArrayRef

fn from(value: ScalarFnArray) -> ArrayRef

Converts to this type from the input type.

impl From<SharedArray> for ArrayRef

fn from(value: SharedArray) -> ArrayRef

Converts to this type from the input type.

impl From<SliceArray> for ArrayRef

fn from(value: SliceArray) -> ArrayRef

Converts to this type from the input type.

impl From<StructArray> for ArrayRef

fn from(value: StructArray) -> ArrayRef

Converts to this type from the input type.

impl From<TemporalArray> for ArrayRef

fn from(value: TemporalArray) -> Self

Converts to this type from the input type.

impl From<VarBinArray> for ArrayRef

fn from(value: VarBinArray) -> ArrayRef

Converts to this type from the input type.

impl From<VarBinViewArray> for ArrayRef

fn from(value: VarBinViewArray) -> ArrayRef

Converts to this type from the input type.

impl FromArrowArray<&BooleanArray> for ArrayRef

fn from_arrow(value: &ArrowBooleanArray, nullable: bool) -> VortexResult<Self>

impl FromArrowArray<&FixedSizeListArray> for ArrayRef

fn from_arrow( array: &ArrowFixedSizeListArray, nullable: bool, ) -> VortexResult<Self>

impl<T: ByteArrayType> FromArrowArray<&GenericByteArray<T>> for ArrayRef

where <T as ByteArrayType>::Offset: IntegerPType,

fn from_arrow(value: &GenericByteArray<T>, nullable: bool) -> VortexResult<Self>

impl<T: ByteViewType> FromArrowArray<&GenericByteViewArray<T>> for ArrayRef

fn from_arrow( value: &GenericByteViewArray<T>, nullable: bool, ) -> VortexResult<Self>

impl<O: IntegerPType + OffsetSizeTrait> FromArrowArray<&GenericListArray<O>> for ArrayRef

fn from_arrow(value: &GenericListArray<O>, nullable: bool) -> VortexResult<Self>

impl<O: OffsetSizeTrait + NativePType> FromArrowArray<&GenericListViewArray<O>> for ArrayRef

fn from_arrow( array: &GenericListViewArray<O>, nullable: bool, ) -> VortexResult<Self>

impl FromArrowArray<&NullArray> for ArrayRef

fn from_arrow(value: &ArrowNullArray, nullable: bool) -> VortexResult<Self>

impl FromArrowArray<&PrimitiveArray<Date32Type>> for ArrayRef

fn from_arrow( value: &ArrowPrimitiveArray<Date32Type>, nullable: bool, ) -> VortexResult<Self>

impl FromArrowArray<&PrimitiveArray<Date64Type>> for ArrayRef

fn from_arrow( value: &ArrowPrimitiveArray<Date64Type>, nullable: bool, ) -> VortexResult<Self>

impl FromArrowArray<&PrimitiveArray<Decimal128Type>> for ArrayRef

fn from_arrow( array: &ArrowPrimitiveArray<Decimal128Type>, nullable: bool, ) -> VortexResult<Self>

impl FromArrowArray<&PrimitiveArray<Decimal256Type>> for ArrayRef

fn from_arrow( array: &ArrowPrimitiveArray<Decimal256Type>, nullable: bool, ) -> VortexResult<Self>

impl FromArrowArray<&PrimitiveArray<Decimal32Type>> for ArrayRef

fn from_arrow( array: &ArrowPrimitiveArray<Decimal32Type>, nullable: bool, ) -> VortexResult<Self>

impl FromArrowArray<&PrimitiveArray<Decimal64Type>> for ArrayRef

fn from_arrow( array: &ArrowPrimitiveArray<Decimal64Type>, nullable: bool, ) -> VortexResult<Self>

impl FromArrowArray<&PrimitiveArray<Float16Type>> for ArrayRef

fn from_arrow( value: &ArrowPrimitiveArray<Float16Type>, nullable: bool, ) -> VortexResult<Self>

impl FromArrowArray<&PrimitiveArray<Float32Type>> for ArrayRef

fn from_arrow( value: &ArrowPrimitiveArray<Float32Type>, nullable: bool, ) -> VortexResult<Self>

impl FromArrowArray<&PrimitiveArray<Float64Type>> for ArrayRef

fn from_arrow( value: &ArrowPrimitiveArray<Float64Type>, nullable: bool, ) -> VortexResult<Self>

impl FromArrowArray<&PrimitiveArray<Int16Type>> for ArrayRef

fn from_arrow( value: &ArrowPrimitiveArray<Int16Type>, nullable: bool, ) -> VortexResult<Self>

impl FromArrowArray<&PrimitiveArray<Int32Type>> for ArrayRef

fn from_arrow( value: &ArrowPrimitiveArray<Int32Type>, nullable: bool, ) -> VortexResult<Self>

impl FromArrowArray<&PrimitiveArray<Int64Type>> for ArrayRef

fn from_arrow( value: &ArrowPrimitiveArray<Int64Type>, nullable: bool, ) -> VortexResult<Self>

impl FromArrowArray<&PrimitiveArray<Int8Type>> for ArrayRef

fn from_arrow( value: &ArrowPrimitiveArray<Int8Type>, nullable: bool, ) -> VortexResult<Self>

impl FromArrowArray<&PrimitiveArray<Time32MillisecondType>> for ArrayRef

fn from_arrow( value: &ArrowPrimitiveArray<Time32MillisecondType>, nullable: bool, ) -> VortexResult<Self>

impl FromArrowArray<&PrimitiveArray<Time32SecondType>> for ArrayRef

fn from_arrow( value: &ArrowPrimitiveArray<Time32SecondType>, nullable: bool, ) -> VortexResult<Self>

impl FromArrowArray<&PrimitiveArray<Time64MicrosecondType>> for ArrayRef

fn from_arrow( value: &ArrowPrimitiveArray<Time64MicrosecondType>, nullable: bool, ) -> VortexResult<Self>

impl FromArrowArray<&PrimitiveArray<Time64NanosecondType>> for ArrayRef

fn from_arrow( value: &ArrowPrimitiveArray<Time64NanosecondType>, nullable: bool, ) -> VortexResult<Self>

impl FromArrowArray<&PrimitiveArray<TimestampMicrosecondType>> for ArrayRef

fn from_arrow( value: &ArrowPrimitiveArray<TimestampMicrosecondType>, nullable: bool, ) -> VortexResult<Self>

impl FromArrowArray<&PrimitiveArray<TimestampMillisecondType>> for ArrayRef

fn from_arrow( value: &ArrowPrimitiveArray<TimestampMillisecondType>, nullable: bool, ) -> VortexResult<Self>

impl FromArrowArray<&PrimitiveArray<TimestampNanosecondType>> for ArrayRef

fn from_arrow( value: &ArrowPrimitiveArray<TimestampNanosecondType>, nullable: bool, ) -> VortexResult<Self>

impl FromArrowArray<&PrimitiveArray<TimestampSecondType>> for ArrayRef

fn from_arrow( value: &ArrowPrimitiveArray<TimestampSecondType>, nullable: bool, ) -> VortexResult<Self>

impl FromArrowArray<&PrimitiveArray<UInt16Type>> for ArrayRef

fn from_arrow( value: &ArrowPrimitiveArray<UInt16Type>, nullable: bool, ) -> VortexResult<Self>

impl FromArrowArray<&PrimitiveArray<UInt32Type>> for ArrayRef

fn from_arrow( value: &ArrowPrimitiveArray<UInt32Type>, nullable: bool, ) -> VortexResult<Self>

impl FromArrowArray<&PrimitiveArray<UInt64Type>> for ArrayRef

fn from_arrow( value: &ArrowPrimitiveArray<UInt64Type>, nullable: bool, ) -> VortexResult<Self>

impl FromArrowArray<&PrimitiveArray<UInt8Type>> for ArrayRef

fn from_arrow( value: &ArrowPrimitiveArray<UInt8Type>, nullable: bool, ) -> VortexResult<Self>

impl FromArrowArray<&RecordBatch> for ArrayRef

fn from_arrow(array: &RecordBatch, nullable: bool) -> VortexResult<Self>

impl FromArrowArray<&StructArray> for ArrayRef

fn from_arrow(value: &ArrowStructArray, nullable: bool) -> VortexResult<Self>

impl FromArrowArray<&dyn Array> for ArrayRef

fn from_arrow(array: &dyn ArrowArray, nullable: bool) -> VortexResult<Self>

impl FromArrowArray<RecordBatch> for ArrayRef

fn from_arrow(array: RecordBatch, nullable: bool) -> VortexResult<Self>

impl IntoArray for ArrayRef

fn into_array(self) -> ArrayRef

impl IntoArrowArray for ArrayRef

fn into_arrow_preferred(self) -> VortexResult<ArrowArrayRef>

Convert this crate::ArrayRef into an Arrow crate::ArrayRef by using the array’s preferred (cheapest) Arrow DataType.

fn into_arrow(self, data_type: &DataType) -> VortexResult<ArrowArrayRef>

impl ReduceNode for ArrayRef

fn as_any(&self) -> &dyn Any

Downcast to Any.

fn node_dtype(&self) -> VortexResult<DType>

Return the data type of this node.

fn scalar_fn(&self) -> Option<&ScalarFn>

Return this node’s scalar function if it is indeed a scalar fn.

fn child(&self, idx: usize) -> ReduceNodeRef

Descend to the child of this handle.

fn child_count(&self) -> usize

Returns the number of children of this node.