Struct polars::export::arrow::bitmap::MutableBitmap

pub struct MutableBitmap { /* private fields */ }

A container to store booleans. MutableBitmap is semantically equivalent to Vec<bool>, but each value is stored as a single bit, thereby achieving a compression of 8x. This container is the counterpart of Vec for boolean values. MutableBitmap can be converted to a Bitmap at O(1). The main difference against Vec<bool> is that a bitmap cannot be represented as &[bool].

Implementation

This container is backed by Vec<u8>.

Implementations

impl MutableBitmap

pub fn new() -> MutableBitmap

Initializes an empty MutableBitmap.

pub fn clear(&mut self)

Empties the MutableBitmap.

pub fn from_len_zeroed(length: usize) -> MutableBitmap

Initializes a zeroed MutableBitmap.

pub fn with_capacity(capacity: usize) -> MutableBitmap

Initializes a pre-allocated MutableBitmap with capacity for capacity bits.

pub fn reserve(&mut self, additional: usize)

Reserves additional bits in the MutableBitmap, potentially re-allocating its buffer.

pub fn push(&mut self, value: bool)

Pushes a new bit to the MutableBitmap, re-sizing it if necessary.

pub fn capacity(&self) -> usize

Returns the capacity of MutableBitmap in number of bits.

pub unsafe fn push_unchecked(&mut self, value: bool)

Pushes a new bit to the MutableBitmap

Safety

The caller must ensure that the MutableBitmap has sufficient capacity.

pub fn null_count(&self) -> usize

Returns the number of unset bits on this MutableBitmap.

pub fn len(&self) -> usize

Returns the length of the MutableBitmap.

pub fn is_empty(&self) -> bool

Returns whether MutableBitmap is empty.

pub fn extend_constant(&mut self, additional: usize, value: bool)

Extends MutableBitmap by additional values of constant value.

pub fn get(&self, index: usize) -> bool

Returns whether the position index is set.

Panics

Panics iff index >= self.len().

pub fn set(&mut self, index: usize, value: bool)

Sets the position index to value

Panics

Panics iff index >= self.len().

pub unsafe fn set_unchecked(&mut self, index: usize, value: bool)

Sets the position index to value

Safety

Caller must ensure that index < self.len()

pub fn shrink_to_fit(&mut self)

Shrinks the capacity of the MutableBitmap to fit its current length.

impl MutableBitmap

pub fn from_vec(buffer: Vec<u8, Global>, length: usize) -> MutableBitmap

Initializes a MutableBitmap from a Vec<u8> and a length. This function is O(1).

Panic

Panics iff the length is larger than the length of the buffer times 8.

impl MutableBitmap

pub fn extend_from_trusted_len_iter<I>(&mut self, iterator: I) where
    I: TrustedLen<Item = bool>, 

Extends self from a TrustedLen iterator.

pub unsafe fn extend_from_trusted_len_iter_unchecked<I>(&mut self, iterator: I) where
    I: Iterator<Item = bool>, 

Extends self from an iterator of trusted len.

Safety

The caller must guarantee that the iterator has a trusted len.

pub unsafe fn from_trusted_len_iter_unchecked<I>(iterator: I) -> MutableBitmap where
    I: Iterator<Item = bool>, 

Creates a new MutableBitmap from an iterator of booleans.

Safety

The iterator must report an accurate length.

pub fn from_trusted_len_iter<I>(iterator: I) -> MutableBitmap where
    I: TrustedLen<Item = bool>, 

Creates a new MutableBitmap from an iterator of booleans.

pub fn try_from_trusted_len_iter<E, I>(iterator: I) -> Result<MutableBitmap, E> where
    I: TrustedLen<Item = Result<bool, E>>, 

Creates a new MutableBitmap from an iterator of booleans.

pub unsafe fn try_from_trusted_len_iter_unchecked<E, I>(
    iterator: I
) -> Result<MutableBitmap, E> where
    I: Iterator<Item = Result<bool, E>>, 

Creates a new MutableBitmap from an falible iterator of booleans.

Safety

The caller must guarantee that the iterator is TrustedLen.

pub fn extend_from_slice(&mut self, slice: &[u8], offset: usize, length: usize)

Extends the MutableBitmap from a slice of bytes with optional offset. This is the fastest way to extend a MutableBitmap.

Implementation

When both MutableBitmap’s length and offset are both multiples of 8, this function performs a memcopy. Else, it extends MutableBitmap bit by bit.

pub fn extend_from_bitmap(&mut self, bitmap: &Bitmap)

Extends the MutableBitmap from a Bitmap.

pub fn as_slice(&self) -> &[u8]

Returns the slice of bytes of this MutableBitmap. Note that the last byte may not be fully used.

impl<'a> MutableBitmap

pub fn iter(&'a self) -> BitmapIter<'a>

constructs a new iterator over the values of MutableBitmap.

Trait Implementations

impl Debug for MutableBitmap

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

Formats the value using the given formatter.

impl Default for MutableBitmap

fn default() -> MutableBitmap

Returns the “default value” for a type.

impl From<MutableBitmap> for Bitmap

fn from(buffer: MutableBitmap) -> Bitmap

Performs the conversion.

impl<P> From<P> for MutableBitmap where
    P: AsRef<[bool]>, 

fn from(slice: P) -> MutableBitmap

Performs the conversion.

impl FromIterator<bool> for MutableBitmap

fn from_iter<I>(iter: I) -> MutableBitmap where
    I: IntoIterator<Item = bool>, 

Creates a value from an iterator.

impl<'a> IntoIterator for &'a MutableBitmap

type Item = bool

The type of the elements being iterated over.

type IntoIter = BitmapIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a MutableBitmap as IntoIterator>::IntoIter

Creates an iterator from a value.

impl PartialEq<MutableBitmap> for MutableBitmap

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.