edu.ucla.sspace.basis

Interface BasisMapping<T,E>

Type Parameters:

T - the type of feature being mapped to a dimension.

E - the type of object to be used as a description of each dimension.

All Known Subinterfaces:

DependencyPathBasisMapping

All Known Implementing Classes:

AbstractBasisMapping, PathBasedBasisMapping, RelationBasedBasisMapping, RelationPathBasisMapping, StringBasisMapping, WordBasedBasisMapping, WordBasisMapping, WordOrderBasisMapping

public interface BasisMapping<T,E>

An interface for specifying how a set of features can be mapped to a vector basis. In the naive case, each feature is mapped it its own dimension. However, many approaches may use information about the feature to represent several different features using a single dimension. For example, each word may correspond to a unique dimension regardless of how it is grammatically related.

This interface also provides support for describing dimensions. The named of the description is left open to the implementation. For example, an implementation may chose to return a String with a human-readable description. Another implementation may return a Set of features that are represented by the dimension in order to facilitate further processing.

Method Summary

Methods

Modifier and Type	Method and Description
int	getDimension(T features) Returns the dimension number corresponding to the provided feature.
E	getDimensionDescription(int dimension) Returns a description of the specified dimension.
boolean	isReadOnly() Returns true if the BasisMapping is read only, false otherwise.
Set<E>	keySet() Returns the set of keys known by this BasisMapping
int	numDimensions() Returns the number of dimensions currently represented in this basis mapping.
void	setReadOnly(boolean readOnly) Sets the read only state of the basis mapping.

Method Detail

getDimension

int getDimension(T features)

Returns the dimension number corresponding to the provided feature.

Parameters:

feature - a feature whose value can be used

Returns:

the dimension for the occurrence of the last word in the path

getDimensionDescription

E getDimensionDescription(int dimension)

Returns a description of the specified dimension.

Parameters:

dimension - a dimension number

Returns:

a description of the dimension

keySet

Set<E> keySet()

Returns the set of keys known by this BasisMapping

numDimensions

int numDimensions()

Returns the number of dimensions currently represented in this basis mapping.

setReadOnly

void setReadOnly(boolean readOnly)

Sets the read only state of the basis mapping. This is intended for when the basis mapping is needed to map to a known set of values, and any unknown values are left unmapped.

isReadOnly

boolean isReadOnly()

Returns true if the BasisMapping is read only, false otherwise.