org.openimaj.pgm.util

Class Document

java.lang.Object

org.openimaj.feature.SparseIntFV

org.openimaj.pgm.util.Document

All Implemented Interfaces:

Serializable, Cloneable, FeatureVector, Readable, ReadableASCII, ReadableBinary, ReadWriteable, Writeable, WriteableASCII, WriteableBinary, Concatenatable<SparseIntFV,SparseIntFV>

public class Document
extends SparseIntFV

A document is a bag of words

Author:

Sina Samangooei (ss@ecs.soton.ac.uk)

See Also:

Serialized Form

Field Summary

Fields inherited from class org.openimaj.feature.SparseIntFV

values

Constructor Summary

Constructors

Constructor and Description
Document(Corpus corpus)
Document(int vocabularySize)

Method Summary

Modifier and Type	Method and Description
int	countUniqueWords()
int	length() Get the length of this vector
void	setWordCount(int word, int count) sets a word in the document's count.

Methods inherited from class org.openimaj.feature.SparseIntFV

asciiHeader, asDoubleFV, asDoubleVector, binaryHeader, concatenate, concatenate, getAsDouble, getVector, newInstance, normaliseFV, normaliseFV, normaliseFV, normaliseFV, readASCII, readBinary, setFromDouble, writeASCII, writeBinary

Methods inherited from class java.lang.Object

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

Constructor Detail

Document

public Document(Corpus corpus)

Parameters:

corpus - documents from the same corpus share the same vocabulary size

Document

public Document(int vocabularySize)

Parameters:

vocabularySize - the number of words in this vocabulary

Method Detail

countUniqueWords

public int countUniqueWords()

Returns:

the number of unique words in this document

length

public int length()

Description copied from interface: FeatureVector

Get the length of this vector

Specified by:

length in interface FeatureVector

Overrides:

length in class SparseIntFV

Returns:

the length of this vector

setWordCount

public void setWordCount(int word,
                         int count)

sets a word in the document's count.

Parameters:

word -

count -