Documentation Set for Swarm 2.2
Prev | Reference IX. Analysis Library | Next

# Entropy

## Name

Entropy -- Computes entropy via a MessageProbe.

## Description

Entropy objects read probabilities (via a MessageProbe) from a collection of objects and calculate the entropy of the underlying distribution.

## Protocols adopted by Entropy

MessageProbe CREATABLE

## Methods

### Phase: Creating

- - setCollection: aCollection
  The setCollection method sets the collection of objects that will be probed.

### Phase: Using

- - (double)getEntropy
  The getEntropy method returns the calculated Entropy. The entropy value is read out of the object, not computed everytime it is requested.

- - (void)update
  The update method polls the collection and updates the entropy. This method should be scheduled prior to collecting the data using getEntropy.

Prev | Home | Next
EZSequence | Up | FunctionGraph