PHP | stats_harmonic_mean() Function

PHP stats_harmonic_mean() Function


Hello folks! welcome back to a new edition of our tutorial on PHP. In this tutorial guide, we are going to be studying about the PHP stats_harmonic_mean() Function.

The built-in stats_harmonic_mean() function in PHP is used to return the harmonic mean of an array of values.

Syntax

Following below is the syntax to use this function -

number stats_harmonic_mean( array $a )


Parameter Details

Sr.NoParameterDescription
1

a

The input array


Return Value

This built-in function returns the harmonic mean of values in a or false if a is empty or not an array.

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 computes the harmonic mean of an array -

<?php
   var_dump(sprintf("%2.9f", stats_harmonic_mean(array(1,3,5,7))));
   }
?>

Output

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

string(11) "2.386363636"

Example2

Following example below is an error case, in the below example, we passed an empty array. A warning is shown in logs -

<?php
   // error cases
   var_dump(stats_standard_deviation(array()));
?>

Output

The above code will produce the following result and a warning in logs PHP Warning: stats_harmonic_mean(): The array has zero elements

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 PHP stats_kurtosis() 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.