org.simmetrics.metrics

Class OverlapCoefficient<T>

java.lang.Object

org.simmetrics.metrics.OverlapCoefficient<T>

Type Parameters:

T - type of the token

All Implemented Interfaces:

Distance<Set<T>>, Metric<Set<T>>, SetDistance<T>, SetMetric<T>

public final class OverlapCoefficient<T>
extends Object
implements SetMetric<T>, SetDistance<T>

The overlap coefficient measures the overlap between two sets. The similarity is defined as the size of the intersection divided by the smaller of the size of the two sets.

similarity(q,r) = ∣q ∩ r∣ / min{∣q∣, ∣r∣}
distance(q,r) = 1 - similarity(q,r)

Unlike the generalized overlap coefficient the occurrence (cardinality) of an entry is not taken into account. E.g. [hello, world] and [hello, world, hello, world] would be identical when compared with the overlap coefficient but are dissimilar when the generalized version is used.

Similar to the generalized Jaccard similarity which divides the intersection by the union of two multisets.

Similar to the dice coefficient which divides the shared information (intersection) by sum of cardinalities.

This class is immutable and thread-safe.

See Also:

GeneralizedOverlapCoefficient, Jaccard, Dice, Wikipedia - Overlap Coefficient

Constructor Summary

Constructors

Constructor and Description
OverlapCoefficient()

Method Summary

Modifier and Type	Method and Description
float	compare(Set<T> a, Set<T> b) Measures the similarity between sets a and b.
float	distance(Set<T> a, Set<T> b) Measures the distance between sets a and b.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

OverlapCoefficient

public OverlapCoefficient()

Method Detail

distance

public float distance(Set<T> a,
                      Set<T> b)

Description copied from interface: SetDistance

Measures the distance between sets a and b. The measurement results in a non-negative value. A value of 0.0 indicates that a and b are similar.

Results are undefined if a and b are sets based on different equivalence relations (as HashSet, TreeSet, and the keySet of an IdentityHashMap all are).

Specified by:

distance in interface Distance<Set<T>>

Specified by:

distance in interface SetDistance<T>

Parameters:

a - set a to compare

b - set b to compare

Returns:

a non-negative value

compare

public float compare(Set<T> a,
                     Set<T> b)

Description copied from interface: SetMetric

Measures the similarity between sets a and b. The measurement results in a value between 0 and 1 inclusive. A value of zero indicates that the sets are dissimilar, a value of 1 indicates they are similar.

Results are undefined if set1 and set2 are sets based on different equivalence relations (as HashSet, TreeSet, and the keySet of an IdentityHashMap all are).

Specified by:

compare in interface Metric<Set<T>>

Specified by:

compare in interface SetMetric<T>

Parameters:

a - set a to compare

b - set b to compare

Returns:

a value between 0 and 1 inclusive indicating similarity

toString

public String toString()

Overrides:

toString in class Object