org.simmetrics.metrics

Class OverlapCoefficient<T>

java.lang.Object

org.simmetrics.metrics.OverlapCoefficient<T>

Type Parameters:

T - type of the token

All Implemented Interfaces:

Metric<Set<T>>, SetMetric<T>

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

Overlap Coefficient algorithm providing a similarity measure between two sets where it is determined to what degree a set is a subset of another.

overlap_coefficient(q,r) = (|q & r|) / min{|q|, |r|}

Related to the Jaccard index.

This class is immutable and thread-safe.

See Also:

JaccardSimilarity, 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.
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

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.

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