org.dkpro.statistics.agreement.distance

Class CachedDistanceFunction

java.lang.Object

org.dkpro.statistics.agreement.distance.CachedDistanceFunction

All Implemented Interfaces:

IDistanceFunction

public class CachedDistanceFunction
extends Object
implements IDistanceFunction

Wrapper class for arbitrary distance functions that caches the distance scores between two categories in a hash table. This is useful, if the calculation of a distance value is computationally complex, for instance, for set-valued categories as assumed by the SetAnnotationDistanceFunction.

Author:

Christian M. Meyer

See Also:

IDistanceFunction

Field Summary

Fields

Modifier and Type	Field and Description
protected Hashtable<String,Double>	cache
protected IDistanceFunction	wrappee

Constructor Summary

Constructors

Constructor and Description
CachedDistanceFunction(IDistanceFunction wrappee) Instantiates the wrapper for the given distance function.

Method Summary

Modifier and Type	Method and Description
double	measureDistance(IAnnotationStudy study, Object category1, Object category2) Returns a distance value for the given pair of categories used within the given annotation study.

Methods inherited from class java.lang.Object

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

Field Detail

cache

protected Hashtable<String,Double> cache

wrappee

protected IDistanceFunction wrappee

Constructor Detail

CachedDistanceFunction

public CachedDistanceFunction(IDistanceFunction wrappee)

Instantiates the wrapper for the given distance function.

Method Detail

measureDistance

public double measureDistance(IAnnotationStudy study,
                              Object category1,
                              Object category2)

Description copied from interface: IDistanceFunction

Returns a distance value for the given pair of categories used within the given annotation study. Normally, the measure should return a distance of 0 if, and only if, the two categories are equal and a positive number otherwise.

Specified by:

measureDistance in interface IDistanceFunction