Struct BitView 

pub struct BitView<'a> { /* private fields */ }

A borrowed fixed-size bit vector of length N bits, represented as an array of usize words.

Internally, it uses a BitArray to store the bits, but this crate has some performance foot-guns in cases where we can lean on better assumptions, and therefore we wrap it up for use within Vortex. Read-only view into a bit array for selection masking in pipeline operations.

Implementations

impl BitView<'static>

pub fn all_true() -> Self

pub fn all_false() -> Self

impl<'a> BitView<'a>

pub fn new(bits: &[usize; 16]) -> Self

pub fn true_count(&self) -> usize

Returns the number of true bits in the view.

pub fn iter_ones<F>(&self, f: F)

where F: FnMut(usize),

Runs the provided function f for each index of a true bit in the view.

pub fn iter_zeros<F>(&self, f: F)

where F: FnMut(usize),

Runs the provided function f for each index of a true bit in the view.

pub fn iter_slices<F>(&self, f: F)

where F: FnMut((usize, usize)),

Runs the provided function f for each range of true bits in the view.

The function f receives a tuple (start, len) where start is the index of the first true bit and len is the number of consecutive true bits.

pub fn as_raw(&self) -> &[usize; 16]

Trait Implementations

impl<'a> Clone for BitView<'a>

fn clone(&self) -> BitView<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BitView<'_>

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

Formats the value using the given formatter.

impl<'a> From<&'a [usize; 16]> for BitView<'a>

fn from(value: &'a [usize; 16]) -> Self

Converts to this type from the input type.

impl<'a> From<&'a BitArray<[usize; 16]>> for BitView<'a>

fn from(bits: &'a BitArray<[usize; 16], Lsb0>) -> Self

Converts to this type from the input type.

impl From<BitView<'_>> for BitVector

fn from(value: BitView<'_>) -> Self

Converts to this type from the input type.

impl<'a> TryFrom<&'a BitSlice> for BitView<'a>

type Error = VortexError

The type returned in the event of a conversion error.

fn try_from(value: &'a BitSlice<usize, Lsb0>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> Copy for BitView<'a>