maths.series.geometric
======================

.. py:module:: maths.series.geometric

.. autoapi-nested-parse::

   Geometric Mean
   Reference :  https://en.wikipedia.org/wiki/Geometric_mean

   Geometric series
   Reference: https://en.wikipedia.org/wiki/Geometric_series



Functions
---------

.. autoapisummary::

   maths.series.geometric.geometric_mean
   maths.series.geometric.is_geometric_series


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

.. py:function:: geometric_mean(series: list) -> float

   return the geometric mean of series

   >>> geometric_mean([2, 4, 8])
   3.9999999999999996
   >>> geometric_mean([3, 6, 12, 24])
   8.48528137423857
   >>> geometric_mean([4, 8, 16])
   7.999999999999999
   >>> geometric_mean(4)
   Traceback (most recent call last):
       ...
   ValueError: Input series is not valid, valid series - [2, 4, 8]
   >>> geometric_mean([1, 2, 3])
   1.8171205928321397
   >>> geometric_mean([0, 2, 3])
   0.0
   >>> geometric_mean([])
   Traceback (most recent call last):
       ...
   ValueError: Input list must be a non empty list



.. py:function:: is_geometric_series(series: list) -> bool

   checking whether the input series is geometric series or not
   >>> is_geometric_series([2, 4, 8])
   True
   >>> is_geometric_series([3, 6, 12, 24])
   True
   >>> is_geometric_series([1, 2, 3])
   False
   >>> is_geometric_series([0, 0, 3])
   False
   >>> is_geometric_series([])
   Traceback (most recent call last):
       ...
   ValueError: Input list must be a non empty list
   >>> is_geometric_series(4)
   Traceback (most recent call last):
       ...
   ValueError: Input series is not valid, valid series - [2, 4, 8]