org.coode.oppl.similarity

Interface SimilarityMeasure<O>

Type Parameters:

O - type

All Known Implementing Classes:

OWLObjectStructuralPrimeHashingBasedSimilarityMeasure, ProgressiveSimilarityMeasure, SymbolBasedSimilarity

public interface SimilarityMeasure<O>

A generic metric to asses the similarity between two objects of the same kind.

Author:

Luigi Iannone

Method Summary

Modifier and Type	Method and Description
double	compare(O anObject, O anotherObject) Compares the two input objects.
boolean	isSymmetric()

Method Detail

isSymmetric

boolean isSymmetric()

Returns:

true if compare(A,B) == compare (B,A)

compare

double compare(O anObject,
               O anotherObject)

Compares the two input objects. It required for this interface to implement this method in accordance to the equals method available for O. If isSymmetric returns true, then it must hold that compare(A,B) == compare (B,A).

Parameters:

anObject - the first object to compare. cannot be null.

anotherObject - the first object to compare. cannot be null.

Returns:

a number between 0 and 1. 1 corresponds to maximum similarity, 0 to minimal

Throws:

NullPointerException - if either input is null.