Struct roaring::bitmap::RoaringBitmap

pub struct RoaringBitmap { /* fields omitted */ }

A compressed bitmap using the Roaring bitmap compression scheme.

Examples

use roaring::RoaringBitmap;

let mut rb = RoaringBitmap::new();

// insert all primes less than 10
rb.insert(2);
rb.insert(3);
rb.insert(5);
rb.insert(7);
println!("total bits set to true: {}", rb.len());

Methods

impl RoaringBitmap

fn new() -> RoaringBitmap

Creates an empty RoaringBitmap.

Examples

use roaring::RoaringBitmap;
let mut rb = RoaringBitmap::new();

fn insert(&mut self, value: u32) -> bool

Adds a value to the set. Returns true if the value was not already present in the set.

Examples

use roaring::RoaringBitmap;

let mut rb = RoaringBitmap::new();
assert_eq!(rb.insert(3), true);
assert_eq!(rb.insert(3), false);
assert_eq!(rb.contains(3), true);

fn remove(&mut self, value: u32) -> bool

Removes a value from the set. Returns true if the value was present in the set.

Examples

use roaring::RoaringBitmap;

let mut rb = RoaringBitmap::new();
rb.insert(3);
assert_eq!(rb.remove(3), true);
assert_eq!(rb.remove(3), false);
assert_eq!(rb.contains(3), false);

fn contains(&self, value: u32) -> bool

Returns true if this set contains the specified integer.

Examples

use roaring::RoaringBitmap;

let mut rb = RoaringBitmap::new();
rb.insert(1);
assert_eq!(rb.contains(0), false);
assert_eq!(rb.contains(1), true);
assert_eq!(rb.contains(100), false);

fn clear(&mut self)

Clears all integers in this set.

Examples

use roaring::RoaringBitmap;

let mut rb = RoaringBitmap::new();
rb.insert(1);
assert_eq!(rb.contains(1), true);
rb.clear();
assert_eq!(rb.contains(1), false);

fn is_empty(&self) -> bool

Returns true if there are no integers in this set.

Examples

use roaring::RoaringBitmap;

let mut rb = RoaringBitmap::new();
assert_eq!(rb.is_empty(), true);

rb.insert(3);
assert_eq!(rb.is_empty(), false);

fn len(&self) -> u64

Returns the number of distinct integers added to the set.

Examples

use roaring::RoaringBitmap;

let mut rb = RoaringBitmap::new();
assert_eq!(rb.len(), 0);

rb.insert(3);
assert_eq!(rb.len(), 1);

rb.insert(3);
rb.insert(4);
assert_eq!(rb.len(), 2);

fn min(&self) -> Option<u32>

Returns the minimum value in the set (if the set is non-empty).

Examples

use roaring::RoaringBitmap;

let mut rb = RoaringBitmap::new();
assert_eq!(rb.min(), None);

rb.insert(3);
rb.insert(4);
assert_eq!(rb.min(), Some(3));

fn max(&self) -> Option<u32>

Returns the maximum value in the set (if the set is non-empty).

Examples

use roaring::RoaringBitmap;

let mut rb = RoaringBitmap::new();
assert_eq!(rb.max(), None);

rb.insert(3);
rb.insert(4);
assert_eq!(rb.max(), Some(4));

impl RoaringBitmap

fn iter(&self) -> Iter

Iterator over each value stored in the RoaringBitmap, guarantees values are ordered by value.

Examples

use roaring::RoaringBitmap;
use std::iter::FromIterator;

let bitmap = RoaringBitmap::from_iter(1..3);
let mut iter = bitmap.iter();

assert_eq!(iter.next(), Some(1));
assert_eq!(iter.next(), Some(2));
assert_eq!(iter.next(), None);

impl RoaringBitmap

fn union_with(&mut self, other: &RoaringBitmap)

Unions in-place with the specified other bitmap.

Examples

use roaring::RoaringBitmap;

let mut rb1: RoaringBitmap = (1..4).collect();
let rb2: RoaringBitmap = (3..5).collect();
let rb3: RoaringBitmap = (1..5).collect();

rb1.union_with(&rb2);

assert_eq!(rb1, rb3);

Can also be done via the BitOr operator.

use roaring::RoaringBitmap;

let mut rb1: RoaringBitmap = (1..4).collect();
let rb2: RoaringBitmap = (3..5).collect();
let rb3: RoaringBitmap = (1..5).collect();

let rb1 = rb1 | rb2;

assert_eq!(rb1, rb3);

fn intersect_with(&mut self, other: &RoaringBitmap)

Intersects in-place with the specified other bitmap.

Examples

use roaring::RoaringBitmap;

let mut rb1: RoaringBitmap = (1..4).collect();
let rb2: RoaringBitmap = (3..5).collect();
let rb3: RoaringBitmap = (3..4).collect();

rb1.intersect_with(&rb2);

assert_eq!(rb1, rb3);

Can also be done via the BitAnd operator.

use roaring::RoaringBitmap;

let mut rb1: RoaringBitmap = (1..4).collect();
let rb2: RoaringBitmap = (3..5).collect();
let rb3: RoaringBitmap = (3..4).collect();

let rb1 = rb1 & rb2;

assert_eq!(rb1, rb3);

fn difference_with(&mut self, other: &RoaringBitmap)

Removes all values in the specified other bitmap from self, in-place.

Examples

use roaring::RoaringBitmap;

let mut rb1: RoaringBitmap = (1..4).collect();
let rb2: RoaringBitmap = (3..5).collect();
let rb3: RoaringBitmap = (1..3).collect();

rb1.difference_with(&rb2);

assert_eq!(rb1, rb3);

Can also be done via the Sub operator.

use roaring::RoaringBitmap;

let mut rb1: RoaringBitmap = (1..4).collect();
let rb2: RoaringBitmap = (3..5).collect();
let rb3: RoaringBitmap = (1..3).collect();

let rb1 = rb1 - rb2;

assert_eq!(rb1, rb3);

fn symmetric_difference_with(&mut self, other: &RoaringBitmap)

Replaces this bitmap with one that is equivalent to self XOR other.

Examples

use roaring::RoaringBitmap;

let mut rb1: RoaringBitmap = (1..4).collect();
let rb2: RoaringBitmap = (3..6).collect();
let rb3: RoaringBitmap = (1..3).chain(4..6).collect();

rb1.symmetric_difference_with(&rb2);

assert_eq!(rb1, rb3);

Can also be done via the BitXor operator.

use roaring::RoaringBitmap;

let mut rb1: RoaringBitmap = (1..4).collect();
let rb2: RoaringBitmap = (3..6).collect();
let rb3: RoaringBitmap = (1..3).chain(4..6).collect();

let rb1 = rb1 ^ rb2;

assert_eq!(rb1, rb3);

impl RoaringBitmap

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

Returns true if the set has no elements in common with other. This is equivalent to checking for an empty intersection.

Examples

use roaring::RoaringBitmap;

let mut rb1 = RoaringBitmap::new();
let mut rb2 = RoaringBitmap::new();

rb1.insert(1);

assert_eq!(rb1.is_disjoint(&rb2), true);

rb2.insert(1);

assert_eq!(rb1.is_disjoint(&rb2), false);

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

Returns true if this set is a subset of other.

Examples

use roaring::RoaringBitmap;

let mut rb1 = RoaringBitmap::new();
let mut rb2 = RoaringBitmap::new();

rb1.insert(1);

assert_eq!(rb1.is_subset(&rb2), false);

rb2.insert(1);

assert_eq!(rb1.is_subset(&rb2), true);

rb1.insert(2);

assert_eq!(rb1.is_subset(&rb2), false);

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

Returns true if this set is a superset of other.

Examples

use roaring::RoaringBitmap;

let mut rb1 = RoaringBitmap::new();
let mut rb2 = RoaringBitmap::new();

rb1.insert(1);

assert_eq!(rb2.is_superset(&rb1), false);

rb2.insert(1);

assert_eq!(rb2.is_superset(&rb1), true);

rb1.insert(2);

assert_eq!(rb2.is_superset(&rb1), false);

impl RoaringBitmap

fn serialized_size(&self) -> usize

Return the size in bytes of the serialized output. This is compatible with the official C/C++, Java and Go implementations.

Examples

use roaring::RoaringBitmap;

let rb1: RoaringBitmap = (1..4).collect();
let mut bytes = Vec::with_capacity(rb1.serialized_size());
rb1.serialize_into(&mut bytes).unwrap();
let rb2 = RoaringBitmap::deserialize_from(&mut &bytes[..]).unwrap();

assert_eq!(rb1, rb2);

fn serialize_into<W: Write>(&self, writer: W) -> Result<()>

Serialize this bitmap into the standard Roaring on-disk format. This is compatible with the official C/C++, Java and Go implementations.

Examples

use roaring::RoaringBitmap;

let rb1: RoaringBitmap = (1..4).collect();
let mut bytes = vec![];
rb1.serialize_into(&mut bytes).unwrap();
let rb2 = RoaringBitmap::deserialize_from(&mut &bytes[..]).unwrap();

assert_eq!(rb1, rb2);

fn deserialize_from<R: Read>(reader: R) -> Result<RoaringBitmap>

Deserialize a bitmap into memory from the standard Roaring on-disk format. This is compatible with the official C/C++, Java and Go implementations.

Examples

use roaring::RoaringBitmap;

let rb1: RoaringBitmap = (1..4).collect();
let mut bytes = vec![];
rb1.serialize_into(&mut bytes).unwrap();
let rb2 = RoaringBitmap::deserialize_from(&mut &bytes[..]).unwrap();

assert_eq!(rb1, rb2);

Trait Implementations

impl Debug for RoaringBitmap

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

Formats the value using the given formatter.

impl Default for RoaringBitmap

fn default() -> RoaringBitmap

Returns the "default value" for a type.

impl<'a> IntoIterator for &'a RoaringBitmap

type Item = u32

The type of the elements being iterated over.

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Iter<'a>

Creates an iterator from a value.

impl IntoIterator for RoaringBitmap

type Item = u32

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> IntoIter

Creates an iterator from a value.

impl FromIterator<u32> for RoaringBitmap

fn from_iter<I: IntoIterator<Item=u32>>(iterator: I) -> RoaringBitmap

Creates a value from an iterator.

impl Extend<u32> for RoaringBitmap

fn extend<I: IntoIterator<Item=u32>>(&mut self, iterator: I)

Extends a collection with the contents of an iterator.

impl BitOr<RoaringBitmap> for RoaringBitmap

type Output = RoaringBitmap

The resulting type after applying the | operator

fn bitor(self, rhs: RoaringBitmap) -> RoaringBitmap

The method for the | operator

impl<'a> BitOr<&'a RoaringBitmap> for RoaringBitmap

type Output = RoaringBitmap

The resulting type after applying the | operator

fn bitor(self, rhs: &'a RoaringBitmap) -> RoaringBitmap

The method for the | operator

impl<'a> BitOr<RoaringBitmap> for &'a RoaringBitmap

type Output = RoaringBitmap

The resulting type after applying the | operator

fn bitor(self, rhs: RoaringBitmap) -> RoaringBitmap

The method for the | operator

impl<'a, 'b> BitOr<&'a RoaringBitmap> for &'b RoaringBitmap

type Output = RoaringBitmap

The resulting type after applying the | operator

fn bitor(self, rhs: &'a RoaringBitmap) -> RoaringBitmap

The method for the | operator

impl BitOrAssign<RoaringBitmap> for RoaringBitmap

fn bitor_assign(&mut self, rhs: RoaringBitmap)

The method for the |= operator

impl<'a> BitOrAssign<&'a RoaringBitmap> for RoaringBitmap

fn bitor_assign(&mut self, rhs: &'a RoaringBitmap)

The method for the |= operator

impl BitAnd<RoaringBitmap> for RoaringBitmap

type Output = RoaringBitmap

The resulting type after applying the & operator

fn bitand(self, rhs: RoaringBitmap) -> RoaringBitmap

The method for the & operator

impl<'a> BitAnd<&'a RoaringBitmap> for RoaringBitmap

type Output = RoaringBitmap

The resulting type after applying the & operator

fn bitand(self, rhs: &'a RoaringBitmap) -> RoaringBitmap

The method for the & operator

impl<'a> BitAnd<RoaringBitmap> for &'a RoaringBitmap

type Output = RoaringBitmap

The resulting type after applying the & operator

fn bitand(self, rhs: RoaringBitmap) -> RoaringBitmap

The method for the & operator

impl<'a, 'b> BitAnd<&'a RoaringBitmap> for &'b RoaringBitmap

type Output = RoaringBitmap

The resulting type after applying the & operator

fn bitand(self, rhs: &'a RoaringBitmap) -> RoaringBitmap

The method for the & operator

impl BitAndAssign<RoaringBitmap> for RoaringBitmap

fn bitand_assign(&mut self, rhs: RoaringBitmap)

The method for the &= operator

impl<'a> BitAndAssign<&'a RoaringBitmap> for RoaringBitmap

fn bitand_assign(&mut self, rhs: &'a RoaringBitmap)

The method for the &= operator

impl Sub<RoaringBitmap> for RoaringBitmap

type Output = RoaringBitmap

The resulting type after applying the - operator

fn sub(self, rhs: RoaringBitmap) -> RoaringBitmap

The method for the - operator

impl<'a> Sub<&'a RoaringBitmap> for RoaringBitmap

type Output = RoaringBitmap

The resulting type after applying the - operator

fn sub(self, rhs: &'a RoaringBitmap) -> RoaringBitmap

The method for the - operator

impl<'a> Sub<RoaringBitmap> for &'a RoaringBitmap

type Output = RoaringBitmap

The resulting type after applying the - operator

fn sub(self, rhs: RoaringBitmap) -> RoaringBitmap

The method for the - operator

impl<'a, 'b> Sub<&'a RoaringBitmap> for &'b RoaringBitmap

type Output = RoaringBitmap

The resulting type after applying the - operator

fn sub(self, rhs: &'a RoaringBitmap) -> RoaringBitmap

The method for the - operator

impl SubAssign<RoaringBitmap> for RoaringBitmap

fn sub_assign(&mut self, rhs: RoaringBitmap)

The method for the -= operator

impl<'a> SubAssign<&'a RoaringBitmap> for RoaringBitmap

fn sub_assign(&mut self, rhs: &'a RoaringBitmap)

The method for the -= operator

impl BitXor<RoaringBitmap> for RoaringBitmap

type Output = RoaringBitmap

The resulting type after applying the ^ operator

fn bitxor(self, rhs: RoaringBitmap) -> RoaringBitmap

The method for the ^ operator

impl<'a> BitXor<&'a RoaringBitmap> for RoaringBitmap

type Output = RoaringBitmap

The resulting type after applying the ^ operator

fn bitxor(self, rhs: &'a RoaringBitmap) -> RoaringBitmap

The method for the ^ operator

impl<'a> BitXor<RoaringBitmap> for &'a RoaringBitmap

type Output = RoaringBitmap

The resulting type after applying the ^ operator

fn bitxor(self, rhs: RoaringBitmap) -> RoaringBitmap

The method for the ^ operator

impl<'a, 'b> BitXor<&'a RoaringBitmap> for &'b RoaringBitmap

type Output = RoaringBitmap

The resulting type after applying the ^ operator

fn bitxor(self, rhs: &'a RoaringBitmap) -> RoaringBitmap

The method for the ^ operator

impl BitXorAssign<RoaringBitmap> for RoaringBitmap

fn bitxor_assign(&mut self, rhs: RoaringBitmap)

The method for the ^= operator

impl<'a> BitXorAssign<&'a RoaringBitmap> for RoaringBitmap

fn bitxor_assign(&mut self, rhs: &'a RoaringBitmap)

The method for the ^= operator

impl PartialEq for RoaringBitmap

fn eq(&self, __arg_0: &RoaringBitmap) -> bool

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

fn ne(&self, __arg_0: &RoaringBitmap) -> bool

This method tests for !=.

impl Clone for RoaringBitmap

fn clone(&self) -> RoaringBitmap

Returns a copy of the value.

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

Performs copy-assignment from source.