pub struct IntegerList(pub RoaringTreemap);
Expand description
A data structure that uses Roaring Bitmaps to efficiently store a list of integers.
This structure provides excellent compression while allowing direct access to individual elements without the need for full decompression.
Key features:
- Efficient compression: the underlying Roaring Bitmaps significantly reduce memory usage.
- Direct access: elements can be accessed or queried without needing to decode the entire list.
- [
RoaringTreemap
] backing: internally backed by [RoaringTreemap
], which supports 64-bit integers.
Tuple Fields§
§0: RoaringTreemap
Implementations§
Source§impl IntegerList
impl IntegerList
Sourcepub fn empty() -> Self
pub fn empty() -> Self
Creates a new empty IntegerList
.
Sourcepub fn new(
list: impl IntoIterator<Item = u64>,
) -> Result<Self, IntegerListError>
pub fn new( list: impl IntoIterator<Item = u64>, ) -> Result<Self, IntegerListError>
Creates an IntegerList
from a list of integers.
Returns an error if the list is not pre-sorted.
Sourcepub fn new_pre_sorted(list: impl IntoIterator<Item = u64>) -> Self
pub fn new_pre_sorted(list: impl IntoIterator<Item = u64>) -> Self
Creates an IntegerList
from a pre-sorted list of integers.
§Panics
Panics if the list is not pre-sorted.
Sourcepub fn append(
&mut self,
list: impl IntoIterator<Item = u64>,
) -> Result<u64, IntegerListError>
pub fn append( &mut self, list: impl IntoIterator<Item = u64>, ) -> Result<u64, IntegerListError>
Appends a list of integers to the current list.
Sourcepub fn push(&mut self, value: u64) -> Result<(), IntegerListError>
pub fn push(&mut self, value: u64) -> Result<(), IntegerListError>
Pushes a new integer to the list.
Sourcepub fn to_mut_bytes<B: BufMut>(&self, buf: &mut B)
pub fn to_mut_bytes<B: BufMut>(&self, buf: &mut B)
Serializes a IntegerList
into a sequence of bytes.
Sourcepub fn from_bytes(data: &[u8]) -> Result<Self, IntegerListError>
pub fn from_bytes(data: &[u8]) -> Result<Self, IntegerListError>
Deserializes a sequence of bytes into a proper IntegerList
.
Methods from Deref<Target = RoaringTreemap>§
pub fn is_disjoint(&self, other: &RoaringTreemap) -> bool
pub fn is_disjoint(&self, other: &RoaringTreemap) -> 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::RoaringTreemap;
let mut rb1 = RoaringTreemap::new();
let mut rb2 = RoaringTreemap::new();
rb1.insert(1);
assert_eq!(rb1.is_disjoint(&rb2), true);
rb2.insert(1);
assert_eq!(rb1.is_disjoint(&rb2), false);
pub fn is_subset(&self, other: &RoaringTreemap) -> bool
pub fn is_subset(&self, other: &RoaringTreemap) -> bool
Returns true
if this set is a subset of other
.
§Examples
use roaring::RoaringTreemap;
let mut rb1 = RoaringTreemap::new();
let mut rb2 = RoaringTreemap::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);
pub fn is_superset(&self, other: &RoaringTreemap) -> bool
pub fn is_superset(&self, other: &RoaringTreemap) -> bool
Returns true
if this set is a superset of other
.
§Examples
use roaring::RoaringTreemap;
let mut rb1 = RoaringTreemap::new();
let mut rb2 = RoaringTreemap::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);
pub fn contains(&self, value: u64) -> bool
pub fn contains(&self, value: u64) -> bool
Returns true
if this set contains the specified integer.
§Examples
use roaring::RoaringTreemap;
let mut rb = RoaringTreemap::new();
rb.insert(1);
assert_eq!(rb.contains(0), false);
assert_eq!(rb.contains(1), true);
assert_eq!(rb.contains(100), false);
pub fn is_empty(&self) -> bool
pub fn is_empty(&self) -> bool
Returns true
if there are no integers in this set.
§Examples
use roaring::RoaringTreemap;
let mut rb = RoaringTreemap::new();
assert_eq!(rb.is_empty(), true);
rb.insert(3);
assert_eq!(rb.is_empty(), false);
pub fn len(&self) -> u64
pub fn len(&self) -> u64
Returns the number of distinct integers added to the set.
§Examples
use roaring::RoaringTreemap;
let mut rb = RoaringTreemap::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);
pub fn min(&self) -> Option<u64>
pub fn min(&self) -> Option<u64>
Returns the minimum value in the set (if the set is non-empty).
§Examples
use roaring::RoaringTreemap;
let mut rb = RoaringTreemap::new();
assert_eq!(rb.min(), None);
rb.insert(3);
rb.insert(4);
assert_eq!(rb.min(), Some(3));
pub fn max(&self) -> Option<u64>
pub fn max(&self) -> Option<u64>
Returns the maximum value in the set (if the set is non-empty).
§Examples
use roaring::RoaringTreemap;
let mut rb = RoaringTreemap::new();
assert_eq!(rb.max(), None);
rb.insert(3);
rb.insert(4);
assert_eq!(rb.max(), Some(4));
pub fn rank(&self, value: u64) -> u64
pub fn rank(&self, value: u64) -> u64
Returns the number of integers that are <= value. rank(u64::MAX) == len()
§Examples
use roaring::RoaringTreemap;
let mut rb = RoaringTreemap::new();
assert_eq!(rb.rank(0), 0);
rb.insert(3);
rb.insert(4);
assert_eq!(rb.rank(3), 1);
assert_eq!(rb.rank(10), 2)
pub fn select(&self, n: u64) -> Option<u64>
pub fn select(&self, n: u64) -> Option<u64>
Returns the n
th integer in the set or None
if n >= len()
§Examples
use roaring::RoaringTreemap;
let mut rb = RoaringTreemap::new();
assert_eq!(rb.select(0), None);
rb.append(vec![0, 10, 100]);
assert_eq!(rb.select(0), Some(0));
assert_eq!(rb.select(1), Some(10));
assert_eq!(rb.select(2), Some(100));
assert_eq!(rb.select(3), None);
pub fn iter(&self) -> Iter<'_>
pub fn iter(&self) -> Iter<'_>
Iterator over each value stored in the RoaringTreemap, guarantees values are ordered by value.
§Examples
use roaring::RoaringTreemap;
use core::iter::FromIterator;
let bitmap = (1..3).collect::<RoaringTreemap>();
let mut iter = bitmap.iter();
assert_eq!(iter.next(), Some(1));
assert_eq!(iter.next(), Some(2));
assert_eq!(iter.next(), None);
pub fn bitmaps(&self) -> BitmapIter<'_>
pub fn bitmaps(&self) -> BitmapIter<'_>
Iterator over pairs of partition number and the corresponding RoaringBitmap. The partition number is defined by the 32 most significant bits of the bit index.
§Examples
use roaring::{RoaringBitmap, RoaringTreemap};
use core::iter::FromIterator;
let original = (0..6000).collect::<RoaringTreemap>();
let mut bitmaps = original.bitmaps();
assert_eq!(bitmaps.next(), Some((0, &(0..6000).collect::<RoaringBitmap>())));
assert_eq!(bitmaps.next(), None);
pub fn union_len(&self, other: &RoaringTreemap) -> u64
pub fn union_len(&self, other: &RoaringTreemap) -> u64
Computes the len of the union with the specified other treemap without creating a new treemap.
This is faster and more space efficient when you’re only interested in the cardinality of the union.
§Examples
use roaring::RoaringTreemap;
let rb1: RoaringTreemap = (1..4).collect();
let rb2: RoaringTreemap = (3..5).collect();
assert_eq!(rb1.union_len(&rb2), (rb1 | rb2).len());
pub fn intersection_len(&self, other: &RoaringTreemap) -> u64
pub fn intersection_len(&self, other: &RoaringTreemap) -> u64
Computes the len of the intersection with the specified other treemap without creating a new treemap.
This is faster and more space efficient when you’re only interested in the cardinality of the intersection.
§Examples
use roaring::RoaringTreemap;
let rb1: RoaringTreemap = (1..4).collect();
let rb2: RoaringTreemap = (3..5).collect();
assert_eq!(rb1.intersection_len(&rb2), (rb1 & rb2).len());
pub fn difference_len(&self, other: &RoaringTreemap) -> u64
pub fn difference_len(&self, other: &RoaringTreemap) -> u64
Computes the len of the difference with the specified other treemap without creating a new treemap.
This is faster and more space efficient when you’re only interested in the cardinality of the difference.
§Examples
use roaring::RoaringTreemap;
let rb1: RoaringTreemap = (1..4).collect();
let rb2: RoaringTreemap = (3..5).collect();
assert_eq!(rb1.difference_len(&rb2), (rb1 - rb2).len());
pub fn symmetric_difference_len(&self, other: &RoaringTreemap) -> u64
pub fn symmetric_difference_len(&self, other: &RoaringTreemap) -> u64
Computes the len of the symmetric difference with the specified other treemap without creating a new bitmap.
This is faster and more space efficient when you’re only interested in the cardinality of the symmetric difference.
§Examples
use roaring::RoaringTreemap;
let rb1: RoaringTreemap = (1..4).collect();
let rb2: RoaringTreemap = (3..5).collect();
assert_eq!(rb1.symmetric_difference_len(&rb2), (rb1 ^ rb2).len());
pub fn serialized_size(&self) -> usize
pub 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::RoaringTreemap;
let rb1: RoaringTreemap = (1..4).collect();
let mut bytes = Vec::with_capacity(rb1.serialized_size());
rb1.serialize_into(&mut bytes).unwrap();
let rb2 = RoaringTreemap::deserialize_from(&bytes[..]).unwrap();
assert_eq!(rb1, rb2);
pub fn serialize_into<W>(&self, writer: W) -> Result<(), Error>where
W: Write,
pub fn serialize_into<W>(&self, writer: W) -> Result<(), Error>where
W: Write,
Serialize this bitmap. This is compatible with the official C/C++, Java and Go implementations.
§Examples
use roaring::RoaringTreemap;
let rb1: RoaringTreemap = (1..4).collect();
let mut bytes = vec![];
rb1.serialize_into(&mut bytes).unwrap();
let rb2 = RoaringTreemap::deserialize_from(&bytes[..]).unwrap();
assert_eq!(rb1, rb2);
Trait Implementations§
Source§impl<'a> Arbitrary<'a> for IntegerList
Available on crate feature arbitrary
only.
impl<'a> Arbitrary<'a> for IntegerList
arbitrary
only.Source§fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self, Error>
fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self, Error>
Self
from the given unstructured data. Read more§fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>
fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>
Self
from the entirety of the given
unstructured data. Read moreSource§impl Clone for IntegerList
impl Clone for IntegerList
Source§fn clone(&self) -> IntegerList
fn clone(&self) -> IntegerList
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for IntegerList
impl Debug for IntegerList
Source§impl Default for IntegerList
impl Default for IntegerList
Source§fn default() -> IntegerList
fn default() -> IntegerList
Source§impl Deref for IntegerList
impl Deref for IntegerList
Source§impl<'de> Deserialize<'de> for IntegerList
impl<'de> Deserialize<'de> for IntegerList
Source§fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
D: Deserializer<'de>,
Source§impl PartialEq for IntegerList
impl PartialEq for IntegerList
Source§impl Serialize for IntegerList
impl Serialize for IntegerList
impl StructuralPartialEq for IntegerList
Auto Trait Implementations§
impl Freeze for IntegerList
impl RefUnwindSafe for IntegerList
impl Send for IntegerList
impl Sync for IntegerList
impl Unpin for IntegerList
impl UnwindSafe for IntegerList
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Conv for T
impl<T> Conv for T
§impl<T> FmtForward for T
impl<T> FmtForward for T
§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.§fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
fn fmt_list(self) -> FmtList<Self>where
&'a Self: for<'a> IntoIterator,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read more§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.§impl<T> Tap for T
impl<T> Tap for T
§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read more§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read more§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read more§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read more§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read more§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read more§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.§impl<T> TryConv for T
impl<T> TryConv for T
§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
§fn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
impl<A> ArbInterop for A
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
impl<T> MaybeArbitrary for Twhere
T: for<'a> Arbitrary<'a>,
Layout§
Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...)
attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.
Size: 24 bytes