ivory.core.data.stat

Class CfTableArray

java.lang.Object

ivory.core.data.stat.CfTableArray

All Implemented Interfaces:

CfTable

public class CfTableArray
extends Object
implements CfTable

Array-based implementation of CfTable. Binary search is used for lookup.

Author:

Jimmy Lin, Tamer Elsayed

Constructor Summary

Constructors

Constructor and Description
CfTableArray(Path file) Creates a CfTableArray object.
CfTableArray(Path file, FileSystem fs) Creates a CfTableArray object.

Method Summary

Methods

Modifier and Type	Method and Description
long	getCf(int term) Returns the collection frequency of a term.
long	getCollectionSize() Returns the total number of terms in this collection.
long	getMaxCf() Returns the collection frequency of the term with the highest collection frequency.
int	getMaxCfTerm() Returns the term with the highest collection frequency.
int	getNumOfSingletonTerms() Returns the number of terms that only appear once in the collection.
int	getVocabularySize() Returns the number of unique terms in the collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

CfTableArray

public CfTableArray(Path file)
             throws IOException

Creates a CfTableArray object.

Parameters:

file - collection frequency data file

Throws:

IOException

CfTableArray

public CfTableArray(Path file,
            FileSystem fs)
             throws IOException

Creates a CfTableArray object.

Parameters:

file - collection frequency data file

fs - FileSystem to read from

Throws:

IOException

Method Detail

getCf

public long getCf(int term)

Description copied from interface: CfTable

Returns the collection frequency of a term.

Specified by:

getCf in interface CfTable

getCollectionSize

public long getCollectionSize()

Description copied from interface: CfTable

Returns the total number of terms in this collection.

Specified by:

getCollectionSize in interface CfTable

getMaxCf

public long getMaxCf()

Description copied from interface: CfTable

Returns the collection frequency of the term with the highest collection frequency.

Specified by:

getMaxCf in interface CfTable

getMaxCfTerm

public int getMaxCfTerm()

Description copied from interface: CfTable

Returns the term with the highest collection frequency.

Specified by:

getMaxCfTerm in interface CfTable

getNumOfSingletonTerms

public int getNumOfSingletonTerms()

Description copied from interface: CfTable

Returns the number of terms that only appear once in the collection.

Specified by:

getNumOfSingletonTerms in interface CfTable

getVocabularySize

public int getVocabularySize()

Description copied from interface: CfTable

Returns the number of unique terms in the collection.

Specified by:

getVocabularySize in interface CfTable