Uses of Interface
cluster.ClusterDoc

Packages that use ClusterDoc

benchmark	Classes that benchmark the system.
cluster	Classes that deal with the unsupervised clustering.
Util	Lots of classes that are used throughout the engine, and could possibly be used in another project.
websearch	Classes for searching general web results.

Uses of ClusterDoc in benchmark

Classes in benchmark that implement ClusterDoc

class	ClusterableReuters
class	TestReuters

Methods in benchmark with parameters of type ClusterDoc

int	ClusterableReuters.compareTo(ClusterDoc arg0)

Uses of ClusterDoc in cluster

Methods in cluster that return types with arguments of type ClusterDoc

java.util.Set<ClusterDoc>	Phrase.getCover() Returns those documents that belong to this phrase by themself If a paper contains a child phrase but not this phrase, then this method will not return the paper although getNestedCover() will
java.util.Set<ClusterDoc>	Phrase.getCoverUnion(Phrase s)
java.util.Set<ClusterDoc>	Phrase.getNestedCover() All documents that support/contain this term or child terms

Methods in cluster with parameters of type ClusterDoc

void	Phrase.addCoveredDoc(ClusterDoc d) cover is a Set anyways, so don't worry about checking before calling this method
static double	PhraseSupporter.findRelevanceRelaxed(ClusterDoc d, Phrase set, Phrase required, int slackNum) An experiment while calculating the relationship between two phrases Abandoned in favor of embedding alternative phrases within Phrase
static int	PhraseSupporter.getNumInstancesOfCombinedSet(ClusterDoc d, Phrase setA, Phrase setB)
static int	PhraseSupporter.getNumInstancesOfSet(ClusterDoc d, Phrase set) Returns how many windows (ie.
static int	PhraseSupporter.getNumInstancesOfSetRelaxed(ClusterDoc d, Phrase set, Phrase required, int slackNum) Set can occur in a sentence if at most slackNum words of the combined phrase are missing, and none of these missing words are in required
static int	PhraseSupporter.getNumInstancesOfSetSingle(ClusterDoc d, Phrase set) A faster implementation when there is only one set

Method parameters in cluster with type arguments of type ClusterDoc

void	Phrase.addCoveredDocs(java.util.Set<ClusterDoc> cover2)
static void	TreeHelper.calculateMemberships(java.util.List<Phrase> clusters, java.util.List<? extends ClusterDoc> files) Assigns all documents into the hierarchy, following certain limitations and goals The number of clusters per doc is at most 4 Try to place documents in smaller clusters
static double	PhraseSupporter.calculateRelevance(java.util.Set<ClusterDoc> docs, Phrase originalSet, Phrase combined) The interpretation is that if P(B|A) -> 1, then phrase b is seen every time phrase A occurs.
static double	PhraseSupporter.calculateRelevanceRelaxed(java.util.Set<ClusterDoc> docs, Phrase originalSet, Phrase combined) An experiment when calculating how two clusters are related.
static boolean	PhraseSupporter.checkSet(java.util.Set<ClusterDoc> docs, Phrase termSet, double cutoff)
static java.util.List<Phrase>	PhraseSupporter.checkSets(java.util.List<? extends ClusterDoc> docs, java.util.List<Phrase> candidates, int sufficientDocs) Records in TestDoc the number of terms supported Records in TermSet the documents that cover each term
static java.util.List<Phrase>	TreeHelper.createClusterTemplate(java.util.List<? extends ClusterDoc> files, java.util.List<Phrase> terms)
static java.util.List<Phrase>	TreeHelper.createClusterTemplateWithCatBoost(java.util.List<? extends ClusterDoc> files, java.util.List<Phrase> terms, int cat) This makes the hierarchy and defines the terms for each node If using snippets, abstracts, it may be possible to just use this
static void	PhraseFinder.findAndAddPhrases(boolean verbose, java.util.List<? extends ClusterDoc> docs, int vocabCutoff, java.util.List<Phrase> set, int phraseSize, VectorManager vm) Finds phrases and adds them to set
static int	PhraseSupporter.getNumInstances(java.util.Set<ClusterDoc> docs, Phrase set)
static int	PhraseSupporter.getNumInstancesOfCombinedSet(java.util.Set<ClusterDoc> docs, Phrase thisI, Phrase thisJ)
static int	PhraseSupporter.numDocsWithSet(java.util.Collection<ClusterDoc> docs, Phrase p)
static void	TreeHelper.pruneTree(java.util.List<Phrase> rootClusters, java.util.List<? extends ClusterDoc> files)

Uses of ClusterDoc in Util

Classes in Util that implement ClusterDoc

class	KnownDoc Repsents documents that are from the training set
class	TestDoc Represents documents that we wish to classify or cluster.

Methods in Util with parameters of type ClusterDoc

int	TestDoc.compareTo(ClusterDoc arg0)

Uses of ClusterDoc in websearch

Classes in websearch that implement ClusterDoc

class

SearchResultDoc A document that implements the methods needed to be clustered Also includes some functionality for cleaning up the results from the snippets of the search engines

Methods in websearch with parameters of type ClusterDoc

int	SearchResultDoc.compareTo(ClusterDoc arg0) Assuming that arg0 is a SearchResultDoc