edu.ucla.sspace.common

Class WordComparator

java.lang.Object

edu.ucla.sspace.common.WordComparator

public class WordComparator
extends Object

A utility class for finding the k most-similar words to a provided word in a SemanticSpace. The comparisons required for generating the list maybe be run in parallel by configuring an instance of this class to use multiple threads.

All instances of this class are thread-safe.

Author:

David Jurgens

Constructor Summary

Constructors

Constructor and Description
WordComparator() Creates this WordComparator with as many threads as processors.
WordComparator(int numThreads) Creates this WordComparator with the specified number of threads.

Method Summary

Methods

Modifier and Type	Method and Description
SortedMultiMap<Double,String>	getMostSimilar(String word, SemanticSpace sspace, int numberOfSimilarWords, Similarity.SimType similarityType) Compares the provided word to all other words in the provided SemanticSpace and return the specified number of words that were most similar according to the specified similarity measure.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WordComparator

public WordComparator()

Creates this WordComparator with as many threads as processors.

WordComparator

public WordComparator(int numThreads)

Creates this WordComparator with the specified number of threads.

Method Detail

getMostSimilar

public SortedMultiMap<Double,String> getMostSimilar(String word,
                                           SemanticSpace sspace,
                                           int numberOfSimilarWords,
                                           Similarity.SimType similarityType)

Compares the provided word to all other words in the provided SemanticSpace and return the specified number of words that were most similar according to the specified similarity measure.

Returns:

the most similar words, or null if the provided word was not in the semantic space.