Package org.apache.commons.text.similarity

Class CosineDistance

  • All Implemented Interfaces:
    EditDistance<java.lang.Double>, SimilarityScore<java.lang.Double>
    public class CosineDistance
extends java.lang.Object
implements EditDistance<java.lang.Double>
    Measures the cosine distance between two character sequences.

    It utilizes the CosineSimilarity to compute the distance. Character sequences are converted into vectors through a simple tokenizer that works with a regular expression to split words in a sentence.

    For further explanation about Cosine Similarity and Cosine Distance, refer to http://en.wikipedia.org/wiki/Cosine_similarity.

    Since:
    1.0
    See Also:
    CosineSimilarity

    • Constructor Summary

      Constructors 
      Constructor Description
      CosineDistance()  

    • 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)
      Compares two CharSequences.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • CosineDistance

        public CosineDistance()

    • Method Detail

      • apply

        public java.lang.Double apply​(java.lang.CharSequence left,
                              java.lang.CharSequence right)
        Description copied from interface: EditDistance
        Compares two CharSequences.
        Specified by:
        apply in interface EditDistance<java.lang.Double>
        Specified by:
        apply in interface SimilarityScore<java.lang.Double>
        Parameters:
        left - the first CharSequence
        right - the second CharSequence
        Returns:
        The similarity score between two CharSequences