Metadata-Version: 2.1
Name: GMDN
Version: 1.0.1
Summary: A python implementation of XKCD''s Geothmetic Meandian ( https://xkcd.com/2435/ )
Home-page: https://github.com/BollaBerg/GMDN
Author: Andreas B. Berg
Author-email: berg.andreasb+PyPi@gmail.com
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/BollaBerg/GMDN/issues
Keywords: XKCD,GMDN,Geothmetic meandian,Math
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# GMDN
A python implementation of XKCD's Geothmetic Meandian ( https://xkcd.com/2435/ )

Simply run 
```python
>>> from GMDN import GMDN
>>> GMDN([1, 1, 2, 3, 5])
2.0890566336242085

```

One can optionally include a limit, for how close the highest and lowest mean/median should be to accept the answer. The limit defaults to 0.00001. Note that the function returns the median of the result.
```python
>>> from GMDN import GMDN
>>> GMDN([1, 1, 2, 3, 5], 1)
2

```

GMDN can also be used to get a tuple of (arithmetic mean, geometric mean, median), using geothmetic_mean found in GMDN.helpers:
```python
>>> from GMDN.helpers import geothmetic_meandian
>>> geothmetic_meandian([1, 1, 2, 3, 5])
(2.4, 1.97435048583482, 2)

```

