maths.geometric_mean
====================

.. py:module:: maths.geometric_mean

.. autoapi-nested-parse::

   The Geometric Mean of n numbers is defined as the n-th root of the product
   of those numbers. It is used to measure the central tendency of the numbers.
   https://en.wikipedia.org/wiki/Geometric_mean



Functions
---------

.. autoapisummary::

   maths.geometric_mean.compute_geometric_mean


Module Contents
---------------

.. py:function:: compute_geometric_mean(*args: int) -> float

   Return the geometric mean of the argument numbers.
   >>> compute_geometric_mean(2,8)
   4.0
   >>> compute_geometric_mean('a', 4)
   Traceback (most recent call last):
       ...
   TypeError: Not a Number
   >>> compute_geometric_mean(5, 125)
   25.0
   >>> compute_geometric_mean(1, 0)
   0.0
   >>> compute_geometric_mean(1, 5, 25, 5)
   5.0
   >>> compute_geometric_mean(2, -2)
   Traceback (most recent call last):
       ...
   ArithmeticError: Cannot Compute Geometric Mean for these numbers.
   >>> compute_geometric_mean(-5, 25, 1)
   -5.0