Skip to content

Commit

Permalink
fix: apply code review suggestion
Browse files Browse the repository at this point in the history
  • Loading branch information
headlessNode committed Oct 20, 2024
1 parent aa137ee commit 0da2404
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 13 deletions.
8 changes: 4 additions & 4 deletions lib/node_modules/@stdlib/blas/ext/base/dnannsumkbn/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,9 @@ The function has the following parameters:

- **N**: number of indexed elements.
- **x**: input [`Float64Array`][@stdlib/array/float64].
- **strideX**: index increment for `x`.
- **strideX**: stride length for `x`.
- **out**: output [`Float64Array`][@stdlib/array/float64] whose first element is the sum and whose second element is the number of non-NaN elements.
- **strideOut**: index increment for `out`.
- **strideOut**: stride length for `out`.

The `N` and stride parameters determine which elements are accessed at runtime. For example, to compute the sum of every other element in `x`,

Expand Down Expand Up @@ -206,7 +206,7 @@ The function accepts the following arguments:
- **N**: `[in] CBLAS_INT` number of indexed elements.
- **X**: `[in] double*` input array.
- **strideX**: `[in] CBLAS_INT` index increment for `X`.
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
- **n**: `[out] CBLAS_INT*` number of non-NaN elements.
```c
Expand All @@ -229,7 +229,7 @@ The function accepts the following arguments:
- **N**: `[in] CBLAS_INT` number of indexed elements.
- **X**: `[in] double*` input array.
- **strideX**: `[in] CBLAS_INT` index increment for `X`.
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
- **offsetX**: `[in] CBLAS_INT` starting index for `X`.
- **n**: `[out] CBLAS_INT*` number of non-NaN elements.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,13 @@
Input array.

strideX: integer
Index increment for `x`.
Stride length for `x`.

out: Float64Array
Output array.

strideOut: integer
Index increment for `out`.
Stride length for `out`.

Returns
-------
Expand Down Expand Up @@ -74,7 +74,7 @@
Input array.

strideX: integer
Index increment for `x`.
Stride length for `x`.

offsetX: integer
Starting index for `x`.
Expand All @@ -83,7 +83,7 @@
Output array.

strideOut: integer
Index increment for `out`.
Stride length for `out`.

offsetOut: integer
Starting index for `out`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,10 @@ var abs = require( '@stdlib/math/base/special/abs' );
*
* @param {PositiveInteger} N - number of indexed elements
* @param {Float64Array} x - input array
* @param {integer} strideX - `x` index increment
* @param {integer} strideX - `x` stride length
* @param {NonNegativeInteger} offsetX - `x` starting index
* @param {Float64Array} out - output array
* @param {integer} strideOut - `out` index increment
* @param {integer} strideOut - `out` stride length
* @param {NonNegativeInteger} offsetOut - `out` starting index
* @returns {Float64Array} output array
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ var addon = require( './../src/addon.node' );
*
* @param {PositiveInteger} N - number of indexed elements
* @param {Float64Array} x - input array
* @param {integer} strideX - `x` index increment
* @param {integer} strideX - `x` stride length
* @param {NonNegativeInteger} offsetX - `x` starting index
* @param {Float64Array} out - output array
* @param {integer} strideOut - `out` index increment
* @param {integer} strideOut - `out` stride length
* @param {NonNegativeInteger} offsetOut - `out` starting index
* @returns {Float64Array} output array
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ double API_SUFFIX(stdlib_strided_dnannsumkbn)( const CBLAS_INT N, const double *
*
* @param N number of indexed elements
* @param X input array
* @param strideX index increment
* @param strideX stride length
* @param offsetX starting index
* @param n number of non-NaN elements
* @return output value
Expand Down

0 comments on commit 0da2404

Please sign in to comment.