Struct Relation 

pub struct Relation<K> { /* private fields */ }

A finite-support function from document ids to semiring values.

Entries are sorted by doc_id, unique by doc_id, and never store the semiring zero value.

Implementations

impl<K> Relation<K>

pub fn new() -> Self

Construct the empty relation.

pub fn entries(&self) -> &[RelationEntry<K>]

Borrow the sorted non-zero entries.

pub fn get(&self, doc_id: DocId) -> Option<&K>

Look up a value by document id.

pub fn support(&self) -> DocSet

Project away values and return the finite support.

pub fn len(&self) -> usize

Number of non-zero entries.

pub fn is_empty(&self) -> bool

Whether the support is empty.

pub fn iter(&self) -> Iter<'_, RelationEntry<K>>

Iterate over non-zero entries in document-id order.

impl<K: Semiring> Relation<K>

pub fn from_support(support: &DocSet) -> Self

Lift a document set to its characteristic relation, assigning the semiring multiplicative identity to every supported document.

pub fn from_terms<I>(terms: I) -> Self

where I: IntoIterator<Item = RelationEntry<K>>,

Construct from possibly unsorted terms, combining duplicate document ids with semiring addition and discarding zero results.

pub fn singleton(doc_id: DocId, value: K) -> Self

Construct a singleton relation. A zero value produces the empty relation.

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

Pointwise semiring addition.

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

Pointwise semiring multiplication.

Trait Implementations

impl<K: Clone> Clone for Relation<K>

fn clone(&self) -> Relation<K>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K: Debug> Debug for Relation<K>

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

Formats the value using the given formatter.

impl<K: Default> Default for Relation<K>

fn default() -> Relation<K>

Returns the “default value” for a type.

impl From<&DocSet> for Relation<bool>

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<K> IntoIterator for Relation<K>

type Item = RelationEntry<K>

The type of the elements being iterated over.

type IntoIter = IntoIter<RelationEntry<K>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, K> IntoIterator for &'a Relation<K>

type Item = &'a RelationEntry<K>

The type of the elements being iterated over.

type IntoIter = Iter<'a, RelationEntry<K>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<K: PartialEq> PartialEq for Relation<K>

fn eq(&self, other: &Relation<K>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<K: PartialEq> StructuralPartialEq for Relation<K>