org.simmetrics.metrics

Class EuclideanDistance<T>

java.lang.Object

org.simmetrics.metrics.EuclideanDistance<T>

Type Parameters:

T - type of the token

All Implemented Interfaces:

Distance<List<T>>, ListDistance<T>, ListMetric<T>, Metric<List<T>>

public class EuclideanDistance<T>
extends Object
implements ListMetric<T>, ListDistance<T>

Euclidean Distance algorithm providing a similarity measure between two lists using the vector space of combined terms as the dimensions.

This class is immutable and thread-safe.

Constructor Summary

Constructors

Constructor and Description
EuclideanDistance()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

EuclideanDistance

public EuclideanDistance()

Method Detail

compare

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

Description copied from interface: ListMetric

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

Specified by:

compare in interface ListMetric<T>

Specified by:

compare in interface Metric<List<T>>

Parameters:

a - list a to compare

b - list b to compare

Returns:

a value between 0 and 1 inclusive indicating similarity

distance

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

Description copied from interface: ListDistance

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

Specified by:

distance in interface Distance<List<T>>

Specified by:

distance in interface ListDistance<T>

Parameters:

a - list a to compare

b - list b to compare

Returns:

a non-negative value

toString

public String toString()

Overrides:

toString in class Object