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

# ProbabilityDistribution

## Name

ProbabilityDistribution -- Probability Distribution

## Description

A process for generating a sequence of random numbers matching the frequencies defined by a specific distribution function. The process is driven by input from a supplied uniform random generator.

## Protocols adopted by ProbabilityDistribution

SwarmObject InternalState

## Methods

### Phase: Creating

- + create: (id <Zone>)aZone setGenerator: (id <SimpleRandomGenerator>)simpleGenerator
  Use this create message if the generator to be attached is a Simple one:

- + create: (id <Zone>)aZone setGenerator: (id <SplitRandomGenerator>)splitGenerator setVirtualGenerator: (unsigned)vGen
  Use this create message if the generator to be attached is a Split one:

- + createWithDefaults: (id <Zone>)aZone
  The createWithDefaults method creates a distribution object with a default set of seeds and parameters, and its own private generator.

### Phase: Setting

- - reset
  The reset method resets the currentCount and other state data.

- - setGenerator: (id <SimpleRandomGenerator>)simpleGenerator
  Use this message if the generator to be attached is a Simple one:

- - setGenerator: (id <SplitRandomGenerator>)splitGenerator setVirtualGenerator: (unsigned)vGen
  Use this message if the generator to be attached is a Split one:

### Phase: Using

- - (unsigned long long int)getCurrentCount
  The getCurrentCount method returns the count of variates generated.

- - (BOOL)getOptionsInitialized
  The getOptionsInitialized returns the value of the parameter.

- - (unsigned)getVirtualGenerator
  The getVirtualGenerator returns the number of the virtual generator used.

- - (id <BasicRandomGenerator>)getGenerator
  The getGenerator method returns the id of the generator.

Prev | Home | Next
PoissonDist | Up | RWC2gen