PHP | stats_rand_gen_iuniform() Function

PHP stats_rand_gen_iuniform() 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_iuniform() function.

The built-in PHP stats_rand_gen_iuniform() function can generate an integer uniformly distributed between low (inclusive) and high (inclusive).

Syntax

Following below is the syntax to use this function -

int stats_rand_gen_iuniform( int $low, int $high )


Parameter Details

Sr.NoParameterDescription
1

low

The lower bound

2

high

The upper bound


Return Value

It return a random integer from the discrete uniform distribution between low (inclusive) and high (inclusive).

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 following example below generates an integer uniformly distributed between 1 and 3 (low < high) -

<?php
   var_dump(stats_rand_gen_iuniform(1, 3));
?>

Output

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

int(2)

Example2

The following example below generates an integer uniformly distributed between 1 and 1 (low == high) -

<?php
   var_dump(stats_rand_gen_iuniform(1, 1));
?>

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 low > high. A warning is shown in logs -

<?php
   // error cases
   var_dump(stats_rand_gen_iuniform(2, 1));    // low > high
?>

Output

The above code will produce the following result and a warning in logs PHP Warning: stats_rand_gen_iuniform(): low greater than high. low: 2 high: 1

bool(false)


Alright guys! This is where we are going to be rounding up for this tutorial post. In our next tutorial post, we will discuss about the PHP stats_rand_gen_noncentral_chisquare() 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.