Struct RowAddrTreeMap 

pub struct RowAddrTreeMap { /* private fields */ }

A collection of row addresses.

Note: For stable row id mode, this may be split into a separate structure in the future.

These row ids may either be stable-style (where they can be an incrementing u64 sequence) or address style, where they are a fragment id and a row offset. When address style, this supports setting entire fragments as selected, without needing to enumerate all the ids in the fragment.

This is similar to a RoaringTreemap but it is optimized for the case where entire fragments are selected or deselected.

Implementations

impl RowAddrTreeMap

pub fn new() -> Self

Create an empty set

pub fn row_addrs(&self) -> Option<impl Iterator<Item = RowAddress> + '_>

An iterator of row addrs

If there are any “full fragment” items then this can’t be calculated and None is returned

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

Insert a single value into the set

Returns true if the value was not already in the set.

use lance_core::utils::mask::{RowAddrTreeMap, RowSetOps};

let mut set = RowAddrTreeMap::new();
assert_eq!(set.insert(10), true);
assert_eq!(set.insert(10), false);
assert_eq!(set.contains(10), true);

pub fn insert_range<R: RangeBounds<u64>>(&mut self, range: R) -> u64

Insert a range of values into the set

pub fn insert_bitmap(&mut self, fragment: u32, bitmap: RoaringBitmap)

Add a bitmap for a single fragment

pub fn insert_fragment(&mut self, fragment_id: u32)

Add a whole fragment to the set

pub fn get_fragment_bitmap(&self, fragment_id: u32) -> Option<&RoaringBitmap>

pub fn retain_fragments(&mut self, frag_ids: impl IntoIterator<Item = u32>)

pub fn serialized_size(&self) -> usize

Compute the serialized size of the set.

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

Serialize the set into the given buffer

The serialization format is stable and used for index serialization

The serialization format is:

• u32: num_entries

for each entry:

• u32: fragment_id
• u32: bitmap size
• [u8]: bitmap

If bitmap size is zero then the entire fragment is selected.

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

Deserialize the set from the given buffer

pub fn mask(&mut self, mask: &RowAddrMask)

Apply a mask to the row addrs

For AllowList: only keep rows that are in the selection and not null For BlockList: remove rows that are blocked (not null) and remove nulls

pub unsafe fn into_addr_iter(self) -> impl Iterator<Item = u64>

Convert the set into an iterator of row addrs

Safety

This is unsafe because if any of the inner RowAddrSelection elements is not a Partial then the iterator will panic because we don’t know the size of the bitmap.

Trait Implementations

impl BitAnd<&RowAddrTreeMap> for RowAddrTreeMap

type Output = RowAddrTreeMap

The resulting type after applying the & operator.

fn bitand(self, rhs: &Self) -> Self::Output

Performs the & operation.

impl BitAnd for RowAddrTreeMap

type Output = RowAddrTreeMap

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitAndAssign<&RowAddrTreeMap> for RowAddrTreeMap

fn bitand_assign(&mut self, rhs: &Self)

Performs the &= operation.

impl BitAndAssign for RowAddrTreeMap

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr<&RowAddrTreeMap> for RowAddrTreeMap

type Output = RowAddrTreeMap

The resulting type after applying the | operator.

fn bitor(self, rhs: &Self) -> Self::Output

Performs the | operation.

impl BitOr for RowAddrTreeMap

type Output = RowAddrTreeMap

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitOrAssign<&RowAddrTreeMap> for RowAddrTreeMap

fn bitor_assign(&mut self, rhs: &Self)

Performs the |= operation.

impl BitOrAssign for RowAddrTreeMap

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl Clone for RowAddrTreeMap

fn clone(&self) -> RowAddrTreeMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RowAddrTreeMap

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

Formats the value using the given formatter.

impl DeepSizeOf for RowAddrTreeMap

fn deep_size_of_children(&self, context: &mut Context) -> usize

Returns an estimation of the heap-managed storage of this object. This does not include the size of the object itself.

fn deep_size_of(&self) -> usize

Returns an estimation of a total size of memory owned by the object, including heap-managed storage.

impl Default for RowAddrTreeMap

fn default() -> RowAddrTreeMap

Returns the “default value” for a type.

impl<'a> Extend<&'a u64> for RowAddrTreeMap

fn extend<T: IntoIterator<Item = &'a u64>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<RowAddrTreeMap> for RowAddrTreeMap

fn extend<T: IntoIterator<Item = Self>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<u64> for RowAddrTreeMap

fn extend<T: IntoIterator<Item = u64>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<Range<u64>> for RowAddrTreeMap

fn from(range: Range<u64>) -> Self

Converts to this type from the input type.

impl From<RangeInclusive<u64>> for RowAddrTreeMap

fn from(range: RangeInclusive<u64>) -> Self

Converts to this type from the input type.

impl From<RoaringTreemap> for RowAddrTreeMap

fn from(roaring: RoaringTreemap) -> Self

Converts to this type from the input type.

impl<'a> FromIterator<&'a u64> for RowAddrTreeMap

fn from_iter<T: IntoIterator<Item = &'a u64>>(iter: T) -> Self

Creates a value from an iterator.

impl FromIterator<u64> for RowAddrTreeMap

fn from_iter<T: IntoIterator<Item = u64>>(iter: T) -> Self

Creates a value from an iterator.

impl PartialEq for RowAddrTreeMap

fn eq(&self, other: &RowAddrTreeMap) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RowSetOps for RowAddrTreeMap

type Row = u64

Logical row handle (u64 for both row ids and row addresses).

fn is_empty(&self) -> bool

Returns true if the set is empty.

fn len(&self) -> Option<u64>

Returns the number of rows in the set, if it is known.

fn remove(&mut self, row: Self::Row) -> bool

Remove a value from the row set.

fn contains(&self, row: Self::Row) -> bool

Returns whether this set contains the given row.

fn union_all(other: &[&Self]) -> Self

Returns the union of other and init self.

fn from_sorted_iter<I>(iter: I) -> Result<Self>

where I: IntoIterator<Item = Self::Row>,

Builds a row set from an iterator of rows.

impl Sub<&RowAddrTreeMap> for RowAddrTreeMap

type Output = RowAddrTreeMap

The resulting type after applying the - operator.

fn sub(self, rhs: &Self) -> Self

Performs the - operation.

impl Sub for RowAddrTreeMap

type Output = RowAddrTreeMap

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<&RowAddrTreeMap> for RowAddrTreeMap

fn sub_assign(&mut self, rhs: &Self)

Performs the -= operation.

impl StructuralPartialEq for RowAddrTreeMap