smile.nlp

Interface Corpus

All Known Implementing Classes:

SimpleCorpus

public interface Corpus

A corpus is a collection of documents.

Method Summary

Modifier and Type	Method and Description
int	getAverageDocumentSize() Returns the average size of documents in the corpus.
int	getBigramFrequency(Bigram bigram) Returns the total frequency of the bigram in the corpus.
java.util.Iterator<Bigram>	getBigrams() Returns an iterator over the bigrams in the corpus.
long	getNumBigrams() Returns the number of bigrams in the corpus.
int	getNumDocuments() Returns the number of documents in the corpus.
int	getNumTerms() Returns the number of unique terms in the corpus.
int	getTermFrequency(java.lang.String term) Returns the total frequency of the term in the corpus.
java.util.Iterator<java.lang.String>	getTerms() Returns an iterator over the terms in the corpus.
java.util.Iterator<Relevance>	search(RelevanceRanker ranker, java.lang.String term) Returns an iterator over the set of documents containing the given term in descending order of relevance.
java.util.Iterator<Relevance>	search(RelevanceRanker ranker, java.lang.String[] terms) Returns an iterator over the set of documents containing (at least one of) the given terms in descending order of relevance.
java.util.Iterator<Text>	search(java.lang.String term) Returns an iterator over the set of documents containing the given term.
long	size() Returns the number of words in the corpus.

Method Detail

size

long size()

Returns the number of words in the corpus.

getNumDocuments

int getNumDocuments()

Returns the number of documents in the corpus.

getNumTerms

int getNumTerms()

Returns the number of unique terms in the corpus.

getNumBigrams

long getNumBigrams()

Returns the number of bigrams in the corpus.

getAverageDocumentSize

int getAverageDocumentSize()

Returns the average size of documents in the corpus.

getTermFrequency

int getTermFrequency(java.lang.String term)

Returns the total frequency of the term in the corpus.

getBigramFrequency

int getBigramFrequency(Bigram bigram)

Returns the total frequency of the bigram in the corpus.

getTerms

java.util.Iterator<java.lang.String> getTerms()

Returns an iterator over the terms in the corpus.

getBigrams

java.util.Iterator<Bigram> getBigrams()

Returns an iterator over the bigrams in the corpus.

search

java.util.Iterator<Text> search(java.lang.String term)

Returns an iterator over the set of documents containing the given term.

search

java.util.Iterator<Relevance> search(RelevanceRanker ranker,
                                     java.lang.String term)

Returns an iterator over the set of documents containing the given term in descending order of relevance.

search

java.util.Iterator<Relevance> search(RelevanceRanker ranker,
                                     java.lang.String[] terms)

Returns an iterator over the set of documents containing (at least one of) the given terms in descending order of relevance.