Trait roaring::MultiOps

pub trait MultiOps<T>: IntoIterator<Item = T> {
    type Output;

    fn union(self) -> Self::Output;
    fn intersection(self) -> Self::Output;
    fn difference(self) -> Self::Output;
    fn symmetric_difference(self) -> Self::Output;
}

A Iterator::collect blanket implementation that provides extra methods for RoaringBitmap and RoaringTreemap.

When merging multiple bitmap with the same operation it’s usually faster to call the method in this trait than to write your own for loop and merging the bitmaps yourself.

Examples

use roaring::{MultiOps, RoaringBitmap};

let bitmaps = [
    RoaringBitmap::from_iter(0..10),
    RoaringBitmap::from_iter(10..20),
    RoaringBitmap::from_iter(20..30),
];

// Stop doing this
let naive = bitmaps.clone().into_iter().reduce(|a, b| a | b).unwrap_or_default();

// And start doing this instead, it will be much faster!
let iter = bitmaps.union();

assert_eq!(naive, iter);

Required Associated Types

type Output

The type of output from operations.

Required Methods

fn union(self) -> Self::Output

The union between all elements.

fn intersection(self) -> Self::Output

The intersection between all elements.

fn difference(self) -> Self::Output

The difference between all elements.

fn symmetric_difference(self) -> Self::Output

The symmetric difference between all elements.

Implementors

impl<'a, I> MultiOps<&'a RoaringBitmap> for Iwhere
    I: IntoIterator<Item = &'a RoaringBitmap>,

type Output = RoaringBitmap

impl<'a, I> MultiOps<&'a RoaringTreemap> for Iwhere
    I: IntoIterator<Item = &'a RoaringTreemap>,

type Output = RoaringTreemap

impl<'a, I, E: 'a> MultiOps<Result<&'a RoaringBitmap, E>> for Iwhere
    I: IntoIterator<Item = Result<&'a RoaringBitmap, E>>,

type Output = Result<RoaringBitmap, E>

impl<'a, I, E: 'a> MultiOps<Result<&'a RoaringTreemap, E>> for Iwhere
    I: IntoIterator<Item = Result<&'a RoaringTreemap, E>>,

type Output = Result<RoaringTreemap, E>

impl<I> MultiOps<RoaringBitmap> for Iwhere
    I: IntoIterator<Item = RoaringBitmap>,

type Output = RoaringBitmap

impl<I> MultiOps<RoaringTreemap> for Iwhere
    I: IntoIterator<Item = RoaringTreemap>,

type Output = RoaringTreemap

impl<I, E> MultiOps<Result<RoaringBitmap, E>> for Iwhere
    I: IntoIterator<Item = Result<RoaringBitmap, E>>,

type Output = Result<RoaringBitmap, E>

impl<I, E> MultiOps<Result<RoaringTreemap, E>> for Iwhere
    I: IntoIterator<Item = Result<RoaringTreemap, E>>,

type Output = Result<RoaringTreemap, E>