Package banner.util

Enum SetSimilarityMetric

java.lang.Object

java.lang.Enum<SetSimilarityMetric>

banner.util.SetSimilarityMetric

All Implemented Interfaces:

Serializable, Comparable<SetSimilarityMetric>

public enum SetSimilarityMetric
extends Enum<SetSimilarityMetric>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BooleanXJaccard
CosineTheta
Dice
Jaccard
Overlap

Method Summary

Modifier and Type	Method	Description
double	similarity(int intersection, int size1, int size2)
protected abstract double	similarityInternal(int intersection, int size1, int size2)
static SetSimilarityMetric	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SetSimilarityMetric[]	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

Dice

public static final SetSimilarityMetric Dice

BooleanXJaccard

public static final SetSimilarityMetric BooleanXJaccard

Jaccard

public static final SetSimilarityMetric Jaccard

Overlap

public static final SetSimilarityMetric Overlap

CosineTheta

public static final SetSimilarityMetric CosineTheta

Method Detail

values

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

Returns:

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

valueOf

public static SetSimilarityMetric 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

similarity

public double similarity(int intersection,
                         int size1,
                         int size2)

similarityInternal

protected abstract double similarityInternal(int intersection,
                                             int size1,
                                             int size2)