Package org.tribuo.math.distance

Enum Class DistanceType

java.lang.Object
java.lang.Enum<DistanceType>
org.tribuo.math.distance.DistanceType
All Implemented Interfaces:
Serializable, Comparable<DistanceType>, Constable
public enum DistanceType extends Enum<DistanceType>
The built-in distance functions.

  • Enum Constant Details

    • L1

      public static final DistanceType L1
      L1 (or Manhattan) distance.

    • L2

      public static final DistanceType L2
      L2 (or Euclidean) distance.

    • COSINE

      public static final DistanceType COSINE
      Cosine similarity used as a distance measure.

  • Method Details

    • values

      public static DistanceType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static DistanceType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • getDistance

      public Distance getDistance()
      Gets the Distance object specified by this enum.
      Returns:
      The distance object.

    • computeDistance

      public double computeDistance(SGDVector vector1, SGDVector vector2)
      Calculates the distance between two vectors.
      Parameters:
      vector1 - A SGDVector representing a data point.
      vector2 - A SGDVector representing a second data point.
      Returns:
      A double representing the distance between the two points.