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

public Class JaccardDistance

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
Measures the Jaccard distance of two sets of character sequence. Jaccard distance is the dissimilarity between two sets. It is the complementary of Jaccard similarity.

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

Since
1.0

Constructor Summary

AccessConstructor and Description
public
JaccardDistance()

Creates a new instance.

Method Summary

Modifier and TypeMethod and Description
public Double

Returns:

The Jaccard distance.
apply(final CharSequence
first input sequence.
left, final CharSequence
second input sequence.
right)

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

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

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

Returns:

index.
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 distance of two set character sequence passed as input.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

JaccardDistanceback to summary
public JaccardDistance()

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 distance of two set character sequence passed as input. Calculates Jaccard similarity and returns the complement of it.

Parameters
left:CharSequence

first input sequence.

right:CharSequence

second input sequence.

Returns:Double

The Jaccard distance.

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 distance of two set character sequence passed as input. Calculates Jaccard similarity and returns the complement of it.

Parameters
<E>
The type of similarity score unit.
left:SimilarityInput<E>

first input sequence.

right:SimilarityInput<E>

second input sequence.

Returns:Double

index.

Exceptions
IllegalArgumentException:
if either String input null.