Struct FilterMask

pub struct FilterMask { /* private fields */ }

Represents the mask argument to a filter function. Internally this will cache the canonical representation of the mask if it is ever used.

Implementations

impl FilterMask

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

Create a new FilterMask where the given indices are set.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn true_count(&self) -> usize

Get the true count of the mask.

pub fn false_count(&self) -> usize

Get the false count of the mask.

pub fn selectivity(&self) -> f64

Return the selectivity of the full mask.

pub fn range_selectivity(&self) -> f64

Return the selectivity of the range of true values of the mask.

pub fn to_boolean_buffer(&self) -> VortexResult<BooleanBuffer>

Get the canonical representation of the mask.

pub fn iter(&self) -> VortexResult<FilterIter<'_>>

Returns the best iterator based on a selectivity threshold.

Currently, this threshold is fixed at 0.8 based on Arrow Rust.

pub fn iter_slices( &self, ) -> VortexResult<impl Iterator<Item = (usize, usize)> + '_>

👎Deprecated: Move to using iter() instead

pub fn iter_indices(&self) -> VortexResult<impl Iterator<Item = usize> + '_>

👎Deprecated: Move to using iter() instead

Trait Implementations

impl Clone for FilterMask

We implement Clone manually to trigger population of our cached indices or slices. By making the filter API take FilterMask by value, whenever it gets used multiple times in a recursive function, we will cache the slices internally.

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FilterMask

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

Formats the value using the given formatter.

impl From<BooleanBuffer> for FilterMask

fn from(value: BooleanBuffer) -> Self

Converts to this type from the input type.

impl FromIterator<bool> for FilterMask

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

Creates a value from an iterator.

impl TryFrom<ArrayData> for FilterMask

type Error = VortexError

The type returned in the event of a conversion error.

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

Performs the conversion.