de.lmu.ifi.dbs.elki.distance.distancefunction.probabilistic

Class KullbackLeiblerDivergenceAsymmetricDistanceFunction

java.lang.Object

de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractPrimitiveDistanceFunction<NumberVector>

de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractNumberVectorDistanceFunction

de.lmu.ifi.dbs.elki.distance.distancefunction.probabilistic.KullbackLeiblerDivergenceAsymmetricDistanceFunction

All Implemented Interfaces:

DistanceFunction<NumberVector>, NumberVectorDistanceFunction<NumberVector>, PrimitiveDistanceFunction<NumberVector>

@Reference(authors="S. Kullback",
           title="Information theory and statistics",
           booktitle="Information theory and statistics, Courier Dover Publications, 1997.")
@Alias(value="kl")
public class KullbackLeiblerDivergenceAsymmetricDistanceFunction
extends AbstractNumberVectorDistanceFunction

Kullback-Leibler (asymmetric!) Distance, also known as relative entropy, information deviation or just KL-distance For a version with the arguments reversed, see KullbackLeiblerDivergenceReverseAsymmetricDistanceFunction. For a symmetric version, see JeffreyDivergenceDistanceFunction. Reference:

S. Kullback
Information theory and statistics
Courier Dover Publications, 1997.

Since:

0.4.0

Author:

Erich Schubert

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KullbackLeiblerDivergenceAsymmetricDistanceFunction.Parameterizer Parameterization class, using the static instance.

Field Summary

Fields

Modifier and Type	Field and Description
static KullbackLeiblerDivergenceAsymmetricDistanceFunction	STATIC Static instance.

Constructor Summary

Constructors

Constructor and Description
KullbackLeiblerDivergenceAsymmetricDistanceFunction() Deprecated. Use static instance!

Method Summary

Methods

Modifier and Type	Method and Description
double	distance(NumberVector v1, NumberVector v2) Computes the distance between two given DatabaseObjects according to this distance function.
boolean	equals(Object obj)
boolean	isSymmetric() Is this function symmetric?
String	toString()

Methods inherited from class de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractNumberVectorDistanceFunction

dimensionality, dimensionality, dimensionality, dimensionality, getInputTypeRestriction

Methods inherited from class de.lmu.ifi.dbs.elki.distance.distancefunction.AbstractPrimitiveDistanceFunction

instantiate, isMetric

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.lmu.ifi.dbs.elki.distance.distancefunction.DistanceFunction

instantiate, isMetric

Field Detail

STATIC

public static final KullbackLeiblerDivergenceAsymmetricDistanceFunction STATIC

Static instance. Use this!

Constructor Detail

KullbackLeiblerDivergenceAsymmetricDistanceFunction

@Deprecated
public KullbackLeiblerDivergenceAsymmetricDistanceFunction()

Deprecated. Use static instance!

Constructor for the Kullback-Leibler divergence.

Method Detail

distance

public double distance(NumberVector v1,
              NumberVector v2)

Description copied from interface: PrimitiveDistanceFunction

Computes the distance between two given DatabaseObjects according to this distance function.

Specified by:

distance in interface NumberVectorDistanceFunction<NumberVector>

Specified by:

distance in interface PrimitiveDistanceFunction<NumberVector>

Specified by:

distance in class AbstractPrimitiveDistanceFunction<NumberVector>

Parameters:

v1 - first DatabaseObject

v2 - second DatabaseObject

Returns:

the distance between two given DatabaseObjects according to this distance function

isSymmetric

public boolean isSymmetric()

Description copied from interface: DistanceFunction

Is this function symmetric?

Specified by:

isSymmetric in interface DistanceFunction<NumberVector>

Overrides:

isSymmetric in class AbstractPrimitiveDistanceFunction<NumberVector>

Returns:

true when symmetric

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object