Skip to content

Commit acae714

Browse files
committed
docs: correct return-condition wording in blas/ext/base/zindex-of-column
Replace `unable to find a search vector` with `unable to find a matching column` in the JSDoc and TypeScript declarations to match the README and the wording used by the analogous `dindex-of-column` package.
1 parent 72f24a8 commit acae714

3 files changed

Lines changed: 5 additions & 5 deletions

File tree

lib/node_modules/@stdlib/blas/ext/base/zindex-of-column/docs/types/index.d.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ interface Routine {
3232
*
3333
* ## Notes
3434
*
35-
* - If the function is provided an empty matrix or if the function is unable to find a search vector, the function returns `-1` (i.e., an invalid index).
35+
* - If the function is provided an empty matrix or if the function is unable to find a matching column, the function returns `-1` (i.e., an invalid index).
3636
* - The `workspace` array is only applicable when an input matrix is stored in row-major order. When the matrix is stored in column-major order, the workspace array is ignored.
3737
*
3838
* @param order - storage layout
@@ -64,7 +64,7 @@ interface Routine {
6464
*
6565
* ## Notes
6666
*
67-
* - If the function is provided an empty matrix or if the function is unable to find a search vector, the function returns `-1` (i.e., an invalid index).
67+
* - If the function is provided an empty matrix or if the function is unable to find a matching column, the function returns `-1` (i.e., an invalid index).
6868
* - The `workspace` array is only applicable when an input matrix is stored in row-major order. When the matrix is stored in column-major order, the workspace array is ignored.
6969
*
7070
* @param M - number of rows in `A`
@@ -100,7 +100,7 @@ interface Routine {
100100
*
101101
* ## Notes
102102
*
103-
* - If the function is provided an empty matrix or if the function is unable to find a search vector, the function returns `-1` (i.e., an invalid index).
103+
* - If the function is provided an empty matrix or if the function is unable to find a matching column, the function returns `-1` (i.e., an invalid index).
104104
* - The `workspace` array is only applicable when an input matrix is stored in row-major order. When the matrix is stored in column-major order, the workspace array is ignored.
105105
*
106106
* @param order - storage layout

lib/node_modules/@stdlib/blas/ext/base/zindex-of-column/lib/ndarray.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ var reinterpret = require( '@stdlib/strided/base/reinterpret-complex128' );
3333
*
3434
* ## Notes
3535
*
36-
* - If the function is provided an empty matrix or if the function is unable to find a search vector, the function returns `-1` (i.e., an invalid index).
36+
* - If the function is provided an empty matrix or if the function is unable to find a matching column, the function returns `-1` (i.e., an invalid index).
3737
* - The `workspace` array is only applicable when an input matrix is stored in row-major order. When the matrix is stored in column-major order, the workspace array is ignored.
3838
*
3939
* @param {PositiveInteger} M - number of rows in `A`

lib/node_modules/@stdlib/blas/ext/base/zindex-of-column/lib/zindex_of_column.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ var ndarray = require( './ndarray.js' );
3636
*
3737
* ## Notes
3838
*
39-
* - If the function is provided an empty matrix or if the function is unable to find a search vector, the function returns `-1` (i.e., an invalid index).
39+
* - If the function is provided an empty matrix or if the function is unable to find a matching column, the function returns `-1` (i.e., an invalid index).
4040
* - The `workspace` array is only applicable when an input matrix is stored in row-major order. When the matrix is stored in column-major order, the workspace array is ignored.
4141
*
4242
* @param {string} order - storage layout

0 commit comments

Comments
 (0)