org.apache.ignite.ml.math.distances

## Class JaccardIndex

- java.lang.Object
- - org.apache.ignite.ml.math.distances.JaccardIndex

- All Implemented Interfaces:
    Externalizable, Serializable, DistanceMeasure

      public class JaccardIndex
      extends Object
      implements DistanceMeasure

  Calculates `J = |A \cap B| / |A \cup B|` (Jaccard index) distance between two points.
  See Also:
    Serialized Form

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `JaccardIndex()`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `double` | `compute(Vector a, Vector b)` Compute the distance between two n-dimensional vectors.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

    - ### Methods inherited from interface org.apache.ignite.ml.math.distances.DistanceMeasure

      `compute, readExternal, writeExternal`

- - ### Constructor Detail

    - #### JaccardIndex

          public JaccardIndex()

  - ### Method Detail

    - #### compute

          public double compute(Vector a,
                                Vector b)
                         throws CardinalityException

      Compute the distance between two n-dimensional vectors.

      The two vectors are required to have the same dimension.

      Specified by:
        `compute` in interface `DistanceMeasure`
      Parameters:
        `a` - The first vector.
        `b` - The second vector.
      Returns:
        The distance between the two vectors.
      Throws:
        `CardinalityException` - if the array lengths differ.

2021 Copyright © Apache Software Foundation
| Follow @ApacheIgnite
Ignite Database and Caching Platform | : ver. 2.10.0
Release Date | : March 10 2021