Struct arrow2::array::BooleanArray
source · [−]pub struct BooleanArray { /* private fields */ }
Expand description
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
sourceimpl BooleanArray
impl BooleanArray
sourcepub fn try_new(
data_type: DataType,
values: Bitmap,
validity: Option<Bitmap>
) -> Result<Self, Error>
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 fromvalues
’s length - The
data_type
’sPhysicalType
is not equal toPhysicalType::Boolean
.
sourcepub fn iter(&self) -> ZipValidity<'_, bool, BitmapIter<'_>>ⓘNotable traits for ZipValidity<'a, T, I>impl<'a, T, I: Iterator<Item = T>> Iterator for ZipValidity<'a, T, I> type Item = Option<T>;
pub fn iter(&self) -> ZipValidity<'_, bool, BitmapIter<'_>>ⓘNotable traits for ZipValidity<'a, T, I>impl<'a, T, I: Iterator<Item = T>> Iterator for ZipValidity<'a, T, I> type Item = Option<T>;
Returns an iterator over the optional values of this BooleanArray
.
sourcepub fn values_iter(&self) -> BitmapIter<'_>ⓘNotable traits for BitmapIter<'a>impl<'a> Iterator for BitmapIter<'a> type Item = bool;
pub fn values_iter(&self) -> BitmapIter<'_>ⓘNotable traits for BitmapIter<'a>impl<'a> Iterator for BitmapIter<'a> type Item = bool;
Returns an iterator over the values of this BooleanArray
.
sourcepub fn values(&self) -> &Bitmap
pub fn values(&self) -> &Bitmap
The values Bitmap
.
Values on null slots are undetermined (they can be anything).
sourcepub unsafe fn value_unchecked(&self, i: usize) -> bool
pub unsafe fn value_unchecked(&self, i: usize) -> bool
sourcepub fn slice(&self, offset: usize, length: usize) -> Self
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()
.
sourcepub unsafe fn slice_unchecked(&self, offset: usize, length: usize) -> Self
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()
.
sourcepub fn with_validity(self, validity: Option<Bitmap>) -> Self
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()
.
sourcepub fn set_validity(&mut self, validity: Option<Bitmap>)
pub fn set_validity(&mut self, validity: Option<Bitmap>)
sourcepub fn with_values(&self, values: Bitmap) -> Self
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()
.
sourcepub fn set_values(&mut self, values: Bitmap)
pub fn set_values(&mut self, values: Bitmap)
sourcepub fn apply_values_mut<F: Fn(&mut MutableBitmap)>(&mut self, f: F)
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
.
sourcepub fn into_mut(self) -> Either<Self, MutableBooleanArray>ⓘNotable traits for Either<L, R>impl<L, R> Future for Either<L, R>where
L: Future,
R: Future<Output = <L as Future>::Output>, type Output = <L as Future>::Output;impl<L, R> Iterator for Either<L, R>where
L: Iterator,
R: Iterator<Item = <L as Iterator>::Item>, type Item = <L as Iterator>::Item;impl<L, R> Write for Either<L, R>where
L: Write,
R: Write,impl<L, R> Read for Either<L, R>where
L: Read,
R: Read,
pub fn into_mut(self) -> Either<Self, MutableBooleanArray>ⓘNotable traits for Either<L, R>impl<L, R> Future for Either<L, R>where
L: Future,
R: Future<Output = <L as Future>::Output>, type Output = <L as Future>::Output;impl<L, R> Iterator for Either<L, R>where
L: Iterator,
R: Iterator<Item = <L as Iterator>::Item>, type Item = <L as Iterator>::Item;impl<L, R> Write for Either<L, R>where
L: Write,
R: Write,impl<L, R> Read for Either<L, R>where
L: Read,
R: Read,
L: Future,
R: Future<Output = <L as Future>::Output>, type Output = <L as Future>::Output;impl<L, R> Iterator for Either<L, R>where
L: Iterator,
R: Iterator<Item = <L as Iterator>::Item>, type Item = <L as Iterator>::Item;impl<L, R> Write for Either<L, R>where
L: Write,
R: Write,impl<L, R> Read for Either<L, R>where
L: Read,
R: Read,
Try to convert this BooleanArray
to a MutableBooleanArray
sourcepub fn new_empty(data_type: DataType) -> Self
pub fn new_empty(data_type: DataType) -> Self
Returns a new empty BooleanArray
.
sourcepub fn new_null(data_type: DataType, length: usize) -> Self
pub fn new_null(data_type: DataType, length: usize) -> Self
Returns a new BooleanArray
whose all slots are null / None
.
sourcepub fn from_trusted_len_values_iter<I: TrustedLen<Item = bool>>(
iterator: I
) -> Self
pub fn from_trusted_len_values_iter<I: TrustedLen<Item = bool>>(
iterator: I
) -> Self
Creates a new BooleanArray
from an TrustedLen
of bool
.
sourcepub unsafe fn from_trusted_len_values_iter_unchecked<I: Iterator<Item = bool>>(
iterator: I
) -> Self
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.
sourcepub fn from_slice<P: AsRef<[bool]>>(slice: P) -> Self
pub fn from_slice<P: AsRef<[bool]>>(slice: P) -> Self
Creates a new BooleanArray
from a slice of bool
.
sourcepub unsafe fn from_trusted_len_iter_unchecked<I, P>(iterator: I) -> Selfwhere
P: Borrow<bool>,
I: Iterator<Item = Option<P>>,
pub unsafe fn from_trusted_len_iter_unchecked<I, P>(iterator: I) -> Selfwhere
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.
sourcepub fn from_trusted_len_iter<I, P>(iterator: I) -> Selfwhere
P: Borrow<bool>,
I: TrustedLen<Item = Option<P>>,
pub fn from_trusted_len_iter<I, P>(iterator: I) -> Selfwhere
P: Borrow<bool>,
I: TrustedLen<Item = Option<P>>,
Creates a BooleanArray
from a TrustedLen
.
sourcepub 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>>,
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.
sourcepub 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>>,
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
.
sourcepub fn boxed(self) -> Box<dyn Array>
pub fn boxed(self) -> Box<dyn Array>
Boxes self into a Box<dyn Array>
.
sourcepub fn arced(self) -> Arc<dyn Array>
pub fn arced(self) -> Arc<dyn Array>
Boxes self into a std::sync::Arc<dyn Array>
.
sourcepub fn new(data_type: DataType, values: Bitmap, validity: Option<Bitmap>) -> Self
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 fromvalues
’s length - The
data_type
’sPhysicalType
is not equal toPhysicalType::Boolean
.
Trait Implementations
sourceimpl Array for BooleanArray
impl Array for BooleanArray
sourcefn as_any(&self) -> &dyn Any
fn as_any(&self) -> &dyn Any
Converts itself to a reference of Any
, which enables downcasting to concrete types.
sourcefn as_any_mut(&mut self) -> &mut dyn Any
fn as_any_mut(&mut self) -> &mut dyn Any
Converts itself to a mutable reference of Any
, which enables mutable downcasting to concrete types.
sourcefn data_type(&self) -> &DataType
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. Read more
sourcefn null_count(&self) -> usize
fn null_count(&self) -> usize
sourceimpl Clone for BooleanArray
impl Clone for BooleanArray
sourcefn clone(&self) -> BooleanArray
fn clone(&self) -> BooleanArray
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for BooleanArray
impl Debug for BooleanArray
sourceimpl<'a> From<GrowableBoolean<'a>> for BooleanArray
impl<'a> From<GrowableBoolean<'a>> for BooleanArray
sourcefn from(val: GrowableBoolean<'a>) -> Self
fn from(val: GrowableBoolean<'a>) -> Self
Converts to this type from the input type.
sourceimpl From<MutableBooleanArray> for BooleanArray
impl From<MutableBooleanArray> for BooleanArray
sourcefn from(other: MutableBooleanArray) -> Self
fn from(other: MutableBooleanArray) -> Self
Converts to this type from the input type.
sourceimpl<Ptr: Borrow<Option<bool>>> FromIterator<Ptr> for BooleanArray
impl<Ptr: Borrow<Option<bool>>> FromIterator<Ptr> for BooleanArray
sourcefn from_iter<I: IntoIterator<Item = Ptr>>(iter: I) -> Self
fn from_iter<I: IntoIterator<Item = Ptr>>(iter: I) -> Self
Creates a value from an iterator. Read more
sourceimpl<'a> IntoIterator for &'a BooleanArray
impl<'a> IntoIterator for &'a BooleanArray
sourceimpl PartialEq<&(dyn Array + 'static)> for BooleanArray
impl PartialEq<&(dyn Array + 'static)> for BooleanArray
sourceimpl PartialEq<BooleanArray> for BooleanArray
impl PartialEq<BooleanArray> for BooleanArray
Auto Trait Implementations
impl RefUnwindSafe for BooleanArray
impl Send for BooleanArray
impl Sync for BooleanArray
impl Unpin for BooleanArray
impl UnwindSafe for BooleanArray
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more