gov.sandia.cognition.text.term.vector
Interface VectorSpaceModel

All Known Subinterfaces:
GlobalTermWeighter
All Known Implementing Classes:
AbstractEntropyBasedGlobalTermWeighter, AbstractFrequencyBasedGlobalTermWeighter, AbstractGlobalTermWeighter, AbstractVectorSpaceModel, DominanceGlobalTermWeighter, EntropyGlobalTermWeighter, InverseDocumentFrequencyGlobalTermWeighter

public interface VectorSpaceModel

An interface for a model based on vector representations of documents.

Since:
3.0
Author:
Justin Basilico

Method Summary
 void add(Vector document)
          Adds a document to the model.
 void add(Vectorizable document)
          Adds a document to the model.
 void addAll(Iterable<? extends Vectorizable> documents)
          Adds all of the given documents to the model.
 int getDocumentCount()
          Gets the number of documents that this object is using for its model
 boolean remove(Vector document)
          Removes the document from the model.
 boolean remove(Vectorizable document)
          Removes the document from the model.
 boolean removeAll(Iterable<? extends Vectorizable> documents)
          Removes all of the given documents from the model.
 

Method Detail

add

void add(Vectorizable document)
Adds a document to the model.

Parameters:
document - Adds a document to the model.

add

void add(Vector document)
Adds a document to the model.

Parameters:
document - Adds a document to the model.

addAll

void addAll(Iterable<? extends Vectorizable> documents)
Adds all of the given documents to the model.

Parameters:
documents - The documents to add.

remove

boolean remove(Vectorizable document)
Removes the document from the model.

Parameters:
document - The document to remove.
Returns:
True if this object changed as a result of the removal.

remove

boolean remove(Vector document)
Removes the document from the model.

Parameters:
document - The document to remove.
Returns:
True if this object changed as a result of the removal.

removeAll

boolean removeAll(Iterable<? extends Vectorizable> documents)
Removes all of the given documents from the model.

Parameters:
documents - The documents to remove.
Returns:
True if this object changed as a result of the removal.

getDocumentCount

int getDocumentCount()
Gets the number of documents that this object is using for its model

Returns:
The number of documents used for the model.