Struct re_viewer::external::arrow2::array::PrimitiveArray

pub struct PrimitiveArray<T>
where
    T: NativeType,
{
    data_type: DataType,
    values: Buffer<T>,
    validity: Option<Bitmap>,
}

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 re_arrow2::array::PrimitiveArray;
use re_arrow2::bitmap::Bitmap;
use re_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])));

Fields

data_type: DataType

values: Buffer<T>

validity: Option<Bitmap>

Implementations

impl<T> PrimitiveArray<T>

where T: NativeType,

pub fn try_new( data_type: DataType, values: Buffer<T>, validity: Option<Bitmap> ) -> Result<PrimitiveArray<T>, 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) -> PrimitiveArray<T>

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 re_arrow2::array::Int32Array;
use re_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>) -> PrimitiveArray<T>

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

Examples

use re_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>, BitmapIter<'_>>

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 get(&self, i: usize) -> Option<T>

Returns the element at index i or None if it is null

Panics

iff i >= self.len()

pub fn slice(&mut self, offset: usize, length: usize)

Slices this PrimitiveArray by an offset and length.

Implementation

This operation is O(1).

pub unsafe fn slice_unchecked(&mut self, offset: usize, length: usize)

Slices this PrimitiveArray by an offset and length.

Implementation

This operation is O(1).

Safety

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

pub fn sliced(self, offset: usize, length: usize) -> PrimitiveArray<T>

Returns this array sliced.

Implementation

This function is O(1).

Panics

iff offset + length > self.len().

pub unsafe fn sliced_unchecked( self, offset: usize, length: usize ) -> PrimitiveArray<T>

Returns this array sliced.

Implementation

This function is O(1).

Safety

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

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

Returns this array with a new validity.

Panic

Panics iff validity.len() != self.len().

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

Sets the validity of this array.

Panics

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

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

Boxes this array into a Box<dyn Array>.

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

Arcs this array into a std::sync::Arc<dyn Array>.

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

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>(&mut self, f: F)

where F: FnOnce(Bitmap) -> Bitmap,

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_inner(self) -> (DataType, Buffer<T>, Option<Bitmap>)

Returns its internal representation

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

Creates a [PrimitiveArray] from its internal representation. This is the inverted from [PrimitiveArray::into_inner]

pub unsafe fn from_inner_unchecked( data_type: DataType, values: Buffer<T>, validity: Option<Bitmap> ) -> PrimitiveArray<T>

Creates a [PrimitiveArray] from its internal representation. This is the inverted from [PrimitiveArray::into_inner]

Safety

Callers must ensure all invariants of this struct are upheld.

pub fn into_mut(self) -> Either<PrimitiveArray<T>, 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) -> PrimitiveArray<T>

Returns a new empty (zero-length) PrimitiveArray.

pub fn new_null(data_type: DataType, length: usize) -> PrimitiveArray<T>

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

pub fn from_values<I>(iter: I) -> PrimitiveArray<T>

where I: IntoIterator<Item = T>,

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>(slice: P) -> PrimitiveArray<T>

where P: AsRef<[T]>,

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>(iter: I) -> PrimitiveArray<T>

where I: TrustedLen<Item = T>,

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>( iter: I ) -> PrimitiveArray<T>

where I: Iterator<Item = T>,

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>(iter: I) -> PrimitiveArray<T>

where I: TrustedLen<Item = Option<T>>,

Creates a PrimitiveArray from a TrustedLen of optional values.

pub unsafe fn from_trusted_len_iter_unchecked<I>(iter: I) -> PrimitiveArray<T>

where I: Iterator<Item = Option<T>>,

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 new( data_type: DataType, values: Buffer<T>, validity: Option<Bitmap> ) -> PrimitiveArray<T>

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.

Trait Implementations

impl<T> Arrow2Arrow for PrimitiveArray<T>

where T: NativeType,

fn to_data(&self) -> ArrayData

Convert this Array into [ArrayData]

fn from_data(data: &ArrayData) -> PrimitiveArray<T>

Create this Array from [ArrayData]

impl<T> Array for PrimitiveArray<T>

where T: NativeType,

fn as_any(&self) -> &(dyn Any + 'static)

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

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

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 slice(&mut self, offset: usize, length: usize)

Slices this Array.

unsafe fn slice_unchecked(&mut self, offset: usize, length: usize)

Slices the Array.

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

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

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 with_validity(&self, validity: Option<Bitmap>) -> Box<dyn Array>

Clones this Array with a new new assigned bitmap.

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.

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

Returns whether slot i is null.

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

Returns whether slot i is valid.

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

Returns a slice of this Array.

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

Returns a slice of this Array.

impl<T> Clone for PrimitiveArray<T>

where T: Clone + NativeType,

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> Debug for PrimitiveArray<T>

where T: NativeType,

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

Formats the value using the given formatter.

impl<T> Default for PrimitiveArray<T>

where T: NativeType,

fn default() -> PrimitiveArray<T>

Returns the “default value” for a type.

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

where T: NativeType,

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

Converts to this type from the input type.

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

where T: NativeType,

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

Converts to this type from the input type.

impl<T, P> From<P> for PrimitiveArray<T>

where T: NativeType, P: AsRef<[Option<T>]>,

fn from(slice: P) -> PrimitiveArray<T>

Converts to this type from the input type.

impl<T, Ptr> FromIterator<Ptr> for PrimitiveArray<T>

where T: NativeType, Ptr: Borrow<Option<T>>,

fn from_iter<I>(iter: I) -> PrimitiveArray<T>

where I: IntoIterator<Item = Ptr>,

Creates a value from an iterator.

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

where T: NativeType,

type Item = Option<&'a T>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a PrimitiveArray<T> as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<T> IntoIterator for PrimitiveArray<T>

where T: NativeType,

type Item = Option<T>

The type of the elements being iterated over.

type IntoIter = ZipValidity<T, IntoIter<T>, IntoIter>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <PrimitiveArray<T> as IntoIterator>::IntoIter

Creates an iterator from a value.

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

where T: NativeType,

fn eq(&self, other: &&(dyn Array + 'static)) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

where T: NativeType,

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> PartialEq for PrimitiveArray<T>

where T: NativeType,

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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> SizeBytes for PrimitiveArray<T>

where T: SizeBytes + NativeType,

fn heap_size_bytes(&self) -> u64

Returns the total size of self on the heap, in bytes.

fn total_size_bytes(&self) -> u64

Returns the total size of self in bytes, accounting for both stack and heap space.

fn stack_size_bytes(&self) -> u64

Returns the total size of self on the stack, in bytes.

fn is_pod() -> bool

Is Self just plain old data?