mtx.js v2.0.1

MTX·JS

mtx.js is a js module that gives you a matrix constructor based on the Array class.

How does it work?

installing the package

You have to require the module, to require the module you can: use npm (node) intsaling the package with npm i mtx.js

const Matrix = require("mtx.js");

use deno or a web engine (download it before in your project folder)

import "./imp.js" as Matrix

or download it manualy from the github project

Using a Matrix

How do you use a Matrix? well, indeed you have to create the matrix with the class constructor (more info bellow)

var mtx1 = new Matrix(3,3,0)

and then you can get any cell by saying in wich row and wich column the cell is.

mtx1[row][column] = cellValue
//be aware that we use the js array index systeme so the first cell is mtx1[0][0]

Creating a Matrix

There are multiple ways to create a matrix with the class (from now known as Matrix) constructor.

1- None module made matrix. If you searched about it before finding this module, you may know that to easily create a matrix in js you only have to create an array with another array in each cell.

var mtx1 = 
[
[0,1,2],
[0,1,2],
[0,1,2]
]

But if you want more methods such as transpose the matrix (more info bellow) you can give them to it by transforming the none module matrix into a module one.

var mtx2 = new Matrix(mtx1)

2- Aray made matrix You can also create a matrix with an Array and the number of rows you want.

var mtx3 = new Matrix([0,1,2,0,1,2,0,1,2] ,  3  )
//                           array         rows
//if the array isn't long enought to have x rows it'll will throw an error

3- placeholder matrix The last way to create a matrix is by creating a void matrix.

var mtx4 = new Matrix(rows, columns,?placeholder)

by default the value of each cell will be undefined but if you specify the placeholder you can set a comon value

Methods and more cool stuff

.tableLog()

To log the value of the matrix in a table shape you can use the .tableLog() method

mtx2.tableLog();

┌─────────┬───┬───┬───┬────────┐
│ (index) │ 0 │ 1 │ 2 │ Values │
├─────────┼───┼───┼───┼────────┤
│    0    │ 0 │ 1 │ 2 │        │
│    1    │ 0 │ 1 │ 2 │        │
│    2    │ 0 │ 1 │ 2 │        │
└─────────┴───┴───┴───┴────────┘

It's the same as using the console.table() command

console.table(mtx2)

.sum() .mult() and .pow()

DOCS ARE WIP but i'm sure you can guess what sum and those methods do