Enum MetricType

    • Method Summary

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

      • L2

        public static final MetricType L2
        Euclidean distance. For float vectors only
      • IP

        public static final MetricType IP
        Inner product. For float vectors only
      • HAMMING

        public static final MetricType HAMMING
        Hamming distance. For binary vectors only
      • JACCARD

        public static final MetricType JACCARD
        Jaccard distance. For binary vectors only
      • TANIMOTO

        public static final MetricType TANIMOTO
        Tanimoto distance. For binary vectors only
      • SUBSTRUCTURE

        public static final MetricType SUBSTRUCTURE
        Substructure. For binary vectors only
      • SUPERSTRUCTURE

        public static final MetricType SUPERSTRUCTURE
        Superstructure. For binary vectors only
    • Method Detail

      • values

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

        public static MetricType 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
      • valueOf

        public static MetricType valueOf​(int val)
        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:
        val - 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
      • getVal

        public int getVal()