Struct PrimitiveArray

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

Implementations

impl PrimitiveArray

pub fn patch(self, patches: Patches) -> VortexResult<Self>

impl PrimitiveArray

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 PrimitiveArray

pub fn new<T: NativePType>( buffer: impl Into<Buffer<T>>, validity: Validity, ) -> Self

pub fn empty<T: NativePType>(nullability: Nullability) -> Self

pub fn from_byte_buffer( buffer: ByteBuffer, ptype: PType, validity: Validity, ) -> Self

pub fn from_option_iter<T: NativePType, I: IntoIterator<Item = Option<T>>>( iter: I, ) -> Self

Create a PrimitiveArray from an iterator of T. NOTE: we cannot impl FromIterator trait since it conflicts with FromIterator<T>.

pub fn validity(&self) -> Validity

pub fn byte_buffer(&self) -> &ByteBuffer

pub fn into_byte_buffer(self) -> ByteBuffer

pub fn buffer<T: NativePType>(&self) -> Buffer<T>

pub fn into_buffer<T: NativePType>(self) -> Buffer<T>

pub fn into_buffer_mut<T: NativePType>(self) -> BufferMut<T>

Extract a mutable buffer from the PrimitiveArray. Attempts to do this with zero-copy if the buffer is uniquely owned, otherwise will make a copy.

pub fn try_into_buffer_mut<T: NativePType>( self, ) -> Result<BufferMut<T>, PrimitiveArray>

Try to extract a mutable buffer from the PrimitiveArray with zero copy.

pub fn map_each<T, R, F>(self, f: F) -> PrimitiveArray

where T: NativePType, R: NativePType, F: FnMut(T) -> R,

Map each element in the array to a new value.

This ignores validity and maps over all maybe-null elements.

TODO(ngates): we could be smarter here if validity is sparse and only run the function over the valid elements.

pub fn as_slice<T: NativePType>(&self) -> &[T]

Return a slice of the array’s buffer.

NOTE: these values may be nonsense if the validity buffer indicates that the value is null.

pub fn get_as_cast<T: NativePType>(&self, idx: usize) -> T

pub fn reinterpret_cast(&self, ptype: PType) -> Self

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: NativePType> Accessor<T> for PrimitiveArray

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

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

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

impl<T: NativePType> ArrayAccessor<T> for PrimitiveArray

fn with_iterator<F, R>(&self, f: F) -> VortexResult<R>

where F: for<'a> FnOnce(&mut dyn Iterator<Item = Option<&'a T>>) -> R,

Iterate over each element of the array, in-order.

impl AsRef<Array> for PrimitiveArray

fn as_ref(&self) -> &Array

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

impl CanonicalVTable<PrimitiveArray> for PrimitiveEncoding

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

impl CastFn<PrimitiveArray> for PrimitiveEncoding

fn cast(&self, array: &PrimitiveArray, dtype: &DType) -> VortexResult<Array>

impl Clone for PrimitiveArray

fn clone(&self) -> PrimitiveArray

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PrimitiveArray

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

Formats the value using the given formatter.

impl Deref for PrimitiveArray

type Target = Array

The resulting type after dereferencing.

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

Dereferences the value.

impl FillForwardFn<PrimitiveArray> for PrimitiveEncoding

fn fill_forward(&self, array: &PrimitiveArray) -> VortexResult<Array>

impl FillNullFn<PrimitiveArray> for PrimitiveEncoding

fn fill_null( &self, array: &PrimitiveArray, fill_value: Scalar, ) -> VortexResult<Array>

impl FilterFn<PrimitiveArray> for PrimitiveEncoding

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

Filter an array by the provided predicate.

impl<T: NativePType> FromIterator<T> for PrimitiveArray

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator.

impl IntoArray for PrimitiveArray

fn into_array(self) -> Array

impl PrimitiveArrayTrait for PrimitiveArray

fn ptype(&self) -> PType

The logical primitive type of the array.

impl ScalarAtFn<PrimitiveArray> for PrimitiveEncoding

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

impl SearchSortedFn<PrimitiveArray> for PrimitiveEncoding

fn search_sorted( &self, array: &PrimitiveArray, 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 SearchSortedUsizeFn<PrimitiveArray> for PrimitiveEncoding

fn search_sorted_usize( &self, array: &PrimitiveArray, value: usize, side: SearchSortedSide, ) -> VortexResult<SearchResult>

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

impl SliceFn<PrimitiveArray> for PrimitiveEncoding

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

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

Compute the requested statistic. Can return additional stats.

impl TakeFn<PrimitiveArray> for PrimitiveEncoding

fn take(&self, array: &PrimitiveArray, 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: &PrimitiveArray, indices: &Array, ) -> VortexResult<Array>

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

impl ToArrowFn<PrimitiveArray> for PrimitiveEncoding

fn to_arrow( &self, primitive_array: &PrimitiveArray, data_type: &DataType, ) -> VortexResult<Option<ArrayRef>>

Convert the array to an Arrow array of the given type.

fn preferred_arrow_data_type( &self, _array: &A, ) -> VortexResult<Option<DataType>>

Return the preferred Arrow DataType of the encoding, or None of the canonical DataType for the array’s Vortex vortex_dtype::DType should be used.

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

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 PrimitiveArray

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<PrimitiveArray> for PrimitiveEncoding

fn validate(&self, array: &PrimitiveArray) -> VortexResult<()>

impl ValidityVTable<PrimitiveArray> for PrimitiveEncoding

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

Returns whether the index item is valid.

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

Returns whether the array is all valid.

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

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

Returns the number of invalid elements in the array.

impl VariantsVTable<PrimitiveArray> for PrimitiveEncoding

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

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

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

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<PrimitiveArray> for PrimitiveEncoding

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