Struct hibitset::BitProducer

pub struct BitProducer<'a, T: 'a + Send + Sync>(pub BitIter<&'a T>, pub u8);

Allows splitting and internally iterating through BitSet.

Usually used internally by BitParIter.

Trait Implementations

impl<'a, T: Debug + 'a + Send + Sync> Debug for BitProducer<'a, T>

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

Formats the value using the given formatter.

impl<'a, T: 'a + Send + Sync> UnindexedProducer for BitProducer<'a, T> where
    T: BitSetLike, 

type Item = u32

The type of item returned by this producer.

fn split(self) -> (Self, Option<Self>)

How the splitting is done:

1. First the highest layer that has at least one set bit is searched.

2. If the layer that was found, has only one bit that's set, it's cleared. After that the correct prefix for the cleared bit is figured out and the descending is continued.

3. If the layer that was found, has more than one bit that's set, a mask is created that splits it's set bits as close to half as possible. After creating the mask the layer is masked by either the mask or it's complement constructing two distinct producers which are then returned.

4. If there isn't any layers that have more than one set bit, splitting doesn't happen.

The actual iteration is performed by the sequential iterator BitIter which internals are modified by this splitting algorithm.

This splitting strategy should split work evenly if the set bits are distributed close to uniformly random. As the strategy only looks one layer at the time, if there are subtrees that have lots of work and sibling subtrees that have little of work, then it will produce non-optimal splittings.

fn fold_with<F>(self, folder: F) -> F where
    F: Folder<Self::Item>, 

Iterate the producer, feeding each element to folder, and stop when the folder is full (or all elements have been consumed).