ivory.core.data.stat

Class DfTableArray

java.lang.Object

ivory.core.data.stat.DfTableArray

All Implemented Interfaces:

DfTable

public class DfTableArray
extends Object
implements DfTable

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

Author:

Jimmy Lin, Tamer Elsayed

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
int	getDf(int term) Returns the document frequency of a term.
int	getMaxDf() Returns the document frequency of the term with the highest document frequency.
int	getMaxDfTerm() Returns the term with the highest document frequency.
int	getNumOfSingletonTerms() Returns the number of terms that only appear in one document.
int	getVocabularySize() Returns the number of unique terms in the collection.
static void	main(String[] args)

Methods inherited from class java.lang.Object

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

Constructor Detail

DfTableArray

public DfTableArray(Path file)
             throws IOException

Creates a DfTableArray object.

Parameters:

file - collection frequency data file

Throws:

IOException

DfTableArray

public DfTableArray(Path file,
            FileSystem fs)
             throws IOException

Creates a DfTableArray object.

Parameters:

file - collection frequency data file path

fs - FileSystem to read from

Throws:

IOException

Method Detail

getDf

public int getDf(int term)

Description copied from interface: DfTable

Returns the document frequency of a term.

Specified by:

getDf in interface DfTable

getMaxDf

public int getMaxDf()

Description copied from interface: DfTable

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

Specified by:

getMaxDf in interface DfTable

getMaxDfTerm

public int getMaxDfTerm()

Description copied from interface: DfTable

Returns the term with the highest document frequency.

Specified by:

getMaxDfTerm in interface DfTable

getNumOfSingletonTerms

public int getNumOfSingletonTerms()

Description copied from interface: DfTable

Returns the number of terms that only appear in one document.

Specified by:

getNumOfSingletonTerms in interface DfTable

getVocabularySize

public int getVocabularySize()

Description copied from interface: DfTable

Returns the number of unique terms in the collection.

Specified by:

getVocabularySize in interface DfTable

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception