ambit2.similarity.stats

Class Histogram<T extends Comparable>

java.lang.Object

java.util.AbstractMap<K,V>

java.util.TreeMap<T,MutableInt>

ambit2.similarity.stats.Histogram<T>

All Implemented Interfaces:

Serializable, Cloneable, Map<T,MutableInt>, NavigableMap<T,MutableInt>, SortedMap<T,MutableInt>

public class Histogram<T extends Comparable>
extends TreeMap<T,MutableInt>

A histogram.

Author:

Nina Jeliazkova
Modified 2005-6-20

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static double	ln2_1
protected static Logger	logger

Constructor Summary

Constructors

Constructor and Description
Histogram()

Method Summary

Modifier and Type	Method and Description
int	addObject(T object)
int	addObject(T object, int frequency)
void	clearFlag()
int	count()
double	entropy() Information entropy of a discrete probability distribution pi
protected boolean	getFlag(T object)
int	getFrequency(T object)
protected double	getFrequencySum(boolean flag, MutableInt count)
Iterator<Map.Entry<T,MutableInt>>	getIterator()
Object	getMaxFrequency()
double	hellinger(Histogram hist) Hellinger distance between two discrete probability distributions pi and qi * @param hist
protected double	relativeEntropy(Histogram hist) Kullback-Leibler distance (or relative entropy) between two discrete probability distributions pi and qi * @param hist
void	setFlag(T object, boolean value)
double	tanimoto(Histogram hist)
String	toString()

Methods inherited from class java.util.TreeMap

ceilingEntry, ceilingKey, clear, clone, comparator, containsKey, containsValue, descendingKeySet, descendingMap, entrySet, firstEntry, firstKey, floorEntry, floorKey, forEach, get, headMap, headMap, higherEntry, higherKey, keySet, lastEntry, lastKey, lowerEntry, lowerKey, navigableKeySet, pollFirstEntry, pollLastEntry, put, putAll, remove, replace, replace, replaceAll, size, subMap, subMap, tailMap, tailMap, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, isEmpty

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove

Field Detail

logger

protected static Logger logger

ln2_1

public static final double ln2_1

Constructor Detail

Histogram

public Histogram()

Method Detail

clearFlag

public void clearFlag()

addObject

public int addObject(T object,
                     int frequency)

addObject

public int addObject(T object)

getFlag

protected boolean getFlag(T object)

setFlag

public void setFlag(T object,
                    boolean value)

getFrequency

public int getFrequency(T object)

getMaxFrequency

public Object getMaxFrequency()

count

public int count()

entropy

public double entropy()

Information entropy of a discrete probability distribution pi

Returns:

d = sum(pi * logger(pi))

relativeEntropy

protected double relativeEntropy(Histogram hist)
                          throws Exception

Kullback-Leibler distance (or relative entropy) between two discrete probability distributions pi and qi * @param hist

Returns:

sum(pi * logger ( pi / qi)

Throws:

Exception

getIterator

public Iterator<Map.Entry<T,MutableInt>> getIterator()

tanimoto

public double tanimoto(Histogram hist)

hellinger

public double hellinger(Histogram hist)
                 throws Exception

Hellinger distance between two discrete probability distributions pi and qi * @param hist

Returns:

sum(( sqrt(pi) + sqrt(qi) )^2)

Throws:

Exception

getFrequencySum

protected double getFrequencySum(boolean flag,
                                 MutableInt count)

toString

public String toString()

Overrides:

toString in class AbstractMap<T extends Comparable,MutableInt>