jsat.text.wordweighting

Enum TfIdf.TermFrequencyWeight

java.lang.Object

java.lang.Enum<TfIdf.TermFrequencyWeight>

jsat.text.wordweighting.TfIdf.TermFrequencyWeight

All Implemented Interfaces:

Serializable, Comparable<TfIdf.TermFrequencyWeight>

Enclosing class:

TfIdf

public static enum TfIdf.TermFrequencyWeight
extends Enum<TfIdf.TermFrequencyWeight>

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOOLEAN BOOLEAN only takes into account whether or not the word is present in the document.
DOC_NORMALIZED DOC_NORMALIZED returns a term weighting in [0, 1] by normalizing the frequency by the most common word in the document.
LOG LOG returns a term weighting in [1, infinity) based on the log value of the term frequency 1 + log(count)

Method Summary

Modifier and Type	Method and Description
static TfIdf.TermFrequencyWeight	valueOf(String name) Returns the enum constant of this type with the specified name.
static TfIdf.TermFrequencyWeight[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

BOOLEAN

public static final TfIdf.TermFrequencyWeight BOOLEAN

BOOLEAN only takes into account whether or not the word is present in the document.
1.0 if the count is non zero.

LOG

public static final TfIdf.TermFrequencyWeight LOG

LOG returns a term weighting in [1, infinity) based on the log value of the term frequency
1 + log(count)

DOC_NORMALIZED

public static final TfIdf.TermFrequencyWeight DOC_NORMALIZED

DOC_NORMALIZED returns a term weighting in [0, 1] by normalizing the frequency by the most common word in the document.
count/(most Frequent word in document)

Method Detail

values

public static TfIdf.TermFrequencyWeight[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TfIdf.TermFrequencyWeight c : TfIdf.TermFrequencyWeight.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TfIdf.TermFrequencyWeight valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null