Skip to content

Commit dfb30a7

Browse files
committed
docs: update function param description
1 parent 1f27ffe commit dfb30a7

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

lib/node_modules/@stdlib/blas/ext/base/dnannsumkbn2/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ The function accepts the following arguments:
207207
- **N**: `[in] CBLAS_INT` number of indexed elements.
208208
- **X**: `[in] double*` input array.
209209
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
210-
- **n**: `[out] CBLAS_INT*` number of non-NaN elements.
210+
- **n**: `[out] CBLAS_INT*` pointer for storing the number of non-NaN elements.
211211
212212
```c
213213
double stdlib_strided_dnannsumkbn2( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, CBLAS_INT *n );
@@ -231,7 +231,7 @@ The function accepts the following arguments:
231231
- **X**: `[in] double*` input array.
232232
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
233233
- **offsetX**: `[in] CBLAS_INT` starting index for `X`.
234-
- **n**: `[out] CBLAS_INT*` number of non-NaN elements.
234+
- **n**: `[out] CBLAS_INT*` pointer for storing the number of non-NaN elements.
235235
236236
```c
237237
double stdlib_strided_dnannsumkbn2_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, CBLAS_INT *n );

lib/node_modules/@stdlib/blas/ext/base/dnannsumkbn2/src/main.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
* @param N number of indexed elements
3737
* @param X input array
3838
* @param strideX stride length
39-
* @param n number of non-NaN elements
39+
* @param n pointer for storing the number of non-NaN elements
4040
* @return output value
4141
*/
4242
double API_SUFFIX(stdlib_strided_dnannsumkbn2)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, CBLAS_INT *n ) {
@@ -59,7 +59,7 @@ double API_SUFFIX(stdlib_strided_dnannsumkbn2)( const CBLAS_INT N, const double
5959
* @param X input array
6060
* @param strideX stride length
6161
* @param offsetX starting index
62-
* @param n number of non-NaN elements
62+
* @param n pointer for storing the number of non-NaN elements
6363
* @return output value
6464
*/
6565
double API_SUFFIX(stdlib_strided_dnannsumkbn2_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, CBLAS_INT *n ) {

0 commit comments

Comments
 (0)