Struct BitVecN 

pub struct BitVecN { /* private fields */ }

A variable-length bitvector with dynamic bit width.

Unlike BitVec2048 which is fixed at 2048 bits, BitVecN allows arbitrary bit widths (512, 1024, 2048, 4096, etc.).

Implementations

impl BitVecN

pub fn new(bits: usize) -> Self

Create a new all-zero bitvector with specified bit width.

Panics

Panics if bits == 0.

pub fn bit_width(&self) -> usize

Return the bit width.

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

Set bit bit to 1.

Panics

Panics if bit >= self.bits.

pub fn get(&self, bit: usize) -> bool

Return the value of bit bit.

Panics

Panics if bit >= self.bits.

pub fn popcount(&self) -> u32

Count the number of bits set to 1.

pub fn tanimoto(&self, other: &Self) -> f64

Tanimoto similarity with another BitVecN.

Both vectors must have the same bit width.

Panics

Panics if the two vectors have different bit widths.

pub fn from_bitvec2048(bv: &BitVec2048) -> Self

Convert from a BitVec2048 (truncates to same 2048 bits).

pub fn to_bitvec2048(&self) -> Option<BitVec2048>

Convert to a BitVec2048 if the bit width is exactly 2048.

Returns None if the bit width is not 2048.

Trait Implementations

impl Clone for BitVecN

fn clone(&self) -> BitVecN

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BitVecN

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

Formats the value using the given formatter.

impl Eq for BitVecN

impl PartialEq for BitVecN

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

Tests for self and other values to be equal, and is used by ==.

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 StructuralPartialEq for BitVecN