PHP | stats_rand_gen_ipoisson() Function

PHP stats_rand_gen_ipoisson() Function


Hello folks! welcome back to a new edition of our tutorial on PHP. In this tutorial guide, we are going to be discussing briefly about the stats_rand_gen_ipoisson() function.

The built-in PHP stats_rand_gen_ipoisson() function generates a single random deviate from the Poisson distribution.

Syntax

Following below is the syntax to use this function -

int stats_rand_gen_ipoisson( float $mu )


Parameter Details

Sr.NoParameterDescription
1

mu

The parameter of the Poisson distribution


Return Value

This PHP function returns a random deviate from the Poisson distribution, where mu is the parameter of the Poisson distribution.

Dependencies

This built-in function was first introduced in statistics extension (PHP version 4.0.0 and PEAR v1.4.0). In this tutorial guide, we used the latest release of stats-2.0.3 (PHP v7.0.0 or newer and PEAR version 1.4.0 or newer).

Example1

The example below computes the random deviation from the Poisson distribution with parameter 1 -

<?php
   var_dump(is_int(stats_rand_gen_ipoisson(1)));
?>

Output

When the above code is executed, it will produce the following result -

bool(true)

Example2

The example below computes the random deviation from the Poisson distribution with parameter 0 -

<?php
   var_dump(stats_rand_gen_ipoisson(0));
?>

Output

When the above code is executed, it will produce the following result -

int(0)

Example3

Following is an error case. In the following example below, we have passed mu < 0. A warning is shown in logs -

<?php
   // error cases
   var_dump(stats_rand_gen_ipoisson(-0.1));    // mu < 0
?>

Output

The above code will produce the following result and a warning in logs PHP Warning: stats_rand_gen_ipoisson(): mu < 0.0. mu : -1.000000E-1

bool(false)


Alright guys! This is where we are going to be rounding up for this tutorial post. In our next tutorial, we are going to be discussing about the built-in stats_rand_gen_iuniform() Function.

Feel free to ask your questions where necessary and we will attend to them as soon as possible. If this tutorial was helpful to you, you can use the share button to share this tutorial.

Follow us on our various social media platforms to stay updated with our latest tutorials. You can also subscribe to our newsletter in order to get our tutorials delivered directly to your emails.

Thanks for reading and bye for now.