# Matrixlib
# NOTICE
## "rank" and "inverse" functions are a work in progress, they DO NOT WORK.
---
### A basic library for matrix and vector operations. Any feedback is highly encouraged. I enjoy trying to create modules and programs that work with mathematical functions and data. I also like looking into higher end modules and researching the processes and programs they use to perform tasks. Any feedback will be taken and acted upon.
<br>
<br>
# Installation
---
### Use the package manager pip to install matrixlib_jfj.
### Release Versions:
``` bash
pip install matrixlib_jfj
```
### Test Versions:
``` bash
pip install -i https://test.pypi.org/simple matrixlib-jfj
```
<br>
<br>
# General Usage
---
``` python
import matrixlib_jfj as ml
# matrix = ml.matrix.Matrix(rowcols=(x, y) or values=[[nested list(s) with values assigned]]) Initialises the matrix.
Example:
matrix = ml.matrix.Matrix(rowcols=(3, 3))
>>> [[0, 0, 0], [0, 0, 0], [0, 0, 0]]
print(matrix)
+- -+
| 0 0 0 |
>>> | 0 0 0 |
| 0 0 0 |
+- -+
# matrix.random(a, b) Adds random values to the entire matrix
Example:
matrix.random(1, 10)
+- -+
|7 10 7 |
>>> |1 1 7 |
|10 5 8 |
+- -+
# matrix.identity() Creates an identity matrix from an existing square matrix
+- -+
|1 0 0|
>>> |0 1 0|
|0 0 1|
+- -+
### Adding ###
matrix1 = ml.matrix.Matrix(values=[
[1, 2, 3],
[4, 5, 6],
[7, 8, 9]
])
matrix2 = ml.matrix.Matrix(values=[
[9, 8, 7],
[6, 5, 4],
[3, 2, 1]
])
+- -+
|10 10 10|
>>> |10 10 10|
|10 10 10|
+- -+
```
<br>
<br>
# Updates
---
## Update 0.0.7
Added "get_submatrix" function that gets the submatrix of any square matrix, added the "det" function which gets the determinant of a square matrix.
<br>
## Update 0.0.8
Fixed bug where an external program would run when the user of the package would run their own program.
<br>
## Update 0.0.81
Updated README file to reflect certain information.
<br>
## Update 0.0.82
Fixed Type Annotations.
<br>
## Update 0.1.82
Removed Deprecations, Removed functionality in utils.py (Temporary) added better typing, improved cumsum function.
<br>
## Update 0.1.90
Added temporary base case to Matrix.rank() function.
<br>
# Contributing
---
Any and All feedback and help is highly encouraged. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
<br>
<br>
# License
---
[GNU General Public License v3.0](https://choosealicense.com/licenses/gpl-3.0/#)
Raw data
{
"_id": null,
"home_page": "",
"name": "matrixlib-jfj",
"maintainer": "",
"docs_url": null,
"requires_python": "<4,>=3.10",
"maintainer_email": "",
"keywords": "",
"author": "Jemma Starecki",
"author_email": "Jemma Starecki <starecki.j@shaw.ca>",
"download_url": "https://files.pythonhosted.org/packages/91/e6/8ddf4ea177a3aa6d817d428fa9191c21c6aa91653edda99642452386d718/matrixlib_jfj-0.2.5.tar.gz",
"platform": null,
"description": "# Matrixlib\r\n\r\n# NOTICE\r\n\r\n## \"rank\" and \"inverse\" functions are a work in progress, they DO NOT WORK.\r\n\r\n---\r\n### A basic library for matrix and vector operations. Any feedback is highly encouraged. I enjoy trying to create modules and programs that work with mathematical functions and data. I also like looking into higher end modules and researching the processes and programs they use to perform tasks. Any feedback will be taken and acted upon.\r\n<br>\r\n<br>\r\n\r\n# Installation\r\n\r\n---\r\n### Use the package manager pip to install matrixlib_jfj.\r\n\r\n### Release Versions:\r\n\r\n``` bash\r\npip install matrixlib_jfj\r\n```\r\n\r\n### Test Versions:\r\n\r\n``` bash\r\npip install -i https://test.pypi.org/simple matrixlib-jfj\r\n```\r\n<br>\r\n<br>\r\n\r\n# General Usage\r\n\r\n---\r\n``` python\r\nimport matrixlib_jfj as ml\r\n\r\n# matrix = ml.matrix.Matrix(rowcols=(x, y) or values=[[nested list(s) with values assigned]]) Initialises the matrix.\r\nExample:\r\nmatrix = ml.matrix.Matrix(rowcols=(3, 3))\r\n>>> [[0, 0, 0], [0, 0, 0], [0, 0, 0]]\r\n\r\nprint(matrix)\r\n +- -+\r\n | 0 0 0 |\r\n>>> | 0 0 0 |\r\n | 0 0 0 |\r\n +- -+\r\n\r\n# matrix.random(a, b) Adds random values to the entire matrix\r\nExample:\r\nmatrix.random(1, 10)\r\n +- -+\r\n |7 10 7 |\r\n>>> |1 1 7 |\r\n |10 5 8 |\r\n +- -+\r\n\r\n# matrix.identity() Creates an identity matrix from an existing square matrix\r\n +- -+\r\n |1 0 0|\r\n>>> |0 1 0|\r\n |0 0 1|\r\n +- -+\r\n\r\n### Adding ###\r\nmatrix1 = ml.matrix.Matrix(values=[\r\n [1, 2, 3],\r\n [4, 5, 6],\r\n [7, 8, 9]\r\n])\r\n\r\nmatrix2 = ml.matrix.Matrix(values=[\r\n [9, 8, 7],\r\n [6, 5, 4],\r\n [3, 2, 1]\r\n])\r\n\r\n +- -+\r\n |10 10 10|\r\n>>> |10 10 10|\r\n |10 10 10|\r\n +- -+\r\n```\r\n<br>\r\n<br>\r\n\r\n# Updates\r\n\r\n---\r\n## Update 0.0.7\r\nAdded \"get_submatrix\" function that gets the submatrix of any square matrix, added the \"det\" function which gets the determinant of a square matrix.\r\n\r\n<br>\r\n\r\n## Update 0.0.8\r\nFixed bug where an external program would run when the user of the package would run their own program.\r\n<br>\r\n\r\n## Update 0.0.81\r\nUpdated README file to reflect certain information.\r\n<br>\r\n\r\n## Update 0.0.82\r\nFixed Type Annotations.\r\n<br>\r\n\r\n## Update 0.1.82\r\nRemoved Deprecations, Removed functionality in utils.py (Temporary) added better typing, improved cumsum function.\r\n<br>\r\n\r\n## Update 0.1.90\r\nAdded temporary base case to Matrix.rank() function.\r\n<br>\r\n\r\n# Contributing\r\n\r\n---\r\nAny and All feedback and help is highly encouraged. For major changes, please open an issue first to discuss what you would like to change.\r\n\r\nPlease make sure to update tests as appropriate.\r\n<br>\r\n<br>\r\n\r\n# License\r\n\r\n---\r\n[GNU General Public License v3.0](https://choosealicense.com/licenses/gpl-3.0/#)\r\n",
"bugtrack_url": null,
"license": "GNU General Public License v3 (GPLv3)",
"summary": "A library that deals with matrix and vector operations.",
"version": "0.2.5",
"project_urls": {
"Issue Tracker": "https://github.com/JemmaFromJupiter/Matrixlib/issues",
"homepage": "https://github.com/JemmaFromJupiter/Matrixlib"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "64756236692fbba93306d05370ed2bfee33ea81301241f54e71eee1d84e63a58",
"md5": "2b3206ca73f3021261353618ed7dd728",
"sha256": "a16c8f251db1b3942b05d9aa8944ce970aa376da5eec0aa1fb5df13b6b97edf6"
},
"downloads": -1,
"filename": "matrixlib_jfj-0.2.5-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "2b3206ca73f3021261353618ed7dd728",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": "<4,>=3.10",
"size": 20443,
"upload_time": "2023-11-23T17:12:06",
"upload_time_iso_8601": "2023-11-23T17:12:06.244572Z",
"url": "https://files.pythonhosted.org/packages/64/75/6236692fbba93306d05370ed2bfee33ea81301241f54e71eee1d84e63a58/matrixlib_jfj-0.2.5-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "91e68ddf4ea177a3aa6d817d428fa9191c21c6aa91653edda99642452386d718",
"md5": "cdddebb83d05ef5fa1a54f5d5366b1e4",
"sha256": "ceeed2b5568d3b299c52fd3618d5af8bae68ecd39b5e30b4d93b5aaf79c64426"
},
"downloads": -1,
"filename": "matrixlib_jfj-0.2.5.tar.gz",
"has_sig": false,
"md5_digest": "cdddebb83d05ef5fa1a54f5d5366b1e4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.10",
"size": 21171,
"upload_time": "2023-11-23T17:12:08",
"upload_time_iso_8601": "2023-11-23T17:12:08.245010Z",
"url": "https://files.pythonhosted.org/packages/91/e6/8ddf4ea177a3aa6d817d428fa9191c21c6aa91653edda99642452386d718/matrixlib_jfj-0.2.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-23 17:12:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "JemmaFromJupiter",
"github_project": "Matrixlib",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "matplotlib",
"specs": [
[
">=",
"3.8.2"
]
]
},
{
"name": "numpy",
"specs": [
[
">=",
"1.24.3"
]
]
}
],
"lcname": "matrixlib-jfj"
}
JSON
