Trait Array 

pub trait Array:
    'static
    + Sealed
    + Send
    + Sync
    + Debug
    + DynArrayEq
    + DynArrayHash
    + ArrayVisitor
    + ReduceNode {
    // Required methods
    fn as_any(&self) -> &dyn Any;
    fn as_any_arc(self: Arc<Self>) -> Arc<dyn Any + Send + Sync>;
    fn to_array(&self) -> ArrayRef;
    fn len(&self) -> usize;
    fn dtype(&self) -> &DType;
    fn vtable(&self) -> &dyn DynVTable;
    fn encoding_id(&self) -> ArrayId;
    fn slice(&self, range: Range<usize>) -> VortexResult<ArrayRef>;
    fn filter(&self, mask: Mask) -> VortexResult<ArrayRef>;
    fn take(&self, indices: ArrayRef) -> VortexResult<ArrayRef>;
    fn scalar_at(&self, index: usize) -> VortexResult<Scalar>;
    fn is_valid(&self, index: usize) -> VortexResult<bool>;
    fn is_invalid(&self, index: usize) -> VortexResult<bool>;
    fn all_valid(&self) -> VortexResult<bool>;
    fn all_invalid(&self) -> VortexResult<bool>;
    fn valid_count(&self) -> VortexResult<usize>;
    fn invalid_count(&self) -> VortexResult<usize>;
    fn validity(&self) -> VortexResult<Validity>;
    fn validity_mask(&self) -> VortexResult<Mask>;
    fn to_canonical(&self) -> VortexResult<Canonical>;
    fn append_to_builder(
        &self,
        builder: &mut dyn ArrayBuilder,
        ctx: &mut ExecutionCtx,
    ) -> VortexResult<()>;
    fn statistics(&self) -> StatsSetRef<'_>;
    fn with_children(&self, children: Vec<ArrayRef>) -> VortexResult<ArrayRef>;

    // Provided method
    fn is_empty(&self) -> bool { ... }
}

The public API trait for all Vortex arrays.

Required Methods

fn as_any(&self) -> &dyn Any

Returns the array as a reference to a generic Any trait object.

fn as_any_arc(self: Arc<Self>) -> Arc<dyn Any + Send + Sync>

Returns the array as an Arc<dyn Any + Send + Sync>.

fn to_array(&self) -> ArrayRef

Returns the array as an ArrayRef.

fn len(&self) -> usize

Returns the length of the array.

fn dtype(&self) -> &DType

Returns the logical Vortex DType of the array.

fn vtable(&self) -> &dyn DynVTable

Returns the vtable of the array.

fn encoding_id(&self) -> ArrayId

Returns the encoding ID of the array.

fn slice(&self, range: Range<usize>) -> VortexResult<ArrayRef>

Performs a constant-time slice of the array.

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

Wraps the array in a FilterArray such that it is logically filtered by the given mask.

fn take(&self, indices: ArrayRef) -> VortexResult<ArrayRef>

Wraps the array in a DictArray such that it is logically taken by the given indices.

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

Fetch the scalar at the given index.

This method panics if the index is out of bounds for the array.

fn is_valid(&self, index: usize) -> VortexResult<bool>

Returns whether the item at index is valid.

fn is_invalid(&self, index: usize) -> VortexResult<bool>

Returns whether the item at index is invalid.

fn all_valid(&self) -> VortexResult<bool>

Returns whether all items in the array are valid.

This is usually cheaper than computing a precise valid_count, but may return false negatives.

fn all_invalid(&self) -> VortexResult<bool>

Returns whether the array is all invalid.

This is usually cheaper than computing a precise invalid_count, but may return false negatives.

fn valid_count(&self) -> VortexResult<usize>

Returns the number of valid elements in the array.

fn invalid_count(&self) -> VortexResult<usize>

Returns the number of invalid elements in the array.

fn validity(&self) -> VortexResult<Validity>

Returns the Validity of the array.

fn validity_mask(&self) -> VortexResult<Mask>

Returns the canonical validity mask for the array.

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

Returns the canonical representation of the array.

fn append_to_builder( &self, builder: &mut dyn ArrayBuilder, ctx: &mut ExecutionCtx, ) -> VortexResult<()>

Writes the array into the canonical builder.

The DType of the builder must match that of the array.

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

Returns the statistics of the array.

fn with_children(&self, children: Vec<ArrayRef>) -> VortexResult<ArrayRef>

Replaces the children of the array with the given array references.

Provided Methods

fn is_empty(&self) -> bool

Returns whether the array is empty (has zero rows).

Implementations

impl dyn Array + '_

pub fn is<M: Matcher>(&self) -> bool

Does the array match the given matcher.

pub fn as_<M: Matcher>(&self) -> M::Match<'_>

Returns the array downcast by the given matcher.

pub fn as_opt<M: Matcher>(&self) -> Option<M::Match<'_>>

Returns the array downcast by the given matcher.

pub fn try_into<V: VTable>(self: Arc<Self>) -> Result<V::Array, Arc<Self>>

Returns the array downcast to the given A as an owned object.

pub fn as_constant(&self) -> Option<Scalar>

pub fn nbytes(&self) -> u64

Total size of the array in bytes, including all children and buffers.

pub fn is_arrow(&self) -> bool

Returns whether this array is an arrow encoding.

pub fn is_canonical(&self) -> bool

Whether the array is of a canonical encoding.

impl dyn Array + '_

pub fn try_to_mask_fill_null_false(&self) -> VortexResult<Mask>

Converts from a possible nullable boolean array. Null values are treated as false.

impl dyn Array + '_

pub fn display_values(&self) -> impl Display

Display logical values of the array

For example, an i16 typed array containing the first five non-negative integers is displayed as: [0i16, 1i16, 2i16, 3i16, 4i16].

Examples

let array = buffer![0_i16, 1, 2, 3, 4].into_array();
assert_eq!(
    format!("{}", array.display_values()),
    "[0i16, 1i16, 2i16, 3i16, 4i16]",
)

See also: Array::display_as, DisplayArrayAs, and DisplayOptions.

pub fn display_as(&self, options: DisplayOptions) -> impl Display

Display the array as specified by the options.

See DisplayOptions for examples.

pub fn display_tree_encodings_only(&self) -> impl Display

Display the tree of array encodings and lengths without metadata, buffers, or stats.

Examples

let array = buffer![0_i16, 1, 2, 3, 4].into_array();
let expected = "root: vortex.primitive(i16, len=5)\n";
assert_eq!(format!("{}", array.display_tree_encodings_only()), expected);

let array = StructArray::from_fields(&[
    ("x", buffer![1, 2].into_array()),
    ("y", buffer![3, 4].into_array()),
]).unwrap().into_array();
let expected = "root: vortex.struct({x=i32, y=i32}, len=2)
  x: vortex.primitive(i32, len=2)
  y: vortex.primitive(i32, len=2)
";
assert_eq!(format!("{}", array.display_tree_encodings_only()), expected);

pub fn display_tree(&self) -> impl Display

Display the tree of encodings of this array as an indented lists.

While some metadata (such as length, bytes and validity-rate) are included, the logical values of the array are not displayed. To view the logical values see Array::display_as and DisplayOptions.

Examples

let array = buffer![0_i16, 1, 2, 3, 4].into_array();
let expected = "root: vortex.primitive(i16, len=5) nbytes=10 B (100.00%)
  metadata: EmptyMetadata
  buffer: values host 10 B (align=2) (100.00%)
";
assert_eq!(format!("{}", array.display_tree()), expected);

pub fn display_table(&self) -> impl Display

Display the array as a formatted table.

For struct arrays, displays a column for each field in the struct. For regular arrays, displays a single column with values.

Examples

let s = StructArray::from_fields(&[
    ("x", buffer![1, 2].into_array()),
    ("y", buffer![3, 4].into_array()),
]).unwrap().into_array();
let expected = "
┌──────┬──────┐
│  x   │  y   │
├──────┼──────┤
│ 1i32 │ 3i32 │
├──────┼──────┤
│ 2i32 │ 4i32 │
└──────┴──────┘".trim();
assert_eq!(format!("{}", s.display_table()), expected);

impl dyn Array + '_

pub fn execute<E: Executable>( self: Arc<Self>, ctx: &mut ExecutionCtx, ) -> VortexResult<E>

Execute this array to produce an instance of E.

See the Executable implementation for details on how this execution is performed.

pub fn execute_as<E: Executable>( self: Arc<Self>, name: &'static str, ctx: &mut ExecutionCtx, ) -> VortexResult<E>

Execute this array, labeling the execution step with a name for tracing.

impl dyn Array + '_

pub fn apply(&self, expr: &Expression) -> VortexResult<ArrayRef>

Apply the expression to this array, producing a new array in constant time.

impl dyn Array + '_

pub fn to_array_iterator(&self) -> impl ArrayIterator + 'static

Create an ArrayIterator over the array.

impl dyn Array + '_

pub fn normalize( self: ArrayRef, options: &mut NormalizeOptions<'_>, ) -> VortexResult<ArrayRef>

Normalize the array according to given options.

This operation performs a recursive traversal of the array. Any non-allowed encoding is normalized per the configured operation.

impl dyn Array + '_

pub fn serialize( &self, ctx: &ArrayContext, options: &SerializeOptions, ) -> VortexResult<Vec<ByteBuffer>>

Serialize the array into a sequence of byte buffers that should be written contiguously. This function returns a vec to avoid copying data buffers.

Optionally, padding can be included to guarantee buffer alignment and ensure zero-copy reads within the context of an external file or stream. In this case, the alignment of the first byte buffer should be respected when writing the buffers to the stream or file.

The format of this blob is a sequence of data buffers, possible with prefixed padding, followed by a flatbuffer containing an fba::Array message, and ending with a little-endian u32 describing the length of the flatbuffer message.

impl dyn Array + '_

pub fn to_array_stream(&self) -> impl ArrayStream + 'static

Create an ArrayStream over the array.

impl dyn Array + '_

pub fn as_null_typed(&self) -> NullTyped<'_>

Downcasts the array for null-specific behavior.

pub fn as_bool_typed(&self) -> BoolTyped<'_>

Downcasts the array for bool-specific behavior.

pub fn as_primitive_typed(&self) -> PrimitiveTyped<'_>

Downcasts the array for primitive-specific behavior.

pub fn as_decimal_typed(&self) -> DecimalTyped<'_>

Downcasts the array for decimal-specific behavior.

pub fn as_utf8_typed(&self) -> Utf8Typed<'_>

Downcasts the array for utf8-specific behavior.

pub fn as_binary_typed(&self) -> BinaryTyped<'_>

Downcasts the array for binary-specific behavior.

pub fn as_struct_typed(&self) -> StructTyped<'_>

Downcasts the array for struct-specific behavior.

pub fn as_list_typed(&self) -> ListTyped<'_>

Downcasts the array for list-specific behavior.

pub fn as_extension_typed(&self) -> ExtensionTyped<'_>

Downcasts the array for extension-specific behavior.

Trait Implementations

impl ArrayEq for dyn Array + '_

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

impl ArrayHash for dyn Array + '_

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

impl AsRef<dyn Array> for ArrowArray

fn as_ref(&self) -> &dyn Array

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

impl AsRef<dyn Array> for BoolArray

fn as_ref(&self) -> &dyn Array

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

impl AsRef<dyn Array> for Canonical

fn as_ref(&self) -> &(dyn Array + 'static)

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

impl AsRef<dyn Array> for CanonicalView<'_>

fn as_ref(&self) -> &dyn Array

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

impl AsRef<dyn Array> for ChunkedArray

fn as_ref(&self) -> &dyn Array

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

impl<'a> AsRef<dyn Array> for ColumnarView<'a>

fn as_ref(&self) -> &dyn Array

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

impl AsRef<dyn Array> for ConstantArray

fn as_ref(&self) -> &dyn Array

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

impl AsRef<dyn Array> for DecimalArray

fn as_ref(&self) -> &dyn Array

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

impl AsRef<dyn Array> for DictArray

fn as_ref(&self) -> &dyn Array

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

impl AsRef<dyn Array> for ExtensionArray

fn as_ref(&self) -> &dyn Array

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

impl AsRef<dyn Array> for FilterArray

fn as_ref(&self) -> &dyn Array

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

impl AsRef<dyn Array> for FixedSizeListArray

fn as_ref(&self) -> &dyn Array

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

impl AsRef<dyn Array> for ListArray

fn as_ref(&self) -> &dyn Array

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

impl AsRef<dyn Array> for ListViewArray

fn as_ref(&self) -> &dyn Array

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

impl AsRef<dyn Array> for MaskedArray

fn as_ref(&self) -> &dyn Array

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

impl AsRef<dyn Array> for NullArray

fn as_ref(&self) -> &dyn Array

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

impl AsRef<dyn Array> for PrimitiveArray

fn as_ref(&self) -> &dyn Array

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

impl AsRef<dyn Array> for ScalarFnArray

fn as_ref(&self) -> &dyn Array

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

impl AsRef<dyn Array> for SharedArray

fn as_ref(&self) -> &dyn Array

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

impl AsRef<dyn Array> for SliceArray

fn as_ref(&self) -> &dyn Array

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

impl AsRef<dyn Array> for StructArray

fn as_ref(&self) -> &dyn Array

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

impl AsRef<dyn Array> for TemporalArray

fn as_ref(&self) -> &dyn Array

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

impl AsRef<dyn Array> for VarBinArray

fn as_ref(&self) -> &dyn Array

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

impl AsRef<dyn Array> for VarBinViewArray

fn as_ref(&self) -> &dyn Array

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

impl Display for dyn Array + '_

Display the encoding and limited metadata of this array.

Examples

let array = buffer![0_i16, 1, 2, 3, 4].into_array();
assert_eq!(
    format!("{}", array),
    "vortex.primitive(i16, len=5)",
);

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

Formats the value using the given formatter.

impl<'a> From<&'a (dyn Array + 'static)> for Input<'a>

fn from(value: &'a dyn Array) -> Self

Converts to this type from the input type.

impl IndexOrd<Scalar> for dyn Array + '_

fn index_cmp(&self, idx: usize, elem: &Scalar) -> VortexResult<Option<Ordering>>

PartialOrd of the value at index idx with elem. For example, if self[idx] > elem, return Some(Greater).

fn index_len(&self) -> usize

Get the length of the underlying ordered collection

fn index_lt(&self, idx: usize, elem: &V) -> VortexResult<bool>

fn index_le(&self, idx: usize, elem: &V) -> VortexResult<bool>

fn index_gt(&self, idx: usize, elem: &V) -> VortexResult<bool>

fn index_ge(&self, idx: usize, elem: &V) -> VortexResult<bool>

impl ToOwned for dyn Array

type Owned = Arc<dyn Array>

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl TryFrom<&(dyn Array + 'static)> for RecordBatch

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &dyn Array) -> VortexResult<Self>

Performs the conversion.

Implementations on Foreign Types

impl Array for Arc<dyn Array>

fn as_any(&self) -> &dyn Any

fn as_any_arc(self: Arc<Self>) -> Arc<dyn Any + Send + Sync>

fn to_array(&self) -> ArrayRef

fn len(&self) -> usize

fn dtype(&self) -> &DType

fn vtable(&self) -> &dyn DynVTable

fn encoding_id(&self) -> ArrayId

fn slice(&self, range: Range<usize>) -> VortexResult<ArrayRef>

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

fn take(&self, indices: ArrayRef) -> VortexResult<ArrayRef>

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

fn is_valid(&self, index: usize) -> VortexResult<bool>

fn is_invalid(&self, index: usize) -> VortexResult<bool>

fn all_valid(&self) -> VortexResult<bool>

fn all_invalid(&self) -> VortexResult<bool>

fn valid_count(&self) -> VortexResult<usize>

fn invalid_count(&self) -> VortexResult<usize>

fn validity(&self) -> VortexResult<Validity>

fn validity_mask(&self) -> VortexResult<Mask>

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

fn append_to_builder( &self, builder: &mut dyn ArrayBuilder, ctx: &mut ExecutionCtx, ) -> VortexResult<()>

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

fn with_children(&self, children: Vec<ArrayRef>) -> VortexResult<ArrayRef>

Implementors

impl<V: VTable> Array for ArrayAdapter<V>