Struct BoolArray

pub struct BoolArray { /* private fields */ }

Implementations

impl BoolArray

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

impl BoolArray

pub fn buffer(&self) -> &Buffer

Access internal array buffer

pub fn into_buffer(self) -> Buffer

Convert array into its internal buffer

pub fn boolean_buffer(&self) -> BooleanBuffer

Get array values as an arrow BooleanBuffer

pub fn into_boolean_builder(self) -> (BooleanBufferBuilder, usize)

Get a mutable version of this array.

If the caller holds the only reference to the underlying buffer the underlying buffer is returned otherwise a copy is created.

The second value of the tuple is a bit_offset of first value in first byte of the returned builder

pub fn validity(&self) -> Validity

pub fn try_new(buffer: BooleanBuffer, validity: Validity) -> VortexResult<Self>

pub fn from_vec(bools: Vec<bool>, validity: Validity) -> Self

pub fn patch<P: AsPrimitive<usize>>( self, positions: &[P], values: BoolArray, ) -> VortexResult<Self>

Trait Implementations

impl AcceptArrayVisitor for BoolArray

fn accept(&self, visitor: &mut dyn ArrayVisitor) -> VortexResult<()>

impl AndFn for BoolArray

fn and(&self, array: &Array) -> VortexResult<Array>

Point-wise logical and between two Boolean arrays.

fn and_kleene(&self, array: &Array) -> VortexResult<Array>

Point-wise Kleene logical and between two Boolean arrays.

impl ArrayAccessor<bool> for BoolArray

fn with_iterator<F, R>(&self, f: F) -> VortexResult<R>

where F: for<'a> FnOnce(&mut dyn Iterator<Item = Option<&'a bool>>) -> R,

Iterate over each element of the array, in-order.

impl ArrayCompute for BoolArray

fn fill_forward(&self) -> Option<&dyn FillForwardFn>

Array function that returns new arrays a non-null value is repeated across runs of nulls.

fn scalar_at(&self) -> Option<&dyn ScalarAtFn>

Single item indexing on Vortex arrays.

fn slice(&self) -> Option<&dyn SliceFn>

Perform zero-copy slicing of an array.

fn take(&self) -> Option<&dyn TakeFn>

Take a set of indices from an array. This often forces allocations and decoding of the receiver.

fn and(&self) -> Option<&dyn AndFn>

Perform an Arrow-style boolean AND operation over two arrays

fn or(&self) -> Option<&dyn OrFn>

Perform an Arrow-style boolean OR operation over two arrays

fn cast(&self) -> Option<&dyn CastFn>

Implemented for arrays that can be casted to different types.

fn compare( &self, _other: &Array, _operator: Operator, ) -> Option<VortexResult<Array>>

Binary operator implementation for arrays against other arrays.

fn filter(&self) -> Option<&dyn FilterFn>

Filtering function on arrays of predicates.

fn subtract_scalar(&self) -> Option<&dyn SubtractScalarFn>

Broadcast subtraction of scalar from Vortex array.

fn search_sorted(&self) -> Option<&dyn SearchSortedFn>

Perform a search over an ordered array.

fn and_kleene(&self) -> Option<&dyn AndFn>

Perform a Kleene-style boolean AND operation over two arrays

fn or_kleene(&self) -> Option<&dyn OrFn>

Perform a Kleene-style boolean OR operation over two arrays

impl ArrayStatisticsCompute for BoolArray

fn compute_statistics(&self, stat: Stat) -> VortexResult<StatsSet>

Compute the requested statistic. Can return additional stats.

impl ArrayTrait for BoolArray

fn nbytes(&self) -> usize

Total size of the array in bytes, including all children and buffers.

impl ArrayValidity for BoolArray

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

fn logical_validity(&self) -> LogicalValidity

impl ArrayVariants for BoolArray

fn as_bool_array(&self) -> Option<&dyn BoolArrayTrait>

fn as_null_array(&self) -> Option<&dyn NullArrayTrait>

fn as_null_array_unchecked(&self) -> &dyn NullArrayTrait

fn as_bool_array_unchecked(&self) -> &dyn BoolArrayTrait

fn as_primitive_array(&self) -> Option<&dyn PrimitiveArrayTrait>

fn as_primitive_array_unchecked(&self) -> &dyn PrimitiveArrayTrait

fn as_utf8_array(&self) -> Option<&dyn Utf8ArrayTrait>

fn as_utf8_array_unchecked(&self) -> &dyn Utf8ArrayTrait

fn as_binary_array(&self) -> Option<&dyn BinaryArrayTrait>

fn as_binary_array_unchecked(&self) -> &dyn BinaryArrayTrait

fn as_struct_array(&self) -> Option<&dyn StructArrayTrait>

fn as_struct_array_unchecked(&self) -> &dyn StructArrayTrait

fn as_list_array(&self) -> Option<&dyn ListArrayTrait>

fn as_list_array_unchecked(&self) -> &dyn ListArrayTrait

fn as_extension_array(&self) -> Option<&dyn ExtensionArrayTrait>

fn as_extension_array_unchecked(&self) -> &dyn ExtensionArrayTrait

impl AsRef<Array> for BoolArray

fn as_ref(&self) -> &Array

Converts this type into a shared reference of the (usually inferred) input type.

impl BoolArrayTrait for BoolArray

fn invert(&self) -> VortexResult<Array>

Return a new inverted version of this array.

fn maybe_null_indices_iter<'a>(&'a self) -> Box<dyn Iterator<Item = usize> + 'a>

An iterator over the sorted indices of set values in the underlying boolean array good to array with low number of set values.

fn maybe_null_slices_iter<'a>( &'a self, ) -> Box<dyn Iterator<Item = (usize, usize)> + 'a>

An iterator over the sorted disjoint contiguous range of set values in the underlying boolean array good for arrays with only long runs of set values.

fn true_count(&self) -> usize

impl Clone for BoolArray

fn clone(&self) -> BoolArray

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BoolArray

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

Formats the value using the given formatter.

impl FillForwardFn for BoolArray

fn fill_forward(&self) -> VortexResult<Array>

impl FilterFn for BoolArray

fn filter(&self, predicate: &Array) -> VortexResult<Array>

Filter an array by the provided predicate.

impl From<BoolArray> for Array

fn from(value: BoolArray) -> Array

Converts to this type from the input type.

impl From<BooleanBuffer> for BoolArray

fn from(value: BooleanBuffer) -> Self

Converts to this type from the input type.

impl From<TypedArray<Bool>> for BoolArray

fn from(typed: TypedArray<Bool>) -> Self

Converts to this type from the input type.

impl From<Vec<bool>> for BoolArray

fn from(value: Vec<bool>) -> Self

Converts to this type from the input type.

impl FromIterator<Option<bool>> for BoolArray

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

Creates a value from an iterator.

impl GetArrayMetadata for BoolArray

fn metadata(&self) -> Arc<dyn ArrayMetadata>

impl IntoArray for BoolArray

fn into_array(self) -> Array

impl IntoCanonical for BoolArray

fn into_canonical(self) -> VortexResult<Canonical>

impl OrFn for BoolArray

fn or(&self, array: &Array) -> VortexResult<Array>

Point-wise logical or between two Boolean arrays.

fn or_kleene(&self, array: &Array) -> VortexResult<Array>

Point-wise Kleene logical or between two Boolean arrays.

impl ScalarAtFn for BoolArray

fn scalar_at(&self, index: usize) -> VortexResult<Scalar>

fn scalar_at_unchecked(&self, index: usize) -> Scalar

impl SliceFn for BoolArray

fn slice(&self, start: usize, stop: usize) -> VortexResult<Array>

Return a zero-copy slice of an array, between start (inclusive) and end (exclusive). If start >= stop, returns an empty array of the same type as self. Assumes that start or stop are out of bounds, may panic otherwise.

impl TakeFn for BoolArray

fn take(&self, indices: &Array) -> VortexResult<Array>

impl ToArray for BoolArray

fn to_array(&self) -> Array

impl TryFrom<&Array> for BoolArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(array: &Array) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Array> for BoolArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(array: Array) -> Result<Self, Self::Error>

Performs the conversion.