Skip to content

Commit 2ad0b70

Browse files
authored
docs: document empty-matrix return value
PR-URL: #13396 Reviewed-by: Athan Reines <kgryte@gmail.com>
1 parent ec14192 commit 2ad0b70

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

  • lib/node_modules/@stdlib/lapack/base/iladlr/lib

‎lib/node_modules/@stdlib/lapack/base/iladlr/lib/iladlr.js‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,10 @@ var base = require( './base.js' );
3333
/**
3434
* Returns the index of the last non-zero row in a matrix `A`.
3535
*
36+
* ## Notes
37+
*
38+
* - If provided an empty matrix or a matrix containing only zeros, the function returns `-1` (i.e., an invalid index).
39+
*
3640
* @param {string} order - storage layout
3741
* @param {PositiveInteger} M - number of rows in `A`
3842
* @param {PositiveInteger} N - number of columns in `A`

0 commit comments

Comments
 (0)