Struct arrow2::array::BooleanArray

pub struct BooleanArray { /* private fields */ }

A BooleanArray is Arrow’s semantically equivalent of an immutable Vec<Option<bool>>. It implements Array.

One way to think about a BooleanArray is (DataType, Arc<Vec<u8>>, 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::BooleanArray;
use arrow2::bitmap::Bitmap;
use arrow2::buffer::Buffer;

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

Implementations

impl BooleanArray

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

The canonical method to create a BooleanArray out of low-end APIs.

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::Boolean.

pub fn iter(&self) -> ZipValidity<'_, bool, BitmapIter<'_>>

Returns an iterator over the optional values of this BooleanArray.

pub fn values_iter(&self) -> BitmapIter<'_>

Returns an iterator over the values of this BooleanArray.

pub fn len(&self) -> usize

Returns the length of this array

pub fn values(&self) -> &Bitmap

The values Bitmap. 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) -> bool

Returns the value at index i

Panic

This function panics iff i >= self.len().

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

Returns the element at index i as bool

Safety

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

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

Returns a slice of this BooleanArray.

Implementation

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

Panic

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

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

Returns a slice of this BooleanArray.

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 BooleanArray with a new validity.

Panic

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

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

Sets the validity of this BooleanArray.

Panics

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

pub fn with_values(&self, values: Bitmap) -> Self

Returns a clone of this BooleanArray with new values.

Panics

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

pub fn set_values(&mut self, values: Bitmap)

Sets the values of this BooleanArray.

Panics

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

pub fn apply_values_mut<F: Fn(&mut MutableBitmap)>(&mut self, f: F)

Applies a function f to the values of this array, cloning the values iff they are being shared with others

This is an API to use clone-on-write

Implementation

This function is O(f) if the data is not being shared, and O(N) + O(f) if it is being shared (since it results in a O(N) memcopy).

Panics

This function panics if the function modifies the length of the MutableBitmap.

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

Try to convert this BooleanArray to a MutableBooleanArray

pub fn new_empty(data_type: DataType) -> Self

Returns a new empty BooleanArray.

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

Returns a new BooleanArray whose all slots are null / None.

pub fn from_trusted_len_values_iter<I: TrustedLen<Item = bool>>(
    iterator: I
) -> Self

Creates a new BooleanArray from an TrustedLen of bool.

pub unsafe fn from_trusted_len_values_iter_unchecked<I: Iterator<Item = bool>>(
    iterator: I
) -> Self

Creates a new BooleanArray from an TrustedLen of bool. Use this over BooleanArray::from_trusted_len_iter when the iterator is trusted len but this crate does not mark it as such.

Safety

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

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

Creates a new BooleanArray from a slice of bool.

pub unsafe fn from_trusted_len_iter_unchecked<I, P>(iterator: I) -> Self where
    P: Borrow<bool>,
    I: Iterator<Item = Option<P>>, 

Creates a BooleanArray from an iterator of trusted length. Use this over BooleanArray::from_trusted_len_iter when the iterator is trusted len but this crate does not mark it as such.

Safety

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

pub fn from_trusted_len_iter<I, P>(iterator: I) -> Self where
    P: Borrow<bool>,
    I: TrustedLen<Item = Option<P>>, 

Creates a BooleanArray from a TrustedLen.

pub unsafe fn try_from_trusted_len_iter_unchecked<E, I, P>(
    iterator: I
) -> Result<Self, E> where
    P: Borrow<bool>,
    I: Iterator<Item = Result<Option<P>, E>>, 

Creates a BooleanArray from an falible iterator of trusted length.

Safety

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

pub fn try_from_trusted_len_iter<E, I, P>(iterator: I) -> Result<Self, E> where
    P: Borrow<bool>,
    I: TrustedLen<Item = Result<Option<P>, E>>, 

Creates a BooleanArray from a TrustedLen.

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: Bitmap, validity: Option<Bitmap>) -> Self

The canonical method to create a BooleanArray

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::Boolean.

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

Alias for new

Trait Implementations

impl Array for BooleanArray

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 Clone for BooleanArray

fn clone(&self) -> BooleanArray

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BooleanArray

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

Formats the value using the given formatter.

impl<'a> From<GrowableBoolean<'a>> for BooleanArray

fn from(val: GrowableBoolean<'a>) -> Self

Converts to this type from the input type.

impl From<MutableBooleanArray> for BooleanArray

fn from(other: MutableBooleanArray) -> Self

Converts to this type from the input type.

impl<P: AsRef<[Option<bool>]>> From<P> for BooleanArray

fn from(slice: P) -> Self

Converts to this type from the input type.

impl<Ptr: Borrow<Option<bool>>> FromIterator<Ptr> for BooleanArray

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

Creates a value from an iterator.

impl<'a> IntoIterator for &'a BooleanArray

type Item = Option<bool>

The type of the elements being iterated over.

type IntoIter = ZipValidity<'a, bool, BitmapIter<'a>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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

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

impl PartialEq<BooleanArray> for BooleanArray

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