matrixflow


Namematrixflow JSON
Version 0.1.3 PyPI version JSON
download
home_pageNone
SummaryA rich library with implementations for mathematical matrices and vectors and their operations
upload_time2024-10-14 21:11:18
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
license MIT License Copyright (c) 2024-present Tom-the-Bomb Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords vector matrix math
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
# Matrixflow

[![Downloads](https://static.pepy.tech/badge/matrixflow)](https://pepy.tech/project/matrixflow)

A rich library with implementations for mathematical **matrices** and **vectors** and their operations

Refer to the documentation over [here](https://matrixflow.readthedocs.io/en/latest/index.html)

## Installation

Python 3.10 or higher is required

```bash
py -m pip install matrixflow
```

or from github

```bash
py -m pip install git+https://github.com/Tom-the-Bomb/matrixflow.git
```

## Examples

```py
from matrixflow import Matrix, Vector

A = Matrix([
    [1, 2, 3],
    [4, 5, 6],
    [7, 8, 9],
])
print(A.det()) # calculates the determinant
A.transpose()   # transposes `A` in place

u = Vector([1, 2, 3])
v = Vector([4, 5, 6])
print(u * v)   # calculates the dot product
```

Further examples can be found over at the documentation [here](https://matrixflow.readthedocs.io/en/latest/examples.html)

## Highlight Features

- **Matrices**
    - Basic operations: addition, subtraction, scalar/matrix multiplication and other basic matrix functions
    - Linear transformations
    - determinant
    - Linear system of equations:
        - Gaussian elimination: row echelon & reduced row echelon forms
        - Inverse
    - and many more!

- **Vectors**
    - Basic operations: addition, subtraction, scalar/dot/cross products and other basic vector functions
    - polar/spherical and cartesian conversions
    - projection, rejection
    - and many more!

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "matrixflow",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": "vector, matrix, math",
    "author": null,
    "author_email": "Tom-the-Bomb <me@tomthebomb.dev>",
    "download_url": "https://files.pythonhosted.org/packages/00/11/97da3ea46beb1474bc7b4942f4b7f9ae42b125bec35a52ffb7c862af44f2/matrixflow-0.1.3.tar.gz",
    "platform": null,
    "description": "\r\n# Matrixflow\r\n\r\n[![Downloads](https://static.pepy.tech/badge/matrixflow)](https://pepy.tech/project/matrixflow)\r\n\r\nA rich library with implementations for mathematical **matrices** and **vectors** and their operations\r\n\r\nRefer to the documentation over [here](https://matrixflow.readthedocs.io/en/latest/index.html)\r\n\r\n## Installation\r\n\r\nPython 3.10 or higher is required\r\n\r\n```bash\r\npy -m pip install matrixflow\r\n```\r\n\r\nor from github\r\n\r\n```bash\r\npy -m pip install git+https://github.com/Tom-the-Bomb/matrixflow.git\r\n```\r\n\r\n## Examples\r\n\r\n```py\r\nfrom matrixflow import Matrix, Vector\r\n\r\nA = Matrix([\r\n    [1, 2, 3],\r\n    [4, 5, 6],\r\n    [7, 8, 9],\r\n])\r\nprint(A.det()) # calculates the determinant\r\nA.transpose()   # transposes `A` in place\r\n\r\nu = Vector([1, 2, 3])\r\nv = Vector([4, 5, 6])\r\nprint(u * v)   # calculates the dot product\r\n```\r\n\r\nFurther examples can be found over at the documentation [here](https://matrixflow.readthedocs.io/en/latest/examples.html)\r\n\r\n## Highlight Features\r\n\r\n- **Matrices**\r\n    - Basic operations: addition, subtraction, scalar/matrix multiplication and other basic matrix functions\r\n    - Linear transformations\r\n    - determinant\r\n    - Linear system of equations:\r\n        - Gaussian elimination: row echelon & reduced row echelon forms\r\n        - Inverse\r\n    - and many more!\r\n\r\n- **Vectors**\r\n    - Basic operations: addition, subtraction, scalar/dot/cross products and other basic vector functions\r\n    - polar/spherical and cartesian conversions\r\n    - projection, rejection\r\n    - and many more!\r\n",
    "bugtrack_url": null,
    "license": " MIT License  Copyright (c) 2024-present Tom-the-Bomb  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "A rich library with implementations for mathematical matrices and vectors and their operations",
    "version": "0.1.3",
    "project_urls": {
        "Issue tracker": "https://github.com/Tom-the-Bomb/matrixflow/issues/",
        "documentation": "https://matrixflow.readthedocs.io/en/latest/",
        "homepage": "https://github.com/Tom-the-Bomb/matrixflow",
        "repository": "https://github.com/Tom-the-Bomb/matrixflow"
    },
    "split_keywords": [
        "vector",
        " matrix",
        " math"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "66b3a79bf263c0c08ca8c4867d988121ffe53bba785c682c511bfdeaee32282a",
                "md5": "ad9c18493304de2e2ec7e58d772fabb0",
                "sha256": "de2a2ce273717faa86b7729c54bdabbdb80553dfd079aaf17e8f396e6542b31d"
            },
            "downloads": -1,
            "filename": "matrixflow-0.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ad9c18493304de2e2ec7e58d772fabb0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 17792,
            "upload_time": "2024-10-14T21:11:15",
            "upload_time_iso_8601": "2024-10-14T21:11:15.770141Z",
            "url": "https://files.pythonhosted.org/packages/66/b3/a79bf263c0c08ca8c4867d988121ffe53bba785c682c511bfdeaee32282a/matrixflow-0.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "001197da3ea46beb1474bc7b4942f4b7f9ae42b125bec35a52ffb7c862af44f2",
                "md5": "e00efdf0da77b27058b743885056b72b",
                "sha256": "d43860582f9f0d414651d0af17d4a5c15716d1c128276844df0a8de15a94ee50"
            },
            "downloads": -1,
            "filename": "matrixflow-0.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "e00efdf0da77b27058b743885056b72b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 17595,
            "upload_time": "2024-10-14T21:11:18",
            "upload_time_iso_8601": "2024-10-14T21:11:18.230292Z",
            "url": "https://files.pythonhosted.org/packages/00/11/97da3ea46beb1474bc7b4942f4b7f9ae42b125bec35a52ffb7c862af44f2/matrixflow-0.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-14 21:11:18",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Tom-the-Bomb",
    "github_project": "matrixflow",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "matrixflow"
}
        
Elapsed time: 0.32085s