Struct RowMask

pub struct RowMask { /* private fields */ }

A RowMask captures a set of selected rows within a range.

The range itself can be u64, but the length of the range must fit into a usize.

Implementations

impl RowMask

pub fn new(mask: FilterMask, begin: u64) -> Self

pub fn new_valid_between(begin: u64, end: u64) -> Self

Construct a RowMask which is valid in the given range.

Panics

If the size of the range is too large to fit into a usize.

pub fn new_invalid_between(begin: u64, end: u64) -> Self

Construct a RowMask which is invalid everywhere in the given range.

pub fn from_array(array: &ArrayData, begin: u64, end: u64) -> VortexResult<Self>

Creates a RowMask from an array, only supported boolean and integer types.

pub fn is_disjoint(&self, range: impl RangeBounds<u64>) -> bool

Whether the mask is disjoint with the given range.

This function may return false negatives, but never false positives.

TODO(ngates): improve this function to take into account the FilterMask.

pub fn and_bitmask(&self, bitmask: ArrayData) -> VortexResult<Self>

Combine the RowMask with bitmask values resulting in new RowMask containing only values true in the bitmask

pub fn and_rowmask(self, other: RowMask) -> VortexResult<Self>

pub fn is_all_false(&self) -> bool

pub fn begin(&self) -> u64

pub fn end(&self) -> u64

pub fn len(&self) -> usize

pub fn filter_mask(&self) -> &FilterMask

Returns the FilterMask whose true values are relative to the range of this RowMask.

pub fn slice(&self, begin: u64, end: u64) -> VortexResult<Self>

Limit mask to [begin..end) range

pub fn filter_array( &self, array: impl AsRef<ArrayData>, ) -> VortexResult<Option<ArrayData>>

Filter array with this RowMask.

This function assumes that Array is no longer than the mask length and that the mask starts on same offset as the array, i.e. the beginning of the array corresponds to the beginning of the mask with begin = 0

pub fn shift(self, offset: u64) -> VortexResult<RowMask>

Shift the RowMask down by the given offset.

pub fn true_count(&self) -> usize

Trait Implementations

impl Clone for RowMask

fn clone(&self) -> RowMask

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RowMask

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

Formats the value using the given formatter.

impl Display for RowMask

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

Formats the value using the given formatter.