Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1556

News	FAQ
Search	Home

randomnumbers.negativeexponential - Function

	Package	utility
	Module	mathematics
	Tool	randomnumbers

Generate random numbers with a negative-exponential distribution

Synopsis
negativeexponential(mean, shape)

Description
The negativeexponential function will generate numbers that follow a negative-exponential or exponential distribution. See the general tool description for a mathematical definition of the probability density function.

The mean can be any positive number. The result will be floating point numbers in the range 0 < x < $\infty$. 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
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();
      numbers := rand.negativeexponential(2);
      rand.done()

This example will calculate a random number from the negative-exponential distribution with a mean of two.