Struct qwt::bitvector::BitVector

pub struct BitVector { /* private fields */ }

Implementations

impl BitVector

pub fn new() -> Self

Creates a new empty binary vector.

pub fn with_capacity(n_bits: usize) -> Self

Creates an empty binary vector with at least a capacity of n_bits.

pub fn with_zeros(n_bits: usize) -> Self

Creates a binary vector with n_bits set to 0.

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

Pushes a bit at the end of the binary vector.

Example

use qwt::{BitVector, AccessBin};

let mut bv = BitVector::new();
bv.push(true);
bv.push(false);
bv.push(true);
assert_eq!(bv.len(), 3);
assert_eq!(bv.get(0), Some(true));

pub fn append_bits(&mut self, bits: u64, len: usize)

Appends len bits at the end of the bit vector by taking the least significant len bits in the u64 value bits.

Panics

Panics if len is larger than 64 or if a bit of position
larger than len is set in bits.

Examples

use qwt::BitVector;

let mut bv = BitVector::new();
bv.append_bits(5, 3); // appends 101
bv.append_bits(6, 4); // appends 0110          
assert_eq!(bv.len(), 7);
assert_eq!(bv.get_bits(0, 3), Some(5));

pub fn extend_with_zeros(&mut self, n: usize)

Extends the bit vector by adding n bits set to 0.

Examples

use qwt::{BitVector, AccessBin};

let mut bv = BitVector::new();
bv.extend_with_zeros(10);
assert_eq!(bv.len(), 10);
assert_eq!(bv.get(8), Some(false));

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

Sets the to bit the given position index.

Panics

Panics if index is out of bounds.

pub fn get_bits(&self, index: usize, len: usize) -> Option<u64>

Accesses len bits, with 1 <= len <= 64, starting at position index.

Returns None if index+len is out of bounds or len == 0 or len > 64.

pub fn set_bits(&mut self, index: usize, len: usize, bits: u64)

Sets len bits, with 1 <= len <= 64, starting at position index to the len least significant bits in bits.

Panics

Panics if index+len is out of bounds or len > 64 or if most significant bit in bits ia at a position larger than of equal to len.

pub fn ones(&self) -> BitVectorBitPositionsIter<'_, true>

Returns an iterator over positions of bit set to 1 in the bit vector.

Examples

use qwt::BitVector;
let vv: Vec<usize> = vec![0, 63, 128, 129, 254, 1026];
let bv: BitVector = vv.iter().copied().collect();

let v: Vec<usize> = bv.ones().collect();
assert_eq!(v, vv);

pub fn zeros(&self) -> BitVectorBitPositionsIter<'_, false>

Gives an iterator over positions of bit set to 0 in the bit vector.

pub fn get_word(&self, i: usize) -> u64

Gets a whole 64bit word.

pub fn shrink_to_fit(&mut self)

Shrinks the underlying vector of 64bit words to fit.

pub fn is_empty(&self) -> bool

Checks if the vector is empty.

pub fn len(&self) -> usize

Returns the number of bits in the bitvector.

pub fn iter(&self) -> BitVectorIter<'_>

Returns a non-consuming iterator over bits of the bit vector.

Trait Implementations

impl AccessBin for BitVector

fn get(&self, i: usize) -> Option<bool>

Returns the bit at the given position i, or None if i is out of bounds.

Examples

use qwt::{BitVector, AccessBin};

let mut bv = BitVector::new();
bv.extend_with_zeros(10);
assert_eq!(bv.get(8), Some(false));

unsafe fn get_unchecked(&self, i: usize) -> bool

Returns the symbol at position i.

Safety

Calling this method with an out-of-bounds index is undefined behavior.

impl Clone for BitVector

fn clone(&self) -> BitVector

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BitVector

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

Formats the value using the given formatter.

impl Default for BitVector

fn default() -> BitVector

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BitVector

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Extend<bool> for BitVector

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = bool>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<usize> for BitVector

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = usize>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<bool> for BitVector

fn from_iter<T>(iter: T) -> Self

where T: IntoIterator<Item = bool>,

Creates a value from an iterator.

impl FromIterator<usize> for BitVector

fn from_iter<T>(iter: T) -> Self

where T: IntoIterator<Item = usize>,

Creates a value from an iterator.

impl<'a> IntoIterator for &'a BitVector

type IntoIter = BitVectorIter<'a>

Which kind of iterator are we turning this into?

type Item = bool

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for BitVector

type IntoIter = BitVectorIntoIter

Which kind of iterator are we turning this into?

type Item = bool

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for BitVector

fn eq(&self, other: &BitVector) -> 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 Serialize for BitVector

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SpaceUsage for BitVector

fn space_usage_byte(&self) -> usize

Returns the space usage in bytes.

fn space_usage_KiB(&self) -> f64

Gives the space usage of the data structure in KiB.

fn space_usage_MiB(&self) -> f64

Gives the space usage of the data structure in MiB.

fn space_usage_GiB(&self) -> f64

Gives the space usage of the data structure in GiB.

impl Eq for BitVector

impl StructuralEq for BitVector

impl StructuralPartialEq for BitVector