Package org.neo4j.gds.similarity.knn.metrics

Enum SimilarityMetric

java.lang.Object

java.lang.Enum<SimilarityMetric>

org.neo4j.gds.similarity.knn.metrics.SimilarityMetric

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SimilarityMetric>

public enum SimilarityMetric
extends java.lang.Enum<SimilarityMetric>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COSINE
DEFAULT
DOUBLE_PROPERTY_METRIC
EUCLIDEAN
JACCARD
LONG_PROPERTY_METRIC
OVERLAP
PEARSON

Method Summary

Modifier and Type	Method	Description
static SimilarityMetric	defaultMetricForType(org.neo4j.gds.api.nodeproperties.ValueType valueType)
static SimilarityMetric	parse(java.lang.String value)
static SimilarityMetric	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static SimilarityMetric[]	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

JACCARD

public static final SimilarityMetric JACCARD

OVERLAP

public static final SimilarityMetric OVERLAP

COSINE

public static final SimilarityMetric COSINE

EUCLIDEAN

public static final SimilarityMetric EUCLIDEAN

PEARSON

public static final SimilarityMetric PEARSON

LONG_PROPERTY_METRIC

public static final SimilarityMetric LONG_PROPERTY_METRIC

DOUBLE_PROPERTY_METRIC

public static final SimilarityMetric DOUBLE_PROPERTY_METRIC

DEFAULT

public static final SimilarityMetric DEFAULT

Method Detail

values

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

Returns:

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

valueOf

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

parse

public static SimilarityMetric parse(java.lang.String value)

defaultMetricForType

public static SimilarityMetric defaultMetricForType(org.neo4j.gds.api.nodeproperties.ValueType valueType)