@stdlib/blas-ext-base-gnansumkbn 0.0.2 → 0.0.6

package/NOTICE

@@ -1 +1 @@
-Copyright (c) 2016-2021 The Stdlib Authors.
+Copyright (c) 2016-2022 The Stdlib Authors.

package/README.md

@@ -20,7 +20,7 @@ limitations under the License.
 
 # gnansumkbn
 
-[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] [![dependencies][dependencies-image]][dependencies-url]
+[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
 
 > Calculate the sum of strided array elements, ignoring `NaN` values and using an improved Kahan–Babuška algorithm.
 
@@ -183,6 +183,28 @@ console.log( v );
 
 <!-- /.references -->
 
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/blas/ext/base/dnansumkbn`][@stdlib/blas/ext/base/dnansumkbn]</span><span class="delimiter">: </span><span class="description">calculate the sum of double-precision floating-point strided array elements, ignoring NaN values and using an improved Kahan–Babuška algorithm.</span>
+-   <span class="package-name">[`@stdlib/blas/ext/base/gnansum`][@stdlib/blas/ext/base/gnansum]</span><span class="delimiter">: </span><span class="description">calculate the sum of strided array elements, ignoring NaN values.</span>
+-   <span class="package-name">[`@stdlib/blas/ext/base/gnansumkbn2`][@stdlib/blas/ext/base/gnansumkbn2]</span><span class="delimiter">: </span><span class="description">calculate the sum of strided array elements, ignoring NaN values and using a second-order iterative Kahan–Babuška algorithm.</span>
+-   <span class="package-name">[`@stdlib/blas/ext/base/gnansumors`][@stdlib/blas/ext/base/gnansumors]</span><span class="delimiter">: </span><span class="description">calculate the sum of strided array elements, ignoring NaN values and using ordinary recursive summation.</span>
+-   <span class="package-name">[`@stdlib/blas/ext/base/gnansumpw`][@stdlib/blas/ext/base/gnansumpw]</span><span class="delimiter">: </span><span class="description">calculate the sum of strided array elements, ignoring NaN values and using pairwise summation.</span>
+-   <span class="package-name">[`@stdlib/blas/ext/base/gsumkbn`][@stdlib/blas/ext/base/gsumkbn]</span><span class="delimiter">: </span><span class="description">calculate the sum of strided array elements using an improved Kahan–Babuška algorithm.</span>
+-   <span class="package-name">[`@stdlib/blas/ext/base/snansumkbn`][@stdlib/blas/ext/base/snansumkbn]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements, ignoring NaN values and using an improved Kahan–Babuška algorithm.</span>
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
 
 <section class="main-repo" >
 
@@ -194,6 +216,10 @@ This package is part of [stdlib][stdlib], a standard library for JavaScript and
 
 For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
 
+#### Community
+
+[![Chat][chat-image]][chat-url]
+
 ---
 
 ## License
@@ -203,7 +229,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -222,9 +248,23 @@ Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/blas-ext-base-gnansumkbn/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/blas-ext-base-gnansumkbn?branch=main
 
-[dependencies-image]: https://img.shields.io/david/stdlib-js/blas-ext-base-gnansumkbn
+<!--
+
+[dependencies-image]: https://img.shields.io/david/stdlib-js/blas-ext-base-gnansumkbn.svg
 [dependencies-url]: https://david-dm.org/stdlib-js/blas-ext-base-gnansumkbn/main
 
+-->
+
+[umd]: https://github.com/umdjs/umd
+[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
+
+[deno-url]: https://github.com/stdlib-js/blas-ext-base-gnansumkbn/tree/deno
+[umd-url]: https://github.com/stdlib-js/blas-ext-base-gnansumkbn/tree/umd
+[esm-url]: https://github.com/stdlib-js/blas-ext-base-gnansumkbn/tree/esm
+
+[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
+[chat-url]: https://gitter.im/stdlib-js/stdlib/
+
 [stdlib]: https://github.com/stdlib-js/stdlib
 
 [stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
@@ -235,11 +275,25 @@ Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
 
 [mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
 
-[@stdlib/blas/ext/base/dnansum]: https://github.com/stdlib-js/blas-ext-base-dnansum
+[@neumaier:1974a]: https://doi.org/10.1002/zamm.19740540106
 
-[@stdlib/blas/ext/base/snansum]: https://github.com/stdlib-js/blas-ext-base-snansum
+<!-- <related-links> -->
 
-[@neumaier:1974a]: https://doi.org/10.1002/zamm.19740540106
+[@stdlib/blas/ext/base/dnansumkbn]: https://www.npmjs.com/package/@stdlib/blas-ext-base-dnansumkbn
+
+[@stdlib/blas/ext/base/gnansum]: https://www.npmjs.com/package/@stdlib/blas-ext-base-gnansum
+
+[@stdlib/blas/ext/base/gnansumkbn2]: https://www.npmjs.com/package/@stdlib/blas-ext-base-gnansumkbn2
+
+[@stdlib/blas/ext/base/gnansumors]: https://www.npmjs.com/package/@stdlib/blas-ext-base-gnansumors
+
+[@stdlib/blas/ext/base/gnansumpw]: https://www.npmjs.com/package/@stdlib/blas-ext-base-gnansumpw
+
+[@stdlib/blas/ext/base/gsumkbn]: https://www.npmjs.com/package/@stdlib/blas-ext-base-gsumkbn
+
+[@stdlib/blas/ext/base/snansumkbn]: https://www.npmjs.com/package/@stdlib/blas-ext-base-snansumkbn
+
+<!-- </related-links> -->
 
 </section>
 

package/lib/index.js

@@ -45,9 +45,16 @@
 
 // MODULES //
 
-var gnansumkbn = require( './main.js' );
+var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
+var main = require( './main.js' );
+var ndarray = require( './ndarray.js' );
+
+
+// MAIN //
+
+setReadOnly( main, 'ndarray', ndarray );
 
 
 // EXPORTS //
 
-module.exports = gnansumkbn;
+module.exports = main;

package/lib/main.js

@@ -20,14 +20,74 @@
 
 // MODULES //
 
-var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
-var gnansumkbn = require( './gnansumkbn.js' );
-var ndarray = require( './ndarray.js' );
+var isnan = require( '@stdlib/math-base-assert-is-nan' );
+var abs = require( '@stdlib/math-base-special-abs' );
 
 
 // MAIN //
 
-setReadOnly( gnansumkbn, 'ndarray', ndarray );
+/**
+* Computes the sum of strided array elements, ignoring `NaN` values and using an improved Kahan–Babuška algorithm.
+*
+* ## Method
+*
+* -   This implementation uses an "improved Kahan–Babuška algorithm", as described by Neumaier (1974).
+*
+* ## References
+*
+* -   Neumaier, Arnold. 1974. "Rounding Error Analysis of Some Methods for Summing Finite Sums." _Zeitschrift Für Angewandte Mathematik Und Mechanik_ 54 (1): 39–51. doi:[10.1002/zamm.19740540106](https://doi.org/10.1002/zamm.19740540106).
+*
+* @param {PositiveInteger} N - number of indexed elements
+* @param {NumericArray} x - input array
+* @param {integer} stride - stride length
+* @returns {number} sum
+*
+* @example
+* var x = [ 1.0, -2.0, NaN, 2.0 ];
+* var N = x.length;
+*
+* var v = gnansumkbn( N, x, 1 );
+* // returns 1.0
+*/
+function gnansumkbn( N, x, stride ) {
+	var sum;
+	var ix;
+	var v;
+	var t;
+	var c;
+	var i;
+
+	if ( N <= 0 ) {
+		return 0.0;
+	}
+	if ( N === 1 || stride === 0 ) {
+		if ( isnan( x[ 0 ] ) ) {
+			return 0.0;
+		}
+		return x[ 0 ];
+	}
+	if ( stride < 0 ) {
+		ix = (1-N) * stride;
+	} else {
+		ix = 0;
+	}
+	sum = 0.0;
+	c = 0.0;
+	for ( i = 0; i < N; i++ ) {
+		v = x[ ix ];
+		if ( isnan( v ) === false ) {
+			t = sum + v;
+			if ( abs( sum ) >= abs( v ) ) {
+				c += (sum-t) + v;
+			} else {
+				c += (v-t) + sum;
+			}
+			sum = t;
+		}
+		ix += stride;
+	}
+	return sum + c;
+}
 
 
 // EXPORTS //

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/blas-ext-base-gnansumkbn",
-  "version": "0.0.2",
+  "version": "0.0.6",
   "description": "Calculate the sum of strided array elements, ignoring NaN values and using an improved Kahan–Babuška algorithm.",
   "license": "Apache-2.0",
   "author": {
@@ -28,7 +28,7 @@
     "examples": "make examples",
     "benchmark": "make benchmark"
   },
-  "homepage": "https://github.com/stdlib-js/stdlib",
+  "homepage": "https://stdlib.io",
   "repository": {
     "type": "git",
     "url": "git://github.com/stdlib-js/blas-ext-base-gnansumkbn.git"

package/CHANGELOG.md

@@ -1,5 +0,0 @@
-# CHANGELOG
-
-> Package changelog.
-
-See [GitHub Releases](https://github.com/stdlib-js/blas-ext-base-gnansumkbn/releases) for the changelog.

package/lib/gnansumkbn.js

@@ -1,95 +0,0 @@
-/**
-* @license Apache-2.0
-*
-* Copyright (c) 2020 The Stdlib Authors.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-*    http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
-
-'use strict';
-
-// MODULES //
-
-var isnan = require( '@stdlib/math-base-assert-is-nan' );
-var abs = require( '@stdlib/math-base-special-abs' );
-
-
-// MAIN //
-
-/**
-* Computes the sum of strided array elements, ignoring `NaN` values and using an improved Kahan–Babuška algorithm.
-*
-* ## Method
-*
-* -   This implementation uses an "improved Kahan–Babuška algorithm", as described by Neumaier (1974).
-*
-* ## References
-*
-* -   Neumaier, Arnold. 1974. "Rounding Error Analysis of Some Methods for Summing Finite Sums." _Zeitschrift Für Angewandte Mathematik Und Mechanik_ 54 (1): 39–51. doi:[10.1002/zamm.19740540106](https://doi.org/10.1002/zamm.19740540106).
-*
-* @param {PositiveInteger} N - number of indexed elements
-* @param {NumericArray} x - input array
-* @param {integer} stride - stride length
-* @returns {number} sum
-*
-* @example
-* var x = [ 1.0, -2.0, NaN, 2.0 ];
-* var N = x.length;
-*
-* var v = gnansumkbn( N, x, 1 );
-* // returns 1.0
-*/
-function gnansumkbn( N, x, stride ) {
-	var sum;
-	var ix;
-	var v;
-	var t;
-	var c;
-	var i;
-
-	if ( N <= 0 ) {
-		return 0.0;
-	}
-	if ( N === 1 || stride === 0 ) {
-		if ( isnan( x[ 0 ] ) ) {
-			return 0.0;
-		}
-		return x[ 0 ];
-	}
-	if ( stride < 0 ) {
-		ix = (1-N) * stride;
-	} else {
-		ix = 0;
-	}
-	sum = 0.0;
-	c = 0.0;
-	for ( i = 0; i < N; i++ ) {
-		v = x[ ix ];
-		if ( isnan( v ) === false ) {
-			t = sum + v;
-			if ( abs( sum ) >= abs( v ) ) {
-				c += (sum-t) + v;
-			} else {
-				c += (v-t) + sum;
-			}
-			sum = t;
-		}
-		ix += stride;
-	}
-	return sum + c;
-}
-
-
-// EXPORTS //
-
-module.exports = gnansumkbn;