edu.ucla.sspace.common

Enum Similarity.SimType

java.lang.Object

java.lang.Enum<Similarity.SimType>

edu.ucla.sspace.common.Similarity.SimType

All Implemented Interfaces:

Serializable, Comparable<Similarity.SimType>

Enclosing class:

Similarity

public static enum Similarity.SimType
extends Enum<Similarity.SimType>

A type of similarity function to use when generating a Method

Enum Constant Summary

Enum Constants

Enum Constant and Description
AVERAGE_COMMON_FEATURE_RANK
COSINE Cosine similarity
EUCLIDEAN
JACCARD_INDEX Jaccard Index
KENDALLS_TAU Kendall's tau
KL_DIVERGENCE
LIN
PEARSON_CORRELATION Pearson product moment correlation coefficient
SPEARMAN_RANK_CORRELATION
TANIMOTO_COEFFICIENT Tanimoto Coefficient

Method Summary

Methods

Modifier and Type	Method and Description
static Similarity.SimType	valueOf(String name) Returns the enum constant of this type with the specified name.
static Similarity.SimType[]	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

COSINE

public static final Similarity.SimType COSINE

Cosine similarity

PEARSON_CORRELATION

public static final Similarity.SimType PEARSON_CORRELATION

Pearson product moment correlation coefficient

EUCLIDEAN

public static final Similarity.SimType EUCLIDEAN

SPEARMAN_RANK_CORRELATION

public static final Similarity.SimType SPEARMAN_RANK_CORRELATION

JACCARD_INDEX

public static final Similarity.SimType JACCARD_INDEX

Jaccard Index

LIN

public static final Similarity.SimType LIN

KL_DIVERGENCE

public static final Similarity.SimType KL_DIVERGENCE

AVERAGE_COMMON_FEATURE_RANK

public static final Similarity.SimType AVERAGE_COMMON_FEATURE_RANK

KENDALLS_TAU

public static final Similarity.SimType KENDALLS_TAU

Kendall's tau

TANIMOTO_COEFFICIENT

public static final Similarity.SimType TANIMOTO_COEFFICIENT

Tanimoto Coefficient

Method Detail

values

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

Returns:

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

valueOf

public static Similarity.SimType 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