Skip to content

Commit de804e5

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

1 file changed

Lines changed: 4 additions & 5 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 & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,6 @@ var out = dindexOfRow.ndarray( 3, 2, A, 2, 1, 0, x, 1, 0, workspace, 1, 0 );
205205
## Notes
206206

207207
- When searching for a matching row, the function checks for equality using the strict equality operator `===`. As a consequence, `NaN` values are considered distinct, and `-0` and `+0` are considered the same.
208-
- The `workspace` array is only accessed if the matrix is stored in column-major order. If the matrix is stored in row-major order, the `workspace` is not accessed.
209208

210209
</section>
211210

@@ -303,10 +302,10 @@ The function accepts the following arguments:
303302
- **LDA**: `[in] CBLAS_INT` stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`).
304303
- **X**: `[in] double*` search vector.
305304
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
306-
- **workspace**: `[inout] uint8_t*` workspace array for tracking row match candidates.
305+
- **workspace**: `[inout] uint8_t*` workspace array for tracking row match candidates. This parameter is ignored if the function is provided an input matrix stored in row-major order.
307306
- **strideW**: `[in] CBLAS_INT` stride length for `workspace`.
308307
309-
If the matrix is stored in a row-major order, the `workspace` is not accessed.
308+
When an input matrix is stored in row-major order, the workspace parameter is ignored, and, thus, one may either provide an empty workspace array or a `NULL` pointer.
310309
311310
```c
312311
#include "stdlib/blas/base/shared.h"
@@ -352,11 +351,11 @@ The function accepts the following arguments:
352351
- **X**: `[in] double*` search vector.
353352
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
354353
- **offsetX**: `[in] CBLAS_INT` starting index for `X`.
355-
- **workspace**: `[inout] uint8_t*` workspace array for tracking row match candidates.
354+
- **workspace**: `[inout] uint8_t*` workspace array for tracking row match candidates. This parameter is ignored if the function is provided an input matrix stored in row-major order.
356355
- **strideW**: `[in] CBLAS_INT` stride length for `workspace`.
357356
- **offsetW**: `[in] CBLAS_INT` starting index for `workspace`.
358357

359-
If the matrix is stored in row-major order, the `workspace` is not accessed.
358+
When an input matrix is stored in row-major order, the workspace parameter is ignored, and, thus, one may either provide an empty workspace array or a `NULL` pointer.
360359

361360
```c
362361
const double A[] = { 1.0, 2.0, 3.0, 4.0, 0.0, 0.0 };

0 commit comments

Comments
 (0)