Enum ClusteringDistance

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<ClusteringDistance>

    public enum ClusteringDistance
    extends java.lang.Enum<ClusteringDistance>
    Clustering distance measure.
    Author:
    Haifeng Li
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static ClusteringDistance valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static ClusteringDistance[] 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

      • EUCLIDEAN

        public static final ClusteringDistance EUCLIDEAN
        Squared Euclidean distance for K-Means.
      • EUCLIDEAN_MISSING_VALUES

        public static final ClusteringDistance EUCLIDEAN_MISSING_VALUES
        Squared Euclidean distance with missing value handling for K-Means.
      • JENSEN_SHANNON_DIVERGENCE

        public static final ClusteringDistance JENSEN_SHANNON_DIVERGENCE
        Jensen-Shannon divergence for SIB.
    • Method Detail

      • values

        public static ClusteringDistance[] 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 (ClusteringDistance c : ClusteringDistance.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

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