Struct BitVector

pub struct BitVector { /* private fields */ }

A bit vector where each element is 1 bit.

Example

let bv = sdsl::bit_vectors::BitVector::new(5, 1)?;
let result: Vec<_> = bv.iter().collect();
let expected = vec![1, 1, 1, 1, 1];
assert_eq!(result, expected);

For further examples see here.

Implementations

impl BitVector

pub fn new(size: usize, default_value: usize) -> Result<Self>

Construct a new bit vector.

Arguments

• size - Number of elements.
• default_value - Default values for elements initialization.

pub fn from_file(path: &PathBuf) -> Result<Self>

Load vector from file.

Arguments

• path - File path.

pub fn is_empty(&self) -> bool

Returns true if the vector is empty, otherwise returns false.

pub fn resize(&mut self, size: usize)

Resize the vector in terms of elements.

Arguments

• size - Target number of elements.

pub fn len(&self) -> usize

The number of elements in the vector.

pub fn max_size(&self) -> usize

Maximum size of the vector.

pub fn bit_size(&self) -> usize

The number of bits in the vector.

pub fn capacity(&self) -> usize

Returns the size of the occupied bits of the vector.

The capacity of a vector is greater or equal to the bit_size().

pub fn data(&self) -> *const c_void

Constant pointer to the raw data of the vector.

pub fn get_int(&self, index: usize, len: u8) -> usize

Get the integer value of the binary string of length len starting at position index in the vector.

Arguments

• index - Starting index of the binary representation of the integer.
• len - Length of the binary representation of the integer.

Example

//                          1, 2, 4, 8, 16
let bv = sdsl::bit_vector! {1, 1, 0, 0, 1};
let result = bv.get_int(0, 5);
let expected = 19; // = 1 + 2 + 16
assert_eq!(result, expected);

pub fn set_int(&mut self, index: usize, value: usize, len: u8)

Set the bits from position index to index+len-1 to the binary representation of integer value.

The bit at position index represents the least significant bit (lsb), and the bit at position index+len-1 the most significant bit (msb) of value.

Arguments

• index - Starting index of the binary representation of value.
• value - The integer to store in the vector.
• len - The length used to store value in the vector.

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

Get the i-th element of the vector.

Arguments

• index - An index in range $ [0, \mathrm{len}()) $.

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

Set the i-th element of the vector.

Arguments

• index - An index in range $ [0, \mathrm{len}()) $.
• value - New element value.

pub fn flip(&mut self)

Flip all bits.

pub fn iter(&self) -> VectorIterator<'_, u8, Self>

Returns an iterator over the vector values.

Trait Implementations

impl Clone for BitVector

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BitVector

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

Formats the value using the given formatter.

impl Drop for BitVector

fn drop(&mut self)

Executes the destructor for this type.

impl IntoIterator for BitVector

type Item = u8

The type of the elements being iterated over.

type IntoIter = VectorIntoIterator<u8, BitVector>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for BitVector

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

Equality operator for two vectors.

Two int_vectors are equal if

• capacities and sizes are equal and
• width are equal and
• the bits in the range [0..bit_size()-1] are equal.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for BitVector