Hunt.Common.Occurrences

Occurrences of words within the index. A word occurs in document at specific locations.

Documentation

type Occurrences = DocIdMap Positions

The occurrences of words in documents. A mapping from document ids to the positions in the document.

empty :: Occurrences

Create an empty set of positions.

fromDocIdSet :: DocIdSet -> Occurrences

Create Occurrences from a DocIdSet Since the DocIdSet contains no position information, we assume position one for each DocId

singleton :: DocId -> Position -> Occurrences

Create a single dcid set with a single position.

singleton' :: DocId -> [Position] -> Occurrences

Create a single dcid set with a set of.

null :: Occurrences -> Bool

Test on empty set of positions.

size :: Occurrences -> Int

Determine the number of positions in a set of occurrences.

insert :: DocId -> Position -> Occurrences -> Occurrences

Add a position to occurrences.

insert' :: DocId -> Positions -> Occurrences -> Occurrences

Add multiple positions to occurrences

deleteOccurrence :: DocId -> Position -> Occurrences -> Occurrences

Remove a position from occurrences.

delete :: DocId -> Occurrences -> Occurrences

Delete a document (by DocId) from occurrences.

update :: (DocId -> DocId) -> Occurrences -> Occurrences

Changes the DocIDs of the occurrences.

merge :: Occurrences -> Occurrences -> Occurrences

Merge two occurrences.

merges :: [Occurrences] -> Occurrences

Merge occurrences

difference :: Occurrences -> Occurrences -> Occurrences

Difference of occurrences.

diffWithSet :: Occurrences -> DocIdSet -> Occurrences

Remove Set of DocIds from Occurrences

subtract :: Occurrences -> Occurrences -> Occurrences

Subtract occurrences from some other occurrences.

intersectOccurrences :: (Positions -> Positions -> Positions) -> Occurrences -> Occurrences -> Occurrences