Struct rsdict::RsDict

pub struct RsDict { /* private fields */ }

Data structure for efficiently computing both rank and select queries

Implementations

impl RsDict

pub fn from_blocks(blocks: impl Iterator<Item = u64>) -> Self

Create a dictionary from a bitset, specified as an iterator of 64-bit blocks. This function is equivalent to pushing each bit one at a time but is much faster.

pub fn heap_size(&self) -> usize

Return the size of the heap allocations associated with the RsDict.

pub fn new() -> Self

Create a new RsDict with zero capacity.

pub fn with_capacity(n: usize) -> Self

Create a new RsDict with the given capacity preallocated.

pub fn rank(&self, pos: u64, bit: bool) -> u64

Non-inclusive rank: Count the number of bit values left of pos. Panics if pos is out-of-bounds.

pub fn bit_and_one_rank(&self, pos: u64) -> (bool, u64)

Query the posth bit (zero-indexed) of the underlying bit and the number of set bits to the left of pos in a single operation. This method is faster than calling get_bit(pos) and rank(pos, true) separately.

pub fn inclusive_rank(&self, pos: u64, bit: bool) -> u64

Inclusive rank: Count the number of bit values at indices less than or equal to pos. Panics if pos is out-of-bounds.

pub fn select(&self, rank: u64, bit: bool) -> Option<u64>

Compute the position of the rankth instance of bit (zero-indexed), returning None if there are not rank + 1 instances of bit in the array.

pub fn select0(&self, rank: u64) -> Option<u64>

Specialized version of RsDict::select for finding positions of zeros.

pub fn select1(&self, rank: u64) -> Option<u64>

Specialized version of RsDict::select for finding positions of ones.

pub fn len(&self) -> usize

Return the length of the underlying bitmap.

pub fn is_empty(&self) -> bool

Return whether the underlying bitmap is empty.

pub fn count_ones(&self) -> usize

Count the number of set bits in the underlying bitmap.

pub fn count_zeros(&self) -> usize

Count the number of unset bits in the underlying bitmap.

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

Push a bit at the end of the underlying bitmap.

pub fn get_bit(&self, pos: u64) -> bool

Query the posth bit (zero-indexed) of the underlying bitmap.

pub fn iter(&self) -> impl Iterator<Item = bool> + '_

Iterate over the bits in the bitset.

Trait Implementations

impl Clone for RsDict

fn clone(&self) -> RsDict

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RsDict

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

Formats the value using the given formatter.

impl Ord for RsDict

fn cmp(&self, rhs: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for RsDict

fn eq(&self, rhs: &Self) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for RsDict

fn partial_cmp(&self, rhs: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for RsDict