Class JaccardSimilarity

  • All Implemented Interfaces:
    SimilarityScore<java.lang.Double>

    public class JaccardSimilarity
    extends java.lang.Object
    implements SimilarityScore<java.lang.Double>
    Measures the Jaccard similarity (aka Jaccard index) of two sets of character sequence. Jaccard similarity is the size of the intersection divided by the size of the union of the two sets.

    For further explanation about Jaccard Similarity, refer https://en.wikipedia.org/wiki/Jaccard_index

    Since:
    1.0
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Double apply​(java.lang.CharSequence left, java.lang.CharSequence right)
      Calculates Jaccard Similarity of two set character sequence passed as input.
      private java.lang.Double calculateJaccardSimilarity​(java.lang.CharSequence left, java.lang.CharSequence right)
      Calculates Jaccard Similarity of two character sequences passed as input.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • JaccardSimilarity

        public JaccardSimilarity()
    • Method Detail

      • apply

        public java.lang.Double apply​(java.lang.CharSequence left,
                                      java.lang.CharSequence right)
        Calculates Jaccard Similarity of two set character sequence passed as input.
        Specified by:
        apply in interface SimilarityScore<java.lang.Double>
        Parameters:
        left - first character sequence
        right - second character sequence
        Returns:
        index
        Throws:
        java.lang.IllegalArgumentException - if either String input null
      • calculateJaccardSimilarity

        private java.lang.Double calculateJaccardSimilarity​(java.lang.CharSequence left,
                                                            java.lang.CharSequence right)
        Calculates Jaccard Similarity of two character sequences passed as input. Does the calculation by identifying the union (characters in at least one of the two sets) of the two sets and intersection (characters which are present in set one which are present in set two)
        Parameters:
        left - first character sequence
        right - second character sequence
        Returns:
        index