Struct 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 polars_arrow::array::BooleanArray;
use polars_arrow::bitmap::Bitmap;
use polars_arrow::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( dtype: ArrowDataType, values: Bitmap, validity: Option<Bitmap>, ) -> PolarsResult<Self>

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 dtype’s PhysicalType is not equal to PhysicalType::Boolean.

pub fn new( dtype: ArrowDataType, values: Bitmap, validity: Option<Bitmap>, ) -> Self

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

pub fn iter(&self) -> ZipValidity<bool, BitmapIter<'_>, 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 non_null_values_iter(&self) -> NonNullValuesIter<'_, BooleanArray>

Returns an iterator of the non-null values.

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 dtype(&self) -> &ArrowDataType

Returns the arrays’ ArrowDataType.

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

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

Slices 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 sliced(self, offset: usize, length: usize) -> Self

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

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

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 take_validity(&mut self) -> Option<Bitmap>

Takes the validity of this array, leaving it without a validity mask.

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: 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(dtype: ArrowDataType) -> Self

Returns a new empty BooleanArray.

pub fn new_null(dtype: ArrowDataType, 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 into_inner(self) -> (ArrowDataType, Bitmap, Option<Bitmap>)

Returns its internal representation

pub unsafe fn from_inner_unchecked( dtype: ArrowDataType, values: Bitmap, validity: Option<Bitmap>, ) -> Self

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

Safety

Callers must ensure all invariants of this struct are upheld.

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 dtype(&self) -> &ArrowDataType

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

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

Split Self at offset into two boxed Arrays where offset <= self.len().

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

Split Self at offset into two boxed Arrays without checking offset <= self.len().

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 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 has_nulls(&self) -> bool

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<'a> ArrayAccessor<'a> for BooleanArray

type Item = bool

unsafe fn value_unchecked(&'a self, index: usize) -> Self::Item

Safety

fn len(&self) -> usize

impl ArrayFromIter<Option<bool>> for BooleanArray

fn arr_from_iter<I: IntoIterator<Item = Option<bool>>>(iter: I) -> Self

fn try_arr_from_iter<E, I: IntoIterator<Item = Result<Option<bool>, E>>>( iter: I, ) -> Result<Self, E>

fn arr_from_iter_trusted<I>(iter: I) -> Self

where I: IntoIterator<Item = T>, I::IntoIter: TrustedLen,

fn try_arr_from_iter_trusted<E, I>(iter: I) -> Result<Self, E>

where I: IntoIterator<Item = Result<T, E>>, I::IntoIter: TrustedLen,

impl ArrayFromIter<bool> for BooleanArray

fn arr_from_iter<I: IntoIterator<Item = bool>>(iter: I) -> Self

fn try_arr_from_iter<E, I: IntoIterator<Item = Result<bool, E>>>( iter: I, ) -> Result<Self, E>

fn arr_from_iter_trusted<I>(iter: I) -> Self

where I: IntoIterator<Item = T>, I::IntoIter: TrustedLen,

fn try_arr_from_iter_trusted<E, I>(iter: I) -> Result<Self, E>

where I: IntoIterator<Item = Result<T, E>>, I::IntoIter: TrustedLen,

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 From<Bitmap> for BooleanArray

fn from(values: Bitmap) -> Self

Converts to this type from the input type.

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 FromData<Bitmap> for BooleanArray

fn from_data_default(values: Bitmap, validity: Option<Bitmap>) -> BooleanArray

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 FromIteratorReversed<Option<bool>> for BooleanArray

fn from_trusted_len_iter_rev<I: TrustedLen<Item = Option<bool>>>( iter: I, ) -> Self

impl FromIteratorReversed<bool> for BooleanArray

fn from_trusted_len_iter_rev<I: TrustedLen<Item = bool>>(iter: I) -> Self

impl FromTrustedLenIterator<Option<bool>> for BooleanArray

fn from_iter_trusted_length<I: IntoIterator<Item = Option<bool>>>( iter: I, ) -> Self

where I::IntoIter: TrustedLen,

impl FromTrustedLenIterator<bool> for BooleanArray

fn from_iter_trusted_length<I: IntoIterator<Item = bool>>(iter: I) -> Self

where I::IntoIter: TrustedLen,

impl<'a> IntoIterator for &'a BooleanArray

type Item = Option<bool>

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for BooleanArray

type Item = Option<bool>

The type of the elements being iterated over.

type IntoIter = ZipValidity<bool, IntoIter, IntoIter>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl ParameterFreeDtypeStaticArray for BooleanArray

fn get_dtype() -> ArrowDataType

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

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for BooleanArray

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Splitable for BooleanArray

fn check_bound(&self, offset: usize) -> bool

unsafe fn _split_at_unchecked(&self, offset: usize) -> (Self, Self)

Internal implementation of split_at_unchecked. For any usage, prefer the using split_at or split_at_unchecked.

fn split_at(&self, offset: usize) -> (Self, Self)

Split Self at offset where offset <= self.len().

unsafe fn split_at_unchecked(&self, offset: usize) -> (Self, Self)

Split Self at offset without checking offset <= self.len().

impl StaticArray for BooleanArray

type ValueT<'a> = bool

type ZeroableValueT<'a> = bool

type ValueIterT<'a> = BitmapIter<'a>

unsafe fn value_unchecked(&self, idx: usize) -> Self::ValueT<'_>

Safety

fn values_iter(&self) -> Self::ValueIterT<'_>

fn iter( &self, ) -> ZipValidity<Self::ValueT<'_>, Self::ValueIterT<'_>, BitmapIter<'_>>

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

fn from_vec(v: Vec<Self::ValueT<'_>>, _dtype: ArrowDataType) -> Self

fn from_zeroable_vec(v: Vec<Self::ValueT<'_>>, _dtype: ArrowDataType) -> Self

fn full_null(length: usize, dtype: ArrowDataType) -> Self

fn full(length: usize, value: Self::ValueT<'_>, _dtype: ArrowDataType) -> Self

fn get(&self, idx: usize) -> Option<Self::ValueT<'_>>

unsafe fn get_unchecked(&self, idx: usize) -> Option<Self::ValueT<'_>>

Safety

fn last(&self) -> Option<Self::ValueT<'_>>

fn value(&self, idx: usize) -> Self::ValueT<'_>

fn as_slice(&self) -> Option<&[Self::ValueT<'_>]>

impl ArrowArray for BooleanArray