@stdlib/blas-ext-base-gnansumkbn2 0.2.2 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/NOTICE CHANGED
@@ -1 +1 @@
1
- Copyright (c) 2016-2024 The Stdlib Authors.
1
+ Copyright (c) 2016-2026 The Stdlib Authors.
package/README.md CHANGED
@@ -59,15 +59,14 @@ npm install @stdlib/blas-ext-base-gnansumkbn2
59
59
  var gnansumkbn2 = require( '@stdlib/blas-ext-base-gnansumkbn2' );
60
60
  ```
61
61
 
62
- #### gnansumkbn2( N, x, stride )
62
+ #### gnansumkbn2( N, x, strideX )
63
63
 
64
64
  Computes the sum of strided array elements, ignoring `NaN` values and using a second-order iterative Kahan–Babuška algorithm.
65
65
 
66
66
  ```javascript
67
67
  var x = [ 1.0, -2.0, NaN, 2.0 ];
68
- var N = x.length;
69
68
 
70
- var v = gnansumkbn2( N, x, 1 );
69
+ var v = gnansumkbn2( x.length, x, 1 );
71
70
  // returns 1.0
72
71
  ```
73
72
 
@@ -75,17 +74,14 @@ The function has the following parameters:
75
74
 
76
75
  - **N**: number of indexed elements.
77
76
  - **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array].
78
- - **stride**: index increment for `x`.
77
+ - **strideX**: stride length for `x`.
79
78
 
80
- The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to compute the sum of every other element in `x`,
79
+ The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to compute the sum of every other element:
81
80
 
82
81
  ```javascript
83
- var floor = require( '@stdlib/math-base-special-floor' );
84
-
85
82
  var x = [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0, NaN, NaN ];
86
- var N = floor( x.length / 2 );
87
83
 
88
- var v = gnansumkbn2( N, x, 2 );
84
+ var v = gnansumkbn2( 5, x, 2 );
89
85
  // returns 5.0
90
86
  ```
91
87
 
@@ -95,42 +91,35 @@ Note that indexing is relative to the first index. To introduce an offset, use [
95
91
 
96
92
  ```javascript
97
93
  var Float64Array = require( '@stdlib/array-float64' );
98
- var floor = require( '@stdlib/math-base-special-floor' );
99
94
 
100
95
  var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
101
96
  var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
102
97
 
103
- var N = floor( x0.length / 2 );
104
-
105
- var v = gnansumkbn2( N, x1, 2 );
98
+ var v = gnansumkbn2( 4, x1, 2 );
106
99
  // returns 5.0
107
100
  ```
108
101
 
109
- #### gnansumkbn2.ndarray( N, x, stride, offset )
102
+ #### gnansumkbn2.ndarray( N, x, strideX, offsetX )
110
103
 
111
104
  Computes the sum of strided array elements, ignoring `NaN` values and using a second-order iterative Kahan–Babuška algorithm and alternative indexing semantics.
112
105
 
113
106
  ```javascript
114
107
  var x = [ 1.0, -2.0, NaN, 2.0 ];
115
- var N = x.length;
116
108
 
117
- var v = gnansumkbn2.ndarray( N, x, 1, 0 );
109
+ var v = gnansumkbn2.ndarray( x.length, x, 1, 0 );
118
110
  // returns 1.0
119
111
  ```
120
112
 
121
113
  The function has the following additional parameters:
122
114
 
123
- - **offset**: starting index for `x`.
115
+ - **offsetX**: starting index for `x`.
124
116
 
125
- While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the `offset` parameter supports indexing semantics based on a starting index. For example, to calculate the sum of every other value in `x` starting from the second value
117
+ While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to calculate the sum of every other element starting from the second element:
126
118
 
127
119
  ```javascript
128
- var floor = require( '@stdlib/math-base-special-floor' );
129
-
130
120
  var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ];
131
- var N = floor( x.length / 2 );
132
121
 
133
- var v = gnansumkbn2.ndarray( N, x, 2, 1 );
122
+ var v = gnansumkbn2.ndarray( 5, x, 2, 1 );
134
123
  // returns 5.0
135
124
  ```
136
125
 
@@ -143,6 +132,7 @@ var v = gnansumkbn2.ndarray( N, x, 2, 1 );
143
132
  ## Notes
144
133
 
145
134
  - If `N <= 0`, both functions return `0.0`.
135
+ - Both functions support array-like objects having getter and setter accessors for array element access (e.g., [`@stdlib/array-base/accessor`][@stdlib/array/base/accessor]).
146
136
  - Depending on the environment, the typed versions ([`dnansumkbn2`][@stdlib/blas/ext/base/dnansumkbn2], [`snansumkbn2`][@stdlib/blas/ext/base/snansumkbn2], etc.) are likely to be significantly more performant.
147
137
 
148
138
  </section>
@@ -156,22 +146,19 @@ var v = gnansumkbn2.ndarray( N, x, 2, 1 );
156
146
  <!-- eslint no-undef: "error" -->
157
147
 
158
148
  ```javascript
159
- var randu = require( '@stdlib/random-base-randu' );
160
- var round = require( '@stdlib/math-base-special-round' );
161
- var Float64Array = require( '@stdlib/array-float64' );
149
+ var bernoulli = require( '@stdlib/random-base-bernoulli' );
150
+ var discreteUniform = require( '@stdlib/random-base-discrete-uniform' );
151
+ var filledarrayBy = require( '@stdlib/array-filled-by' );
162
152
  var gnansumkbn2 = require( '@stdlib/blas-ext-base-gnansumkbn2' );
163
153
 
164
- var x;
165
- var i;
166
-
167
- x = new Float64Array( 10 );
168
- for ( i = 0; i < x.length; i++ ) {
169
- if ( randu() < 0.2 ) {
170
- x[ i ] = NaN;
171
- } else {
172
- x[ i ] = round( randu()*100.0 );
154
+ function rand() {
155
+ if ( bernoulli( 0.8 ) > 0 ) {
156
+ return discreteUniform( 0, 100 );
173
157
  }
158
+ return NaN;
174
159
  }
160
+
161
+ var x = filledarrayBy( 10, 'float64', rand );
175
162
  console.log( x );
176
163
 
177
164
  var v = gnansumkbn2( x.length, x, 1 );
@@ -240,7 +227,7 @@ See [LICENSE][stdlib-license].
240
227
 
241
228
  ## Copyright
242
229
 
243
- Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
230
+ Copyright &copy; 2016-2026. The Stdlib [Authors][stdlib-authors].
244
231
 
245
232
  </section>
246
233
 
@@ -253,8 +240,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
253
240
  [npm-image]: http://img.shields.io/npm/v/@stdlib/blas-ext-base-gnansumkbn2.svg
254
241
  [npm-url]: https://npmjs.org/package/@stdlib/blas-ext-base-gnansumkbn2
255
242
 
256
- [test-image]: https://github.com/stdlib-js/blas-ext-base-gnansumkbn2/actions/workflows/test.yml/badge.svg?branch=v0.2.2
257
- [test-url]: https://github.com/stdlib-js/blas-ext-base-gnansumkbn2/actions/workflows/test.yml?query=branch:v0.2.2
243
+ [test-image]: https://github.com/stdlib-js/blas-ext-base-gnansumkbn2/actions/workflows/test.yml/badge.svg?branch=v0.3.0
244
+ [test-url]: https://github.com/stdlib-js/blas-ext-base-gnansumkbn2/actions/workflows/test.yml?query=branch:v0.3.0
258
245
 
259
246
  [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/blas-ext-base-gnansumkbn2/main.svg
260
247
  [coverage-url]: https://codecov.io/github/stdlib-js/blas-ext-base-gnansumkbn2?branch=main
@@ -266,8 +253,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
266
253
 
267
254
  -->
268
255
 
269
- [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
270
- [chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
256
+ [chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
257
+ [chat-url]: https://stdlib.zulipchat.com
271
258
 
272
259
  [stdlib]: https://github.com/stdlib-js/stdlib
273
260
 
@@ -290,6 +277,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
290
277
 
291
278
  [mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
292
279
 
280
+ [@stdlib/array/base/accessor]: https://www.npmjs.com/package/@stdlib/array-base-accessor
281
+
293
282
  [@klein:2005a]: https://doi.org/10.1007/s00607-005-0139-x
294
283
 
295
284
  <!-- <related-links> -->
package/dist/index.js CHANGED
@@ -1,7 +1,10 @@
1
- "use strict";var b=function(s,e){return function(){return e||s((e={exports:{}}).exports,e),e.exports}};var g=b(function(B,y){
2
- var p=require('@stdlib/math-base-assert-is-nan/dist'),q=require('@stdlib/math-base-special-abs/dist');function h(s,e,l){var i,v,f,n,u,c,r,a,t;if(s<=0)return 0;if(s===1||l===0)return p(e[0])?0:e[0];for(l<0?f=(1-s)*l:f=0,i=0,v=0,n=0,t=0;t<s;t++)c=e[f],p(c)===!1&&(r=i+c,q(i)>=q(c)?a=i-r+c:a=c-r+i,i=r,r=n+a,q(n)>=q(a)?u=n-r+a:u=a-r+n,n=r,v+=u),f+=l;return i+n+v}y.exports=h
3
- });var O=b(function(C,x){
4
- var k=require('@stdlib/math-base-assert-is-nan/dist'),m=require('@stdlib/math-base-special-abs/dist');function j(s,e,l,i){var v,f,n,u,c,r,a,t,o;if(s<=0)return 0;if(s===1||l===0)return k(e[i])?0:e[i];for(n=i,v=0,f=0,u=0,o=0;o<s;o++)r=e[n],k(r)===!1&&(a=v+r,m(v)>=m(r)?t=v-a+r:t=r-a+v,v=a,a=u+t,m(u)>=m(t)?c=u-a+t:c=t-a+u,u=a,f+=c),n+=l;return v+u+f}x.exports=j
5
- });var w=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),R=g(),z=O();w(R,"ndarray",z);module.exports=R;
1
+ "use strict";var g=function(i,r){return function(){return r||i((r={exports:{}}).exports,r),r.exports}};var d=g(function(I,x){
2
+ var p=require('@stdlib/math-base-assert-is-nan/dist'),b=require('@stdlib/math-base-special-abs/dist');function w(i,r,o,l){var v,q,e,u,t,c,a,s,n,f,y;if(v=r.data,q=r.accessors[0],a=l,o===0)return p(q(v,a))?0:i*q(v,a);for(e=0,u=0,t=0,y=0;y<i;y++)s=q(v,a),p(s)===!1&&(n=e+s,b(e)>=b(s)?f=e-n+s:f=s-n+e,e=n,n=t+f,b(t)>=b(f)?c=t-n+f:c=f-n+t,t=n,u+=c),a+=o;return e+t+u}x.exports=w
3
+ });var k=g(function(J,O){
4
+ var z=require('@stdlib/array-base-arraylike2object/dist'),j=require('@stdlib/math-base-assert-is-nan/dist'),m=require('@stdlib/math-base-special-abs/dist'),A=d();function B(i,r,o,l){var v,q,e,u,t,c,a,s,n,f;if(i<=0)return 0;if(n=z(r),n.accessorProtocol)return A(i,n,o,l);if(e=l,o===0)return j(r[e])?0:i*r[e];for(v=0,q=0,u=0,f=0;f<i;f++)c=r[e],j(c)===!1&&(a=v+c,m(v)>=m(c)?s=v-a+c:s=c-a+v,v=a,a=u+s,m(u)>=m(s)?t=u-a+s:t=s-a+u,u=a,q+=t),e+=o;return v+u+q}O.exports=B
5
+ });var R=g(function(K,P){
6
+ var C=require('@stdlib/strided-base-stride2offset/dist'),D=k();function E(i,r,o){return D(i,r,o,C(i,o))}P.exports=E
7
+ });var F=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),h=R(),G=k();F(h,"ndarray",G);module.exports=h;
8
+ /** @license Apache-2.0 */
6
9
  /** @license Apache-2.0 */
7
10
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "version": 3,
3
- "sources": ["../lib/main.js", "../lib/ndarray.js", "../lib/index.js"],
4
- "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2020 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar abs = require( '@stdlib/math-base-special-abs' );\n\n\n// MAIN //\n\n/**\n* Computes the sum of strided array elements, ignoring `NaN` values and using a second-order iterative Kahan\u2013Babu\u0161ka algorithm.\n*\n* ## Method\n*\n* - This implementation uses a second-order iterative Kahan\u2013Babu\u0161ka algorithm, as described by Klein (2005).\n*\n* ## References\n*\n* - Klein, Andreas. 2005. \"A Generalized Kahan-Babu\u0161ka-Summation-Algorithm.\" _Computing_ 76 (3): 279\u201393. doi:[10.1007/s00607-005-0139-x](https://doi.org/10.1007/s00607-005-0139-x).\n*\n* @param {PositiveInteger} N - number of indexed elements\n* @param {NumericArray} x - input array\n* @param {integer} stride - stride length\n* @returns {number} sum\n*\n* @example\n* var x = [ 1.0, -2.0, NaN, 2.0 ];\n* var N = x.length;\n*\n* var v = gnansumkbn2( N, x, 1 );\n* // returns 1.0\n*/\nfunction gnansumkbn2( N, x, stride ) {\n\tvar sum;\n\tvar ccs;\n\tvar ix;\n\tvar cs;\n\tvar cc;\n\tvar v;\n\tvar t;\n\tvar c;\n\tvar i;\n\n\tif ( N <= 0 ) {\n\t\treturn 0.0;\n\t}\n\tif ( N === 1 || stride === 0 ) {\n\t\tif ( isnan( x[ 0 ] ) ) {\n\t\t\treturn 0.0;\n\t\t}\n\t\treturn x[ 0 ];\n\t}\n\tif ( stride < 0 ) {\n\t\tix = (1-N) * stride;\n\t} else {\n\t\tix = 0;\n\t}\n\tsum = 0.0;\n\tccs = 0.0; // second order correction term for lost low order bits\n\tcs = 0.0; // first order correction term for lost low order bits\n\tfor ( i = 0; i < N; i++ ) {\n\t\tv = x[ ix ];\n\t\tif ( isnan( v ) === false ) {\n\t\t\tt = sum + v;\n\t\t\tif ( abs( sum ) >= abs( v ) ) {\n\t\t\t\tc = (sum-t) + v;\n\t\t\t} else {\n\t\t\t\tc = (v-t) + sum;\n\t\t\t}\n\t\t\tsum = t;\n\t\t\tt = cs + c;\n\t\t\tif ( abs( cs ) >= abs( c ) ) {\n\t\t\t\tcc = (cs-t) + c;\n\t\t\t} else {\n\t\t\t\tcc = (c-t) + cs;\n\t\t\t}\n\t\t\tcs = t;\n\t\t\tccs += cc;\n\t\t}\n\t\tix += stride;\n\t}\n\treturn sum + cs + ccs;\n}\n\n\n// EXPORTS //\n\nmodule.exports = gnansumkbn2;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2020 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar abs = require( '@stdlib/math-base-special-abs' );\n\n\n// MAIN //\n\n/**\n* Computes the sum of strided array elements, ignoring `NaN` values and using a second-order iterative Kahan\u2013Babu\u0161ka algorithm.\n*\n* ## Method\n*\n* - This implementation uses a second-order iterative Kahan\u2013Babu\u0161ka algorithm, as described by Klein (2005).\n*\n* ## References\n*\n* - Klein, Andreas. 2005. \"A Generalized Kahan-Babu\u0161ka-Summation-Algorithm.\" _Computing_ 76 (3): 279\u201393. doi:[10.1007/s00607-005-0139-x](https://doi.org/10.1007/s00607-005-0139-x).\n*\n* @param {PositiveInteger} N - number of indexed elements\n* @param {NumericArray} x - input array\n* @param {integer} stride - stride length\n* @param {NonNegativeInteger} offset - starting index\n* @returns {number} sum\n*\n* @example\n* var floor = require( '@stdlib/math-base-special-floor' );\n*\n* var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ];\n* var N = floor( x.length / 2 );\n*\n* var v = gnansumkbn2( N, x, 2, 1 );\n* // returns 5.0\n*/\nfunction gnansumkbn2( N, x, stride, offset ) {\n\tvar sum;\n\tvar ccs;\n\tvar ix;\n\tvar cs;\n\tvar cc;\n\tvar v;\n\tvar t;\n\tvar c;\n\tvar i;\n\n\tif ( N <= 0 ) {\n\t\treturn 0.0;\n\t}\n\tif ( N === 1 || stride === 0 ) {\n\t\tif ( isnan( x[ offset ] ) ) {\n\t\t\treturn 0.0;\n\t\t}\n\t\treturn x[ offset ];\n\t}\n\tix = offset;\n\tsum = 0.0;\n\tccs = 0.0; // second order correction term for lost low order bits\n\tcs = 0.0; // first order correction term for lost low order bits\n\tfor ( i = 0; i < N; i++ ) {\n\t\tv = x[ ix ];\n\t\tif ( isnan( v ) === false ) {\n\t\t\tt = sum + v;\n\t\t\tif ( abs( sum ) >= abs( v ) ) {\n\t\t\t\tc = (sum-t) + v;\n\t\t\t} else {\n\t\t\t\tc = (v-t) + sum;\n\t\t\t}\n\t\t\tsum = t;\n\t\t\tt = cs + c;\n\t\t\tif ( abs( cs ) >= abs( c ) ) {\n\t\t\t\tcc = (cs-t) + c;\n\t\t\t} else {\n\t\t\t\tcc = (c-t) + cs;\n\t\t\t}\n\t\t\tcs = t;\n\t\t\tccs += cc;\n\t\t}\n\t\tix += stride;\n\t}\n\treturn sum + cs + ccs;\n}\n\n\n// EXPORTS //\n\nmodule.exports = gnansumkbn2;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2020 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Compute the sum of strided array elements, ignoring `NaN` values and using a second-order iterative Kahan\u2013Babu\u0161ka algorithm.\n*\n* @module @stdlib/blas-ext-base-gnansumkbn2\n*\n* @example\n* var gnansumkbn2 = require( '@stdlib/blas-ext-base-gnansumkbn2' );\n*\n* var x = [ 1.0, -2.0, NaN, 2.0 ];\n* var N = x.length;\n*\n* var v = gnansumkbn2( N, x, 1 );\n* // returns 1.0\n*\n* @example\n* var floor = require( '@stdlib/math-base-special-floor' );\n* var gnansumkbn2 = require( '@stdlib/blas-ext-base-gnansumkbn2' );\n*\n* var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ];\n* var N = floor( x.length / 2 );\n*\n* var v = gnansumkbn2.ndarray( N, x, 2, 1 );\n* // returns 5.0\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar ndarray = require( './ndarray.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'ndarray', ndarray );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
5
- "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAQ,QAAS,iCAAkC,EACnDC,EAAM,QAAS,+BAAgC,EA4BnD,SAASC,EAAaC,EAAGC,EAAGC,EAAS,CACpC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,GAAKX,GAAK,EACT,MAAO,GAER,GAAKA,IAAM,GAAKE,IAAW,EAC1B,OAAKL,EAAOI,EAAG,CAAE,CAAE,EACX,EAEDA,EAAG,CAAE,EAUb,IARKC,EAAS,EACbG,GAAM,EAAEL,GAAKE,EAEbG,EAAK,EAENF,EAAM,EACNC,EAAM,EACNE,EAAK,EACCK,EAAI,EAAGA,EAAIX,EAAGW,IACnBH,EAAIP,EAAGI,CAAG,EACLR,EAAOW,CAAE,IAAM,KACnBC,EAAIN,EAAMK,EACLV,EAAKK,CAAI,GAAKL,EAAKU,CAAE,EACzBE,EAAKP,EAAIM,EAAKD,EAEdE,EAAKF,EAAEC,EAAKN,EAEbA,EAAMM,EACNA,EAAIH,EAAKI,EACJZ,EAAKQ,CAAG,GAAKR,EAAKY,CAAE,EACxBH,EAAMD,EAAGG,EAAKC,EAEdH,EAAMG,EAAED,EAAKH,EAEdA,EAAKG,EACLL,GAAOG,GAERF,GAAMH,EAEP,OAAOC,EAAMG,EAAKF,CACnB,CAKAR,EAAO,QAAUG,IC1GjB,IAAAa,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAQ,QAAS,iCAAkC,EACnDC,EAAM,QAAS,+BAAgC,EA+BnD,SAASC,EAAaC,EAAGC,EAAGC,EAAQC,EAAS,CAC5C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,GAAKZ,GAAK,EACT,MAAO,GAER,GAAKA,IAAM,GAAKE,IAAW,EAC1B,OAAKL,EAAOI,EAAGE,CAAO,CAAE,EAChB,EAEDF,EAAGE,CAAO,EAMlB,IAJAG,EAAKH,EACLC,EAAM,EACNC,EAAM,EACNE,EAAK,EACCK,EAAI,EAAGA,EAAIZ,EAAGY,IACnBH,EAAIR,EAAGK,CAAG,EACLT,EAAOY,CAAE,IAAM,KACnBC,EAAIN,EAAMK,EACLX,EAAKM,CAAI,GAAKN,EAAKW,CAAE,EACzBE,EAAKP,EAAIM,EAAKD,EAEdE,EAAKF,EAAEC,EAAKN,EAEbA,EAAMM,EACNA,EAAIH,EAAKI,EACJb,EAAKS,CAAG,GAAKT,EAAKa,CAAE,EACxBH,EAAMD,EAAGG,EAAKC,EAEdH,EAAMG,EAAED,EAAKH,EAEdA,EAAKG,EACLL,GAAOG,GAERF,GAAMJ,EAEP,OAAOE,EAAMG,EAAKF,CACnB,CAKAT,EAAO,QAAUG,IC1DjB,IAAIc,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD",
6
- "names": ["require_main", "__commonJSMin", "exports", "module", "isnan", "abs", "gnansumkbn2", "N", "x", "stride", "sum", "ccs", "ix", "cs", "cc", "v", "t", "c", "i", "require_ndarray", "__commonJSMin", "exports", "module", "isnan", "abs", "gnansumkbn2", "N", "x", "stride", "offset", "sum", "ccs", "ix", "cs", "cc", "v", "t", "c", "i", "setReadOnly", "main", "ndarray"]
3
+ "sources": ["../lib/accessors.js", "../lib/ndarray.js", "../lib/main.js", "../lib/index.js"],
4
+ "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2025 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar abs = require( '@stdlib/math-base-special-abs' );\n\n\n// MAIN //\n\n/**\n* Computes the sum of strided array elements, ignoring `NaN` values and using a second-order iterative Kahan\u2013Babu\u0161ka algorithm.\n*\n* ## Method\n*\n* - This implementation uses a second-order iterative Kahan\u2013Babu\u0161ka algorithm, as described by Klein (2005).\n*\n* ## References\n*\n* - Klein, Andreas. 2005. \"A Generalized Kahan-Babu\u0161ka-Summation-Algorithm.\" _Computing_ 76 (3): 279\u201393. doi:[10.1007/s00607-005-0139-x](https://doi.org/10.1007/s00607-005-0139-x).\n*\n* @private\n* @param {PositiveInteger} N - number of indexed elements\n* @param {Object} x - input array object\n* @param {Collection} x.data - input array data\n* @param {Array<Function>} x.accessors - array element accessors\n* @param {integer} strideX - stride length for `x`\n* @param {NonNegativeInteger} offsetX - starting index for `x`\n* @returns {number} sum\n*\n* @example\n* var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' );\n* var arraylike2object = require( '@stdlib/array-base-arraylike2object' );\n*\n* var x = toAccessorArray( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );\n*\n* var v = gnansumkbn2( 4, arraylike2object( x ), 2, 1 );\n* // returns 5.0\n*/\nfunction gnansumkbn2( N, x, strideX, offsetX ) {\n\tvar xbuf;\n\tvar xget;\n\tvar sum;\n\tvar ccs;\n\tvar cs;\n\tvar cc;\n\tvar ix;\n\tvar v;\n\tvar t;\n\tvar c;\n\tvar i;\n\n\t// Cache reference to array data:\n\txbuf = x.data;\n\n\t// Cache reference to the element accessors:\n\txget = x.accessors[ 0 ];\n\n\tix = offsetX;\n\tif ( strideX === 0 ) {\n\t\tif ( isnan( xget( xbuf, ix ) ) ) {\n\t\t\treturn 0.0;\n\t\t}\n\t\treturn N * xget( xbuf, ix );\n\t}\n\tsum = 0.0;\n\tccs = 0.0; // second order correction term for lost low order bits\n\tcs = 0.0; // first order correction term for lost low order bits\n\tfor ( i = 0; i < N; i++ ) {\n\t\tv = xget( xbuf, ix );\n\t\tif ( isnan( v ) === false ) {\n\t\t\tt = sum + v;\n\t\t\tif ( abs( sum ) >= abs( v ) ) {\n\t\t\t\tc = (sum-t) + v;\n\t\t\t} else {\n\t\t\t\tc = (v-t) + sum;\n\t\t\t}\n\t\t\tsum = t;\n\t\t\tt = cs + c;\n\t\t\tif ( abs( cs ) >= abs( c ) ) {\n\t\t\t\tcc = (cs-t) + c;\n\t\t\t} else {\n\t\t\t\tcc = (c-t) + cs;\n\t\t\t}\n\t\t\tcs = t;\n\t\t\tccs += cc;\n\t\t}\n\t\tix += strideX;\n\t}\n\treturn sum + cs + ccs;\n}\n\n\n// EXPORTS //\n\nmodule.exports = gnansumkbn2;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2020 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar arraylike2object = require( '@stdlib/array-base-arraylike2object' );\nvar isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar abs = require( '@stdlib/math-base-special-abs' );\nvar accessors = require( './accessors.js' );\n\n\n// MAIN //\n\n/**\n* Computes the sum of strided array elements, ignoring `NaN` values and using a second-order iterative Kahan\u2013Babu\u0161ka algorithm.\n*\n* ## Method\n*\n* - This implementation uses a second-order iterative Kahan\u2013Babu\u0161ka algorithm, as described by Klein (2005).\n*\n* ## References\n*\n* - Klein, Andreas. 2005. \"A Generalized Kahan-Babu\u0161ka-Summation-Algorithm.\" _Computing_ 76 (3): 279\u201393. doi:[10.1007/s00607-005-0139-x](https://doi.org/10.1007/s00607-005-0139-x).\n*\n* @param {PositiveInteger} N - number of indexed elements\n* @param {NumericArray} x - input array\n* @param {integer} strideX - stride length\n* @param {NonNegativeInteger} offsetX - starting index\n* @returns {number} sum\n*\n* @example\n* var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ];\n*\n* var v = gnansumkbn2( 4, x, 2, 1 );\n* // returns 5.0\n*/\nfunction gnansumkbn2( N, x, strideX, offsetX ) {\n\tvar sum;\n\tvar ccs;\n\tvar ix;\n\tvar cs;\n\tvar cc;\n\tvar v;\n\tvar t;\n\tvar c;\n\tvar o;\n\tvar i;\n\n\tif ( N <= 0 ) {\n\t\treturn 0.0;\n\t}\n\to = arraylike2object( x );\n\tif ( o.accessorProtocol ) {\n\t\treturn accessors( N, o, strideX, offsetX );\n\t}\n\tix = offsetX;\n\tif ( strideX === 0 ) {\n\t\tif ( isnan( x[ ix ] ) ) {\n\t\t\treturn 0.0;\n\t\t}\n\t\treturn N * x[ ix ];\n\t}\n\tsum = 0.0;\n\tccs = 0.0; // second order correction term for lost low order bits\n\tcs = 0.0; // first order correction term for lost low order bits\n\tfor ( i = 0; i < N; i++ ) {\n\t\tv = x[ ix ];\n\t\tif ( isnan( v ) === false ) {\n\t\t\tt = sum + v;\n\t\t\tif ( abs( sum ) >= abs( v ) ) {\n\t\t\t\tc = (sum-t) + v;\n\t\t\t} else {\n\t\t\t\tc = (v-t) + sum;\n\t\t\t}\n\t\t\tsum = t;\n\t\t\tt = cs + c;\n\t\t\tif ( abs( cs ) >= abs( c ) ) {\n\t\t\t\tcc = (cs-t) + c;\n\t\t\t} else {\n\t\t\t\tcc = (c-t) + cs;\n\t\t\t}\n\t\t\tcs = t;\n\t\t\tccs += cc;\n\t\t}\n\t\tix += strideX;\n\t}\n\treturn sum + cs + ccs;\n}\n\n\n// EXPORTS //\n\nmodule.exports = gnansumkbn2;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2020 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar stride2offset = require( '@stdlib/strided-base-stride2offset' );\nvar ndarray = require( './ndarray.js' );\n\n\n// MAIN //\n\n/**\n* Computes the sum of strided array elements, ignoring `NaN` values and using a second-order iterative Kahan\u2013Babu\u0161ka algorithm.\n*\n* ## Method\n*\n* - This implementation uses a second-order iterative Kahan\u2013Babu\u0161ka algorithm, as described by Klein (2005).\n*\n* ## References\n*\n* - Klein, Andreas. 2005. \"A Generalized Kahan-Babu\u0161ka-Summation-Algorithm.\" _Computing_ 76 (3): 279\u201393. doi:[10.1007/s00607-005-0139-x](https://doi.org/10.1007/s00607-005-0139-x).\n*\n* @param {PositiveInteger} N - number of indexed elements\n* @param {NumericArray} x - input array\n* @param {integer} strideX - stride length\n* @returns {number} sum\n*\n* @example\n* var x = [ 1.0, -2.0, NaN, 2.0 ];\n*\n* var v = gnansumkbn2( x.length, x, 1 );\n* // returns 1.0\n*/\nfunction gnansumkbn2( N, x, strideX ) {\n\treturn ndarray( N, x, strideX, stride2offset( N, strideX ) );\n}\n\n\n// EXPORTS //\n\nmodule.exports = gnansumkbn2;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2020 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Compute the sum of strided array elements, ignoring `NaN` values and using a second-order iterative Kahan\u2013Babu\u0161ka algorithm.\n*\n* @module @stdlib/blas-ext-base-gnansumkbn2\n*\n* @example\n* var gnansumkbn2 = require( '@stdlib/blas-ext-base-gnansumkbn2' );\n*\n* var x = [ 1.0, -2.0, NaN, 2.0 ];\n*\n* var v = gnansumkbn2( x.length, x, 1 );\n* // returns 1.0\n*\n* @example\n* var gnansumkbn2 = require( '@stdlib/blas-ext-base-gnansumkbn2' );\n*\n* var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ];\n*\n* var v = gnansumkbn2.ndarray( 5, x, 2, 1 );\n* // returns 5.0\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar ndarray = require( './ndarray.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'ndarray', ndarray );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
5
+ "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAQ,QAAS,iCAAkC,EACnDC,EAAM,QAAS,+BAAgC,EAkCnD,SAASC,EAAaC,EAAGC,EAAGC,EAASC,EAAU,CAC9C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EASJ,GANAV,EAAOH,EAAE,KAGTI,EAAOJ,EAAE,UAAW,CAAE,EAEtBS,EAAKP,EACAD,IAAY,EAChB,OAAKL,EAAOQ,EAAMD,EAAMM,CAAG,CAAE,EACrB,EAEDV,EAAIK,EAAMD,EAAMM,CAAG,EAK3B,IAHAJ,EAAM,EACNC,EAAM,EACNC,EAAK,EACCM,EAAI,EAAGA,EAAId,EAAGc,IACnBH,EAAIN,EAAMD,EAAMM,CAAG,EACdb,EAAOc,CAAE,IAAM,KACnBC,EAAIN,EAAMK,EACLb,EAAKQ,CAAI,GAAKR,EAAKa,CAAE,EACzBE,EAAKP,EAAIM,EAAKD,EAEdE,EAAKF,EAAEC,EAAKN,EAEbA,EAAMM,EACNA,EAAIJ,EAAKK,EACJf,EAAKU,CAAG,GAAKV,EAAKe,CAAE,EACxBJ,EAAMD,EAAGI,EAAKC,EAEdJ,EAAMI,EAAED,EAAKJ,EAEdA,EAAKI,EACLL,GAAOE,GAERC,GAAMR,EAEP,OAAOI,EAAME,EAAKD,CACnB,CAKAX,EAAO,QAAUG,ICjHjB,IAAAgB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAmB,QAAS,qCAAsC,EAClEC,EAAQ,QAAS,iCAAkC,EACnDC,EAAM,QAAS,+BAAgC,EAC/CC,EAAY,IA4BhB,SAASC,EAAaC,EAAGC,EAAGC,EAASC,EAAU,CAC9C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAEJ,GAAKb,GAAK,EACT,MAAO,GAGR,GADAY,EAAIjB,EAAkBM,CAAE,EACnBW,EAAE,iBACN,OAAOd,EAAWE,EAAGY,EAAGV,EAASC,CAAQ,EAG1C,GADAG,EAAKH,EACAD,IAAY,EAChB,OAAKN,EAAOK,EAAGK,CAAG,CAAE,EACZ,EAEDN,EAAIC,EAAGK,CAAG,EAKlB,IAHAF,EAAM,EACNC,EAAM,EACNE,EAAK,EACCM,EAAI,EAAGA,EAAIb,EAAGa,IACnBJ,EAAIR,EAAGK,CAAG,EACLV,EAAOa,CAAE,IAAM,KACnBC,EAAIN,EAAMK,EACLZ,EAAKO,CAAI,GAAKP,EAAKY,CAAE,EACzBE,EAAKP,EAAIM,EAAKD,EAEdE,EAAKF,EAAEC,EAAKN,EAEbA,EAAMM,EACNA,EAAIH,EAAKI,EACJd,EAAKU,CAAG,GAAKV,EAAKc,CAAE,EACxBH,EAAMD,EAAGG,EAAKC,EAEdH,EAAMG,EAAED,EAAKH,EAEdA,EAAKG,EACLL,GAAOG,GAERF,GAAMJ,EAEP,OAAOE,EAAMG,EAAKF,CACnB,CAKAX,EAAO,QAAUK,IC7GjB,IAAAe,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAU,IA2Bd,SAASC,EAAaC,EAAGC,EAAGC,EAAU,CACrC,OAAOJ,EAASE,EAAGC,EAAGC,EAASL,EAAeG,EAAGE,CAAQ,CAAE,CAC5D,CAKAN,EAAO,QAAUG,ICbjB,IAAII,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD",
6
+ "names": ["require_accessors", "__commonJSMin", "exports", "module", "isnan", "abs", "gnansumkbn2", "N", "x", "strideX", "offsetX", "xbuf", "xget", "sum", "ccs", "cs", "cc", "ix", "v", "t", "c", "i", "require_ndarray", "__commonJSMin", "exports", "module", "arraylike2object", "isnan", "abs", "accessors", "gnansumkbn2", "N", "x", "strideX", "offsetX", "sum", "ccs", "ix", "cs", "cc", "v", "t", "c", "o", "i", "require_main", "__commonJSMin", "exports", "module", "stride2offset", "ndarray", "gnansumkbn2", "N", "x", "strideX", "setReadOnly", "main", "ndarray"]
7
7
  }
@@ -20,7 +20,12 @@
20
20
 
21
21
  /// <reference types="@stdlib/types"/>
22
22
 
23
- import { NumericArray } from '@stdlib/types/array';
23
+ import { NumericArray, Collection, AccessorArrayLike } from '@stdlib/types/array';
24
+
25
+ /**
26
+ * Input array.
27
+ */
28
+ type InputArray = NumericArray | Collection<number> | AccessorArrayLike<number>;
24
29
 
25
30
  /**
26
31
  * Interface describing `gnansumkbn2`.
@@ -31,7 +36,7 @@ interface Routine {
31
36
  *
32
37
  * @param N - number of indexed elements
33
38
  * @param x - input array
34
- * @param stride - stride length
39
+ * @param strideX - stride length
35
40
  * @returns sum
36
41
  *
37
42
  * @example
@@ -40,15 +45,15 @@ interface Routine {
40
45
  * var v = gnansumkbn2( x.length, x, 1 );
41
46
  * // returns 1.0
42
47
  */
43
- ( N: number, x: NumericArray, stride: number ): number;
48
+ ( N: number, x: InputArray, strideX: number ): number;
44
49
 
45
50
  /**
46
51
  * Computes the sum of strided array elements, ignoring `NaN` values and using a second-order iterative Kahan–Babuška algorithm and alternative indexing semantics.
47
52
  *
48
53
  * @param N - number of indexed elements
49
54
  * @param x - input array
50
- * @param stride - stride length
51
- * @param offset - starting index
55
+ * @param strideX - stride length
56
+ * @param offsetX - starting index
52
57
  * @returns sum
53
58
  *
54
59
  * @example
@@ -57,7 +62,7 @@ interface Routine {
57
62
  * var v = gnansumkbn2.ndarray( x.length, x, 1, 0 );
58
63
  * // returns 1.0
59
64
  */
60
- ndarray( N: number, x: NumericArray, stride: number, offset: number ): number;
65
+ ndarray( N: number, x: InputArray, strideX: number, offsetX: number ): number;
61
66
  }
62
67
 
63
68
  /**
@@ -65,7 +70,7 @@ interface Routine {
65
70
  *
66
71
  * @param N - number of indexed elements
67
72
  * @param x - input array
68
- * @param stride - stride length
73
+ * @param strideX - stride length
69
74
  * @returns sum
70
75
  *
71
76
  * @example
@@ -0,0 +1,114 @@
1
+ /**
2
+ * @license Apache-2.0
3
+ *
4
+ * Copyright (c) 2025 The Stdlib Authors.
5
+ *
6
+ * Licensed under the Apache License, Version 2.0 (the "License");
7
+ * you may not use this file except in compliance with the License.
8
+ * You may obtain a copy of the License at
9
+ *
10
+ * http://www.apache.org/licenses/LICENSE-2.0
11
+ *
12
+ * Unless required by applicable law or agreed to in writing, software
13
+ * distributed under the License is distributed on an "AS IS" BASIS,
14
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
+ * See the License for the specific language governing permissions and
16
+ * limitations under the License.
17
+ */
18
+
19
+ 'use strict';
20
+
21
+ // MODULES //
22
+
23
+ var isnan = require( '@stdlib/math-base-assert-is-nan' );
24
+ var abs = require( '@stdlib/math-base-special-abs' );
25
+
26
+
27
+ // MAIN //
28
+
29
+ /**
30
+ * Computes the sum of strided array elements, ignoring `NaN` values and using a second-order iterative Kahan–Babuška algorithm.
31
+ *
32
+ * ## Method
33
+ *
34
+ * - This implementation uses a second-order iterative Kahan–Babuška algorithm, as described by Klein (2005).
35
+ *
36
+ * ## References
37
+ *
38
+ * - Klein, Andreas. 2005. "A Generalized Kahan-Babuška-Summation-Algorithm." _Computing_ 76 (3): 279–93. doi:[10.1007/s00607-005-0139-x](https://doi.org/10.1007/s00607-005-0139-x).
39
+ *
40
+ * @private
41
+ * @param {PositiveInteger} N - number of indexed elements
42
+ * @param {Object} x - input array object
43
+ * @param {Collection} x.data - input array data
44
+ * @param {Array<Function>} x.accessors - array element accessors
45
+ * @param {integer} strideX - stride length for `x`
46
+ * @param {NonNegativeInteger} offsetX - starting index for `x`
47
+ * @returns {number} sum
48
+ *
49
+ * @example
50
+ * var toAccessorArray = require( '@stdlib/array-base-to-accessor-array' );
51
+ * var arraylike2object = require( '@stdlib/array-base-arraylike2object' );
52
+ *
53
+ * var x = toAccessorArray( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
54
+ *
55
+ * var v = gnansumkbn2( 4, arraylike2object( x ), 2, 1 );
56
+ * // returns 5.0
57
+ */
58
+ function gnansumkbn2( N, x, strideX, offsetX ) {
59
+ var xbuf;
60
+ var xget;
61
+ var sum;
62
+ var ccs;
63
+ var cs;
64
+ var cc;
65
+ var ix;
66
+ var v;
67
+ var t;
68
+ var c;
69
+ var i;
70
+
71
+ // Cache reference to array data:
72
+ xbuf = x.data;
73
+
74
+ // Cache reference to the element accessors:
75
+ xget = x.accessors[ 0 ];
76
+
77
+ ix = offsetX;
78
+ if ( strideX === 0 ) {
79
+ if ( isnan( xget( xbuf, ix ) ) ) {
80
+ return 0.0;
81
+ }
82
+ return N * xget( xbuf, ix );
83
+ }
84
+ sum = 0.0;
85
+ ccs = 0.0; // second order correction term for lost low order bits
86
+ cs = 0.0; // first order correction term for lost low order bits
87
+ for ( i = 0; i < N; i++ ) {
88
+ v = xget( xbuf, ix );
89
+ if ( isnan( v ) === false ) {
90
+ t = sum + v;
91
+ if ( abs( sum ) >= abs( v ) ) {
92
+ c = (sum-t) + v;
93
+ } else {
94
+ c = (v-t) + sum;
95
+ }
96
+ sum = t;
97
+ t = cs + c;
98
+ if ( abs( cs ) >= abs( c ) ) {
99
+ cc = (cs-t) + c;
100
+ } else {
101
+ cc = (c-t) + cs;
102
+ }
103
+ cs = t;
104
+ ccs += cc;
105
+ }
106
+ ix += strideX;
107
+ }
108
+ return sum + cs + ccs;
109
+ }
110
+
111
+
112
+ // EXPORTS //
113
+
114
+ module.exports = gnansumkbn2;
package/lib/index.js CHANGED
@@ -27,19 +27,16 @@
27
27
  * var gnansumkbn2 = require( '@stdlib/blas-ext-base-gnansumkbn2' );
28
28
  *
29
29
  * var x = [ 1.0, -2.0, NaN, 2.0 ];
30
- * var N = x.length;
31
30
  *
32
- * var v = gnansumkbn2( N, x, 1 );
31
+ * var v = gnansumkbn2( x.length, x, 1 );
33
32
  * // returns 1.0
34
33
  *
35
34
  * @example
36
- * var floor = require( '@stdlib/math-base-special-floor' );
37
35
  * var gnansumkbn2 = require( '@stdlib/blas-ext-base-gnansumkbn2' );
38
36
  *
39
37
  * var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0, NaN, NaN ];
40
- * var N = floor( x.length / 2 );
41
38
  *
42
- * var v = gnansumkbn2.ndarray( N, x, 2, 1 );
39
+ * var v = gnansumkbn2.ndarray( 5, x, 2, 1 );
43
40
  * // returns 5.0
44
41
  */
45
42
 
package/lib/main.js CHANGED
@@ -20,8 +20,8 @@
20
20
 
21
21
  // MODULES //
22
22
 
23
- var isnan = require( '@stdlib/math-base-assert-is-nan' );
24
- var abs = require( '@stdlib/math-base-special-abs' );
23
+ var stride2offset = require( '@stdlib/strided-base-stride2offset' );
24
+ var ndarray = require( './ndarray.js' );
25
25
 
26
26
 
27
27
  // MAIN //
@@ -39,66 +39,17 @@ var abs = require( '@stdlib/math-base-special-abs' );
39
39
  *
40
40
  * @param {PositiveInteger} N - number of indexed elements
41
41
  * @param {NumericArray} x - input array
42
- * @param {integer} stride - stride length
42
+ * @param {integer} strideX - stride length
43
43
  * @returns {number} sum
44
44
  *
45
45
  * @example
46
46
  * var x = [ 1.0, -2.0, NaN, 2.0 ];
47
- * var N = x.length;
48
47
  *
49
- * var v = gnansumkbn2( N, x, 1 );
48
+ * var v = gnansumkbn2( x.length, x, 1 );
50
49
  * // returns 1.0
51
50
  */
52
- function gnansumkbn2( N, x, stride ) {
53
- var sum;
54
- var ccs;
55
- var ix;
56
- var cs;
57
- var cc;
58
- var v;
59
- var t;
60
- var c;
61
- var i;
62
-
63
- if ( N <= 0 ) {
64
- return 0.0;
65
- }
66
- if ( N === 1 || stride === 0 ) {
67
- if ( isnan( x[ 0 ] ) ) {
68
- return 0.0;
69
- }
70
- return x[ 0 ];
71
- }
72
- if ( stride < 0 ) {
73
- ix = (1-N) * stride;
74
- } else {
75
- ix = 0;
76
- }
77
- sum = 0.0;
78
- ccs = 0.0; // second order correction term for lost low order bits
79
- cs = 0.0; // first order correction term for lost low order bits
80
- for ( i = 0; i < N; i++ ) {
81
- v = x[ ix ];
82
- if ( isnan( v ) === false ) {
83
- t = sum + v;
84
- if ( abs( sum ) >= abs( v ) ) {
85
- c = (sum-t) + v;
86
- } else {
87
- c = (v-t) + sum;
88
- }
89
- sum = t;
90
- t = cs + c;
91
- if ( abs( cs ) >= abs( c ) ) {
92
- cc = (cs-t) + c;
93
- } else {
94
- cc = (c-t) + cs;
95
- }
96
- cs = t;
97
- ccs += cc;
98
- }
99
- ix += stride;
100
- }
101
- return sum + cs + ccs;
51
+ function gnansumkbn2( N, x, strideX ) {
52
+ return ndarray( N, x, strideX, stride2offset( N, strideX ) );
102
53
  }
103
54
 
104
55
 
package/lib/ndarray.js CHANGED
@@ -20,8 +20,10 @@
20
20
 
21
21
  // MODULES //
22
22
 
23
+ var arraylike2object = require( '@stdlib/array-base-arraylike2object' );
23
24
  var isnan = require( '@stdlib/math-base-assert-is-nan' );
24
25
  var abs = require( '@stdlib/math-base-special-abs' );
26
+ var accessors = require( './accessors.js' );
25
27
 
26
28
 
27
29
  // MAIN //
@@ -39,20 +41,17 @@ var abs = require( '@stdlib/math-base-special-abs' );
39
41
  *
40
42
  * @param {PositiveInteger} N - number of indexed elements
41
43
  * @param {NumericArray} x - input array
42
- * @param {integer} stride - stride length
43
- * @param {NonNegativeInteger} offset - starting index
44
+ * @param {integer} strideX - stride length
45
+ * @param {NonNegativeInteger} offsetX - starting index
44
46
  * @returns {number} sum
45
47
  *
46
48
  * @example
47
- * var floor = require( '@stdlib/math-base-special-floor' );
48
- *
49
49
  * var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ];
50
- * var N = floor( x.length / 2 );
51
50
  *
52
- * var v = gnansumkbn2( N, x, 2, 1 );
51
+ * var v = gnansumkbn2( 4, x, 2, 1 );
53
52
  * // returns 5.0
54
53
  */
55
- function gnansumkbn2( N, x, stride, offset ) {
54
+ function gnansumkbn2( N, x, strideX, offsetX ) {
56
55
  var sum;
57
56
  var ccs;
58
57
  var ix;
@@ -61,18 +60,23 @@ function gnansumkbn2( N, x, stride, offset ) {
61
60
  var v;
62
61
  var t;
63
62
  var c;
63
+ var o;
64
64
  var i;
65
65
 
66
66
  if ( N <= 0 ) {
67
67
  return 0.0;
68
68
  }
69
- if ( N === 1 || stride === 0 ) {
70
- if ( isnan( x[ offset ] ) ) {
69
+ o = arraylike2object( x );
70
+ if ( o.accessorProtocol ) {
71
+ return accessors( N, o, strideX, offsetX );
72
+ }
73
+ ix = offsetX;
74
+ if ( strideX === 0 ) {
75
+ if ( isnan( x[ ix ] ) ) {
71
76
  return 0.0;
72
77
  }
73
- return x[ offset ];
78
+ return N * x[ ix ];
74
79
  }
75
- ix = offset;
76
80
  sum = 0.0;
77
81
  ccs = 0.0; // second order correction term for lost low order bits
78
82
  cs = 0.0; // first order correction term for lost low order bits
@@ -95,7 +99,7 @@ function gnansumkbn2( N, x, stride, offset ) {
95
99
  cs = t;
96
100
  ccs += cc;
97
101
  }
98
- ix += stride;
102
+ ix += strideX;
99
103
  }
100
104
  return sum + cs + ccs;
101
105
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stdlib/blas-ext-base-gnansumkbn2",
3
- "version": "0.2.2",
3
+ "version": "0.3.0",
4
4
  "description": "Calculate the sum of strided array elements, ignoring NaN values and using a second-order iterative Kahan–Babuška algorithm.",
5
5
  "license": "Apache-2.0",
6
6
  "author": {
@@ -30,8 +30,10 @@
30
30
  "url": "https://github.com/stdlib-js/stdlib/issues"
31
31
  },
32
32
  "dependencies": {
33
+ "@stdlib/array-base-arraylike2object": "^0.2.1",
33
34
  "@stdlib/math-base-assert-is-nan": "^0.2.2",
34
35
  "@stdlib/math-base-special-abs": "^0.2.2",
36
+ "@stdlib/strided-base-stride2offset": "^0.1.0",
35
37
  "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2"
36
38
  },
37
39
  "devDependencies": {},
@@ -66,7 +68,6 @@
66
68
  "strided array",
67
69
  "array"
68
70
  ],
69
- "__stdlib__": {},
70
71
  "funding": {
71
72
  "type": "opencollective",
72
73
  "url": "https://opencollective.com/stdlib"