Alzebra
An All-In-One Herd of Linear Algebra Functions
View the website for API documentation and more!
## Table of Contents
- [Why should you use Alzebra?](#why-should-you-use-alzebra)
- [Installation](#installation)
- [Usage](#usage)
- [Website](#website)
- [Contributors](#contributors)
## Why should you use Alzebra?
- 🚀 [**<2kB** size](https://bundlephobia.com/package/alzebra) (zipped)
- ✨ TypeScript definitions **built in**
- 📖 **Thorough** and **detailed** documentation
- ✅ Tested **end-to-end** with Jest
- 🌟 Code quality **perfected** with linters ([Prettier](https://prettier.io/), [ESLint](https://eslint.org/), [EditorConfig](https://editorconfig.org/), [Markdownlint](https://github.com/DavidAnson/markdownlint)) to reduce **bundle size** and ensure **bug-free code**
- 💫 Automated [GitHub Workflows](https://github.com/YashTotale/alzebra/actions) ensure that every change is **high quality** and **functional**
## Installation
Using [npm](https://www.npmjs.com):
```shell
npm install alzebra
```
Using [yarn](https://yarnpkg.com/):
```shell
yarn add alzebra
```
You can browse the package's files on [unpkg](https://unpkg.com/browse/alzebra/).
## Usage
```javascript
// ESM: import Alzebra from "alzebra";
const Alzebra = require("alzebra");
const matrix = [
[1, 1, 0],
[0, 1, 1],
[2, 1, 1],
];
const solutions = [10, 15, 25];
const result = new Alzebra(matrix).eliminassian(solutions);
/**
result = {
matrix: [
[1, 0, 0],
[0, 1, 0],
[0, 0, 1],
],
vector: [5, 5, 10]
}
*/
```
## Website
[](https://alzebra.yashtotale.dev/)
**[The website contains all API documentation and information about this package.](https://alzebra.yashtotale.dev/)**
## Contributors
Project Contributors ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
