You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: lib/node_modules/@stdlib/blas/ext/base/dindex-of-row/README.md
+4-5Lines changed: 4 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -205,7 +205,6 @@ var out = dindexOfRow.ndarray( 3, 2, A, 2, 1, 0, x, 1, 0, workspace, 1, 0 );
205
205
## Notes
206
206
207
207
- 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.
209
208
210
209
</section>
211
210
@@ -303,10 +302,10 @@ The function accepts the following arguments:
303
302
- **LDA**: `[in] CBLAS_INT` stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`).
304
303
- **X**: `[in] double*` search vector.
305
304
- **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.
307
306
- **strideW**: `[in] CBLAS_INT` stride length for `workspace`.
308
307
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.
310
309
311
310
```c
312
311
#include "stdlib/blas/base/shared.h"
@@ -352,11 +351,11 @@ The function accepts the following arguments:
352
351
-**X**: `[in] double*` search vector.
353
352
-**strideX**: `[in] CBLAS_INT` stride length for `X`.
354
353
-**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.
356
355
-**strideW**: `[in] CBLAS_INT` stride length for `workspace`.
357
356
-**offsetW**: `[in] CBLAS_INT` starting index for `workspace`.
358
357
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.
0 commit comments