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

Trait Implementations

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

fn array_len(&self) -> usize

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

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

fn array_validity(&self) -> Validity

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

fn as_ref(&self) -> &ArrayData

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

impl CastFn<PrimitiveArray> for PrimitiveEncoding

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

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

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

impl FillNullFn<PrimitiveArray> for PrimitiveEncoding

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

impl FilterFn<PrimitiveArray> for PrimitiveEncoding

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

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

fn into_array(self) -> ArrayData

impl IntoCanonical for PrimitiveArray

fn into_canonical(self) -> VortexResult<Canonical>

fn into_arrow(self) -> VortexResult<ArrayRef>

where Self: Sized,

fn into_arrow_with_data_type( self, data_type: &DataType, ) -> VortexResult<ArrayRef>

where Self: Sized,

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: &Array, 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: &Array, values: &[usize], side: SearchSortedSide, ) -> VortexResult<Vec<SearchResult>>

impl SliceFn<PrimitiveArray> for PrimitiveEncoding

fn slice( &self, array: &PrimitiveArray, 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<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: &ArrayData, ) -> VortexResult<ArrayData>

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

unsafe fn take_unchecked( &self, array: &PrimitiveArray, indices: &ArrayData, ) -> VortexResult<ArrayData>

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

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

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 PrimitiveArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(data: ArrayData) -> 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) -> bool

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

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

impl ArrayTrait for PrimitiveArray