@stdlib/blas-ext-base-gcusumpw 0.0.9 → 0.1.0

package/CITATION.cff

@@ -0,0 +1,30 @@
+cff-version: 1.2.0
+title: stdlib
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+
+type: software
+
+authors:
+  - name: The Stdlib Authors
+    url: https://github.com/stdlib-js/stdlib/graphs/contributors
+
+repository-code: https://github.com/stdlib-js/stdlib
+url: https://stdlib.io
+
+abstract: |
+  Standard library for JavaScript and Node.js.
+
+keywords:
+  - JavaScript
+  - Node.js
+  - TypeScript
+  - standard library
+  - scientific computing
+  - numerical computing
+  - statistical computing
+
+license: Apache-2.0 AND BSL-1.0
+
+date-released: 2016

package/NOTICE

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

package/README.md

@@ -18,6 +18,17 @@ limitations under the License.
 
 -->
 
+
+<details>
+  <summary>
+    About stdlib...
+  </summary>
+  <p>We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.</p>
+  <p>The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.</p>
+  <p>When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.</p>
+  <p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p>
+</details>
+
 # gcusumpw
 
 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
@@ -210,9 +221,9 @@ console.log( y );
 
 ## 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>
+-   <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>
 
@@ -244,7 +255,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -257,8 +268,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/blas-ext-base-gcusumpw.svg
 [npm-url]: https://npmjs.org/package/@stdlib/blas-ext-base-gcusumpw
 
-[test-image]: https://github.com/stdlib-js/blas-ext-base-gcusumpw/actions/workflows/test.yml/badge.svg?branch=v0.0.9
-[test-url]: https://github.com/stdlib-js/blas-ext-base-gcusumpw/actions/workflows/test.yml?query=branch:v0.0.9
+[test-image]: https://github.com/stdlib-js/blas-ext-base-gcusumpw/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/blas-ext-base-gcusumpw/actions/workflows/test.yml?query=branch:v0.1.0
 
 [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
@@ -271,7 +282,7 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 -->
 
 [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://gitter.im/stdlib-js/stdlib/
+[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
 
 [stdlib]: https://github.com/stdlib-js/stdlib
 

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+/// <reference path="../docs/types/index.d.ts" />
+import gcusumpw from '../docs/types/index';
+export = gcusumpw;

package/dist/index.js

@@ -0,0 +1,7 @@
+"use strict";var m=function(r,a){return function(){return a||r((a={exports:{}}).exports,a),a.exports}};var s=m(function(S,x){
+var B=require('@stdlib/math-base-special-floor/dist'),C=128;function l(r,a,i,n,t,u,e,f){var c,v,p,o,q;if(r<=0)return u;if(c=t,v=f,r<=C){for(p=0,q=0;q<r;q++)p+=i[c],u[v]=a+p,c+=n,v+=e;return u}return o=B(r/2),l(o,a,i,n,c,u,e,v),v+=(o-1)*e,l(r-o,u[v],i,n,c+o*n,u,e,v+e),u}x.exports=l
+});var w=m(function(Z,g){
+var E=s();function I(r,a,i,n,t,u){var e,f;return r<=0?t:(n<0?e=(1-r)*n:e=0,u<0?f=(1-r)*u:f=0,E(r,a,i,n,e,t,u,f))}g.exports=I
+});var K=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),O=w(),L=s();K(O,"ndarray",L);module.exports=O;
+/** @license Apache-2.0 */
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../lib/ndarray.js", "../lib/main.js", "../lib/index.js"],
+  "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 floor = require( '@stdlib/math-base-special-floor' );\n\n\n// VARIABLES //\n\n// Blocksize for pairwise summation:\nvar BLOCKSIZE = 128;\n\n\n// MAIN //\n\n/**\n* Computes the cumulative sum of strided array elements using pairwise summation.\n*\n* ## Method\n*\n* -   This implementation uses pairwise summation, which accrues rounding error `O(log2 N)` instead of `O(N)`. The recursion depth is also `O(log2 N)`.\n*\n* ## References\n*\n* -   Higham, Nicholas J. 1993. \"The Accuracy of Floating Point Summation.\" _SIAM Journal on Scientific Computing_ 14 (4): 783\u201399. doi:[10.1137/0914050](https://doi.org/10.1137/0914050).\n*\n* @param {PositiveInteger} N - number of indexed elements\n* @param {number} sum - initial sum\n* @param {NumericArray} x - input array\n* @param {integer} strideX - `x` stride length\n* @param {NonNegativeInteger} offsetX - starting index for `x`\n* @param {NumericArray} y - output array\n* @param {integer} strideY - `y` stride length\n* @param {NonNegativeInteger} offsetY - starting index for `y`\n* @returns {NumericArray} output array\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 y = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];\n* var N = floor( x.length / 2 );\n*\n* gcusumpw( N, 0.0, x, 2, 1, y, 1, 0 );\n* // y => [ 1.0, -1.0, 1.0, 5.0, 0.0, 0.0, 0.0, 0.0 ]\n*/\nfunction gcusumpw( N, sum, x, strideX, offsetX, y, strideY, offsetY ) {\n\tvar ix;\n\tvar iy;\n\tvar s;\n\tvar n;\n\tvar i;\n\n\tif ( N <= 0 ) {\n\t\treturn y;\n\t}\n\tix = offsetX;\n\tiy = offsetY;\n\tif ( N <= BLOCKSIZE ) {\n\t\ts = 0.0;\n\t\tfor ( i = 0; i < N; i++ ) {\n\t\t\ts += x[ ix ];\n\t\t\ty[ iy ] = sum + s;\n\t\t\tix += strideX;\n\t\t\tiy += strideY;\n\t\t}\n\t\treturn y;\n\t}\n\tn = floor( N/2 );\n\tgcusumpw( n, sum, x, strideX, ix, y, strideY, iy );\n\tiy += (n-1) * strideY;\n\tgcusumpw( N-n, y[ iy ], x, strideX, ix+(n*strideX), y, strideY, iy+strideY ); // eslint-disable-line max-len\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = gcusumpw;\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 cusum = require( './ndarray.js' );\n\n\n// MAIN //\n\n/**\n* Computes the cumulative sum of strided array elements using pairwise summation.\n*\n* ## Method\n*\n* -   This implementation uses pairwise summation, which accrues rounding error `O(log2 N)` instead of `O(N)`. The recursion depth is also `O(log2 N)`.\n*\n* ## References\n*\n* -   Higham, Nicholas J. 1993. \"The Accuracy of Floating Point Summation.\" _SIAM Journal on Scientific Computing_ 14 (4): 783\u201399. doi:[10.1137/0914050](https://doi.org/10.1137/0914050).\n*\n* @param {PositiveInteger} N - number of indexed elements\n* @param {number} sum - initial sum\n* @param {NumericArray} x - input array\n* @param {integer} strideX - `x` stride length\n* @param {NumericArray} y - output array\n* @param {integer} strideY - `y` stride length\n* @returns {NumericArray} output array\n*\n* @example\n* var x = [ 1.0, -2.0, 2.0 ];\n* var y = [ 0.0, 0.0, 0.0 ];\n*\n* var v = gcusumpw( x.length, 0.0, x, 1, y, 1 );\n* // returns [ 1.0, -1.0, 1.0 ]\n*/\nfunction gcusumpw( N, sum, x, strideX, y, strideY ) {\n\tvar ix;\n\tvar iy;\n\n\tif ( N <= 0 ) {\n\t\treturn y;\n\t}\n\tif ( strideX < 0 ) {\n\t\tix = (1-N) * strideX;\n\t} else {\n\t\tix = 0;\n\t}\n\tif ( strideY < 0 ) {\n\t\tiy = (1-N) * strideY;\n\t} else {\n\t\tiy = 0;\n\t}\n\treturn cusum( N, sum, x, strideX, ix, y, strideY, iy );\n}\n\n\n// EXPORTS //\n\nmodule.exports = gcusumpw;\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 cumulative sum of strided array elements using pairwise summation.\n*\n* @module @stdlib/blas-ext-base-gcusumpw\n*\n* @example\n* var gcusumpw = require( '@stdlib/blas-ext-base-gcusumpw' );\n*\n* var x = [ 1.0, -2.0, 2.0 ];\n* var y = [ 0.0, 0.0, 0.0 ];\n*\n* gcusumpw( x.length, 0.0, x, 1, y, 1 );\n* // y => [ 1.0, -1.0, 1.0 ]\n*\n* @example\n* var floor = require( '@stdlib/math-base-special-floor' );\n* var gcusumpw = require( '@stdlib/blas-ext-base-gcusumpw' );\n*\n* var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ];\n* var y = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];\n* var N = floor( x.length / 2 );\n*\n* gcusumpw.ndarray( N, 0.0, x, 2, 1, y, 1, 0 );\n* // y => [ 1.0, -1.0, 1.0, 5.0, 0.0, 0.0, 0.0, 0.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"],
+  "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAQ,QAAS,iCAAkC,EAMnDC,EAAY,IAoChB,SAASC,EAAUC,EAAGC,EAAKC,EAAGC,EAASC,EAASC,EAAGC,EAASC,EAAU,CACrE,IAAIC,EACAC,EACAC,EACAC,EACAC,EAEJ,GAAKZ,GAAK,EACT,OAAOK,EAIR,GAFAG,EAAKJ,EACLK,EAAKF,EACAP,GAAKF,EAAY,CAErB,IADAY,EAAI,EACEE,EAAI,EAAGA,EAAIZ,EAAGY,IACnBF,GAAKR,EAAGM,CAAG,EACXH,EAAGI,CAAG,EAAIR,EAAMS,EAChBF,GAAML,EACNM,GAAMH,EAEP,OAAOD,CACR,CACA,OAAAM,EAAId,EAAOG,EAAE,CAAE,EACfD,EAAUY,EAAGV,EAAKC,EAAGC,EAASK,EAAIH,EAAGC,EAASG,CAAG,EACjDA,IAAOE,EAAE,GAAKL,EACdP,EAAUC,EAAEW,EAAGN,EAAGI,CAAG,EAAGP,EAAGC,EAASK,EAAIG,EAAER,EAAUE,EAAGC,EAASG,EAAGH,CAAQ,EACpED,CACR,CAKAT,EAAO,QAAUG,IChGjB,IAAAc,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAQ,IA+BZ,SAASC,EAAUC,EAAGC,EAAKC,EAAGC,EAASC,EAAGC,EAAU,CACnD,IAAIC,EACAC,EAEJ,OAAKP,GAAK,EACFI,GAEHD,EAAU,EACdG,GAAM,EAAEN,GAAKG,EAEbG,EAAK,EAEDD,EAAU,EACdE,GAAM,EAAEP,GAAKK,EAEbE,EAAK,EAECT,EAAOE,EAAGC,EAAKC,EAAGC,EAASG,EAAIF,EAAGC,EAASE,CAAG,EACtD,CAKAV,EAAO,QAAUE,IC5BjB,IAAIS,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD",
+  "names": ["require_ndarray", "__commonJSMin", "exports", "module", "floor", "BLOCKSIZE", "gcusumpw", "N", "sum", "x", "strideX", "offsetX", "y", "strideY", "offsetY", "ix", "iy", "s", "n", "i", "require_main", "__commonJSMin", "exports", "module", "cusum", "gcusumpw", "N", "sum", "x", "strideX", "y", "strideY", "ix", "iy", "setReadOnly", "main", "ndarray"]
+}

package/docs/types/index.d.ts

@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /// <reference types="@stdlib/types"/>
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/blas-ext-base-gcusumpw",
-  "version": "0.0.9",
+  "version": "0.1.0",
   "description": "Calculate the cumulative sum of strided array elements using pairwise summation.",
   "license": "Apache-2.0",
   "author": {
@@ -37,21 +37,21 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/math-base-special-floor": "^0.0.x",
-    "@stdlib/types": "^0.0.x",
-    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x"
+    "@stdlib/math-base-special-floor": "^0.1.0",
+    "@stdlib/types": "^0.1.0",
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0"
   },
   "devDependencies": {
-    "@stdlib/array-float64": "^0.0.x",
-    "@stdlib/bench": "^0.0.x",
-    "@stdlib/blas-ext-base-gfill": "^0.0.x",
-    "@stdlib/math-base-assert-is-nan": "^0.0.x",
-    "@stdlib/math-base-special-pow": "^0.0.x",
-    "@stdlib/math-base-special-round": "^0.0.x",
-    "@stdlib/random-base-randu": "^0.0.x",
+    "@stdlib/array-float64": "^0.1.0",
+    "@stdlib/bench": "^0.1.0",
+    "@stdlib/blas-ext-base-gfill": "^0.0.10",
+    "@stdlib/math-base-assert-is-nan": "^0.1.0",
+    "@stdlib/math-base-special-pow": "^0.0.7",
+    "@stdlib/math-base-special-round": "^0.1.0",
+    "@stdlib/random-base-randu": "^0.0.8",
     "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
     "istanbul": "^0.4.1",
-    "tap-spec": "5.x.x"
+    "tap-min": "git+https://github.com/Planeshifter/tap-min.git"
   },
   "engines": {
     "node": ">=0.10.0",
@@ -90,7 +90,7 @@
   ],
   "__stdlib__": {},
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/docs/repl.txt

@@ -1,121 +0,0 @@
-
-{{alias}}( N, sum, x, strideX, y, strideY )
-    Computes the cumulative sum of strided array elements using pairwise
-    summation.
-
-    The `N` and `stride` parameters determine which elements in `x` and `y` are
-    accessed at runtime.
-
-    Indexing is relative to the first index. To introduce an offset, use a typed
-    array view.
-
-    If `N <= 0`, the function returns `y` unchanged.
-
-    Parameters
-    ----------
-    N: integer
-        Number of indexed elements.
-
-    sum: number
-        Initial sum.
-
-    x: Array<number>|TypedArray
-        Input array.
-
-    strideX: integer
-        Index increment for `x`.
-
-    y: Array<number>|TypedArray
-        Output array.
-
-    strideY: integer
-        Index increment for `y`.
-
-    Returns
-    -------
-    out: Array<number>|TypedArray
-        Output array.
-
-    Examples
-    --------
-    // Standard Usage:
-    > var x = [ 1.0, -2.0, 2.0 ];
-    > var y = [ 0.0, 0.0, 0.0 ];
-    > {{alias}}( x.length, 0.0, x, 1, y, 1 )
-    [ 1.0, -1.0, 1.0 ]
-
-    // Using `N` and `stride` parameters:
-    > x = [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ];
-    > y = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
-    > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
-    > {{alias}}( N, 0.0, x, 2, y, 2 )
-    [ -2.0, 0.0, -1.0, 0.0, 1.0, 0.0 ]
-
-    // Using view offsets:
-    > var x0 = new {{alias:@stdlib/array/float64}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] );
-    > var y0 = new {{alias:@stdlib/array/float64}}( x0.length );
-    > var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 );
-    > var y1 = new {{alias:@stdlib/array/float64}}( y0.buffer, y0.BYTES_PER_ELEMENT*3 );
-    > N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 );
-    > {{alias}}( N, 0.0, x1, 2, y1, 1 )
-    <Float64Array>[ -2.0, 0.0, -1.0 ]
-    > y0
-    <Float64Array>[ 0.0, 0.0, 0.0, -2.0, 0.0, -1.0 ]
-
-{{alias}}.ndarray( N, sum, x, strideX, offsetX, y, strideY, offsetY )
-    Computes the cumulative sum of strided array elements using pairwise
-    summation and alternative indexing semantics.
-
-    While typed array views mandate a view offset based on the underlying
-    buffer, the `offset` parameter supports indexing semantics based on a
-    starting index.
-
-    Parameters
-    ----------
-    N: integer
-        Number of indexed elements.
-
-    sum: number
-        Initial sum.
-
-    x: Array<number>|TypedArray
-        Input array.
-
-    strideX: integer
-        Index increment for `x`.
-
-    offsetX: integer
-        Starting index for `x`.
-
-    y: Array<number>|TypedArray
-        Output array.
-
-    strideY: integer
-        Index increment for `y`.
-
-    offsetY: integer
-        Starting index for `y`.
-
-    Returns
-    -------
-    out: Array<number>|TypedArray
-        Output array.
-
-    Examples
-    --------
-    // Standard Usage:
-    > var x = [ 1.0, -2.0, 2.0 ];
-    > var y = [ 0.0, 0.0, 0.0 ];
-    > {{alias}}.ndarray( x.length, 0.0, x, 1, 0, y, 1, 0 )
-    <Float64Array>[ 1.0, -1.0, 1.0 ]
-
-    // Advanced indexing:
-    > x = [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ];
-    > y = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
-    > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 );
-    > {{alias}}.ndarray( N, 0.0, x, 2, 1, y, -1, y.length-1 )
-    <Float64Array>[ 0.0, 0.0, 0.0, -1.0, 0.0, -2.0 ]
-
-    See Also
-    --------
-

package/docs/types/test.ts

@@ -1,280 +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.
-*/
-
-import gcusumpw = require( './index' );
-
-
-// TESTS //
-
-// The function returns a numeric array...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	gcusumpw( x.length, 0.0, x, 1, y, 1 ); // $ExpectType NumericArray
-}
-
-// The compiler throws an error if the function is provided a first argument which is not a number...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	gcusumpw( '10', 0.0, x, 1, y, 1 ); // $ExpectError
-	gcusumpw( true, 0.0, x, 1, y, 1 ); // $ExpectError
-	gcusumpw( false, 0.0, x, 1, y, 1 ); // $ExpectError
-	gcusumpw( null, 0.0, x, 1, y, 1 ); // $ExpectError
-	gcusumpw( undefined, 0.0, x, 1, y, 1 ); // $ExpectError
-	gcusumpw( [], 0.0, x, 1, y, 1 ); // $ExpectError
-	gcusumpw( {}, 0.0, x, 1, y, 1 ); // $ExpectError
-	gcusumpw( ( x: number ): number => x, 0.0, x, 1, y, 1 ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a second argument which is not a number...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	gcusumpw( x.length, '10', 0.0, x, 1, y, 1 ); // $ExpectError
-	gcusumpw( x.length, true, 0.0, x, 1, y, 1 ); // $ExpectError
-	gcusumpw( x.length, false, 0.0, x, 1, y, 1 ); // $ExpectError
-	gcusumpw( x.length, null, 0.0, x, 1, y, 1 ); // $ExpectError
-	gcusumpw( x.length, undefined, 0.0, x, 1, y, 1 ); // $ExpectError
-	gcusumpw( x.length, [], 0.0, x, 1, y, 1 ); // $ExpectError
-	gcusumpw( x.length, {}, 0.0, x, 1, y, 1 ); // $ExpectError
-	gcusumpw( x.length, ( x: number ): number => x, 0.0, x, 1, y, 1 ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a third argument which is not a numeric array...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	gcusumpw( x.length, 0.0, 10, 1, y, 1 ); // $ExpectError
-	gcusumpw( x.length, 0.0, '10', 1, y, 1 ); // $ExpectError
-	gcusumpw( x.length, 0.0, true, 1, y, 1 ); // $ExpectError
-	gcusumpw( x.length, 0.0, false, 1, y, 1 ); // $ExpectError
-	gcusumpw( x.length, 0.0, null, 1, y, 1 ); // $ExpectError
-	gcusumpw( x.length, 0.0, undefined, 1, y, 1 ); // $ExpectError
-	gcusumpw( x.length, 0.0, [ '1' ], 1, y, 1 ); // $ExpectError
-	gcusumpw( x.length, 0.0, {}, 1, y, 1 ); // $ExpectError
-	gcusumpw( x.length, 0.0, ( x: number ): number => x, 1, y, 1 ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a fourth argument which is not a number...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	gcusumpw( x.length, 0.0, x, '10', y, 1 ); // $ExpectError
-	gcusumpw( x.length, 0.0, x, true, y, 1 ); // $ExpectError
-	gcusumpw( x.length, 0.0, x, false, y, 1 ); // $ExpectError
-	gcusumpw( x.length, 0.0, x, null, y, 1 ); // $ExpectError
-	gcusumpw( x.length, 0.0, x, undefined, y, 1 ); // $ExpectError
-	gcusumpw( x.length, 0.0, x, [], y, 1 ); // $ExpectError
-	gcusumpw( x.length, 0.0, x, {}, y, 1 ); // $ExpectError
-	gcusumpw( x.length, 0.0, x, ( x: number ): number => x, y, 1 ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a fifth argument which is not a numeric array...
-{
-	const x = new Float64Array( 10 );
-
-	gcusumpw( x.length, 0.0, x, 1, 10, 1 ); // $ExpectError
-	gcusumpw( x.length, 0.0, x, 1, '10', 1 ); // $ExpectError
-	gcusumpw( x.length, 0.0, x, 1, true, 1 ); // $ExpectError
-	gcusumpw( x.length, 0.0, x, 1, false, 1 ); // $ExpectError
-	gcusumpw( x.length, 0.0, x, 1, null, 1 ); // $ExpectError
-	gcusumpw( x.length, 0.0, x, 1, undefined, 1 ); // $ExpectError
-	gcusumpw( x.length, 0.0, x, 1, [ '1' ], 1 ); // $ExpectError
-	gcusumpw( x.length, 0.0, x, 1, {}, 1 ); // $ExpectError
-	gcusumpw( x.length, 0.0, x, 1, ( x: number ): number => x, 1 ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a sixth argument which is not a number...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	gcusumpw( x.length, 0.0, x, 1, y, '10' ); // $ExpectError
-	gcusumpw( x.length, 0.0, x, 1, y, true ); // $ExpectError
-	gcusumpw( x.length, 0.0, x, 1, y, false ); // $ExpectError
-	gcusumpw( x.length, 0.0, x, 1, y, null ); // $ExpectError
-	gcusumpw( x.length, 0.0, x, 1, y, undefined ); // $ExpectError
-	gcusumpw( x.length, 0.0, x, 1, y, [] ); // $ExpectError
-	gcusumpw( x.length, 0.0, x, 1, y, {} ); // $ExpectError
-	gcusumpw( x.length, 0.0, x, 1, y, ( x: number ): number => x ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided an unsupported number of arguments...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	gcusumpw(); // $ExpectError
-	gcusumpw( x.length ); // $ExpectError
-	gcusumpw( x.length, 0.0 ); // $ExpectError
-	gcusumpw( x.length, 0.0, x ); // $ExpectError
-	gcusumpw( x.length, 0.0, x, 1 ); // $ExpectError
-	gcusumpw( x.length, 0.0, x, 1, y ); // $ExpectError
-	gcusumpw( x.length, 0.0, x, 1, y, 1, 10 ); // $ExpectError
-}
-
-// Attached to main export is an `ndarray` method which returns a numeric array...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	gcusumpw.ndarray( x.length, 0.0, x, 1, 0, y, 1, 0 ); // $ExpectType NumericArray
-}
-
-// The compiler throws an error if the `ndarray` method is provided a first argument which is not a number...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	gcusumpw.ndarray( '10', 0.0, x, 1, 0, y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( true, 0.0, x, 1, 0, y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( false, 0.0, x, 1, 0, y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( null, 0.0, x, 1, 0, y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( undefined, 0.0, x, 1, 0, y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( [], 0.0, x, 1, 0, y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( {}, 0.0, x, 1, 0, y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( ( x: number ): number => x, 0.0, x, 1, 0, y, 1, 0 ); // $ExpectError
-}
-
-// The compiler throws an error if the `ndarray` method is provided a second argument which is not a number...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	gcusumpw.ndarray( x.length, '10', 0.0, x, 1, 0, y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, true, 0.0, x, 1, 0, y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, false, 0.0, x, 1, 0, y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, null, 0.0, x, 1, 0, y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, undefined, 0.0, x, 1, 0, y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, [], 0.0, x, 1, 0, y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, {}, 0.0, x, 1, 0, y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, ( x: number ): number => x, 0.0, x, 1, 0, y, 1, 0 ); // $ExpectError
-}
-
-// The compiler throws an error if the `ndarray` method is provided a third argument which is not a numeric array...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	gcusumpw.ndarray( x.length, 0.0, 10, 1, 0, y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, '10', 1, 0, y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, true, 1, 0, y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, false, 1, 0, y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, null, 1, 0, y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, undefined, 1, 0, y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, [ '1' ], 1, 0, y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, {}, 1, 0, y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, ( x: number ): number => x, 1, 0, y, 1, 0 ); // $ExpectError
-}
-
-// The compiler throws an error if the `ndarray` method is provided a fourth argument which is not a number...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	gcusumpw.ndarray( x.length, 0.0, x, '10', 0, y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, true, 0, y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, false, 0, y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, null, 0, y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, undefined, 0, y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, [], 0, y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, {}, 0, y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, ( x: number ): number => x, 0, y, 1, 0 ); // $ExpectError
-}
-
-// The compiler throws an error if the `ndarray` method is provided a fifth argument which is not a number...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	gcusumpw.ndarray( x.length, 0.0, x, 1, '10', y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, 1, true, y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, 1, false, y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, 1, null, y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, 1, undefined, y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, 1, [], y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, 1, {}, y, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, 1, ( x: number ): number => x, y, 1, 0 ); // $ExpectError
-}
-
-// The compiler throws an error if the `ndarray` method is provided a sixth argument which is not a numeric array...
-{
-	const x = new Float64Array( 10 );
-
-	gcusumpw.ndarray( x.length, 0.0, x, 1, 0, 10, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, 1, 0, '10', 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, 1, 0, true, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, 1, 0, false, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, 1, 0, null, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, 1, 0, undefined, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, 1, 0, [ '1' ], 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, 1, 0, {}, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, 1, 0, ( x: number ): number => x, 1, 0 ); // $ExpectError
-}
-
-// The compiler throws an error if the `ndarray` method is provided a seventh argument which is not a number...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	gcusumpw.ndarray( x.length, 0.0, x, 1, 0, y, '10', 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, 1, 0, y, true, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, 1, 0, y, false, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, 1, 0, y, null, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, 1, 0, y, undefined, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, 1, 0, y, [], 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, 1, 0, y, {}, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, 1, 0, y, ( x: number ): number => x, 0 ); // $ExpectError
-}
-
-// The compiler throws an error if the `ndarray` method is provided an eighth argument which is not a number...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	gcusumpw.ndarray( x.length, 0.0, x, 1, 0, y, 1, '10' ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, 1, 0, y, 1, true ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, 1, 0, y, 1, false ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, 1, 0, y, 1, null ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, 1, 0, y, 1, undefined ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, 1, 0, y, 1, [] ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, 1, 0, y, 1, {} ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, 1, 0, y, 1, ( x: number ): number => x ); // $ExpectError
-}
-
-// The compiler throws an error if the `ndarray` method is provided an unsupported number of arguments...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	gcusumpw.ndarray(); // $ExpectError
-	gcusumpw.ndarray( x.length ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, 1 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, 1, 0 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, 1, 0, y ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, 1, 0, y, 1 ); // $ExpectError
-	gcusumpw.ndarray( x.length, 0.0, x, 1, 0, y, 1, 0, 10 ); // $ExpectError
-}