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

Class KullbackLeiblerDivergenceAsymmetricDistanceFunction

java.lang.Object

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

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

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

All Implemented Interfaces:

DistanceFunction<NumberVector<?>,DoubleDistance>, NumberVectorDistanceFunction<DoubleDistance>, PrimitiveDistanceFunction<NumberVector<?>,DoubleDistance>, PrimitiveDoubleDistanceFunction<NumberVector<?>>, Parameterizable

@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 AbstractVectorDoubleDistanceFunction

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.

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	doubleDistance(NumberVector<?> v1, NumberVector<?> v2) Computes the distance between two given Objects 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.AbstractVectorDoubleDistanceFunction

dimensionality, dimensionality, dimensionality, dimensionality, distance, getDistanceFactory, 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

doubleDistance

public double doubleDistance(NumberVector<?> v1,
                    NumberVector<?> v2)

Description copied from interface: PrimitiveDoubleDistanceFunction

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

Parameters:

v1 - first Object

v2 - second Object

Returns:

the distance between two given Objects 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<?>,DoubleDistance>

Overrides:

isSymmetric in class AbstractPrimitiveDistanceFunction<NumberVector<?>,DoubleDistance>

Returns:

true when symmetric

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object