Struct vortex_file::RowMask

pub struct RowMask { /* private fields */ }

A RowMask captures a set of selected rows offset by a range.

i.e., row zero of the inner FilterMask represents the offset row of the RowMask.

Implementations

impl RowMask

pub fn try_new(mask: FilterMask, begin: usize, end: usize) -> VortexResult<Self>

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

Construct a RowMask which is valid in the given range.

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

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

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

Construct a RowMask from a Boolean typed array.

True-valued positions are kept by the returned mask.

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

Construct a RowMask from an integral array.

The array values are interpreted as indices and those indices are kept by the returned mask.

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 is_all_false(&self) -> bool

pub fn begin(&self) -> usize

pub fn end(&self) -> usize

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn slice(&self, begin: usize, end: usize) -> 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: usize) -> VortexResult<RowMask>

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.