Struct bitarray::BitArray

#[repr(align(64))]
pub struct BitArray<const B: usize> {
    pub bytes: [u8; B],
}

A constant sized array of bits. B defines the number of bytes. This has an alignment of 64 to maximize the efficiency of SIMD operations. It will automatically utilize SIMD at runtime where possible.

Fields

bytes: [u8; B]

Implementations

impl<const B: usize> BitArray<B>

pub fn new(bytes: [u8; B]) -> Self

Create a new BitArray.

use bitarray::BitArray;
let array = BitArray::new([0]);
assert_eq!(*array.bytes(), [0]);

pub fn zeros() -> Self

Create a new BitArray with all zeros.

use bitarray::BitArray;
let array = BitArray::zeros();
assert_eq!(array, BitArray::new([0]));
assert_eq!(*array, [0]);

pub fn bytes(&self) -> &[u8; B]

Retrieve the byte array of a BitArray.

use bitarray::BitArray;
let array = BitArray::new([1, 2]);
assert_eq!(*array, [1, 2]);

pub fn bytes_mut(&mut self) -> &mut [u8; B]

Retrieve the mutable byte array of a BitArray.

use bitarray::BitArray;
let mut array = BitArray::new([1, 2]);
array.bytes_mut()[0] = 3;
assert_eq!(*array, [3, 2]);

pub fn weight(&self) -> usize

Compute the hamming weight of the BitArray.

use bitarray::BitArray;
let array = BitArray::new([0xAA; 83]);
assert_eq!(array.weight(), 4 * 83);

pub fn distance(&self, other: &Self) -> usize

Compute the hamming distance to another BitArray.

use bitarray::BitArray;

// All the bits are different.
let a = BitArray::new([0xAA; 65]);
let b = BitArray::new([0x55; 65]);
assert_eq!(a.distance(&b), 8 * 65);

// None of the bits are different.
let a = BitArray::new([0xAA; 65]);
let b = BitArray::new([0xAA; 65]);
assert_eq!(a.distance(&b), 0);

Trait Implementations

impl<const B: usize> Clone for BitArray<B>

fn clone(&self) -> BitArray<B>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const B: usize> Debug for BitArray<B>

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

Formats the value using the given formatter.

impl<const B: usize> Deref for BitArray<B>

use bitarray::BitArray;
let mut array = BitArray::new([1, 2]);
assert_eq!(*array, [1, 2]);

type Target = [u8; B]

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<const B: usize> DerefMut for BitArray<B>

use bitarray::BitArray;
let mut array = BitArray::zeros();
array[0] = 1;
array[1] = 2;
assert_eq!(*array, [1, 2]);

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<const B: usize> Hash for BitArray<B>

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<const B: usize> PartialEq<BitArray<B>> for BitArray<B>

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl<const B: usize> Copy for BitArray<B>

impl<const B: usize> Eq for BitArray<B>