Struct BitArraySet

Source

pub struct BitArraySet<B: BitsIn, NBits>where
    NBits: Add<<B as BitsIn>::Output> + Unsigned + NonZero,
    <NBits as Add<<B as BitsIn>::Output>>::Output: Sub<B1>,
    <<NBits as Add<<B as BitsIn>::Output>>::Output as Sub<B1>>::Output: Div<<B as BitsIn>::Output>,
    <<<NBits as Add<<B as BitsIn>::Output>>::Output as Sub<B1>>::Output as Div<<B as BitsIn>::Output>>::Output: ArrayLength<B>,
{ /* private fields */ }

Implementations§

Source §

impl<B: BitsIn + BitBlock + Default, NBits> BitArraySet<B, NBits>
where NBits: Add<::Output> + Unsigned + NonZero, <NBits as Add<::Output>>::Output: Sub<B1>, <<NBits as Add<::Output>>::Output as Sub<B1>>::Output: Div<::Output>, <<<NBits as Add<::Output>>::Output as Sub<B1>>::Output as Div<::Output>>::Output: ArrayLength,

Source

pub fn new() -> Self

Creates a new empty BitArraySet.

§Examples

extern crate typenum;
use typenum::{Unsigned, U8};
use bitarray_set::BitArraySet;

let mut s = BitArraySet::<u32, U8>::new();

Source

pub fn from_bit_array(bit_array: BitArray<B, NBits>) -> Self

Creates a new BitArraySet from the given bit array.

§Examples

extern crate typenum;
extern crate bit_array;
extern crate bitarray_set;
use typenum::{Unsigned, U8};
use bit_array::BitArray;
use bitarray_set::BitArraySet;

fn main() {
    let bv = BitArray::<u32, U8>::from_bytes(&[0b01100000]);
    let s = BitArraySet::from_bit_array(bv);

    // Print 1, 2 in arbitrary order
    for x in s.iter() {
        println!("{}", x);
    }
}

Source

pub fn from_bytes(bytes: &[u8]) -> Self

Source

pub fn into_bit_array(self) -> BitArray<B, NBits>

Consumes this set to return the underlying bit array.

§Examples

extern crate typenum;
use typenum::{Unsigned, U8};
use bitarray_set::BitArraySet;

let mut s = BitArraySet::<u32, U8>::new();
s.insert(0);
s.insert(3);

let bv = s.into_bit_array();
assert!(bv[0]);
assert!(bv[3]);

Source

pub fn get_ref(&self) -> &BitArray<B, NBits>

Returns a reference to the underlying bit array.

§Examples

extern crate typenum;
use typenum::{Unsigned, U8};
use bitarray_set::BitArraySet;

let mut s = BitArraySet::<u32, U8>::new();
s.insert(0);

let bv = s.get_ref();
assert_eq!(bv[0], true);

Source

pub fn iter(&self) -> Iter<'_, B> ⓘ

Iterator over each usize stored in the BitArraySet.

§Examples

extern crate typenum;
use typenum::{Unsigned, U8};
use bitarray_set::BitArraySet;

let s = BitArraySet::<u32, U8>::from_bytes(&[0b01001010]);

// Print 1, 4, 6 in arbitrary order
for x in s.iter() {
    println!("{}", x);
}

Source

pub fn union<'a>(&'a self, other: &'a Self) -> Union<'a, B> ⓘ

Iterator over each usize stored in self union other. See union_with for an efficient in-place version.

§Examples

extern crate typenum;
use typenum::{Unsigned, U8};
use bitarray_set::BitArraySet;

let a = BitArraySet::<u32, U8>::from_bytes(&[0b01101000]);
let b = BitArraySet::<u32, U8>::from_bytes(&[0b10100000]);

// Print 0, 1, 2, 4 in arbitrary order
for x in a.union(&b) {
    println!("{}", x);
}

Source

pub fn intersection<'a>(&'a self, other: &'a Self) -> Intersection<'a, B> ⓘ

Iterator over each usize stored in self intersect other. See intersect_with for an efficient in-place version.

§Examples

extern crate typenum;
use typenum::{Unsigned, U8};
use bitarray_set::BitArraySet;

let a = BitArraySet::<u32, U8>::from_bytes(&[0b01101000]);
let b = BitArraySet::<u32, U8>::from_bytes(&[0b10100000]);

// Print 2
for x in a.intersection(&b) {
    println!("{}", x);
}

Source

pub fn difference<'a>(&'a self, other: &'a Self) -> Difference<'a, B> ⓘ

Iterator over each usize stored in the self setminus other. See difference_with for an efficient in-place version.

§Examples

extern crate typenum;
use typenum::{Unsigned, U8};
use bitarray_set::BitArraySet;

let a = BitArraySet::<u32, U8>::from_bytes(&[0b01101000]);
let b = BitArraySet::<u32, U8>::from_bytes(&[0b10100000]);

// Print 1, 4 in arbitrary order
for x in a.difference(&b) {
    println!("{}", x);
}

// Note that difference is not symmetric,
// and `b - a` means something else.
// This prints 0
for x in b.difference(&a) {
    println!("{}", x);
}

Source

pub fn symmetric_difference<'a>( &'a self, other: &'a Self, ) -> SymmetricDifference<'a, B> ⓘ

Iterator over each usize stored in the symmetric difference of self and other. See symmetric_difference_with for an efficient in-place version.

§Examples

extern crate typenum;
use typenum::{Unsigned, U8};
use bitarray_set::BitArraySet;

let a = BitArraySet::<u32, U8>::from_bytes(&[0b01101000]);
let b = BitArraySet::<u32, U8>::from_bytes(&[0b10100000]);

// Print 0, 1, 4 in arbitrary order
for x in a.symmetric_difference(&b) {
    println!("{}", x);
}

Source

pub fn union_with(&mut self, other: &Self)

Unions in-place with the specified other bit array.

§Examples

extern crate typenum;
use typenum::{Unsigned, U8};
use bitarray_set::BitArraySet;

let a   = 0b01101000;
let b   = 0b10100000;
let res = 0b11101000;

let mut a = BitArraySet::<u32, U8>::from_bytes(&[a]);
let b = BitArraySet::<u32, U8>::from_bytes(&[b]);
let res = BitArraySet::<u32, U8>::from_bytes(&[res]);

a.union_with(&b);
assert_eq!(a, res);

Source

pub fn intersect_with(&mut self, other: &Self)

Intersects in-place with the specified other bit array.

§Examples

extern crate typenum;
use typenum::{Unsigned, U8};
use bitarray_set::BitArraySet;

let a   = 0b01101000;
let b   = 0b10100000;
let res = 0b00100000;

let mut a = BitArraySet::<u32, U8>::from_bytes(&[a]);
let b = BitArraySet::<u32, U8>::from_bytes(&[b]);
let res = BitArraySet::<u32, U8>::from_bytes(&[res]);

a.intersect_with(&b);
assert_eq!(a, res);

Source

pub fn difference_with(&mut self, other: &Self)

Makes this bit array the difference with the specified other bit array in-place.

§Examples

extern crate typenum;
use typenum::{Unsigned, U8};
use bitarray_set::BitArraySet;

let a   = 0b01101000;
let b   = 0b10100000;
let a_b = 0b01001000; // a - b
let b_a = 0b10000000; // b - a

let mut bva = BitArraySet::<u32, U8>::from_bytes(&[a]);
let bvb = BitArraySet::<u32, U8>::from_bytes(&[b]);
let bva_b = BitArraySet::<u32, U8>::from_bytes(&[a_b]);
let bvb_a = BitArraySet::<u32, U8>::from_bytes(&[b_a]);

bva.difference_with(&bvb);
assert_eq!(bva, bva_b);

let bva = BitArraySet::<u32, U8>::from_bytes(&[a]);
let mut bvb = BitArraySet::<u32, U8>::from_bytes(&[b]);

bvb.difference_with(&bva);
assert_eq!(bvb, bvb_a);

Source

pub fn symmetric_difference_with(&mut self, other: &Self)

Makes this bit array the symmetric difference with the specified other bit array in-place.

§Examples

extern crate typenum;
use typenum::{Unsigned, U8};
use bitarray_set::BitArraySet;

let a   = 0b01101000;
let b   = 0b10100000;
let res = 0b11001000;

let mut a = BitArraySet::<u32, U8>::from_bytes(&[a]);
let b = BitArraySet::<u32, U8>::from_bytes(&[b]);
let res = BitArraySet::<u32, U8>::from_bytes(&[res]);

a.symmetric_difference_with(&b);
assert_eq!(a, res);