Skip to content
This repository has been archived by the owner on Sep 27, 2024. It is now read-only.

Commit

Permalink
docs: update README to reflect changes to matrices
Browse files Browse the repository at this point in the history
  • Loading branch information
lnsp committed Jun 10, 2017
1 parent badf7f5 commit 5e4b068
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,13 +87,16 @@ Operation | Description
`m.at(n)` | Access the n-th row of the matrix as a constant
`m.at(n, x)` | Access the element at row n and col x as a constant
`m * v` | Multiply matrix `m` with vector `v`
`m * a` | Multiply matrix `m` with matrix `a`
`m * s` | Multiply matrix `m` with scalar `s`
`-m` | Negate matrix `m`
`a + b` | Add the matrices
`a - b` | Subtract the matrices
`a.equal(b, e)` | Tests if the matrix `a` is equal to `b` with the accuary `e`
`a == b` | Tests if the matrix `a` is equal to `b`
`a != b` | Tests if the matrix `a` is not equal to `b`
`a.width()` | Get the number of matrix cols
`a.height()` | Get the number of matrix rows
`a.colCount()` | Get the number of matrix cols
`a.rowCount()` | Get the number of matrix rows
`a.to_string()` | Generate a string representation of the matrix

## What is planned?
Expand Down

0 comments on commit 5e4b068

Please sign in to comment.