jklustor-all-api-0.0.7-20140619012755 (ChemAxon)


com.chemaxon.descriptors.metrics
Enum FloatVectorMetrics

Object
  extended by Enum<FloatVectorMetrics>
      extended by com.chemaxon.descriptors.metrics.FloatVectorMetrics
All Implemented Interfaces:
FloatVectorComparator, MetricMetadata, Serializable, Comparable<FloatVectorMetrics>

@Beta
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.

Author:
Laszlo Antal

Nested Class Summary
 
Nested classes/interfaces inherited from interface com.chemaxon.descriptors.metrics.FloatVectorComparator
FloatVectorComparator.Util
 
Enum Constant Summary
EUCLIDEAN
          Euclidean distance.
EUCLIDEAN_NORMALIZED
          Normalized Euclidean distance.
TANIMOTO_HISTOGRAM
          Tanimoto coefficient (adapted to histograms).
 
Method Summary
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 Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class 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_NORMALIZED

public static final FloatVectorMetrics EUCLIDEAN_NORMALIZED
Normalized Euclidean distance.

The similarity/dissimilarity values range of the EUCLIDEAN normalized to the unit interval (0.0 - 1.0, including bounds).


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

jklustor-all-api-0.0.7-20140619012755 (ChemAxon)