edu.ucla.sspace.nonlinear

Class LocalityPreservingCooccurrenceSpace

java.lang.Object

edu.ucla.sspace.nonlinear.LocalityPreservingCooccurrenceSpace

All Implemented Interfaces:

SemanticSpace

public class LocalityPreservingCooccurrenceSpace
extends Object
implements SemanticSpace

Author:

David Jurgens

See Also:

SemanticSpace, LocalityPreservingSemanticAnalysis, AffinityMatrixCreator, LocalityPreservingProjection

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_WEIGHTING The default WeightingFunction to use.
static int	DEFAULT_WINDOW_SIZE The default number of words before and after the focus word to include
static String	ENTROPY_THRESHOLD_PROPERTY The property to specify the minimum entropy theshold a word should have to be included in the vector space after processing.
static String	LPCS_DIMENSIONS_PROPERTY The property to set the number of dimension to which the space should be reduced using the SVD
static String	WEIGHTING_FUNCTION_PROPERTY The property to set the WeightingFunction to be used with weighting the co-occurrence of neighboring words based on their distance.
static String	WINDOW_SIZE_PROPERTY The property to specify the number of words to view before and after each word in focus.

Constructor Summary

Constructors

Constructor and Description
LocalityPreservingCooccurrenceSpace(AffinityMatrixCreator creator) Constructs a new instance using the system properties for configuration.
LocalityPreservingCooccurrenceSpace(AffinityMatrixCreator creator, Properties properties) Constructs a new instance using the provided properties for configuration.

Method Summary

Methods

Modifier and Type	Method and Description
String	getSpaceName() Returns a unique string describing the name and configuration of this algorithm.
Vector	getVector(String word) Returns the semantic vector for the provided word.
int	getVectorLength() Returns the length of vectors in this semantic space.
Set<String>	getWords() Returns the set of words that are represented in this semantic space.
void	processDocument(BufferedReader document) Processes the contents of the provided file as a document.
void	processSpace(Properties properties) Once all the documents have been processed, performs any post-processing steps on the data.

Methods inherited from class java.lang.Object

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

Field Detail

ENTROPY_THRESHOLD_PROPERTY

public static final String ENTROPY_THRESHOLD_PROPERTY

The property to specify the minimum entropy theshold a word should have to be included in the vector space after processing. The specified value of this property should be a double

See Also:

Constant Field Values

WINDOW_SIZE_PROPERTY

public static final String WINDOW_SIZE_PROPERTY

The property to specify the number of words to view before and after each word in focus.

See Also:

Constant Field Values

WEIGHTING_FUNCTION_PROPERTY

public static final String WEIGHTING_FUNCTION_PROPERTY

The property to set the WeightingFunction to be used with weighting the co-occurrence of neighboring words based on their distance.

See Also:

Constant Field Values

LPCS_DIMENSIONS_PROPERTY

public static final String LPCS_DIMENSIONS_PROPERTY

The property to set the number of dimension to which the space should be reduced using the SVD

See Also:

Constant Field Values

DEFAULT_WINDOW_SIZE

public static final int DEFAULT_WINDOW_SIZE

The default number of words before and after the focus word to include

See Also:

Constant Field Values

DEFAULT_WEIGHTING

public static final String DEFAULT_WEIGHTING

The default WeightingFunction to use.

See Also:

Constant Field Values

Constructor Detail

LocalityPreservingCooccurrenceSpace

public LocalityPreservingCooccurrenceSpace(AffinityMatrixCreator creator)

Constructs a new instance using the system properties for configuration.

LocalityPreservingCooccurrenceSpace

public LocalityPreservingCooccurrenceSpace(AffinityMatrixCreator creator,
                                   Properties properties)

Constructs a new instance using the provided properties for configuration.

Method Detail

processDocument

public void processDocument(BufferedReader document)
                     throws IOException

Processes the contents of the provided file as a document.

Specified by:

processDocument in interface SemanticSpace

Parameters:

document - a reader that allows access to the text of the document

Throws:

IOException - if any error occurs while reading the document

getWords

public Set<String> getWords()

Returns the set of words that are represented in this semantic space.

Specified by:

getWords in interface SemanticSpace

Returns:

the set of words that are represented in this semantic space.

getVector

public Vector getVector(String word)

Returns the semantic vector for the provided word.

Specified by:

getVector in interface SemanticSpace

Parameters:

word - a word that may be in the semantic space

Returns:

The Vector for the provided word or null if the word was not in the space.

getVectorLength

public int getVectorLength()

Returns the length of vectors in this semantic space. Implementations are left free to define whether the returned value is valid before processSpace is called.

Specified by:

getVectorLength in interface SemanticSpace

processSpace

public void processSpace(Properties properties)

Once all the documents have been processed, performs any post-processing steps on the data. An algorithm should treat this as a no-op if no post-processing is required. Callers may specify the values for any exposed parameters using the properties argument.

By general contract, once this method has been called, processDocument will not be called again.

Specified by:

processSpace in interface SemanticSpace

Parameters:

properties - a set of properties and values that may be used to configure any exposed parameters of the algorithm.

getSpaceName

public String getSpaceName()

Returns a unique string describing the name and configuration of this algorithm. Any configurable parameters that would affect the resulting semantic space should be expressed as a part of this name.

Specified by:

getSpaceName in interface SemanticSpace