Struct arrow2::array::PrimitiveArray

pub struct PrimitiveArray<T: NativeType> { /* private fields */ }

A PrimitiveArray is Arrow’s semantically equivalent of an immutable Vec<Option<T>> where T is NativeType (e.g. i32). It implements Array.

One way to think about a PrimitiveArray is (DataType, Arc<Vec<T>>, Option<Arc<Vec<u8>>>) where:

• the first item is the array’s logical type
• the second is the immutable values
• the third is the immutable validity (whether a value is null or not as a bitmap).

The size of this struct is O(1), as all data is stored behind an std::sync::Arc.

Example

use arrow2::array::PrimitiveArray;
use arrow2::bitmap::Bitmap;
use arrow2::buffer::Buffer;

let array = PrimitiveArray::from([Some(1i32), None, Some(10)]);
assert_eq!(array.value(0), 1);
assert_eq!(array.iter().collect::<Vec<_>>(), vec![Some(&1i32), None, Some(&10)]);
assert_eq!(array.values_iter().copied().collect::<Vec<_>>(), vec![1, 0, 10]);
// the underlying representation
assert_eq!(array.values(), &Buffer::from(vec![1i32, 0, 10]));
assert_eq!(array.validity(), Some(&Bitmap::from([true, false, true])));

Implementations

impl<T: NativeType> PrimitiveArray<T>

pub fn try_new(
    data_type: DataType,
    values: Buffer<T>,
    validity: Option<Bitmap>
) -> Result<Self, Error>

The canonical method to create a PrimitiveArray out of its internal components.

Implementation

This function is O(1).

Errors

This function errors iff:

• The validity is not None and its length is different from values’s length
• The data_type’s PhysicalType is not equal to [PhysicalType::Primitive(T::PRIMITIVE)]

pub fn to(self, data_type: DataType) -> Self

Returns a new PrimitiveArray with a different logical type.

This function is useful to assign a different DataType to the array. Used to change the arrays’ logical type (see example).

Example

use arrow2::array::Int32Array;
use arrow2::datatypes::DataType;

let array = Int32Array::from(&[Some(1), None, Some(2)]).to(DataType::Date32);
assert_eq!(
   format!("{:?}", array),
   "Date32[1970-01-02, None, 1970-01-03]"
);

Panics

Panics iff the data_type’s PhysicalType is not equal to [PhysicalType::Primitive(T::PRIMITIVE)]

pub fn from_vec(values: Vec<T>) -> Self

Creates a (non-null) PrimitiveArray from a vector of values. This function is O(1).

Examples

use arrow2::array::PrimitiveArray;

let array = PrimitiveArray::from_vec(vec![1, 2, 3]);
assert_eq!(format!("{:?}", array), "Int32[1, 2, 3]");

pub fn iter(&self) -> ZipValidity<'_, &T, Iter<'_, T>>

Returns an iterator over the values and validity, Option<&T>.

pub fn values_iter(&self) -> Iter<'_, T>

Returns an iterator of the values, &T, ignoring the arrays’ validity.

pub fn len(&self) -> usize

Returns the length of this array

pub fn values(&self) -> &Buffer<T>

The values Buffer. Values on null slots are undetermined (they can be anything).

pub fn validity(&self) -> Option<&Bitmap>

Returns the optional validity.

pub fn data_type(&self) -> &DataType

Returns the arrays’ DataType.

pub fn value(&self, i: usize) -> T

Returns the value at slot i.

Equivalent to self.values()[i]. The value of a null slot is undetermined (it can be anything).

Panic

This function panics iff i >= self.len.

pub unsafe fn value_unchecked(&self, i: usize) -> T

Returns the value at index i. The value on null slots is undetermined (it can be anything).

Safety

Caller must be sure that i < self.len()

pub fn slice(&self, offset: usize, length: usize) -> Self

Returns a clone of this PrimitiveArray sliced by an offset and length.

Implementation

This operation is O(1) as it amounts to increase two ref counts.

Examples

use arrow2::array::PrimitiveArray;

let array = PrimitiveArray::from_vec(vec![1, 2, 3]);
assert_eq!(format!("{:?}", array), "Int32[1, 2, 3]");
let sliced = array.slice(1, 1);
assert_eq!(format!("{:?}", sliced), "Int32[2]");
// note: `sliced` and `array` share the same memory region.

Panic

This function panics iff offset + length > self.len().

pub unsafe fn slice_unchecked(&self, offset: usize, length: usize) -> Self

Returns a clone of this PrimitiveArray sliced by an offset and length.

Implementation

This operation is O(1) as it amounts to increase two ref counts.

Safety

The caller must ensure that offset + length <= self.len().

pub fn with_validity(self, validity: Option<Bitmap>) -> Self

Returns this PrimitiveArray with a new validity.

Panics

This function panics iff validity.len() != self.len().

pub fn set_validity(&mut self, validity: Option<Bitmap>)

Sets the validity of this PrimitiveArray.

Panics

This function panics iff validity.len() != self.len().

pub fn with_values(self, values: Buffer<T>) -> Self

Returns this PrimitiveArray with new values.

Panics

This function panics iff values.len() != self.len().

pub fn set_values(&mut self, values: Buffer<T>)

Update the values of this PrimitiveArray.

Panics

This function panics iff values.len() != self.len().

pub fn apply_validity<F: FnOnce(Bitmap) -> Bitmap>(&mut self, f: F)

Applies a function f to the validity of this array.

This is an API to leverage clone-on-write

Panics

This function panics if the function f modifies the length of the Bitmap.

pub fn get_mut_values(&mut self) -> Option<&mut [T]>

Returns an option of a mutable reference to the values of this PrimitiveArray.

pub fn into_mut(self) -> Either<Self, MutablePrimitiveArray<T>>

Try to convert this PrimitiveArray to a MutablePrimitiveArray via copy-on-write semantics.

A PrimitiveArray is backed by a Buffer and Bitmap which are essentially Arc<Vec<_>>. This function returns a MutablePrimitiveArray (via std::sync::Arc::get_mut) iff both values and validity have not been cloned / are unique references to their underlying vectors.

This function is primarily used to re-use memory regions.

pub fn new_empty(data_type: DataType) -> Self

Returns a new empty (zero-length) PrimitiveArray.

pub fn new_null(data_type: DataType, length: usize) -> Self

Returns a new PrimitiveArray where all slots are null / None.

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

Creates a (non-null) PrimitiveArray from an iterator of values.

Implementation

This does not assume that the iterator has a known length.

pub fn from_slice<P: AsRef<[T]>>(slice: P) -> Self

Creates a (non-null) PrimitiveArray from a slice of values.

Implementation

This is essentially a memcopy and is thus O(N)

pub fn from_trusted_len_values_iter<I: TrustedLen<Item = T>>(iter: I) -> Self

Creates a (non-null) PrimitiveArray from a TrustedLen of values.

Implementation

This does not assume that the iterator has a known length.

pub unsafe fn from_trusted_len_values_iter_unchecked<I: Iterator<Item = T>>(
    iter: I
) -> Self

Creates a new PrimitiveArray from an iterator over values

Safety

The iterator must be TrustedLen. I.e. that size_hint().1 correctly reports its length.

pub fn from_trusted_len_iter<I: TrustedLen<Item = Option<T>>>(iter: I) -> Self

Creates a PrimitiveArray from a TrustedLen of optional values.

pub unsafe fn from_trusted_len_iter_unchecked<I: Iterator<Item = Option<T>>>(
    iter: I
) -> Self

Creates a PrimitiveArray from an iterator of optional values.

Safety

The iterator must be TrustedLen. I.e. that size_hint().1 correctly reports its length.

pub fn boxed(self) -> Box<dyn Array>

Boxes self into a Box<dyn Array>.

pub fn arced(self) -> Arc<dyn Array>

Boxes self into a std::sync::Arc<dyn Array>.

pub fn new(
    data_type: DataType,
    values: Buffer<T>,
    validity: Option<Bitmap>
) -> Self

Alias for Self::try_new(..).unwrap().

Panics

This function errors iff:

• The validity is not None and its length is different from values’s length
• The data_type’s PhysicalType is not equal to PhysicalType::Primitive.

pub fn from_data(
    data_type: DataType,
    values: Buffer<T>,
    validity: Option<Bitmap>
) -> Self

Alias for Self::try_new(..).unwrap().

Trait Implementations

impl<T: NativeType> Array for PrimitiveArray<T>

fn as_any(&self) -> &dyn Any

Converts itself to a reference of Any, which enables downcasting to concrete types.

fn as_any_mut(&mut self) -> &mut dyn Any

Converts itself to a mutable reference of Any, which enables mutable downcasting to concrete types.

fn len(&self) -> usize

The length of the Array. Every array has a length corresponding to the number of elements (slots).

fn data_type(&self) -> &DataType

The DataType of the Array. In combination with Array::as_any, this can be used to downcast trait objects (dyn Array) to concrete arrays.

fn validity(&self) -> Option<&Bitmap>

The validity of the Array: every array has an optional Bitmap that, when available specifies whether the array slot is valid or not (null). When the validity is None, all slots are valid.

fn slice(&self, offset: usize, length: usize) -> Box<dyn Array>

Slices the Array, returning a new Box<dyn Array>.

unsafe fn slice_unchecked(&self, offset: usize, length: usize) -> Box<dyn Array>

Slices the Array, returning a new Box<dyn Array>.

fn with_validity(&self, validity: Option<Bitmap>) -> Box<dyn Array>

Clones this Array with a new new assigned bitmap.

fn to_boxed(&self) -> Box<dyn Array>

Clone a &dyn Array to an owned Box<dyn Array>.

fn is_empty(&self) -> bool

whether the array is empty

fn null_count(&self) -> usize

The number of null slots on this Array.

fn is_null(&self, i: usize) -> bool

Returns whether slot i is null.

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

Returns whether slot i is valid.

impl<T> ArrayAdd<PrimitiveArray<T>> for PrimitiveArray<T> where
    T: NativeArithmetics + Add<Output = T>, 

Available on crate feature compute_arithmetics only.

fn add(&self, rhs: &PrimitiveArray<T>) -> Self

Adds itself to rhs

impl ArrayAdd<PrimitiveArray<i128>> for PrimitiveArray<i128>

Available on crate feature compute_arithmetics only.

fn add(&self, rhs: &PrimitiveArray<i128>) -> Self

Adds itself to rhs

impl<T> ArrayAdd<T> for PrimitiveArray<T> where
    T: NativeArithmetics + Add<Output = T>, 

Available on crate feature compute_arithmetics only.

fn add(&self, rhs: &T) -> Self

Adds itself to rhs

impl<T> ArrayCheckedAdd<PrimitiveArray<T>> for PrimitiveArray<T> where
    T: NativeArithmetics + CheckedAdd<Output = T>, 

Available on crate feature compute_arithmetics only.

fn checked_add(&self, rhs: &PrimitiveArray<T>) -> Self

Checked add

impl ArrayCheckedAdd<PrimitiveArray<i128>> for PrimitiveArray<i128>

Available on crate feature compute_arithmetics only.

fn checked_add(&self, rhs: &PrimitiveArray<i128>) -> Self

Checked add

impl<T> ArrayCheckedAdd<T> for PrimitiveArray<T> where
    T: NativeArithmetics + CheckedAdd<Output = T>, 

Available on crate feature compute_arithmetics only.

fn checked_add(&self, rhs: &T) -> Self

Checked add

impl<T> ArrayCheckedDiv<PrimitiveArray<T>> for PrimitiveArray<T> where
    T: NativeArithmetics + CheckedDiv<Output = T>, 

Available on crate feature compute_arithmetics only.

fn checked_div(&self, rhs: &PrimitiveArray<T>) -> Self

checked division

impl ArrayCheckedDiv<PrimitiveArray<i128>> for PrimitiveArray<i128>

Available on crate feature compute_arithmetics only.

fn checked_div(&self, rhs: &PrimitiveArray<i128>) -> Self

checked division

impl<T> ArrayCheckedDiv<T> for PrimitiveArray<T> where
    T: NativeArithmetics + CheckedDiv<Output = T>, 

Available on crate feature compute_arithmetics only.

fn checked_div(&self, rhs: &T) -> Self

checked division

impl<T> ArrayCheckedMul<PrimitiveArray<T>> for PrimitiveArray<T> where
    T: NativeArithmetics + CheckedMul<Output = T>, 

Available on crate feature compute_arithmetics only.

fn checked_mul(&self, rhs: &PrimitiveArray<T>) -> Self

checked multiplication

impl ArrayCheckedMul<PrimitiveArray<i128>> for PrimitiveArray<i128>

Available on crate feature compute_arithmetics only.

fn checked_mul(&self, rhs: &PrimitiveArray<i128>) -> Self

checked multiplication

impl<T> ArrayCheckedMul<T> for PrimitiveArray<T> where
    T: NativeArithmetics + CheckedMul<Output = T>, 

Available on crate feature compute_arithmetics only.

fn checked_mul(&self, rhs: &T) -> Self

checked multiplication

impl<T> ArrayCheckedRem<PrimitiveArray<T>> for PrimitiveArray<T> where
    T: NativeArithmetics + CheckedRem<Output = T>, 

Available on crate feature compute_arithmetics only.

fn checked_rem(&self, rhs: &PrimitiveArray<T>) -> Self

checked remainder

impl<T> ArrayCheckedRem<T> for PrimitiveArray<T> where
    T: NativeArithmetics + CheckedRem<Output = T>, 

Available on crate feature compute_arithmetics only.

fn checked_rem(&self, rhs: &T) -> Self

checked remainder

impl<T> ArrayCheckedSub<PrimitiveArray<T>> for PrimitiveArray<T> where
    T: NativeArithmetics + CheckedSub<Output = T>, 

Available on crate feature compute_arithmetics only.

fn checked_sub(&self, rhs: &PrimitiveArray<T>) -> Self

checked subtraction

impl ArrayCheckedSub<PrimitiveArray<i128>> for PrimitiveArray<i128>

Available on crate feature compute_arithmetics only.

fn checked_sub(&self, rhs: &PrimitiveArray<i128>) -> Self

checked subtraction

impl<T> ArrayCheckedSub<T> for PrimitiveArray<T> where
    T: NativeArithmetics + CheckedSub<Output = T>, 

Available on crate feature compute_arithmetics only.

fn checked_sub(&self, rhs: &T) -> Self

checked subtraction

impl<T> ArrayDiv<PrimitiveArray<T>> for PrimitiveArray<T> where
    T: NativeArithmetics + Div<Output = T>, 

Available on crate feature compute_arithmetics only.

fn div(&self, rhs: &PrimitiveArray<T>) -> Self

division

impl ArrayDiv<PrimitiveArray<i128>> for PrimitiveArray<i128>

Available on crate feature compute_arithmetics only.

fn div(&self, rhs: &PrimitiveArray<i128>) -> Self

division

impl<T> ArrayDiv<T> for PrimitiveArray<T> where
    T: NativeArithmetics + Div<Output = T> + NumCast, 

Available on crate feature compute_arithmetics only.

fn div(&self, rhs: &T) -> Self

division

impl<T> ArrayMul<PrimitiveArray<T>> for PrimitiveArray<T> where
    T: NativeArithmetics + Mul<Output = T>, 

Available on crate feature compute_arithmetics only.

fn mul(&self, rhs: &PrimitiveArray<T>) -> Self

multiplication

impl ArrayMul<PrimitiveArray<i128>> for PrimitiveArray<i128>

Available on crate feature compute_arithmetics only.

fn mul(&self, rhs: &PrimitiveArray<i128>) -> Self

multiplication

impl<T> ArrayMul<T> for PrimitiveArray<T> where
    T: NativeArithmetics + Mul<Output = T>, 

Available on crate feature compute_arithmetics only.

fn mul(&self, rhs: &T) -> Self

multiplication

impl<T> ArrayOverflowingAdd<PrimitiveArray<T>> for PrimitiveArray<T> where
    T: NativeArithmetics + OverflowingAdd<Output = T>, 

Available on crate feature compute_arithmetics only.

fn overflowing_add(&self, rhs: &PrimitiveArray<T>) -> (Self, Bitmap)

Overflowing add

impl<T> ArrayOverflowingAdd<T> for PrimitiveArray<T> where
    T: NativeArithmetics + OverflowingAdd<Output = T>, 

Available on crate feature compute_arithmetics only.

fn overflowing_add(&self, rhs: &T) -> (Self, Bitmap)

Overflowing add

impl<T> ArrayOverflowingMul<PrimitiveArray<T>> for PrimitiveArray<T> where
    T: NativeArithmetics + OverflowingMul<Output = T>, 

Available on crate feature compute_arithmetics only.

fn overflowing_mul(&self, rhs: &PrimitiveArray<T>) -> (Self, Bitmap)

overflowing multiplication

impl<T> ArrayOverflowingMul<T> for PrimitiveArray<T> where
    T: NativeArithmetics + OverflowingMul<Output = T>, 

Available on crate feature compute_arithmetics only.

fn overflowing_mul(&self, rhs: &T) -> (Self, Bitmap)

overflowing multiplication

impl<T> ArrayOverflowingSub<PrimitiveArray<T>> for PrimitiveArray<T> where
    T: NativeArithmetics + OverflowingSub<Output = T>, 

Available on crate feature compute_arithmetics only.

fn overflowing_sub(&self, rhs: &PrimitiveArray<T>) -> (Self, Bitmap)

overflowing subtraction

impl<T> ArrayOverflowingSub<T> for PrimitiveArray<T> where
    T: NativeArithmetics + OverflowingSub<Output = T>, 

Available on crate feature compute_arithmetics only.

fn overflowing_sub(&self, rhs: &T) -> (Self, Bitmap)

overflowing subtraction

impl<T> ArrayRem<PrimitiveArray<T>> for PrimitiveArray<T> where
    T: NativeArithmetics + Rem<Output = T>, 

Available on crate feature compute_arithmetics only.

fn rem(&self, rhs: &PrimitiveArray<T>) -> Self

remainder

impl<T> ArrayRem<T> for PrimitiveArray<T> where
    T: NativeArithmetics + Rem<Output = T> + NumCast, 

Available on crate feature compute_arithmetics only.

fn rem(&self, rhs: &T) -> Self

remainder

impl<T> ArraySaturatingAdd<PrimitiveArray<T>> for PrimitiveArray<T> where
    T: NativeArithmetics + SaturatingAdd<Output = T>, 

Available on crate feature compute_arithmetics only.

fn saturating_add(&self, rhs: &PrimitiveArray<T>) -> Self

Saturating add

impl ArraySaturatingAdd<PrimitiveArray<i128>> for PrimitiveArray<i128>

Available on crate feature compute_arithmetics only.

fn saturating_add(&self, rhs: &PrimitiveArray<i128>) -> Self

Saturating add

impl<T> ArraySaturatingAdd<T> for PrimitiveArray<T> where
    T: NativeArithmetics + SaturatingAdd<Output = T>, 

Available on crate feature compute_arithmetics only.

fn saturating_add(&self, rhs: &T) -> Self

Saturating add

impl<T> ArraySaturatingMul<PrimitiveArray<T>> for PrimitiveArray<T> where
    T: NativeArithmetics + SaturatingMul<Output = T>, 

Available on crate feature compute_arithmetics only.

fn saturating_mul(&self, rhs: &PrimitiveArray<T>) -> Self

saturating multiplication

impl ArraySaturatingMul<PrimitiveArray<i128>> for PrimitiveArray<i128>

Available on crate feature compute_arithmetics only.

fn saturating_mul(&self, rhs: &PrimitiveArray<i128>) -> Self

saturating multiplication

impl<T> ArraySaturatingMul<T> for PrimitiveArray<T> where
    T: NativeArithmetics + SaturatingMul<Output = T>, 

Available on crate feature compute_arithmetics only.

fn saturating_mul(&self, rhs: &T) -> Self

saturating multiplication

impl<T> ArraySaturatingSub<PrimitiveArray<T>> for PrimitiveArray<T> where
    T: NativeArithmetics + SaturatingSub<Output = T>, 

Available on crate feature compute_arithmetics only.

fn saturating_sub(&self, rhs: &PrimitiveArray<T>) -> Self

saturarting subtraction

impl ArraySaturatingSub<PrimitiveArray<i128>> for PrimitiveArray<i128>

Available on crate feature compute_arithmetics only.

fn saturating_sub(&self, rhs: &PrimitiveArray<i128>) -> Self

saturarting subtraction

impl<T> ArraySaturatingSub<T> for PrimitiveArray<T> where
    T: NativeArithmetics + SaturatingSub<Output = T>, 

Available on crate feature compute_arithmetics only.

fn saturating_sub(&self, rhs: &T) -> Self

saturarting subtraction

impl<T> ArraySub<PrimitiveArray<T>> for PrimitiveArray<T> where
    T: NativeArithmetics + Sub<Output = T>, 

Available on crate feature compute_arithmetics only.

fn sub(&self, rhs: &PrimitiveArray<T>) -> Self

subtraction

impl ArraySub<PrimitiveArray<i128>> for PrimitiveArray<i128>

Available on crate feature compute_arithmetics only.

fn sub(&self, rhs: &PrimitiveArray<i128>) -> Self

subtraction

impl<T> ArraySub<T> for PrimitiveArray<T> where
    T: NativeArithmetics + Sub<Output = T>, 

Available on crate feature compute_arithmetics only.

fn sub(&self, rhs: &T) -> Self

subtraction

impl<T> ArrayWrappingAdd<PrimitiveArray<T>> for PrimitiveArray<T> where
    T: NativeArithmetics + WrappingAdd<Output = T>, 

Available on crate feature compute_arithmetics only.

fn wrapping_add(&self, rhs: &PrimitiveArray<T>) -> Self

Adds itself to rhs using wrapping addition

impl<T> ArrayWrappingMul<PrimitiveArray<T>> for PrimitiveArray<T> where
    T: NativeArithmetics + WrappingMul<Output = T>, 

Available on crate feature compute_arithmetics only.

fn wrapping_mul(&self, rhs: &PrimitiveArray<T>) -> Self

wrapping multiplication

impl<T> ArrayWrappingSub<PrimitiveArray<T>> for PrimitiveArray<T> where
    T: NativeArithmetics + WrappingSub<Output = T>, 

Available on crate feature compute_arithmetics only.

fn wrapping_sub(&self, rhs: &PrimitiveArray<T>) -> Self

wrapping subtraction

impl<T: Clone + NativeType> Clone for PrimitiveArray<T>

fn clone(&self) -> PrimitiveArray<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: NativeType> Debug for PrimitiveArray<T>

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

Formats the value using the given formatter.

impl<T: NativeType> Default for PrimitiveArray<T>

fn default() -> Self

Returns the “default value” for a type.

impl<'a, T: NativeType> From<GrowablePrimitive<'a, T>> for PrimitiveArray<T>

fn from(val: GrowablePrimitive<'a, T>) -> Self

Converts to this type from the input type.

impl<T: NativeType> From<MutablePrimitiveArray<T>> for PrimitiveArray<T>

fn from(other: MutablePrimitiveArray<T>) -> Self

Converts to this type from the input type.

impl<T: NativeType, P: AsRef<[Option<T>]>> From<P> for PrimitiveArray<T>

fn from(slice: P) -> Self

Converts to this type from the input type.

impl<T: NativeType, Ptr: Borrow<Option<T>>> FromIterator<Ptr> for PrimitiveArray<T>

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

Creates a value from an iterator.

impl<'a, T: NativeType> IntoIterator for &'a PrimitiveArray<T>

type Item = Option<&'a T>

The type of the elements being iterated over.

type IntoIter = ZipValidity<'a, &'a T, Iter<'a, T>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: NativeType> PartialEq<&(dyn Array + 'static)> for PrimitiveArray<T>

fn eq(&self, other: &&dyn Array) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: NativeType> PartialEq<PrimitiveArray<T>> for &dyn Array

fn eq(&self, other: &PrimitiveArray<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T: NativeType> PartialEq<PrimitiveArray<T>> for PrimitiveArray<T>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.