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

# EZDistribution

## Name

EZDistribution -- An EZBin that treats data as a distribution.

## Description

This is a subclass of EZBin which normalizes the data and treats it as a distribution. This means that in addition to the statistics it can calculate by virtue of being a subclass of EZBin, it can also calculate the entropy of the distribution as well as return the probabilities associated with the individual bins.

## Protocols adopted by EZDistribution

EZBin CREATABLE

## Methods

### Phase: Using

- - (double)getEntropy
  The getEntropy method returns the entropy of the distribution as calculated in the previous call to update.

- - (double *)getProbabilities
  The getProbabilities method returns an array of doubles representing the probability of every bin in the distribution.

- - (void)output
  The output method causes the graphical display to be updated with the information extracted by the previous call to update. When file I/O is enabled (the state of setFileOutput is set to 1), the probability associated with each bin is sent to the output file. When the graphical display is enabled (the state of setGraphics is set to 1), the histogram will be drawn.

- - (void)update
  The update method polls the bins and updates the entropy of the distribution as well as the probabilities associated with the individual bins.

Prev | Home | Next
EZBin | Up | EZGraph