Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ladunjexa/matrixlab.ts
A TypeScript matrix math library @matrixlab.ts
https://github.com/ladunjexa/matrixlab.ts
linear-algebra-concepts matrix-computations matrix-library matrixlab-ts npm-package typedoc vite-typescript
Last synced: 16 days ago
JSON representation
A TypeScript matrix math library @matrixlab.ts
- Host: GitHub
- URL: https://github.com/ladunjexa/matrixlab.ts
- Owner: ladunjexa
- License: mit
- Created: 2023-06-22T04:07:43.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-13T18:29:04.000Z (6 months ago)
- Last Synced: 2024-09-17T02:33:24.017Z (about 2 months ago)
- Topics: linear-algebra-concepts, matrix-computations, matrix-library, matrixlab-ts, npm-package, typedoc, vite-typescript
- Language: TypeScript
- Homepage: https://ladunjexa.github.io/matrixlab.ts/
- Size: 1010 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
matrixlab.ts
A TypeScript matrix math library
[](https://github.com/ladunjexa) [](https://github.com/ladunjexa/matrixlab.ts/blob/master/LICENSE) [](https://github.com/ladunjexa/matrixlab.ts/actions?query=workflow%3ADeploy) [](https://www.npmjs.com/package/matrixlab.ts) [](https://www.npmjs.com/package/matrixlab.ts) [](https://github.com/ladunjexa/matrixlab.ts) [](https://github.com/ladunjexa/matrixlab.ts/blob/master/CONTRIBUTING.md)
`matrixlab.ts` is a matrix math library written in TypeScript with _no dependencies_.
## How to install it
Using `npm`
```bash
npm install --save matrixlab.ts
```
Or add the [unpkg](https://unpkg.com/) cdn link to your html
```html
```
## Usage
Import the module, from TypeScript or ES6 JavaScript
```javascript
import { Matrix } from "matrixlab.ts";
```
The library is built as an ECMAScript module (`.mjs` file), but it also exports a UMD version if needed.
Then use the methods as you want
```javascript
const m1 = new Matrix(2, 2, [
[1, 2],
[3, 4],
]);
m1.multiply(2);
// ==>
// Matrix {
// rows: 2,
// cols: 2,
// values: [ [ 2, 4 ], [ 6, 8 ] ]
// }
m1.set(0, 0, 5);
m1.at(0, 0); // ==> 5
```
---
## Documentation
### Constructor
| constructor | description |
| --------------------------- | ---------------------------------------------------------------------------- |
| Matrix() | Creates a 1x1 matrix with zero value |
| Matrix(n) | Creates an _nxn_ matrix with zeroes |
| Matrix(data) | Creates a matrix from the specified 2D array |
| Matrix(rows, columns) | Creates an _mxn_ matrix with zeroes |
| Matrix(rows, columns, data) | Creates a matrix from the specified 2D array (with the specified dimensions) |
| Matrix(n, data) | Creates an _nxn_ matrix from the specified 2D array |
### Accessors and Mutators
| member | description |
| ------- | --------------------------------------------- |
| rows | Retrieves the number of rows in the matrix |
| columns | Retrieves the number of columns in the matrix |
| data | Gets the data of the matrix |
### Public Methods
| method | description |
| ------------------------- | ---------------------------------------------------------------------- |
| shape | Gets the shape of the matrix |
| size | Gets the size of the matrix |
| set(row, column, value) | Sets the value at the specified row and column indices |
| at(row, column) | Retrieves the value at the specified row and column indices |
| reset() | Sets all matrix values to 0 |
| clone() | Returns a new instance of the matrix |
| setData(array) | Copies data from the specified 2D array to the matrix |
| add(matrix) | Adds the specified matrix to the current matrix |
| subtract(matrix) | Subtracts the specified matrix from the current matrix |
| multiply(Matrix / Scalar) | Multiplies the current matrix by the specified matrix or scalar |
| modulo(modulus) | Modulos the current matrix by the specified modulus |
| isSquare() | Checks if the matrix is square |
| isSymmetric() | Checks if the matrix is symmetric |
| isIdentity() | Checks if the matrix is identity |
| setShape(array) | Sets the shape of the matrix |
| setAsIdentity() | Sets the matrix as an identity matrix |
| transpose() | Transposes the matrix |
| determinant() | Calculates the determinant of the matrix |
| getCofactor(row, column) | Calculates the cofactor of the matrix for the specified row and column |
| getMinor(row, column) | Calculates the minor of the matrix for the specified row and column |
| trace() | Calculates the trace of the matrix |
| inverse() | Calculates the inverse of the matrix |
| rowSpace() | Calculates the row space of the matrix |
| colSpace() | Calculates the column space of the matrix |
| isSameOrder(matrix) | Checks if the matrix has the same order as the specified matrix |
| equals() | Checks if the matrix is equal to the specified matrix |
### Private Methods
| method | description |
| ------------------------- | ----------------------------------------------------------------------------- |
| \_isOutOfMatrix(row, col) | Checks if the specified row and column indices are out of the matrix's bounds |
| \_initializeMatrix() | Initializes the matrix with the specified dimensions and data |
For more information, please refer to the [_Matrix_ Class documentation](https://ladunjexa.github.io/matrixlab.ts/Matrix.html)
# Contributing
<a href="https://github.com/ladunjexa/matrixlab.ts/graphs/contributors">
<img src="https://contrib.rocks/image?repo=ladunjexa/matrixlab.ts" />
</a>
Contributions are always welcome!
See [`contributing.md`](https://github.com/ladunjexa/matrixlab.ts) for ways to get started.
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
# License
The _MatrixLab_ is open source and distributed under the [MIT License](LICENSE).
# Contact
If you want to contact me, you can reach me at [@ladunjexa](https://t.me/ladunjexa).