Trait succinct::BitVec

pub trait BitVec {
    type Block: BlockType;
    fn bit_len(&self) -> u64;

    fn block_len(&self) -> usize { ... }
    fn get_bit(&self, position: u64) -> bool { ... }
    fn get_block(&self, position: usize) -> Self::Block { ... }
    fn get_bits(&self, start: u64, count: usize) -> Self::Block { ... }
}

Read-only bit vector operations.

Minimal complete definition is get_bit or get_block, since each is defined in terms of the other. Note that get_block in terms of get_bit is inefficient, and thus you should implement get_block directly if possible.

Associated Types

type Block: BlockType

The underlying block type used to store the bits of the vector.

Loading content...

Required methods

fn bit_len(&self) -> u64

The length of the slice in bits.

Loading content...

Provided methods

fn block_len(&self) -> usize

The length of the slice in blocks.

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

Gets the bit at position

The default implementation calls get_block and masks out the correct bit.

Panics

Panics if position is out of bounds.

fn get_block(&self, position: usize) -> Self::Block

Gets the block at position

The bits are laid out Block::nbits() per block, with the notional zeroth bit in the least significant position. If self.bit_len() is not a multiple of Block::nbits() then the last block will contain extra bits that are not part of the bit vector.

The default implementation assembles a block by reading each of its bits. Consider it a slow reference implementation, and override it.

Panics

Panics if position is out of bounds.

fn get_bits(&self, start: u64, count: usize) -> Self::Block

Gets count bits starting at bit index start, interpreted as a little-endian integer.

Panics

Panics if the bit span goes out of bounds.

Loading content...

Implementations on Foreign Types

impl<Block: BlockType> BitVec for [Block]

type Block = Block

fn bit_len(&self) -> u64

fn block_len(&self) -> usize

fn get_block(&self, position: usize) -> Block

impl<'a, Block: BlockType> BitVec for &'a [Block]

type Block = Block

fn bit_len(&self) -> u64

fn block_len(&self) -> usize

fn get_block(&self, position: usize) -> Block

impl<'a, Block: BlockType> BitVec for &'a mut [Block]

type Block = Block

fn bit_len(&self) -> u64

fn block_len(&self) -> usize

fn get_block(&self, position: usize) -> Block

impl<Block: BlockType> BitVec for Vec<Block>

type Block = Block

fn bit_len(&self) -> u64

fn block_len(&self) -> usize

fn get_block(&self, position: usize) -> Block

impl BitVec for Vec<bool>

type Block = u8

fn bit_len(&self) -> u64

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

impl BitVec for u8

type Block = u8

fn bit_len(&self) -> u64

fn block_len(&self) -> usize

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

fn get_block(&self, position: usize) -> Self::Block

fn get_bits(&self, start: u64, count: usize) -> Self

impl BitVec for u16

type Block = u16

fn bit_len(&self) -> u64

fn block_len(&self) -> usize

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

fn get_block(&self, position: usize) -> Self::Block

fn get_bits(&self, start: u64, count: usize) -> Self

impl BitVec for u32

type Block = u32

fn bit_len(&self) -> u64

fn block_len(&self) -> usize

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

fn get_block(&self, position: usize) -> Self::Block

fn get_bits(&self, start: u64, count: usize) -> Self

impl BitVec for u64

type Block = u64

fn bit_len(&self) -> u64

fn block_len(&self) -> usize

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

fn get_block(&self, position: usize) -> Self::Block

fn get_bits(&self, start: u64, count: usize) -> Self

impl BitVec for usize

type Block = usize

fn bit_len(&self) -> u64

fn block_len(&self) -> usize

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

fn get_block(&self, position: usize) -> Self::Block

fn get_bits(&self, start: u64, count: usize) -> Self

Loading content...

Implementors

impl<'a, Base: 'a + BitVec + ?Sized> BitVec for BitSlice<'a, Base>

type Block = Base::Block

fn bit_len(&self) -> u64

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

fn get_bits(&self, position: u64, count: usize) -> Self::Block

fn get_block(&self, position: usize) -> Self::Block

impl<'a, Base: 'a + BitVecMut + ?Sized> BitVec for BitSliceMut<'a, Base>

type Block = Base::Block

fn bit_len(&self) -> u64

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

fn get_bits(&self, position: u64, count: usize) -> Self::Block

fn get_block(&self, position: usize) -> Self::Block

impl<Block: BlockType> BitVec for BitVector<Block>

type Block = Block

fn bit_len(&self) -> u64

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

fn get_block(&self, index: usize) -> Block

impl<Block: BlockType> BitVec for IntVector<Block>

type Block = Block

fn block_len(&self) -> usize

fn bit_len(&self) -> u64

fn get_block(&self, position: usize) -> Block

impl<Inner: BitVec> BitVec for BitBuffer<Inner>

type Block = Inner::Block

fn block_len(&self) -> usize

fn bit_len(&self) -> u64

fn get_block(&self, position: usize) -> Self::Block

impl<Rank: BitVec> BitVec for BinSearchSelect<Rank>

type Block = Rank::Block

fn bit_len(&self) -> u64

fn block_len(&self) -> usize

fn get_block(&self, index: usize) -> Rank::Block

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

fn get_bits(&self, index: u64, count: usize) -> Rank::Block

impl<Store: BitVec> BitVec for JacobsonRank<Store>

type Block = Store::Block

fn bit_len(&self) -> u64

fn block_len(&self) -> usize

fn get_block(&self, index: usize) -> Store::Block

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

fn get_bits(&self, index: u64, count: usize) -> Store::Block

impl<Store: BitVec<Block = u64>> BitVec for Rank9<Store>

type Block = u64

fn bit_len(&self) -> u64

fn block_len(&self) -> usize

fn get_block(&self, index: usize) -> u64

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

fn get_bits(&self, index: u64, count: usize) -> u64

Loading content...