Skip to content

Commit fe3ba5d

Browse files
headlessNodeheadlessNode
committed
docs: apply review suggestions
1 parent 86f678d commit fe3ba5d

File tree

10 files changed

+29
-29
lines changed

10 files changed

+29
-29
lines changed

‎lib/node_modules/@stdlib/blas/ext/base/dsapxsumpw/README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ var dsapxsumpw = require( '@stdlib/blas/ext/base/dsapxsumpw' );
3838

3939
#### dsapxsumpw( N, alpha, x, strideX )
4040

41-
Adds a constant to each single-precision floating-point strided array element and computes the sum using pairwise summation with extended accumulation and returning an extended precision result.
41+
Adds a constant to each single-precision floating-point strided array element, computes the sum using pairwise summation with extended accumulation and returning an extended precision result.
4242

4343
```javascript
4444
var Float32Array = require( '@stdlib/array/float32' );
@@ -83,7 +83,7 @@ var v = dsapxsumpw( 4, 5.0, x1, 2 );
8383

8484
#### dsapxsumpw.ndarray( N, alpha, x, strideX, offsetX )
8585

86-
Adds a constant to each single-precision floating-point strided array element and computes the sum using pairwise summation with extended accumulation and alternative indexing semantics and returning an extended precision result.
86+
Adds a constant to each single-precision floating-point strided array element, computes the sum using pairwise summation with extended accumulation and alternative indexing semantics, and returning an extended precision result.
8787

8888
```javascript
8989
var Float32Array = require( '@stdlib/array/float32' );
@@ -175,7 +175,7 @@ console.log( v );
175175

176176
#### stdlib_strided_dsapxsumpw( N, alpha, \*X, strideX )
177177

178-
Adds a constant to each single-precision floating-point strided array element and computes the sum using pairwise summation with extended accumulation and returning an extended precision result.
178+
Adds a constant to each single-precision floating-point strided array element, computes the sum using pairwise summation with extended accumulation and returning an extended precision result.
179179

180180
```c
181181
const float x[] = { 1.0f, -2.0f, 2.0f };
@@ -197,7 +197,7 @@ double stdlib_strided_dsapxsumpw( const CBLAS_INT N, const float alpha, const fl
197197

198198
#### stdlib_strided_dsapxsumpw_ndarray( N, alpha, \*X, strideX, offsetX )
199199

200-
Adds a constant to each single-precision floating-point strided array element and computes the sum using pairwise summation with extended accumulation and alternative indexing semantics and returning an extended precision result.
200+
Adds a constant to each single-precision floating-point strided array element, computes the sum using pairwise summation with extended accumulation and alternative indexing semantics, and returning an extended precision result.
201201

202202
```c
203203
const float x[] = { 1.0f, -2.0f, 2.0f };

‎lib/node_modules/@stdlib/blas/ext/base/dsapxsumpw/docs/repl.txt‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
{{alias}}( N, alpha, x, strideX )
33
Adds a constant to each single-precision floating-point strided array
4-
element and computes the sum using pairwise summation with extended
4+
element, computes the sum using pairwise summation with extended
55
accumulation and returning an extended precision result.
66

77
The `N` and stride parameters determine which elements in
@@ -52,8 +52,8 @@
5252

5353
{{alias}}.ndarray( N, alpha, x, strideX, offsetX )
5454
Adds a constant to each single-precision floating-point strided array
55-
element and computes the sum using pairwise summation with extended
56-
accumulation and alternative indexing semantics and returning an extended
55+
element, computes the sum using pairwise summation with extended
56+
accumulation and alternative indexing semantics, and returning an extended
5757
precision result.
5858

5959
While typed array views mandate a view offset based on the underlying

‎lib/node_modules/@stdlib/blas/ext/base/dsapxsumpw/docs/types/index.d.ts‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@
2323
*/
2424
interface Routine {
2525
/**
26-
* Adds a constant to each single-precision floating-point strided array element and computes the sum using pairwise summation with extended accumulation and returning an extended precision result.
26+
* Adds a constant to each single-precision floating-point strided array element, computes the sum using pairwise summation with extended accumulation and returning an extended precision result.
2727
*
2828
* @param N - number of indexed elements
29-
* @param alpha - constant
29+
* @param alpha - scalar constant
3030
* @param x - input array
3131
* @param strideX - stride length
3232
* @returns sum
@@ -42,10 +42,10 @@ interface Routine {
4242
( N: number, alpha: number, x: Float32Array, strideX: number ): number;
4343

4444
/**
45-
* Adds a constant to each single-precision floating-point strided array element and computes the sum using extended accumulation and alternative indexing semantics and returning an extended precision result.
45+
* Adds a constant to each single-precision floating-point strided array element, computes the sum using extended accumulation and alternative indexing semantics, and returning an extended precision result.
4646
*
4747
* @param N - number of indexed elements
48-
* @param alpha - constant
48+
* @param alpha - scalar constant
4949
* @param x - input array
5050
* @param strideX - stride length
5151
* @param offsetX - starting index
@@ -63,10 +63,10 @@ interface Routine {
6363
}
6464

6565
/**
66-
* Adds a constant to each single-precision floating-point strided array element and computes the sum using pairwise summation with extended accumulation and returning an extended precision result.
66+
* Adds a constant to each single-precision floating-point strided array element, computes the sum using pairwise summation with extended accumulation and returning an extended precision result.
6767
*
6868
* @param N - number of indexed elements
69-
* @param alpha - constant
69+
* @param alpha - scalar constant
7070
* @param x - input array
7171
* @param strideX - stride length
7272
* @returns sum

‎lib/node_modules/@stdlib/blas/ext/base/dsapxsumpw/include/stdlib/blas/ext/base/dsapxsumpw.h‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ extern "C" {
2929
#endif
3030

3131
/**
32-
* Adds a scalar constant to each single-precision floating-point strided array element and computes the sum using pairwise summation with extended accumulation and returning an extended precision result.
32+
* Adds a scalar constant to each single-precision floating-point strided array element, computes the sum using pairwise summation with extended accumulation and returning an extended precision result.
3333
*/
3434
double API_SUFFIX(stdlib_strided_dsapxsumpw)( const CBLAS_INT N, const float alpha, const float *X, const CBLAS_INT strideX );
3535

3636
/**
37-
* Adds a scalar constant to each single-precision floating-point strided array element and computes the sum using pairwise summation with extended accumulation and alternative indexing semantics and returning an extended precision result.
37+
* Adds a scalar constant to each single-precision floating-point strided array element, computes the sum using pairwise summation with extended accumulation and alternative indexing semantics, and returning an extended precision result.
3838
*/
3939
double API_SUFFIX(stdlib_strided_dsapxsumpw_ndarray)( const CBLAS_INT N, const float alpha, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX );
4040

‎lib/node_modules/@stdlib/blas/ext/base/dsapxsumpw/lib/dsapxsumpw.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ var ndarray = require( './ndarray.js' );
2727
// MAIN //
2828

2929
/**
30-
* Adds a constant to each single-precision floating-point strided array element and computes the sum using pairwise summation with extended accumulation and returning an extended precision result.
30+
* Adds a constant to each single-precision floating-point strided array element, computes the sum using pairwise summation with extended accumulation and returning an extended precision result.
3131
*
3232
* ## Method
3333
*
@@ -38,7 +38,7 @@ var ndarray = require( './ndarray.js' );
3838
* - Higham, Nicholas J. 1993. "The Accuracy of Floating Point Summation." _SIAM Journal on Scientific Computing_ 14 (4): 783–99. doi:[10.1137/0914050](https://doi.org/10.1137/0914050).
3939
*
4040
* @param {PositiveInteger} N - number of indexed elements
41-
* @param {number} alpha - constant
41+
* @param {number} alpha - scalar constant
4242
* @param {Float32Array} x - input array
4343
* @param {integer} strideX - stride length
4444
* @returns {number} sum

‎lib/node_modules/@stdlib/blas/ext/base/dsapxsumpw/lib/dsapxsumpw.native.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ var addon = require( './../src/addon.node' );
2626
// MAIN //
2727

2828
/**
29-
* Adds a constant to each single-precision floating-point strided array element and computes the sum using pairwise summation with extended accumulation and returning an extended precision result.
29+
* Adds a constant to each single-precision floating-point strided array element, computes the sum using pairwise summation with extended accumulation and returning an extended precision result.
3030
*
3131
* @param {PositiveInteger} N - number of indexed elements
32-
* @param {number} alpha - constant
32+
* @param {number} alpha - scalar constant
3333
* @param {Float32Array} x - input array
3434
* @param {integer} strideX - stride length
3535
* @returns {number} sum

‎lib/node_modules/@stdlib/blas/ext/base/dsapxsumpw/lib/index.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
'use strict';
2020

2121
/**
22-
* Add a constant to each single-precision floating-point strided array element and compute the sum using pairwise summation with extended accumulation and returning an extended precision result.
22+
* Add a constant to each single-precision floating-point strided array element, compute the sum using pairwise summation with extended accumulation and returning an extended precision result.
2323
*
2424
* @module @stdlib/blas/ext/base/dsapxsumpw
2525
*

‎lib/node_modules/@stdlib/blas/ext/base/dsapxsumpw/lib/ndarray.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var BLOCKSIZE = 128;
3232
// MAIN //
3333

3434
/**
35-
* Adds a constant to each single-precision floating-point strided array element and computes the sum using pairwise summation with extended accumulation and returning an extended precision result.
35+
* Adds a constant to each single-precision floating-point strided array element, computes the sum using pairwise summation with extended accumulation and returning an extended precision result.
3636
*
3737
* ## Method
3838
*
@@ -43,7 +43,7 @@ var BLOCKSIZE = 128;
4343
* - Higham, Nicholas J. 1993. "The Accuracy of Floating Point Summation." _SIAM Journal on Scientific Computing_ 14 (4): 783–99. doi:[10.1137/0914050](https://doi.org/10.1137/0914050).
4444
*
4545
* @param {PositiveInteger} N - number of indexed elements
46-
* @param {number} alpha - constant
46+
* @param {number} alpha - scalar constant
4747
* @param {Float32Array} x - input array
4848
* @param {integer} strideX - stride length
4949
* @param {NonNegativeInteger} offsetX - starting index

‎lib/node_modules/@stdlib/blas/ext/base/dsapxsumpw/lib/ndarray.native.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ var addon = require( './../src/addon.node' );
2626
// MAIN //
2727

2828
/**
29-
* Adds a constant to each single-precision floating-point strided array element and computes the sum using pairwise summation with extended accumulation and returning an extended precision result.
29+
* Adds a constant to each single-precision floating-point strided array element, computes the sum using pairwise summation with extended accumulation and returning an extended precision result.
3030
*
3131
* @param {PositiveInteger} N - number of indexed elements
32-
* @param {number} alpha - constant
32+
* @param {number} alpha - scalar constant
3333
* @param {Float32Array} x - input array
3434
* @param {integer} strideX - stride length
3535
* @param {NonNegativeInteger} offsetX - starting index

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
#include "stdlib/strided/base/stride2offset.h"
2222

2323
/**
24-
* Adds a constant to each single-precision floating-point strided array element and computes the sum using pairwise summation with extended accumulation and returning an extended precision result.
24+
* Adds a constant to each single-precision floating-point strided array element, computes the sum using pairwise summation with extended accumulation and returning an extended precision result.
2525
*
2626
* ## Method
2727
*
@@ -32,7 +32,7 @@
3232
* - Higham, Nicholas J. 1993. "The Accuracy of Floating Point Summation." _SIAM Journal on Scientific Computing_ 14 (4): 783–99. doi:[10.1137/0914050](https://doi.org/10.1137/0914050).
3333
*
3434
* @param N number of indexed elements
35-
* @param alpha constant
35+
* @param alpha scalar constant
3636
* @param X input array
3737
* @param strideX stride length
3838
* @return output value
@@ -43,7 +43,7 @@ double API_SUFFIX(stdlib_strided_dsapxsumpw)( const CBLAS_INT N, const float alp
4343
}
4444

4545
/**
46-
* Adds a constant to each single-precision floating-point strided array element and computes the sum using pairwise summation with extended accumulation and using alternative indexing semantics and returning an extended precision result.
46+
* Adds a constant to each single-precision floating-point strided array element, computes the sum using pairwise summation with extended accumulation and using alternative indexing semantics, and returning an extended precision result.
4747
*
4848
* ## Method
4949
*
@@ -54,18 +54,18 @@ double API_SUFFIX(stdlib_strided_dsapxsumpw)( const CBLAS_INT N, const float alp
5454
* - Higham, Nicholas J. 1993. "The Accuracy of Floating Point Summation." _SIAM Journal on Scientific Computing_ 14 (4): 783–99. doi:[10.1137/0914050](https://doi.org/10.1137/0914050).
5555
*
5656
* @param N number of indexed elements
57-
* @param alpha constant
57+
* @param alpha scalar constant
5858
* @param X input array
5959
* @param strideX stride length
6060
* @param offsetX starting index
6161
* @return output value
6262
*/
6363
double API_SUFFIX(stdlib_strided_dsapxsumpw_ndarray)( const CBLAS_INT N, const float alpha, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ) {
64-
double sum;
6564
CBLAS_INT ix;
6665
CBLAS_INT M;
6766
CBLAS_INT n;
6867
CBLAS_INT i;
68+
double sum;
6969
double s0;
7070
double s1;
7171
double s2;

0 commit comments

Comments
 (0)