Struct ConstantArray

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

Implementations

impl ConstantArray

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

Optionally downcast an Array 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 ConstantArray

pub fn new<S>(scalar: S, length: usize) -> Self

where S: Into<Scalar>,

pub fn scalar(&self) -> Scalar

Returns the Scalar value of this constant array.

Methods from Deref<Target = Array>

pub fn vtable(&self) -> &VTableRef

Return the array’s encoding VTable.

pub fn encoding(&self) -> EncodingId

Return the array’s encoding ID.

pub fn len(&self) -> usize

Returns the number of logical elements in the array.

pub fn is_empty(&self) -> bool

Check whether the array has any data

pub fn dtype(&self) -> &DType

Return the array’s dtype

pub fn is_canonical(&self) -> bool

Whether the array is of a canonical encoding.

pub fn is_arrow(&self) -> bool

Whether the array is fully zero-copy to Arrow (including children). This means any nested types, like Structs, Lists, and Extensions are not present.

pub fn is_constant(&self) -> bool

Return whether the array is constant.

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

Return scalar value of this array if the array is constant

pub fn child<'a>( &'a self, idx: usize, dtype: &'a DType, len: usize, ) -> VortexResult<Self>

pub fn children(&self) -> Vec<Array>

Returns a Vec of Arrays with all the array’s child arrays.

pub fn named_children(&self) -> Vec<(String, Array)>

Returns a Vec of Arrays with all the array’s child arrays.

pub fn nchildren(&self) -> usize

Returns the number of child arrays

pub fn depth_first_traversal(&self) -> ArrayChildrenIterator

pub fn cumulative_nbuffers(&self) -> usize

Count the number of cumulative buffers encoded by self.

pub fn all_buffer_offsets(&self, alignment: usize) -> Vec<u64>

Return the buffer offsets and the total length of all buffers, assuming the given alignment. This includes all child buffers.

pub fn metadata_bytes(&self) -> Option<&[u8]>

pub fn nbuffers(&self) -> usize

pub fn byte_buffer(&self, index: usize) -> Option<&ByteBuffer>

pub fn byte_buffers(&self) -> impl Iterator<Item = ByteBuffer> + '_

pub fn is_encoding(&self, id: EncodingId) -> bool

Checks whether array is of a given encoding.

pub fn try_downcast_ref<E: Encoding>(&self) -> VortexResult<(&E::Array, &E)>

where for<'a> &'a E::Array: TryFrom<&'a Array, Error = VortexError>,

pub fn nbytes(&self) -> usize

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

pub fn statistics(&self) -> &(dyn Statistics + '_)

pub fn inherit_statistics(&self, parent: &dyn Statistics)

pub fn tree_display(&self) -> TreeDisplayWrapper<'_>

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

Return whether the element at the given index is valid (true) or null (false).

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

Return whether all elements in the array are valid.

pub fn null_count(&self) -> VortexResult<usize>

Return the number of null elements in the array.

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

Return the canonical validity of the array as a Mask.

pub fn as_null_array(&self) -> Option<&dyn NullArrayTrait>

pub fn as_bool_array(&self) -> Option<&dyn BoolArrayTrait>

pub fn as_primitive_array(&self) -> Option<&dyn PrimitiveArrayTrait>

pub fn as_utf8_array(&self) -> Option<&dyn Utf8ArrayTrait>

pub fn as_binary_array(&self) -> Option<&dyn BinaryArrayTrait>

pub fn as_struct_array(&self) -> Option<&dyn StructArrayTrait>

pub fn as_list_array(&self) -> Option<&dyn ListArrayTrait>

pub fn as_extension_array(&self) -> Option<&dyn ExtensionArrayTrait>

Trait Implementations

impl<T> Accessor<T> for ConstantArray

where T: Clone + TryFrom<Scalar, Error = VortexError>,

fn value_unchecked(&self, _index: usize) -> T

fn batch_size(&self, start_idx: usize) -> usize

fn decode_batch(&self, start_idx: usize) -> Vec<T>

impl AsRef<Array> for ConstantArray

fn as_ref(&self) -> &Array

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

impl BinaryBooleanFn<ConstantArray> for ConstantEncoding

fn binary_boolean( &self, lhs: &ConstantArray, rhs: &Array, op: BinaryOperator, ) -> VortexResult<Option<Array>>

impl BinaryNumericFn<ConstantArray> for ConstantEncoding

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

impl CanonicalVTable<ConstantArray> for ConstantEncoding

fn into_canonical(&self, array: ConstantArray) -> VortexResult<Canonical>

impl Clone for ConstantArray

fn clone(&self) -> ConstantArray

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CompareFn<ConstantArray> for ConstantEncoding

fn compare( &self, lhs: &ConstantArray, rhs: &Array, operator: Operator, ) -> VortexResult<Option<Array>>

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 ConstantArray

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

Formats the value using the given formatter.

impl Deref for ConstantArray

type Target = Array

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl ExtensionArrayTrait for ConstantArray

fn storage_data(&self) -> Array

Returns the underlying Array, without the ExtDType.

fn ext_dtype(&self) -> &Arc<ExtDType>

Returns the extension logical DType.

impl FilterFn<ConstantArray> for ConstantEncoding

fn filter(&self, array: &ConstantArray, mask: &Mask) -> VortexResult<Array>

Filter an array by the provided predicate.

impl IntoArray for ConstantArray

fn into_array(self) -> Array

impl InvertFn<ConstantArray> for ConstantEncoding

fn invert(&self, array: &ConstantArray) -> VortexResult<Array>

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

impl PrimitiveArrayTrait for ConstantArray

fn ptype(&self) -> PType

The logical primitive type of the array.

impl ScalarAtFn<ConstantArray> for ConstantEncoding

fn scalar_at( &self, array: &ConstantArray, _index: usize, ) -> VortexResult<Scalar>

impl SearchSortedFn<ConstantArray> for ConstantEncoding

fn search_sorted( &self, array: &ConstantArray, value: &Scalar, side: SearchSortedSide, ) -> VortexResult<SearchResult>

fn search_sorted_many( &self, array: &A, values: &[Scalar], side: SearchSortedSide, ) -> VortexResult<Vec<SearchResult>>

Bulk search for many values.

impl SliceFn<ConstantArray> for ConstantEncoding

fn slice( &self, array: &ConstantArray, start: usize, stop: usize, ) -> VortexResult<Array>

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<ConstantArray> for ConstantEncoding

fn compute_statistics( &self, array: &ConstantArray, _stat: Stat, ) -> VortexResult<StatsSet>

Compute the requested statistic. Can return additional stats.

impl StructArrayTrait for ConstantArray

fn maybe_null_field_by_idx(&self, idx: usize) -> Option<Array>

Return a field’s array by index, ignoring struct nullability

fn project(&self, projection: &[FieldName]) -> VortexResult<Array>

fn names(&self) -> &FieldNames

fn field_info(&self, field: &Field) -> VortexResult<FieldInfo>

fn dtypes(&self) -> Vec<DType>

fn nfields(&self) -> usize

fn maybe_null_field_by_name(&self, name: &str) -> Option<Array>

Return a field’s array by name, ignoring struct nullability

fn maybe_null_field(&self, field: &Field) -> Option<Array>

impl TakeFn<ConstantArray> for ConstantEncoding

fn take(&self, array: &ConstantArray, indices: &Array) -> VortexResult<Array>

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

unsafe fn take_unchecked( &self, array: &A, indices: &Array, ) -> VortexResult<Array>

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

impl<'a> TryFrom<&'a Array> for &'a ConstantArray

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Array> for ConstantArray

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl ValidateVTable<ConstantArray> for ConstantEncoding

fn validate(&self, _array: &Array) -> VortexResult<()>

impl ValidityVTable<ConstantArray> for ConstantEncoding

fn is_valid(&self, array: &ConstantArray, _index: usize) -> VortexResult<bool>

Returns whether the index item is valid.

fn all_valid(&self, array: &ConstantArray) -> VortexResult<bool>

Returns whether the array is all valid.

fn validity_mask(&self, array: &ConstantArray) -> VortexResult<Mask>

fn invalid_count(&self, array: &Array) -> VortexResult<usize>

Returns the number of invalid elements in the array.

impl VariantsVTable<ConstantArray> for ConstantEncoding

Constant arrays support all DTypes

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

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

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

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

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

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

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

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

impl VisitorVTable<ConstantArray> for ConstantEncoding

fn accept( &self, _array: &ConstantArray, _visitor: &mut dyn ArrayVisitor, ) -> VortexResult<()>

impl BinaryArrayTrait for ConstantArray

impl BoolArrayTrait for ConstantArray

impl ListArrayTrait for ConstantArray

impl NullArrayTrait for ConstantArray

impl Utf8ArrayTrait for ConstantArray