Skip to content

Commit c6c8e5a

Browse files
authored
Apply suggestions from code review
Co-authored-by: Athan <kgryte@gmail.com> Signed-off-by: Athan <kgryte@gmail.com>
1 parent 7c0242f commit c6c8e5a

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

  • lib/node_modules/@stdlib/blas/ext/base/dindex-of-row

lib/node_modules/@stdlib/blas/ext/base/dindex-of-row/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,10 +72,10 @@ The function has the following parameters:
7272
- **LDA**: stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`).
7373
- **x**: search vector stored as a [`Float64Array`][mdn-float64array].
7474
- **strideX**: stride length of `x`.
75-
- **workspace**: workspace array stored as a [`Uint8Array`][mdn-uint8array] for tracking row match candidates.
75+
- **workspace**: workspace array stored as a [`Uint8Array`][mdn-uint8array] for tracking row match candidates. This parameter is ignored if the function is provided an input matrix stored in row-major order.
7676
- **strideW**: stride length of `workspace`.
7777

78-
If the matrix is stored in a row-major order, the `workspace` is not accessed.
78+
When an input matrix is stored in row-major order, the workspace parameter is ignored, and, thus, one may provide an empty workspace array.
7979

8080
```javascript
8181
var Float64Array = require( '@stdlib/array/float64' );
@@ -176,11 +176,11 @@ The function has the following parameters:
176176
- **x**: search vector stored as a [`Float64Array`][mdn-float64array].
177177
- **strideX**: stride length of `x`.
178178
- **offsetX**: starting index for `x`.
179-
- **workspace**: workspace array stored as a [`Uint8Array`][mdn-uint8array] for tracking row match candidates.
179+
- **workspace**: workspace array stored as a [`Uint8Array`][mdn-uint8array] for tracking row match candidates. This parameter is ignored if the function is provided an input matrix stored in row-major order.
180180
- **strideW**: stride length of `workspace`.
181181
- **offsetW**: starting index for `workspace`.
182182

183-
If the matrix is stored in a row-major order, the `workspace` is not accessed.
183+
When an input matrix is stored in row-major order, the workspace parameter is ignored, and, thus, one may provide an empty workspace array.
184184

185185
```javascript
186186
var Float64Array = require( '@stdlib/array/float64' );

0 commit comments

Comments
 (0)