Getting Started Documentation Glish Learn More Programming Contact Us
Version 1.9 Build 1556
News FAQ
Search Home


next up previous contents index
Next: randomnumbers.geometric - Function Up: randomnumbers - Tool Previous: randomnumbers.discreteuniform - Function


randomnumbers.erlang - Function



Package utility
Module mathematics
Tool randomnumbers


Generate random numbers that have an Erlang distribution.


Synopsis
erlang(mean, variance, shape)


Description
The erlang function will generate numbers that follow a erlang, or Gamma distribution. See the general tool description for a mathematical definition of the probability density function.

The mean can be any real number except zero and the variance must be a positive number. The result will be floating point numbers in the range 0 < x < $ \infty$ if the mean is positive and in the range - $ \infty$ < x < 0 if it is negative. The shape can be either an integer or a vector of integers where all the values are greater than zero. The default value of one will produce a scalar output.



Arguments

mean in Mean of the distribution
    Allowed: double
    Default: 1.0
variance in Variance of the distribution
    Allowed: double
    Default: 1.0
shape in Shape of the output array
    Allowed: integer or a vector of integers
    Default: 1


Returns
A floating point scalar or array.


Example
      include 'randomnumbers.g'
      rand := randomnumbers();
      print rand.erlang(4, 8);
      rand.done()
This example will print a random number from the erlang distribution.



next up previous contents index
Next: randomnumbers.geometric - Function Up: randomnumbers - Tool Previous: randomnumbers.discreteuniform - Function   Contents   Index
Please send questions or comments about AIPS++ to aips2-request@nrao.edu.
Copyright © 1995-2000 Associated Universities Inc., Washington, D.C.

Return to AIPS++ Home Page
2006-10-15