Struct PrimitiveArray

pub struct PrimitiveArray { /* private fields */ }

Implementations

impl PrimitiveArray

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

impl PrimitiveArray

pub fn top_value(&self) -> VortexResult<Option<(PValue, usize)>>

Compute most common present value of this array

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 map_each_with_validity<T, R, F>( self, f: F, ) -> VortexResult<PrimitiveArray>

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

Map each element in the array to a new value.

This doesn’t ignore validity and maps over all maybe-null elements, with a bool true if valid and false otherwise.

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 reinterpret_cast(&self, ptype: PType) -> Self

Trait Implementations

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

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

Returns the canonical representation of the array.

fn _append_to_builder(&self, builder: &mut dyn ArrayBuilder) -> VortexResult<()>

Writes the array into the canonical builder.

impl ArrayComputeImpl for PrimitiveArray

const FILTER: Option<KernelRef>

fn _find_kernel(&self, _compute_fn: &dyn ComputeFn) -> Option<KernelRef>

Fallback implementation to lookup compute kernels at runtime.

impl ArrayImpl for PrimitiveArray

type Encoding = PrimitiveEncoding

fn _len(&self) -> usize

fn _dtype(&self) -> &DType

fn _vtable(&self) -> VTableRef

fn _with_children(&self, children: &[ArrayRef]) -> VortexResult<Self>

Replace the children of this array with the given arrays.

impl ArrayStatisticsImpl for PrimitiveArray

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

impl ArrayValidityImpl for PrimitiveArray

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

Returns whether the index item is valid.

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

Returns whether the array is all valid.

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

Returns whether the array is all invalid.

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

Returns the canonical validity mask for the array.

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.

impl ArrayVariantsImpl for PrimitiveArray

fn _as_primitive_typed(&self) -> Option<&dyn PrimitiveArrayTrait>

Downcasts the array for primitive-specific behavior.

fn _as_null_typed(&self) -> Option<&dyn NullArrayTrait>

Downcasts the array for null-specific behavior.

fn _as_bool_typed(&self) -> Option<&dyn BoolArrayTrait>

Downcasts the array for bool-specific behavior.

fn _as_utf8_typed(&self) -> Option<&dyn Utf8ArrayTrait>

Downcasts the array for utf8-specific behavior.

fn _as_binary_typed(&self) -> Option<&dyn BinaryArrayTrait>

Downcasts the array for binary-specific behavior.

fn _as_struct_typed(&self) -> Option<&dyn StructArrayTrait>

Downcasts the array for struct-specific behavior.

fn _as_list_typed(&self) -> Option<&dyn ListArrayTrait>

Downcasts the array for list-specific behavior.

fn _as_extension_typed(&self) -> Option<&dyn ExtensionArrayTrait>

Downcasts the array for extension-specific behavior.

impl ArrayVisitorImpl for PrimitiveArray

fn _visit_buffers(&self, visitor: &mut dyn ArrayBufferVisitor)

fn _visit_children(&self, visitor: &mut dyn ArrayChildVisitor)

fn _metadata(&self) -> EmptyMetadata

fn _nbuffers(&self) -> usize

fn _nchildren(&self) -> usize

impl BetweenFn<&PrimitiveArray> for PrimitiveEncoding

fn between( &self, arr: &PrimitiveArray, lower: &dyn Array, upper: &dyn Array, options: &BetweenOptions, ) -> VortexResult<Option<ArrayRef>>

impl CastFn<&PrimitiveArray> for PrimitiveEncoding

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

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

impl FillNullFn<&PrimitiveArray> for PrimitiveEncoding

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

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

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

Creates a value from an iterator.

impl IsConstantFn<&PrimitiveArray> for PrimitiveEncoding

fn is_constant( &self, array: &PrimitiveArray, _opts: &IsConstantOpts, ) -> VortexResult<Option<bool>>

Preconditions

impl IsSortedFn<&PrimitiveArray> for PrimitiveEncoding

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

Preconditions

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

impl MaskFn<&PrimitiveArray> for PrimitiveEncoding

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

Replace masked values with null in array.

impl MinMaxFn<&PrimitiveArray> for PrimitiveEncoding

fn min_max(&self, array: &PrimitiveArray) -> VortexResult<Option<MinMaxResult>>

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

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

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

Preconditions

impl TakeFn<&PrimitiveArray> for PrimitiveEncoding

fn take( &self, array: &PrimitiveArray, indices: &dyn Array, ) -> VortexResult<ArrayRef>

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

fn take_into( &self, array: &PrimitiveArray, indices: &dyn Array, builder: &mut dyn ArrayBuilder, ) -> VortexResult<()>

Has the same semantics as Self::take but materializes the result into the provided builder.

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 TryFrom<Arc<dyn Array>> for PrimitiveArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: ArrayRef) -> Result<Self, Self::Error>

Performs the conversion.

impl UncompressedSizeFn<&PrimitiveArray> for PrimitiveEncoding

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

Compute the approximated uncompressed size of the array, in bytes.