@stdlib/blas-ext-base-gcusumpw 0.0.3 → 0.0.7

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.
 
 # gcusumpw
 
-[![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 cumulative sum of strided array elements using pairwise summation.
 
@@ -108,7 +108,7 @@ var y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); // start at 4th
 var N = floor( x0.length / 2 );
 
 gcusumpw( N, 0.0, x1, -2, y1, 1 );
-// y0 => <Float64Array>[ 0.0, 0.0, 0.0, 0.0, 4.0, 6.0, 4.0, 5.0 ]
+// y0 => <Float64Array>[ 0.0, 0.0, 0.0, 4.0, 6.0, 4.0, 5.0, 0.0 ]
 ```
 
 #### gcusumpw.ndarray( N, sum, x, strideX, offsetX, y, strideY, offsetY )
@@ -202,6 +202,24 @@ console.log( y );
 
 <!-- /.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/dcusumpw`][@stdlib/blas/ext/base/dcusumpw]</span><span class="delimiter">: </span><span class="description">calculate the cumulative sum of double-precision floating-point strided array elements using pairwise summation.</span>
+-   <span class="package-name">[`@stdlib/blas/ext/base/gcusum`][@stdlib/blas/ext/base/gcusum]</span><span class="delimiter">: </span><span class="description">calculate the cumulative sum of strided array elements.</span>
+-   <span class="package-name">[`@stdlib/blas/ext/base/scusumpw`][@stdlib/blas/ext/base/scusumpw]</span><span class="delimiter">: </span><span class="description">calculate the cumulative sum of single-precision floating-point strided array elements using pairwise summation.</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" >
 
@@ -213,6 +231,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
@@ -222,7 +244,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>
 
@@ -241,9 +263,23 @@ Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/blas-ext-base-gcusumpw/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/blas-ext-base-gcusumpw?branch=main
 
-[dependencies-image]: https://img.shields.io/david/stdlib-js/blas-ext-base-gcusumpw
+<!--
+
+[dependencies-image]: https://img.shields.io/david/stdlib-js/blas-ext-base-gcusumpw.svg
 [dependencies-url]: https://david-dm.org/stdlib-js/blas-ext-base-gcusumpw/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-gcusumpw/tree/deno
+[umd-url]: https://github.com/stdlib-js/blas-ext-base-gcusumpw/tree/umd
+[esm-url]: https://github.com/stdlib-js/blas-ext-base-gcusumpw/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
@@ -254,11 +290,17 @@ 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/dcusumpw]: https://github.com/stdlib-js/blas-ext-base-dcusumpw
+[@higham:1993a]: https://doi.org/10.1137/0914050
 
-[@stdlib/blas/ext/base/scusumpw]: https://github.com/stdlib-js/blas-ext-base-scusumpw
+<!-- <related-links> -->
 
-[@higham:1993a]: https://doi.org/10.1137/0914050
+[@stdlib/blas/ext/base/dcusumpw]: https://www.npmjs.com/package/@stdlib/blas-ext-base-dcusumpw
+
+[@stdlib/blas/ext/base/gcusum]: https://www.npmjs.com/package/@stdlib/blas-ext-base-gcusum
+
+[@stdlib/blas/ext/base/scusumpw]: https://www.npmjs.com/package/@stdlib/blas-ext-base-scusumpw
+
+<!-- </related-links> -->
 
 </section>
 

package/lib/index.js

@@ -46,9 +46,16 @@
 
 // MODULES //
 
-var gcusumpw = 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 = gcusumpw;
+module.exports = main;

package/lib/main.js

@@ -20,14 +20,56 @@
 
 // MODULES //
 
-var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
-var gcusumpw = require( './gcusumpw.js' );
-var ndarray = require( './ndarray.js' );
+var cusum = require( './ndarray.js' );
 
 
 // MAIN //
 
-setReadOnly( gcusumpw, 'ndarray', ndarray );
+/**
+* Computes the cumulative sum of strided array elements using pairwise summation.
+*
+* ## Method
+*
+* -   This implementation uses pairwise summation, which accrues rounding error `O(log2 N)` instead of `O(N)`. The recursion depth is also `O(log2 N)`.
+*
+* ## References
+*
+* -   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).
+*
+* @param {PositiveInteger} N - number of indexed elements
+* @param {number} sum - initial sum
+* @param {NumericArray} x - input array
+* @param {integer} strideX - `x` stride length
+* @param {NumericArray} y - output array
+* @param {integer} strideY - `y` stride length
+* @returns {NumericArray} output array
+*
+* @example
+* var x = [ 1.0, -2.0, 2.0 ];
+* var y = [ 0.0, 0.0, 0.0 ];
+*
+* var v = gcusumpw( x.length, 0.0, x, 1, y, 1 );
+* // returns [ 1.0, -1.0, 1.0 ]
+*/
+function gcusumpw( N, sum, x, strideX, y, strideY ) {
+	var ix;
+	var iy;
+
+	if ( N <= 0 ) {
+		return y;
+	}
+	if ( strideX < 0 ) {
+		ix = (1-N) * strideX;
+	} else {
+		ix = 0;
+	}
+	if ( strideY < 0 ) {
+		iy = (1-N) * strideY;
+	} else {
+		iy = 0;
+	}
+	return cusum( N, sum, x, strideX, ix, y, strideY, iy );
+}
 
 
 // EXPORTS //

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/blas-ext-base-gcusumpw",
-  "version": "0.0.3",
+  "version": "0.0.7",
   "description": "Calculate the cumulative sum of strided array elements using pairwise summation.",
   "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-gcusumpw.git"

package/CHANGELOG.md

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

package/lib/gcusumpw.js

@@ -1,77 +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 cusum = require( './ndarray.js' );
-
-
-// MAIN //
-
-/**
-* Computes the cumulative sum of strided array elements using pairwise summation.
-*
-* ## Method
-*
-* -   This implementation uses pairwise summation, which accrues rounding error `O(log2 N)` instead of `O(N)`. The recursion depth is also `O(log2 N)`.
-*
-* ## References
-*
-* -   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).
-*
-* @param {PositiveInteger} N - number of indexed elements
-* @param {number} sum - initial sum
-* @param {NumericArray} x - input array
-* @param {integer} strideX - `x` stride length
-* @param {NumericArray} y - output array
-* @param {integer} strideY - `y` stride length
-* @returns {NumericArray} output array
-*
-* @example
-* var x = [ 1.0, -2.0, 2.0 ];
-* var y = [ 0.0, 0.0, 0.0 ];
-*
-* var v = gcusumpw( x.length, 0.0, x, 1, y, 1 );
-* // returns [ 1.0, -1.0, 1.0 ]
-*/
-function gcusumpw( N, sum, x, strideX, y, strideY ) {
-	var ix;
-	var iy;
-
-	if ( N <= 0 ) {
-		return y;
-	}
-	if ( strideX < 0 ) {
-		ix = (1-N) * strideX;
-	} else {
-		ix = 0;
-	}
-	if ( strideY < 0 ) {
-		iy = (1-N) * strideY;
-	} else {
-		iy = 0;
-	}
-	return cusum( N, sum, x, strideX, ix, y, strideY, iy );
-}
-
-
-// EXPORTS //
-
-module.exports = gcusumpw;