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

public Class JaccardSimilarity

extends Object
implements SimilarityScore<Double>
Class Inheritance
All Implemented Interfaces
org.apache.commons.text.similarity.SimilarityScore, org.apache.commons.text.similarity.ObjectSimilarityScore, java.util.function.BiFunction
Imports
java.util.HashSet, .Set
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

Field Summary

Modifier and TypeField and Description
pack-priv static final JaccardSimilarity
INSTANCE

The singleton instance.

Constructor Summary

AccessConstructor and Description
public
JaccardSimilarity()

Creates a new instance.

Method Summary

Modifier and TypeMethod and Description
public Double

Returns:

The Jaccard Similarity of two set character sequence passed as input.
apply(final CharSequence
first input sequence.
left, final CharSequence
second input sequence.
right)

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

Computes the Jaccard Similarity of two set character sequence passed as input.

public <
The type of similarity score unit.
E> Double

Returns:

The Jaccard Similarity of two set character sequence passed as input.
apply(final SimilarityInput<E>
first input sequence.
left, final SimilarityInput<E>
second input sequence.
right)

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

Computes the Jaccard Similarity of two character sequences passed as input.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

INSTANCEback to summary
pack-priv static final JaccardSimilarity INSTANCE

The singleton instance.

Constructor Detail

JaccardSimilarityback to summary
public JaccardSimilarity()

Creates 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.

Computes the Jaccard Similarity of two set character sequence passed as input.

Parameters
left:CharSequence

first input sequence.

right:CharSequence

second input sequence.

Returns:Double

The Jaccard Similarity of two set character sequence passed as input.

Annotations
@Override
Exceptions
IllegalArgumentException:
if either String input null.
applyback to summary
public <E> Double apply(final SimilarityInput<E> left, final SimilarityInput<E> right)

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

Computes the 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
<E>
The type of similarity score unit.
left:SimilarityInput<E>

first input sequence.

right:SimilarityInput<E>

second input sequence.

Returns:Double

The Jaccard Similarity of two set character sequence passed as input.

Since
1.13.0