trainorpj / matrix-magic Goto Github PK

Code should not have TODO in the comments. Any appearance of TODO should be removed and then turned into an issue.

I'd like to have basic, illustrative examples in the documentation for each function. I would like each entry in the docs to look like:

getMiddleCols(matrix)

[Whatever the description of getMiddleCols is]

Example:

getMiddleCols()

[[*, 1, 2, 3, *],          [[1, 2, 3],
 [*, 4, 5, 6, *],    -->    [4, 5, 6],
 [*, 7, 8, 9, *]]           [7, 8, 9]]

If you're going to contribute, please only do one at a time. This would go a long way, and it might make a good first contribution 😃

There are all these handy-dandy utilities that would work as methods in a Matrix class, so that one could do Matrix.getDiagonals() instead of passing function arguments around.

I'm not sure how to go about doing this (other than making a very basic class), but it would be cool if it could work with other matrix-based libraries (if they have classes).