Struct bitm::ArrayWithRankSimple

pub struct ArrayWithRankSimple {
    pub content: Box<[u64]>,
    pub ranks: Box<[u32]>,
}

The structure that holds array of bits content and ranks structure that takes no more than 6.25% extra space. It can returns the number of ones in first index bits of the content (see rank method) in O(1) time. Only content with less than 2^32 bit ones is supported.

Usually ArrayWithRankSelect101111 should be preferred to ArrayWithRankSimple.

Fields

content: Box<[u64]>

ranks: Box<[u32]>

Implementations

impl ArrayWithRankSimple

pub fn build(content: Box<[u64]>) -> (Self, u32)

Constructs ArrayWithRankSimple and count number of bits set in content. Returns both.

pub fn try_rank(&self, index: usize) -> Option<u32>

pub fn rank(&self, index: usize) -> u32

Trait Implementations

impl AsRef<[u64]> for ArrayWithRankSimple

fn as_ref(&self) -> &[u64]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ArrayWithRankSimple

fn clone(&self) -> ArrayWithRankSimple

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<Box<[u64]>> for ArrayWithRankSimple

fn from(value: Box<[u64]>) -> Self

Converts to this type from the input type.

impl GetSize for ArrayWithRankSimple

fn size_bytes_dyn(&self) -> usize

Returns approximate number of bytes occupied by dynamic (heap) part of self. Same as self.size_bytes() - std::mem::size_of_val(self).

const USES_DYN_MEM: bool = true

true if and only if the variables of this type can use dynamic (heap) memory.

fn size_bytes_content_dyn(&self) -> usize

Returns approximate number of bytes occupied by dynamic (heap) part of self content. It usually equals to size_bytes_dyn(). However, sometimes it is smaller by the amount of memory reserved but not yet used (e.g., size_bytes_content_dyn() only takes into account the length of the vector and not its capacity).

fn size_bytes(&self) -> usize

Returns approximate, total (including heap memory) number of bytes occupied by self.

impl Rank for ArrayWithRankSimple

fn try_rank(&self, index: usize) -> Option<usize>

Returns the number of ones in first index bits or None if index is out of bound.

fn rank(&self, index: usize) -> usize

Returns the number of ones in first index bits or panics if index is out of bound.

unsafe fn rank_unchecked(&self, index: usize) -> usize

Returns the number of ones in first index bits. The result is undefined if index is out of bound.

fn try_rank0(&self, index: usize) -> Option<usize>

Returns the number of zeros in first index bits or None if index is out of bound.

fn rank0(&self, index: usize) -> usize

Returns the number of zeros in first index bits or panics if index is out of bound.

unsafe fn rank0_unchecked(&self, index: usize) -> usize

Returns the number of ones in first index bits. The result is undefined if index is out of bound.