Struct BoolArray

pub struct BoolArray { /* private fields */ }

Implementations

impl BoolArray

pub fn from_indices<I: IntoIterator<Item = usize>>( length: usize, indices: I, ) -> Self

Create a new BoolArray from a set of indices and a length. All indices must be less than the length.

pub fn new(buffer: BooleanBuffer, validity: Validity) -> Self

Creates a new BoolArray from a BooleanBuffer and Validity, without checking any invariants.

pub fn boolean_buffer(&self) -> &BooleanBuffer

Returns the underlying BooleanBuffer of the array.

pub fn validity(&self) -> &Validity

Returns the underlying Validity of the array.

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

impl BoolArray

pub fn patch(self, patches: &Patches) -> VortexResult<Self>

Trait Implementations

impl ArrayCanonicalImpl for BoolArray

fn _to_canonical(&self) -> VortexResult<Canonical>

Returns the canonical representation of the array.

fn _append_to_builder(&self, builder: &mut dyn ArrayBuilder) -> VortexResult<()>

Writes the array into the canonical builder.

impl ArrayComputeImpl for BoolArray

const FILTER: Option<KernelRef>

fn _find_kernel(&self, _compute_fn: &dyn ComputeFn) -> Option<KernelRef>

Fallback implementation to lookup compute kernels at runtime.

impl ArrayImpl for BoolArray

type Encoding = BoolEncoding

fn _len(&self) -> usize

fn _dtype(&self) -> &DType

fn _vtable(&self) -> VTableRef

fn _with_children(&self, children: &[ArrayRef]) -> VortexResult<Self>

Replace the children of this array with the given arrays.

impl ArrayStatisticsImpl for BoolArray

fn _stats_ref(&self) -> StatsSetRef<'_>

impl ArrayValidityImpl for BoolArray

fn _is_valid(&self, index: usize) -> VortexResult<bool>

Returns whether the index item is valid.

fn _all_valid(&self) -> VortexResult<bool>

Returns whether the array is all valid.

fn _all_invalid(&self) -> VortexResult<bool>

Returns whether the array is all invalid.

fn _validity_mask(&self) -> VortexResult<Mask>

Returns the canonical validity mask for the array.

fn _valid_count(&self) -> VortexResult<usize>

Returns the number of valid elements in the array.

fn _invalid_count(&self) -> VortexResult<usize>

Returns the number of invalid elements in the array.

impl ArrayVariantsImpl for BoolArray

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

Downcasts the array for bool-specific behavior.

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

Downcasts the array for null-specific behavior.

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

Downcasts the array for primitive-specific behavior.

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

Downcasts the array for utf8-specific behavior.

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

Downcasts the array for binary-specific behavior.

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

Downcasts the array for struct-specific behavior.

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

Downcasts the array for list-specific behavior.

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

Downcasts the array for extension-specific behavior.

impl ArrayVisitorImpl<RkyvMetadata<BoolMetadata>> for BoolArray

fn _visit_buffers(&self, visitor: &mut dyn ArrayBufferVisitor)

fn _visit_children(&self, visitor: &mut dyn ArrayChildVisitor)

fn _metadata(&self) -> RkyvMetadata<BoolMetadata>

fn _nbuffers(&self) -> usize

fn _nchildren(&self) -> usize

impl CastFn<&BoolArray> for BoolEncoding

fn cast(&self, array: &BoolArray, dtype: &DType) -> VortexResult<ArrayRef>

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<&BoolArray> for BoolEncoding

fn fill_forward(&self, array: &BoolArray) -> VortexResult<ArrayRef>

impl FillNullFn<&BoolArray> for BoolEncoding

fn fill_null( &self, array: &BoolArray, fill_value: Scalar, ) -> VortexResult<ArrayRef>

impl From<BooleanBuffer> for BoolArray

fn from(value: BooleanBuffer) -> 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 FromIterator<bool> for BoolArray

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

Creates a value from an iterator.

impl InvertFn<&BoolArray> for BoolEncoding

fn invert(&self, array: &BoolArray) -> VortexResult<ArrayRef>

Logically invert a boolean array. Converts true -> false, false -> true, null -> null.

impl IsConstantFn<&BoolArray> for BoolEncoding

fn is_constant( &self, array: &BoolArray, _opts: &IsConstantOpts, ) -> VortexResult<Option<bool>>

Preconditions

impl IsSortedFn<&BoolArray> for BoolEncoding

fn is_sorted(&self, array: &BoolArray) -> VortexResult<bool>

Preconditions

fn is_strict_sorted(&self, array: &BoolArray) -> VortexResult<bool>

impl MaskFn<&BoolArray> for BoolEncoding

fn mask(&self, array: &BoolArray, mask: Mask) -> VortexResult<ArrayRef>

Replace masked values with null in array.

impl MinMaxFn<&BoolArray> for BoolEncoding

fn min_max(&self, array: &BoolArray) -> VortexResult<Option<MinMaxResult>>

impl ScalarAtFn<&BoolArray> for BoolEncoding

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

impl SliceFn<&BoolArray> for BoolEncoding

fn slice( &self, array: &BoolArray, start: usize, stop: usize, ) -> VortexResult<ArrayRef>

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 SumFn<&BoolArray> for BoolEncoding

fn sum(&self, array: &BoolArray) -> VortexResult<Scalar>

Preconditions

impl TakeFn<&BoolArray> for BoolEncoding

fn take(&self, array: &BoolArray, indices: &dyn Array) -> VortexResult<ArrayRef>

Create a new array by taking the values from the array at the given indices.

fn take_into( &self, array: &BoolArray, indices: &dyn Array, builder: &mut dyn ArrayBuilder, ) -> VortexResult<()>

Has the same semantics as Self::take but materializes the result into the provided builder.

impl ToArrowFn<&BoolArray> for BoolEncoding

fn to_arrow( &self, array: &BoolArray, data_type: &DataType, ) -> VortexResult<Option<ArrayRef>>

Convert the array to an Arrow array of the given type.

fn preferred_arrow_data_type(&self, _array: A) -> VortexResult<Option<DataType>>

Return the preferred Arrow DataType of the encoding, or None of the canonical DataType for the array’s Vortex vortex_dtype::DType should be used.

impl TryFrom<&BoolArray> for Mask

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl UncompressedSizeFn<&BoolArray> for BoolEncoding

fn uncompressed_size(&self, array: &BoolArray) -> VortexResult<usize>

Compute the approximated uncompressed size of the array, in bytes.

impl BoolArrayTrait for BoolArray