Struct DocSet 

pub struct DocSet { /* private fields */ }

A finite set of document ids stored in ascending order.

The explicit universe passed to Self::complement determines the finite Boolean algebra in which a complement is evaluated.

Implementations

impl DocSet

pub fn new() -> Self

Construct an empty document set.

pub fn from_unsorted(doc_ids: Vec<DocId>) -> Self

Construct a document set from ids in arbitrary order.

pub fn union(&self, other: &Self) -> Self

Set union.

pub fn intersect(&self, other: &Self) -> Self

Set intersection.

pub fn difference(&self, other: &Self) -> Self

Set difference, self \\ other.

pub fn complement(&self, universe: &Self) -> Self

Complement relative to an explicit finite universe.

pub fn contains(&self, doc_id: DocId) -> bool

Return whether doc_id belongs to this set.

pub fn as_slice(&self) -> &[DocId]

Borrow the sorted document-id representation.

pub fn iter( &self, ) -> impl ExactSizeIterator<Item = DocId> + DoubleEndedIterator + '_

Iterate over document ids in ascending order.

pub fn len(&self) -> usize

Number of document ids in the set.

pub fn is_empty(&self) -> bool

Whether the set contains no document ids.

Trait Implementations

impl BitAnd for &DocSet

type Output = DocSet

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitOr for &DocSet

type Output = DocSet

The resulting type after applying the | operator.

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

Performs the | operation.

impl Clone for DocSet

fn clone(&self) -> DocSet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocSet

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

Formats the value using the given formatter.

impl Default for DocSet

fn default() -> DocSet

Returns the “default value” for a type.

impl Eq for DocSet

impl From<&DocSet> for PostingList

fn from(support: &DocSet) -> Self

Converts to this type from the input type.

impl From<&DocSet> for Relation<bool>

fn from(support: &DocSet) -> Self

Converts to this type from the input type.

impl From<&PostingList> for DocSet

fn from(posting_list: &PostingList) -> Self

Converts to this type from the input type.

impl From<DocSet> for PostingList

fn from(support: DocSet) -> Self

Converts to this type from the input type.

impl From<DocSet> for Relation<bool>

fn from(support: DocSet) -> Self

Converts to this type from the input type.

impl From<Vec<u64>> for DocSet

fn from(doc_ids: Vec<DocId>) -> Self

Converts to this type from the input type.

impl FromIterator<u64> for DocSet

fn from_iter<I: IntoIterator<Item = DocId>>(iter: I) -> Self

Creates a value from an iterator.

impl Hash for DocSet

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoIterator for DocSet

type Item = u64

The type of the elements being iterated over.

type IntoIter = IntoIter<u64>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a DocSet

type Item = u64

The type of the elements being iterated over.

type IntoIter = Copied<Iter<'a, u64>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Ord for DocSet

fn cmp(&self, other: &DocSet) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for DocSet

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for DocSet

fn partial_cmp(&self, other: &DocSet) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for DocSet

impl Sub for &DocSet

type Output = DocSet

The resulting type after applying the - operator.

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

Performs the - operation.