StructuredVectorSpace (S-Space Package 2.0.1 API)

java.lang.Object
- edu.ucla.sspace.svs.StructuredVectorSpace

All Implemented Interfaces:

SemanticSpace, Serializable
```
public class StructuredVectorSpace
extends Object
implements SemanticSpace, Serializable
```
A dependency parsed based approach to statistical semantics that uses a collection of vectors to represent a word. This implementaiton is based on the following paper:
Katrin Erk and Sebastian Sebastian Padó, "A structured vector space model for word meaning in context," in Annual Meeting of the ACL, Honolulu, Hawaii. 2008.

This model requires a dependency parsed corpus. When processing, three types of vectors: word, which represnts the co-occureences word has with all other tokens via a dependency chain; REL|word, which records the set of tokens that govern the REL relationship with word; and word|REL, which records the set of tokens that are governed by word in the REL relationship. The first vector is referred to as a lemma vector and the later two are called selectional preference vectors. In all cases REL is a dependency relationship.

This class implements Filterable, which allows for fine-grained control of which semantics are retained. The setSemanticFilter(Set) method can be used to speficy which words should have their semantics retained. Note that the words that are filtered out will still be used in computing the semantics of other words. This behavior is intended for use with a large corpora where retaining the semantics of all words in memory is infeasible.

processDocument

getVector

processSpace

Author:: Keith Stevens
See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`EMPTY_STRING` A static variable for the empty string.
`static String`	`SSPACE_NAME` The Semantic Space name for `StructuredVectorSpace`

Constructor Summary

Constructors
Constructor and Description
`StructuredVectorSpace(DependencyExtractor extractor, DependencyPathAcceptor acceptor, VectorCombinor combinor)` Create a new instance of `StructuredVectorSpace`.
`StructuredVectorSpace(DependencyExtractor extractor, DependencyPathAcceptor acceptor, VectorCombinor combinor, StringBasisMapping termBasis, Set<String> semanticFilter)` Create a new instance of `StructuredVectorSpace`.

Method Summary

Methods
Modifier and Type	Method and Description
`SparseDoubleVector`	`contextualize(String focusWord, String relation, String secondWord, boolean isFocusHeadWord)`
`String`	`getSpaceName()` Returns a unique string describing the name and configuration of this algorithm.
`Vector`	`getVector(String term)` 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.
`void`	`setSemanticFilter(Set<String> semanticsToRetain)` .

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SSPACE_NAME
```
public static final String SSPACE_NAME
```
    The Semantic Space name for StructuredVectorSpace
    
    See Also:
    Constant Field Values
  - EMPTY_STRING
```
public static final String EMPTY_STRING
```
    A static variable for the empty string.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - StructuredVectorSpace
```
public StructuredVectorSpace(DependencyExtractor extractor,
                     DependencyPathAcceptor acceptor,
                     VectorCombinor combinor)
```
    Create a new instance of StructuredVectorSpace.
  - StructuredVectorSpace
```
public StructuredVectorSpace(DependencyExtractor extractor,
                     DependencyPathAcceptor acceptor,
                     VectorCombinor combinor,
                     StringBasisMapping termBasis,
                     Set<String> semanticFilter)
```
    Create a new instance of StructuredVectorSpace.
- Method Detail
  - 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 term)
```
    Returns the semantic vector for the provided word.
    
    Specified by:
    
    getVector in interface SemanticSpace
    
    Parameters:
    term - 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.
  - 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
  - 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
  - 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
  - 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.
  - contextualize
```
public SparseDoubleVector contextualize(String focusWord,
                               String relation,
                               String secondWord,
                               boolean isFocusHeadWord)
```
  - setSemanticFilter
```
public void setSemanticFilter(Set<String> semanticsToRetain)
```
    .

Class StructuredVectorSpace

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SSPACE_NAME

EMPTY_STRING

Constructor Detail

StructuredVectorSpace

StructuredVectorSpace

Method Detail

getWords

getVector

getSpaceName

getVectorLength

processDocument

processSpace

contextualize

setSemanticFilter