PHP | stats_rand_gen_noncentral_chisquare() Function

PHP stats_rand_gen_noncentral_chisquare() 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_noncentral_chisquare() function.

The stats_rand_gen_noncentral_chisquare() function generates a random deviate from the non-central chi-square distribution.

Syntax

Following below is the syntax to use this function -

float stats_rand_gen_noncentral_chisquare( float $df, float $xnonc )


Parameter Details

Sr.NoParameterDescription
1

df

The degrees of freedoms

2

xnonc

The non-centrality parameter


Return Value

This PHP function returns a random deviate from the non-central chi-square distribution with a degrees of freedoms df, and the non-centrality parameter xnonc.

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

Below example generates a random deviate from the non-central chi-square distribution with a degree of freedom set to 2, and non-centrality parameter set to 3 -

<?php
   var_dump(is_float(stats_rand_gen_noncentral_chisquare(2, 3)));
?>

Output

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

bool(true)

Example2

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

<?php
   // error cases
   var_dump(stats_rand_gen_noncentral_chisquare(0.9, 3));  // df < 1
?>

Output

The above code will produce the following result and a warning in logs PHP Warning: stats_rand_gen_noncentral_chisquare(): df < 1 or xnonc < 0. df value: 9.000000E-1 xnonc value: 3.000000E+0

bool(false)

Example3

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

<?php
   // error cases
   var_dump(stats_rand_gen_noncentral_chisquare(2, -0.1)); // xnonc < 0
?>

Output

The above code will produce the following result and a warning in logs PHP Warning: stats_rand_gen_noncentral_chisquare(): df < 1 or xnonc < 0. df value: 2.000000E+0 xnonc value: -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 will be studying about the built-in PHP stats_rand_gen_noncentral_f() 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.