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

Class JensenShannonDivergenceDistanceFunction

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.AbstractSpatialDistanceFunction

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

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

All Implemented Interfaces:

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

public class JensenShannonDivergenceDistanceFunction
extends JeffreyDivergenceDistanceFunction

Jensen-Shannon Divergence is essentially the same as Jeffrey divergence, only scaled by half.

Since:

0.6.0

Author:

Erich Schubert

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
JensenShannonDivergenceDistanceFunction() 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.
double	minDist(SpatialComparable mbr1, SpatialComparable mbr2) Computes the distance between the two given MBRs according to this distance function.
String	toString()

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

equals

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

instantiate

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

isMetric, isSymmetric

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.PrimitiveDistanceFunction

getInputTypeRestriction

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

isMetric, isSymmetric

Field Detail

STATIC

public static final JensenShannonDivergenceDistanceFunction STATIC

Static instance. Use this!

Constructor Detail

JensenShannonDivergenceDistanceFunction

@Deprecated
public JensenShannonDivergenceDistanceFunction()

Deprecated. Use static instance!

Constructor for the Jensen-Shannon 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>

Overrides:

distance in class JeffreyDivergenceDistanceFunction

Parameters:

v1 - first DatabaseObject

v2 - second DatabaseObject

Returns:

the distance between two given DatabaseObjects according to this distance function

minDist

public double minDist(SpatialComparable mbr1,
             SpatialComparable mbr2)

Description copied from interface: SpatialPrimitiveDistanceFunction

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

Specified by:

minDist in interface SpatialPrimitiveDistanceFunction<NumberVector>

Overrides:

minDist in class JeffreyDivergenceDistanceFunction

Parameters:

mbr1 - the first MBR object

mbr2 - the second MBR object

Returns:

the distance between the two given MBRs according to this distance function

toString

public String toString()

Overrides:

toString in class JeffreyDivergenceDistanceFunction