be.ac.ulb.mlg.utils.measure.entropy

Class ShannonEntropy

java.lang.Object

be.ac.ulb.mlg.utils.measure.Entropy

be.ac.ulb.mlg.utils.measure.entropy.EmpiricalEntropy

be.ac.ulb.mlg.utils.measure.entropy.ShannonEntropy

All Implemented Interfaces:

Measure

public class ShannonEntropy
extends EmpiricalEntropy

Shannon entropy estimate (empirical) of Uniform probability distribution.

Version:

1.2, 18/08/2015

Author:

Jean-Sébastien Lerat

Field Summary

Fields inherited from interface be.ac.ulb.mlg.utils.Measure

ERROR_VALUE

Constructor Summary

Constructors

Constructor and Description
ShannonEntropy()

Method Summary

Modifier and Type	Method and Description
double	entropy(double[] frequencies, int distinctValues, int numberOfValues) Compute the entropy of a vector of values (non missing values (NaN))
boolean	hasNativeImplementation() Know if the measure owns a native implementation

Methods inherited from class be.ac.ulb.mlg.utils.measure.Entropy

entropy, jointEntropy, measure, requireDataTransformation, transform

Methods inherited from class java.lang.Object

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

Constructor Detail

ShannonEntropy

public ShannonEntropy()

Method Detail

entropy

public double entropy(double[] frequencies,
                      int distinctValues,
                      int numberOfValues)

Description copied from class: Entropy

Compute the entropy of a vector of values (non missing values (NaN))

Overrides:

entropy in class EmpiricalEntropy

Parameters:

frequencies - The occurrences array (of values)

distinctValues - The number of distinct values

numberOfValues - The number of values

Returns:

The pseudo count

hasNativeImplementation

public boolean hasNativeImplementation()

Description copied from interface: Measure

Know if the measure owns a native implementation

Specified by:

hasNativeImplementation in interface Measure

Overrides:

hasNativeImplementation in class EmpiricalEntropy

Returns:

True if the measure is also natively implemented