fabelous-math/README.md

45 lines
1.4 KiB
Markdown

# Fabelous Math
Fabelous Math is a simple library designed to provide basic mathematical functions, saving you the trouble of writing these common utilities repeatedly. This library includes essential functions like checking if a number is even or odd.
## Installation
You can easily install `fabelous-math` using pip:
```sh
pip install git+https://gitea.fabelous.app/Fabel/fabelous-math.git
```
## Usage
### Python
To use the functions provided by Fabelous Math in your Python code, you can import them as follows:
```python
from fabelous_math import is_even, is_odd, rooting, approximate_pi
number = 42
print(f"Is {number} even? {is_even(number)}")
print(f"Is {number} odd? {is_odd(number)}")
# Extended feature for rooting with a specified root
root = 4
number = 16
print(f"Rooting {number} to the power of {root}: {rooting(number, root)}")
# Extended feature for approximate_pi with additional parameters if needed
precision = 10000000
print(f"Approximate Pi with precision {precision}: {approximate_pi(precision)}")
```
## Performance Comparison
To understand the performance of `fabelous-math` functions, I conducted a series of tests comparing my methods with traditional modulo operations. Below are the results:
### Low Numbers Performance:
![Low Numbers Performance](docs/low_numbers_comparison.png)
### High Numbers Performance:
![High Numbers Performance](docs/high_numbers_comparison.png)