water.util.comparison.string

Enum QGramComparator.Formula

java.lang.Object

java.lang.Enum<QGramComparator.Formula>

water.util.comparison.string.QGramComparator.Formula

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<QGramComparator.Formula>

Enclosing class:

QGramComparator

public static enum QGramComparator.Formula
extends java.lang.Enum<QGramComparator.Formula>

Represents the different formulas we can use to compute similarity.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DICE
JACCARD
OVERLAP

Method Summary

Modifier and Type	Method and Description
double	compute(int common, java.util.Set<java.lang.String> q1, java.util.Set<java.lang.String> q2)
static QGramComparator.Formula	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static QGramComparator.Formula[]	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

OVERLAP

public static final QGramComparator.Formula OVERLAP

JACCARD

public static final QGramComparator.Formula JACCARD

DICE

public static final QGramComparator.Formula DICE

Method Detail

values

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

Returns:

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

valueOf

public static QGramComparator.Formula 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

compute

public double compute(int common,
                      java.util.Set<java.lang.String> q1,
                      java.util.Set<java.lang.String> q2)