Package com.chemaxon.descriptors.metrics

Enum FloatVectorMetrics

java.lang.Object

java.lang.Enum<FloatVectorMetrics>

com.chemaxon.descriptors.metrics.FloatVectorMetrics

All Implemented Interfaces:

FloatVectorComparator, MetricMetadata, Serializable, Comparable<FloatVectorMetrics>

@Beta
@PublicAPI
public enum FloatVectorMetrics
extends Enum<FloatVectorMetrics>
implements FloatVectorComparator, Serializable

Simple metrics for float vectors.

Please note that this enum is marked with @Beta annotation, so it can be subject of incompatible changes or removal in later releases.

TODO: add dot product, normalized dot product, vector product length and normalized vector product length metrics

Nested Class Summary

Nested classes/interfaces inherited from interface com.chemaxon.descriptors.metrics.FloatVectorComparator

FloatVectorComparator.Util

Enum Constant Summary

Enum Constants

Enum Constant	Description
EUCLIDEAN	Euclidean distance.
EUCLIDEAN_SQR	Square of Euclidean distance.
MANHATTAN	Manhattan distance.
MAXIMUM	Uniform / maximum norm based distance.
TANIMOTO_HISTOGRAM	Tanimoto coefficient (adapted to histograms).

Method Summary

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

Methods inherited from interface com.chemaxon.descriptors.metrics.FloatVectorComparator

calculateFloatVectorDissimilarity, calculateFloatVectorSimilarity, getLowerBoundForFloatVectors, getUpperBoundForFloatVectors

Methods inherited from interface com.chemaxon.descriptors.metrics.MetricMetadata

isDissimilarityZeroIFFEquals, isMetricSpace, isNonNegative, isSymmetric, isTriangeInequalityHolds

Enum Constant Detail

EUCLIDEAN

public static final FloatVectorMetrics EUCLIDEAN

Euclidean distance.

Square root of the sums of the difference squares.

See Also:

http://en.wikipedia.org/wiki/Euclidean_distance

EUCLIDEAN_SQR

public static final FloatVectorMetrics EUCLIDEAN_SQR

Square of Euclidean distance. Sums of the difference squares.

See Also:

http://en.wikipedia.org/wiki/Euclidean_distance

MANHATTAN

public static final FloatVectorMetrics MANHATTAN

Manhattan distance. Sums of the abs of the differences.

See Also:

http://en.wikipedia.org/wiki/Manhattan_distance

MAXIMUM

public static final FloatVectorMetrics MAXIMUM

Uniform / maximum norm based distance. maximum of the abs of the differences.

See Also:

http://en.wikipedia.org/wiki/Uniform_norm, http://en.wikipedia.org/wiki/Chebyshev_distance

TANIMOTO_HISTOGRAM

public static final FloatVectorMetrics TANIMOTO_HISTOGRAM

Tanimoto coefficient (adapted to histograms).

See Also:

http://en.wikipedia.org/wiki/Jaccard_index

Method Detail

values

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

Returns:

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

valueOf

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