Top Description Constructors Methods
org.apache.commons.text.similarity

public Class CosineDistance

extends Object
implements EditDistance<Double>
Class Inheritance
All Implemented Interfaces
org.apache.commons.text.similarity.EditDistance, org.apache.commons.text.similarity.SimilarityScore, org.apache.commons.text.similarity.ObjectSimilarityScore, java.util.function.BiFunction
Imports
java.util.Map
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 https://en.wikipedia.org/wiki/Cosine_similarity.

Since
1.0
See Also
CosineSimilarity

Constructor Summary

AccessConstructor and Description
public
CosineDistance()

Construct a new instance.

Method Summary

Modifier and TypeMethod and Description
public Double
apply(final CharSequence left, final CharSequence right)

Implements org.apache.commons.text.similarity.SimilarityScore.apply.

Compares two CharSequences.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

CosineDistanceback to summary
public CosineDistance()

Construct a new instance.

Method Detail

applyback to summary
public Double apply(final CharSequence left, final CharSequence right)

Implements org.apache.commons.text.similarity.SimilarityScore.apply.

Doc from org.apache.commons.text.similarity.SimilarityScore.apply.

Compares two CharSequences.

Annotations
@Override