Metadata-Version: 2.1
Name: mmq
Version: 0.0.1
Summary: It computes the coeficientes of the MMQ for a given set of 2-D points
Project-URL: Homepage, https://github.com/pypa/sampleproject
Project-URL: Bug Tracker, https://github.com/pypa/sampleproject/issues
Author-email: Igor Jasenovski <igormjsk@gmail.com>
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Description-Content-Type: text/markdown

# MMQ (Least Squares method) Package

## Description
The function takes a set of 2-D points **(np.array)** and returns the coefficients of the function that best fits the points, using the Least Squares method.
User needs to provide the function degree (1 for linear, 2 for quadratic, etc.) and the points (x and y) as np.arrays.

Maybe, for high degree functions, the function will face some problems. Be careful.

## Installation
```bash
pip install mmq
```

## Requirements
- numpy

## Usage
```python
from mmq import metodo_minimos_quadrados
metodo_minimos_quadrados.mmq(x, y, degree)
```

## Example
```python
from mmq import metodo_minimos_quadrados
import numpy as np

x = np.array([1, 2, 3, 4, 5])
y = np.array([1, 3, 5, 7, 9])
degree = 1

metodo_minimos_quadrados.mmq(x, y, degree)
```

## License
[MIT](https://choosealicense.com/licenses/mit/)

## Author
[Igor Matheus Jasenovski]

## Version
0.0.1

## References
[Least Squares Method](https://en.wikipedia.org/wiki/Least_squares)