Documentation Set for Swarm 2.2
Prev | Reference V. Random Library | Next

# PoissonDist

## Name

PoissonDist -- Poisson distribution

## Description

A distribution used to model the integer number of occurrences of some event over an interval of time or space.

## Protocols adopted by PoissonDist

UnsignedDistribution CREATABLE

## Methods

### Phase: Creating

- + create: (id <Zone>)aZone setGenerator: (id <SplitRandomGenerator>)generator setVirtualGenerator: (unsigned)vGen setOccurRate: (double)anOccurRate setInterval: (double)anInterval
  Use this create message if the generator to be attached is a Split one and both the occurrence rate and the interval are to be set at create time:

- + create: (id <Zone>)aZone setGenerator: (id <SimpleRandomGenerator>)generator setOccurRate: (double)anOccurRate setInterval: (double)anInterval
  Use this create message if the generator to be attached is a Simple one and both the occurrence rate and the interval are set at create time:

### Phase: Setting

- - setOccurRate: (double)anOccurRate
  The setOccurRate method only sets the occurRate parameter; the interval parameter is left unchanged from its previous or initialized value

- - setOccurRate: (double)anOccurRate setInterval: (double)anInterval
  The setOccurRate:setInterval method sets both the occurrence rate and the interval parameters.

- - setInterval: (double)anInterval
  The setInterval method only sets the interval parameter; the occurRate parameter is left unchanged from its previous or initialized value

### Phase: Using

- - (unsigned)getUnsignedSampleWithOccurRate: (double)anOccurRate withInterval: (double)anInterval
  The getUnsignedSampleWithOccurRate:andInterval method returns a sample value for the specified occurrence rate and interval. Does not change the the distribution's parameter values set by the setter methods.

- - (unsigned)getUnsignedSampleWithInterval: (double)anInterval
  The getUnsignedSampleWithInterval method returns a sample value using the distribution's current occurrence rate and new interval value. Causes an error if the occurrence rate has not been previously set.

- - (double)getInterval
  The getInterval method returns the interval parameter.

- - (double)getOccurRate
  The getOccurRate method returns the occurrence rate parameter.

Prev | Home | Next
PSWBgen | Up | ProbabilityDistribution