Struct bv::BV

pub struct BV<Block = usize> { /* fields omitted */ }

A bit-vector, akin to Vec<bool> but packed.

Methods

impl<Block: BlockType> BV<Block>

pub fn new() -> Self

Creates a new, empty bit-vector of one block.

Examples

use bv::{BV, BitVec};

let mut bv: BV = BV::new();
assert_eq!(bv.len(), 0);

bv.push(true);
bv.push(false);
bv.push(true);
assert_eq!(bv.len(), 3);

assert_eq!(bv.get_bit(0), true);
assert_eq!(bv.get_bit(1), false);
assert_eq!(bv.get_bit(2), true);

pub fn with_capacity(nbits: u64) -> Self

Creates a new, empty bit-vector with the given bit capacity.

Examples

use bv::BV;

let mut bv: BV<u16> = BV::with_capacity(20);
assert_eq!(bv.capacity(), 32);

pub fn with_block_capacity(nblocks: usize) -> Self

Creates a new, empty bit-vector with the given block capacity.

Examples

use bv::BV;

let mut bv: BV<u16> = BV::with_block_capacity(8);
assert_eq!(bv.capacity(), 128);

pub fn new_fill(value: bool, len: u64) -> Self

Creates a new bit-vector of size len, filled with all 0s or 1s depending on value.

Examples

use bv::*;

let mut bv: BV<u64> = BV::new_fill(false, 100);

assert_eq!( bv.get_bit(0), false );
assert_eq!( bv.len(), 100 );

pub fn len(&self) -> u64

The number of bits in the bit-vector.

Examples

use bv::BV;

let mut bv: BV = BV::new();
assert_eq!(bv.len(), 0);
bv.push(false);
assert_eq!(bv.len(), 1);
bv.push(false);
assert_eq!(bv.len(), 2);
bv.push(false);
assert_eq!(bv.len(), 3);

pub fn block_len(&self) -> usize

The number of blocks used by this bit-vector.

Examples

use bv::*;

let mut bv: BV<u64> = BV::new_fill(false, 100);

assert_eq!( bv.len(), 100 );
assert_eq!( bv.block_len(), 2 );

pub fn capacity(&self) -> u64

The capacity of the bit-vector in bits.

pub fn block_capacity(&self) -> usize

The capacity of the bit-vector in blocks.

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

Adjust the capacity to hold at least additional additional bits.

May reserve more to avoid frequent reallocations.

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

Adjust the capacity to hold at least additional additional blocks.

May reserve more to avoid frequent reallocations.

pub fn reserve_exact(&mut self, additional: u64)

Adjust the capacity to hold at least additional additional bits.

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

Adjusts the capacity to at least additional blocks beyond those used.

pub fn shrink_to_fit(&mut self)

Shrinks the capacity of the vector as much as possible.

pub fn into_boxed_slice(self) -> Box<[Block]>

Converts the vector into Box<[Block]>.

Note that this will not drop any excess capacity.

pub fn truncate(&mut self, len: u64)

Shortens the vector, keeping the first len elements and dropping the rest.

If len is greater than the vector's current length, this has no effect.

Note that this method has no effect on the capacity of the bit-vector.

pub fn resize(&mut self, len: u64, value: bool)

Resizes the bit-vector, filling with value if it has to grow.

pub fn as_slice(&self) -> BitSlice<Block>

Gets a slice to a BV.

pub fn as_mut_slice(&mut self) -> BitSliceMut<Block>

Gets a mutable slice to a BV.

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

Adds the given bool to the end of the bit-vector.

pub fn pop(&mut self) -> Option<bool>

Removes and returnst the last element of the bit-vector, or None if empty.

pub fn clear(&mut self)

Removes all elements from the bit-vector.

Does not change the capacity.

pub fn is_empty(&self) -> bool

Does the bit-vector have no elements?

Trait Implementations

impl<Block: Clone> Clone for BV<Block>

fn clone(&self) -> BV<Block>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Block: BlockType> Default for BV<Block>

fn default() -> Self

Returns the "default value" for a type.

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

type Block = Block

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

fn bit_len(&self) -> u64

The length of the slice in bits.

fn bit_offset(&self) -> u8

The number of bits into the first block that the bit vector starts. Must be less than Block::nbits().

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

Gets the block at position

fn block_len(&self) -> usize

The length of the slice in blocks.

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

Gets the bit at position

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

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

impl<Block: BlockType> BitVecMut for BV<Block>

fn set_block(&mut self, position: usize, value: Block)

Sets the block at position to value.

fn set_bit(&mut self, position: u64, value: bool)

Sets the bit at position to value.

fn set_bits(&mut self, start: u64, count: usize, value: Self::Block)

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

impl<Block: BlockType> BitVecPush for BV<Block>

fn push_bit(&mut self, value: bool)

Adds the given bit to the end of the bit vector.

fn pop_bit(&mut self) -> Option<bool>

Removes and returns the last bit, if any.

fn align_block(&mut self, value: bool)

Pushes value 0 or more times until the size of the bit vector is block-aligned.

fn push_block(&mut self, value: Block)

Pushes the given block onto the end of the bit vector.

impl<'a, Block: BlockType> BitSliceable<Range<u64>> for &'a BV<Block>

type Slice = BitSlice<'a, Block>

The type of the slice.

fn bit_slice(self, range: Range<u64>) -> BitSlice<'a, Block>

(Re-)slices the given object.

impl<'a, Block: BlockType> BitSliceable<Range<u64>> for &'a mut BV<Block>

type Slice = BitSliceMut<'a, Block>

The type of the slice.

fn bit_slice(self, range: Range<u64>) -> BitSliceMut<'a, Block>

(Re-)slices the given object.

impl<'a, Block: BlockType> BitSliceable<RangeFrom<u64>> for &'a BV<Block>

type Slice = BitSlice<'a, Block>

The type of the slice.

fn bit_slice(self, range: RangeFrom<u64>) -> BitSlice<'a, Block>

(Re-)slices the given object.

impl<'a, Block: BlockType> BitSliceable<RangeFrom<u64>> for &'a mut BV<Block>

type Slice = BitSliceMut<'a, Block>

The type of the slice.

fn bit_slice(self, range: RangeFrom<u64>) -> BitSliceMut<'a, Block>

(Re-)slices the given object.

impl<'a, Block: BlockType> BitSliceable<RangeTo<u64>> for &'a BV<Block>

type Slice = BitSlice<'a, Block>

The type of the slice.

fn bit_slice(self, range: RangeTo<u64>) -> BitSlice<'a, Block>

(Re-)slices the given object.

impl<'a, Block: BlockType> BitSliceable<RangeTo<u64>> for &'a mut BV<Block>

type Slice = BitSliceMut<'a, Block>

The type of the slice.

fn bit_slice(self, range: RangeTo<u64>) -> BitSliceMut<'a, Block>

(Re-)slices the given object.

impl<'a, Block: BlockType> BitSliceable<RangeFull> for &'a BV<Block>

type Slice = BitSlice<'a, Block>

The type of the slice.

fn bit_slice(self, _: RangeFull) -> BitSlice<'a, Block>

(Re-)slices the given object.

impl<'a, Block: BlockType> BitSliceable<RangeFull> for &'a mut BV<Block>

type Slice = BitSliceMut<'a, Block>

The type of the slice.

fn bit_slice(self, _: RangeFull) -> BitSliceMut<'a, Block>

(Re-)slices the given object.

impl<Block: BlockType> Index<u64> for BV<Block>

type Output = bool

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<Block: BlockType> PartialEq for BV<Block>

fn eq(&self, other: &BV<Block>) -> 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 !=.

impl<Block: BlockType> PartialOrd for BV<Block>

fn partial_cmp(&self, other: &BV<Block>) -> 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<Block: BlockType> Eq for BV<Block>

impl<Block: BlockType> Ord for BV<Block>

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl<Block: BlockType + Hash> Hash for BV<Block>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<Block: BlockType> Debug for BV<Block>

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

Formats the value using the given formatter.