Struct FilterMask

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

Represents the mask argument to a filter function.

A FilterMask can be constructed from various representations, and converted to various others. Internally, these are cached.

Implementations

impl FilterMask

pub fn new_true(length: usize) -> Self

Create a new FilterMask where all values are set.

pub fn new_false(length: usize) -> Self

Create a new FilterMask where no values are set.

pub fn from_buffer(buffer: BooleanBuffer) -> Self

Create a new FilterMask from a BooleanBuffer.

pub fn from_indices(len: usize, vec: Vec<usize>) -> Self

Create a new FilterMask from a Vec<usize>.

pub fn from_slices(len: usize, vec: Vec<(usize, usize)>) -> Self

Create a new FilterMask from a [Vec<(usize, usize)>] where each range represents a contiguous range of true values.

pub fn from_intersection_indices( len: usize, lhs: impl Iterator<Item = usize>, rhs: impl Iterator<Item = usize>, ) -> Self

Create a new FilterMask from the intersection of two indices slices.

pub fn len(&self) -> usize

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 boolean_buffer(&self) -> &BooleanBuffer

Get the canonical representation of the mask.

pub fn indices(&self) -> &[usize]

Get the indices of the true values in the mask.

pub fn slices(&self) -> &[(usize, usize)]

Get the slices of the true values in the mask.

pub fn first(&self) -> Option<usize>

Returns the first true index in the mask.

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

Returns the best iterator based on a selectivity threshold.

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

pub fn slice(&self, offset: usize, length: usize) -> Self

Slice the mask.

pub fn intersect_by_rank(&self, mask: &FilterMask) -> FilterMask

take the intersection of the mask with the set of true values in self.

We are more interested in low selectivity self (as indices) with a boolean buffer mask, so we don’t optimize for other cases, yet.

Trait Implementations

impl BitAnd for &FilterMask

type Output = FilterMask

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl Clone for FilterMask

fn clone(&self) -> FilterMask

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 PartialEq for FilterMask

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

impl Eq for FilterMask