tml.vectorspace
Enum TermWeighting.LocalWeight

java.lang.Object
  java.lang.Enum<TermWeighting.LocalWeight>
      tml.vectorspace.TermWeighting.LocalWeight

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TermWeighting.LocalWeight>

Enclosing class:

TermWeighting

public static enum TermWeighting.LocalWeight
extends java.lang.Enum<TermWeighting.LocalWeight>

Implemented local weight functions

Enum Constant Summary

Binary
1 if the term is in the document, 0 otherwise

LOGTF
The log of 1 plus the term frequency

TF
The frequency of the term in the document

TFn
The normalised frequency, i.e. divided by the maximum frequency in the doc

Method Summary

static TermWeighting.LocalWeight	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TermWeighting.LocalWeight[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Binary

public static final TermWeighting.LocalWeight Binary

1 if the term is in the document, 0 otherwise

TF

public static final TermWeighting.LocalWeight TF

The frequency of the term in the document

TFn

public static final TermWeighting.LocalWeight TFn

The normalised frequency, i.e. divided by the maximum frequency in the doc

LOGTF

public static final TermWeighting.LocalWeight LOGTF

The log of 1 plus the term frequency

Method Detail

values

public static TermWeighting.LocalWeight[] 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 (TermWeighting.LocalWeight c : TermWeighting.LocalWeight.values())
    System.out.println(c);

Returns:

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

valueOf

public static TermWeighting.LocalWeight valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null