CALL RANPOI Routine

Returns a random variate from a Poisson distribution.

Category:	Random Number
Restriction:	This function is not valid on the CAS server.
Note:	Argument types for arguments that are updated must match in CALL routines. All argument types must be CHAR, VARCHAR, or NUMERIC. If the argument types do not match, a warning is issued to the log.

Table of Contents

Syntax

CALL RANPOI(seed, m, x);

Required Arguments

seed

is the seed value. A new value for seed is returned each time CALL RANPOI is executed.

Range	seed < 2³¹ - 1
Note	If seed ≤ 0, the time of day is used to initialize the seed stream.
See	Seed Values and Comparison of Seed Values in Random-Number Functions and CALL Routines

m

is a numeric mean parameter.

Range

m ≥ 0

x

is a numeric variable. A new value for the random variate x is returned each time CALL RANPOI is executed.

Details

The CALL RANPOI routine updates seed and returns a variate x that is generated from a Poisson distribution, with mean m.

By adjusting the seeds, you can force streams of variates to agree or disagree for some or all of the observations in the same, or in subsequent, DATA steps.

For m< 85, an inverse transform method applied to a RANUNI uniform variate is used (Fishman, 1976; see in References.) For m ≥ 85, the normal approximation of a Poisson random variable is used. To expedite execution, internal variables are calculated only on initial calls (that is, with each new m).

For a discussion and example of an effective use of the random number CALL routines, see Starting, Stopping, and Restarting a Stream.

Comparisons

The CALL RANPOI routine gives greater control of the seed and random number streams than does the RANPOI function.

Example

This example uses the CALL RANPOI routine:

data u1(keep=x);
   seed=104;
   do i=1 to 5;
      call ranpoi(seed, 2000, x); 
      output;
   end;
   call symputx('seed', seed);
run;
data u2(keep=x);
   seed=&seed;
   do i=1 to 5;
      call ranpoi(seed, 2000, x); 
      output;
   end;
run;
data all;
   set u1 u2;
   z=ranpoi(104, 2000);
run;
proc print label;
   label x='Separate Streams' z = 'Single Stream';
run;

Output from the CALL RANPOI Routine

CALL RANPOI Routine

Syntax

Required Arguments

seed

m

x

Details

Comparisons

Example

See Also