io.warp10.script.aggregator

Class ShannonEntropy

java.lang.Object

io.warp10.script.NamedWarpScriptFunction

io.warp10.script.aggregator.ShannonEntropy

All Implemented Interfaces:

WarpScriptAggregatorFunction, WarpScriptBucketizerFunction, WarpScriptMapperFunction, WarpScriptReducerFunction

public class ShannonEntropy
extends NamedWarpScriptFunction
implements WarpScriptMapperFunction, WarpScriptBucketizerFunction, WarpScriptReducerFunction

Compute a Shannon Entropy, considering GTS values to be number of occurrences of the underlying symbol. The nature of the underlying symbol is not important. The returned entropy is normalized by log(N) where N is the sum of occurrences.

Constructor Summary

Constructors

Constructor and Description
ShannonEntropy(java.lang.String name, boolean invert)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	apply(java.lang.Object[] args)

Methods inherited from class io.warp10.script.NamedWarpScriptFunction

getName, refSnapshot, setName, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ShannonEntropy

public ShannonEntropy(java.lang.String name,
                      boolean invert)

Method Detail

apply

public java.lang.Object apply(java.lang.Object[] args)
                       throws WarpScriptException

Specified by:

apply in interface WarpScriptAggregatorFunction

Throws:

WarpScriptException