uk.ac.gla.dcs.renaissance.iqir
Enum WeightingScheme.Scheme

java.lang.Object
  java.lang.Enum<WeightingScheme.Scheme>
      uk.ac.gla.dcs.renaissance.iqir.WeightingScheme.Scheme

All Implemented Interfaces:

Serializable, Comparable<WeightingScheme.Scheme>

Enclosing class:

WeightingScheme

public static enum WeightingScheme.Scheme
extends Enum<WeightingScheme.Scheme>

Enum Constant Summary

BINARY
Term presence - absence

BM25
BM25 with standard parameters

FisherLMDirichlet
Fisher kernel with Dirichlet smoothed LM

FULL_NORMALISED
Normalised (centred and with unit variance)

NORMALISED
Normalised (centred and with unit variance)

NTF
Normalised frequency: TF / DL

TF
Simple term frequency

TFIDF
TF * log(idf)

Method Summary

boolean	needsDF() Check if this weighting scheme needs document frequencies
boolean	needsGlobalTF()
boolean	needsMeanAndStandardDeviation()
static WeightingScheme.Scheme	valueOf(String name) Returns the enum constant of this type with the specified name.
static WeightingScheme.Scheme[]	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

TF

public static final WeightingScheme.Scheme TF

Simple term frequency

TFIDF

public static final WeightingScheme.Scheme TFIDF

TF * log(idf)

NTF

public static final WeightingScheme.Scheme NTF

Normalised frequency: TF / DL

BINARY

public static final WeightingScheme.Scheme BINARY

Term presence - absence

BM25

public static final WeightingScheme.Scheme BM25

BM25 with standard parameters

FisherLMDirichlet

public static final WeightingScheme.Scheme FisherLMDirichlet

Fisher kernel with Dirichlet smoothed LM

NORMALISED

public static final WeightingScheme.Scheme NORMALISED

Normalised (centred and with unit variance)

FULL_NORMALISED

public static final WeightingScheme.Scheme FULL_NORMALISED

Normalised (centred and with unit variance)

Method Detail

values

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

Returns:

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

valueOf

public static WeightingScheme.Scheme 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

needsDF

public boolean needsDF()

Check if this weighting scheme needs document frequencies

needsMeanAndStandardDeviation

public boolean needsMeanAndStandardDeviation()

needsGlobalTF

public boolean needsGlobalTF()