Struct vortex_array::array::BoolArray

pub struct BoolArray(/* private fields */);

Implementations

impl BoolArray

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

impl BoolArray

pub fn maybe_from(data: impl AsRef<ArrayData>) -> Option<Self>

Optionally downcast an ArrayData instance to a specific encoding.

Preferred in cases where a backtrace isn’t needed, like when trying multiple encoding to go down different code paths.

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 new(buffer: BooleanBuffer, nullability: Nullability) -> Self

Create a new BoolArray from a buffer and nullability.

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

Create a new BoolArray from a buffer and validity metadata. Returns an error if the validity length does not match the buffer length.

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.

Trait Implementations

impl AsRef<ArrayData> for BoolArray

fn as_ref(&self) -> &ArrayData

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

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<ArrayData>

impl FillNullFn<BoolArray> for BoolEncoding

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

impl FilterFn<BoolArray> for BoolEncoding

fn filter(&self, array: &BoolArray, mask: FilterMask) -> VortexResult<ArrayData>

Filter an array by the provided predicate.

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 IntoArrayData for BoolArray

fn into_array(self) -> ArrayData

impl IntoCanonical for BoolArray

fn into_canonical(self) -> VortexResult<Canonical>

fn into_arrow(self) -> VortexResult<ArrayRef>

where Self: Sized,

impl InvertFn<BoolArray> for BoolEncoding

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

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

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<ArrayData>

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

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

Compute the requested statistic. Can return additional stats.

impl TakeFn<BoolArray> for BoolEncoding

fn take( &self, array: &BoolArray, indices: &ArrayData, ) -> VortexResult<ArrayData>

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

unsafe fn take_unchecked( &self, array: &BoolArray, indices: &ArrayData, ) -> VortexResult<ArrayData>

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

impl<'a> TryFrom<&'a ArrayData> for &'a BoolArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(data: &'a ArrayData) -> VortexResult<Self>

Performs the conversion.

impl TryFrom<ArrayData> for BoolArray

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(data: ArrayData) -> VortexResult<Self>

Performs the conversion.

impl ValidityVTable<BoolArray> for BoolEncoding

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

fn logical_validity(&self, array: &BoolArray) -> LogicalValidity

impl VariantsVTable<BoolArray> for BoolEncoding

fn as_bool_array<'a>( &self, array: &'a BoolArray, ) -> Option<&'a dyn BoolArrayTrait>

fn as_null_array<'a>(&self, _array: &'a Array) -> Option<&'a dyn NullArrayTrait>

fn as_primitive_array<'a>( &self, _array: &'a Array, ) -> Option<&'a dyn PrimitiveArrayTrait>

fn as_utf8_array<'a>(&self, _array: &'a Array) -> Option<&'a dyn Utf8ArrayTrait>

fn as_binary_array<'a>( &self, _array: &'a Array, ) -> Option<&'a dyn BinaryArrayTrait>

fn as_struct_array<'a>( &self, _array: &'a Array, ) -> Option<&'a dyn StructArrayTrait>

fn as_list_array<'a>(&self, _array: &'a Array) -> Option<&'a dyn ListArrayTrait>

fn as_extension_array<'a>( &self, _array: &'a Array, ) -> Option<&'a dyn ExtensionArrayTrait>

impl VisitorVTable<BoolArray> for BoolEncoding

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

impl ArrayTrait for BoolArray

impl BoolArrayTrait for BoolArray