@stdlib/stats-base-cumax 0.0.8 → 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>
+
 # cumax
 
 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
@@ -185,9 +196,9 @@ console.log( y );
 
 ## See Also
 
--   <span class="package-name">[`@stdlib/stats/base/cumin`][@stdlib/stats/base/cumin]</span><span class="delimiter">: </span><span class="description">calculate the cumulative minimum of a strided array.</span>
--   <span class="package-name">[`@stdlib/stats/base/dcumax`][@stdlib/stats/base/dcumax]</span><span class="delimiter">: </span><span class="description">calculate the cumulative maximum of double-precision floating-point strided array elements.</span>
--   <span class="package-name">[`@stdlib/stats/base/scumax`][@stdlib/stats/base/scumax]</span><span class="delimiter">: </span><span class="description">calculate the cumulative maximum of single-precision floating-point strided array elements.</span>
+-   <span class="package-name">[`@stdlib/stats-base/cumin`][@stdlib/stats/base/cumin]</span><span class="delimiter">: </span><span class="description">calculate the cumulative minimum of a strided array.</span>
+-   <span class="package-name">[`@stdlib/stats-base/dcumax`][@stdlib/stats/base/dcumax]</span><span class="delimiter">: </span><span class="description">calculate the cumulative maximum of double-precision floating-point strided array elements.</span>
+-   <span class="package-name">[`@stdlib/stats-base/scumax`][@stdlib/stats/base/scumax]</span><span class="delimiter">: </span><span class="description">calculate the cumulative maximum of single-precision floating-point strided array elements.</span>
 
 </section>
 
@@ -219,7 +230,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>
 
@@ -232,8 +243,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-cumax.svg
 [npm-url]: https://npmjs.org/package/@stdlib/stats-base-cumax
 
-[test-image]: https://github.com/stdlib-js/stats-base-cumax/actions/workflows/test.yml/badge.svg?branch=v0.0.8
-[test-url]: https://github.com/stdlib-js/stats-base-cumax/actions/workflows/test.yml?query=branch:v0.0.8
+[test-image]: https://github.com/stdlib-js/stats-base-cumax/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/stats-base-cumax/actions/workflows/test.yml?query=branch:v0.1.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-cumax/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-cumax?branch=main
@@ -246,7 +257,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 cumax from '../docs/types/index';
+export = cumax;

package/dist/index.js

@@ -0,0 +1,9 @@
+"use strict";var x=function(v,f){return function(){return f||v((f={exports:{}}).exports,f),f.exports}};var p=x(function(C,l){
+var q=require('@stdlib/math-base-assert-is-nan/dist'),R=require('@stdlib/math-base-assert-is-positive-zero/dist');function g(v,f,c,n,u){var e,s,r,i,a;if(v<=0)return n;if(c<0?s=(1-v)*c:s=0,u<0?r=(1-v)*u:r=0,e=f[s],n[r]=e,r+=u,a=1,q(e)===!1)for(a;a<v;a++){if(s+=c,i=f[s],q(i)){e=i;break}(i>e||i===e&&R(i))&&(e=i),n[r]=e,r+=u}if(q(e))for(a;a<v;a++)n[r]=e,r+=u;return n}l.exports=g
+});var k=x(function(D,b){
+var m=require('@stdlib/math-base-assert-is-nan/dist'),h=require('@stdlib/math-base-assert-is-positive-zero/dist');function j(v,f,c,n,u,e,s){var r,i,a,o,t;if(v<=0)return u;if(i=n,a=s,r=f[i],u[a]=r,a+=e,t=1,m(r)===!1)for(t;t<v;t++){if(i+=c,o=f[i],m(o)){r=o;break}(o>r||o===r&&h(o))&&(r=o),u[a]=r,a+=e}if(m(r))for(t;t<v;t++)u[a]=r,a+=e;return u}b.exports=j
+});var O=x(function(E,Z){
+var w=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),P=p(),z=k();w(P,"ndarray",z);Z.exports=P
+});var A=O();module.exports=A;
+/** @license Apache-2.0 */
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../lib/cumax.js", "../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 isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar isPositiveZero = require( '@stdlib/math-base-assert-is-positive-zero' );\n\n\n// MAIN //\n\n/**\n* Computes the cumulative maximum of a strided array.\n*\n* @param {PositiveInteger} N - number of indexed elements\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* var N = x.length;\n*\n* var v = cumax( N, x, 1, y, 1 );\n* // returns [ 1.0, 1.0, 2.0 ]\n*/\nfunction cumax( N, x, strideX, y, strideY ) {\n\tvar max;\n\tvar ix;\n\tvar iy;\n\tvar v;\n\tvar i;\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\tmax = x[ ix ];\n\ty[ iy ] = max;\n\n\tiy += strideY;\n\ti = 1;\n\tif ( isnan( max ) === false ) {\n\t\tfor ( i; i < N; i++ ) {\n\t\t\tix += strideX;\n\t\t\tv = x[ ix ];\n\t\t\tif ( isnan( v ) ) {\n\t\t\t\tmax = v;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tif ( v > max || ( v === max && isPositiveZero( v ) ) ) {\n\t\t\t\tmax = v;\n\t\t\t}\n\t\t\ty[ iy ] = max;\n\t\t\tiy += strideY;\n\t\t}\n\t}\n\tif ( isnan( max ) ) {\n\t\tfor ( i; i < N; i++ ) {\n\t\t\ty[ iy ] = max;\n\t\t\tiy += strideY;\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = cumax;\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 isPositiveZero = require( '@stdlib/math-base-assert-is-positive-zero' );\n\n\n// MAIN //\n\n/**\n* Computes the cumulative maximum of a strided array.\n*\n* @param {PositiveInteger} N - number of indexed elements\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* var v = cumax( N, x, 2, 1, y, 1, 0 );\n* // returns [ 1.0, 1.0, 2.0, 4.0, 0.0, 0.0, 0.0, 0.0 ]\n*/\nfunction cumax( N, x, strideX, offsetX, y, strideY, offsetY ) {\n\tvar max;\n\tvar ix;\n\tvar iy;\n\tvar v;\n\tvar i;\n\n\tif ( N <= 0 ) {\n\t\treturn y;\n\t}\n\tix = offsetX;\n\tiy = offsetY;\n\n\tmax = x[ ix ];\n\ty[ iy ] = max;\n\n\tiy += strideY;\n\ti = 1;\n\tif ( isnan( max ) === false ) {\n\t\tfor ( i; i < N; i++ ) {\n\t\t\tix += strideX;\n\t\t\tv = x[ ix ];\n\t\t\tif ( isnan( v ) ) {\n\t\t\t\tmax = v;\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tif ( v > max || ( v === max && isPositiveZero( v ) ) ) {\n\t\t\t\tmax = v;\n\t\t\t}\n\t\t\ty[ iy ] = max;\n\t\t\tiy += strideY;\n\t\t}\n\t}\n\tif ( isnan( max ) ) {\n\t\tfor ( i; i < N; i++ ) {\n\t\t\ty[ iy ] = max;\n\t\t\tiy += strideY;\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = cumax;\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 setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar cumax = require( './cumax.js' );\nvar ndarray = require( './ndarray.js' );\n\n\n// MAIN //\n\nsetReadOnly( cumax, 'ndarray', ndarray );\n\n\n// EXPORTS //\n\nmodule.exports = cumax;\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 maximum of a strided array.\n*\n* @module @stdlib/stats-base-cumax\n*\n* @example\n* var cumax = require( '@stdlib/stats-base-cumax' );\n*\n* var x = [ 1.0, -2.0, 2.0 ];\n* var y = [ 0.0, 0.0, 0.0 ];\n* var N = x.length;\n*\n* cumax( N, x, 1, y, 1 );\n* // y => [ 1.0, 1.0, 2.0 ]\n*\n* @example\n* var floor = require( '@stdlib/math-base-special-floor' );\n* var cumax = require( '@stdlib/stats-base-cumax' );\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* cumax.ndarray( N, x, 2, 1, y, 1, 0 );\n* // y => [ 1.0, 1.0, 2.0, 4.0, 0.0, 0.0, 0.0, 0.0 ]\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n\n// exports: { \"ndarray\": \"main.ndarray\" }\n"],
+  "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAQ,QAAS,iCAAkC,EACnDC,EAAiB,QAAS,2CAA4C,EAuB1E,SAASC,EAAOC,EAAGC,EAAGC,EAASC,EAAGC,EAAU,CAC3C,IAAIC,EACAC,EACAC,EACAC,EACAC,EAEJ,GAAKT,GAAK,EACT,OAAOG,EAiBR,GAfKD,EAAU,EACdI,GAAM,EAAEN,GAAKE,EAEbI,EAAK,EAEDF,EAAU,EACdG,GAAM,EAAEP,GAAKI,EAEbG,EAAK,EAENF,EAAMJ,EAAGK,CAAG,EACZH,EAAGI,CAAG,EAAIF,EAEVE,GAAMH,EACNK,EAAI,EACCZ,EAAOQ,CAAI,IAAM,GACrB,IAAMI,EAAGA,EAAIT,EAAGS,IAAM,CAGrB,GAFAH,GAAMJ,EACNM,EAAIP,EAAGK,CAAG,EACLT,EAAOW,CAAE,EAAI,CACjBH,EAAMG,EACN,KACD,EACKA,EAAIH,GAASG,IAAMH,GAAOP,EAAgBU,CAAE,KAChDH,EAAMG,GAEPL,EAAGI,CAAG,EAAIF,EACVE,GAAMH,CACP,CAED,GAAKP,EAAOQ,CAAI,EACf,IAAMI,EAAGA,EAAIT,EAAGS,IACfN,EAAGI,CAAG,EAAIF,EACVE,GAAMH,EAGR,OAAOD,CACR,CAKAP,EAAO,QAAUG,IClGjB,IAAAW,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAQ,QAAS,iCAAkC,EACnDC,EAAiB,QAAS,2CAA4C,EA2B1E,SAASC,EAAOC,EAAGC,EAAGC,EAASC,EAASC,EAAGC,EAASC,EAAU,CAC7D,IAAIC,EACAC,EACAC,EACAC,EACAC,EAEJ,GAAKX,GAAK,EACT,OAAOI,EAUR,GARAI,EAAKL,EACLM,EAAKH,EAELC,EAAMN,EAAGO,CAAG,EACZJ,EAAGK,CAAG,EAAIF,EAEVE,GAAMJ,EACNM,EAAI,EACCd,EAAOU,CAAI,IAAM,GACrB,IAAMI,EAAGA,EAAIX,EAAGW,IAAM,CAGrB,GAFAH,GAAMN,EACNQ,EAAIT,EAAGO,CAAG,EACLX,EAAOa,CAAE,EAAI,CACjBH,EAAMG,EACN,KACD,EACKA,EAAIH,GAASG,IAAMH,GAAOT,EAAgBY,CAAE,KAChDH,EAAMG,GAEPN,EAAGK,CAAG,EAAIF,EACVE,GAAMJ,CACP,CAED,GAAKR,EAAOU,CAAI,EACf,IAAMI,EAAGA,EAAIX,EAAGW,IACfP,EAAGK,CAAG,EAAIF,EACVE,GAAMJ,EAGR,OAAOD,CACR,CAKAR,EAAO,QAAUG,IC/FjB,IAAAa,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAQ,IACRC,EAAU,IAKdF,EAAaC,EAAO,UAAWC,CAAQ,EAKvCH,EAAO,QAAUE,ICejB,IAAIE,EAAO,IAKX,OAAO,QAAUA",
+  "names": ["require_cumax", "__commonJSMin", "exports", "module", "isnan", "isPositiveZero", "cumax", "N", "x", "strideX", "y", "strideY", "max", "ix", "iy", "v", "i", "require_ndarray", "__commonJSMin", "exports", "module", "isnan", "isPositiveZero", "cumax", "N", "x", "strideX", "offsetX", "y", "strideY", "offsetY", "max", "ix", "iy", "v", "i", "require_main", "__commonJSMin", "exports", "module", "setReadOnly", "cumax", "ndarray", "main"]
+}

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/lib/index.js

@@ -47,9 +47,11 @@
 
 // MODULES //
 
-var cumax = require( './main.js' );
+var main = require( './main.js' );
 
 
 // EXPORTS //
 
-module.exports = cumax;
+module.exports = main;
+
+// exports: { "ndarray": "main.ndarray" }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/stats-base-cumax",
-  "version": "0.0.8",
+  "version": "0.1.0",
   "description": "Calculate the cumulative maximum of a strided array.",
   "license": "Apache-2.0",
   "author": {
@@ -37,22 +37,22 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/math-base-assert-is-nan": "^0.0.x",
-    "@stdlib/math-base-assert-is-positive-zero": "^0.0.x",
-    "@stdlib/types": "^0.0.x",
-    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x"
+    "@stdlib/math-base-assert-is-nan": "^0.1.0",
+    "@stdlib/math-base-assert-is-positive-zero": "^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/math-base-assert-is-negative-zero": "^0.0.x",
-    "@stdlib/math-base-special-floor": "^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.0.6",
+    "@stdlib/bench": "^0.1.0",
+    "@stdlib/math-base-assert-is-negative-zero": "^0.0.8",
+    "@stdlib/math-base-special-floor": "^0.0.8",
+    "@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,114 +0,0 @@
-
-{{alias}}( N, x, strideX, y, strideY )
-    Computes the cumulative maximum of a strided array.
-
-    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.
-
-    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, x, 1, y, 1 )
-    [ 1.0, 1.0, 2.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, x, 2, y, 2 )
-    [ -2.0, 0.0, 1.0, 0.0, 2.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, x1, 2, y1, 1 )
-    <Float64Array>[ -2.0, 2.0, 2.0 ]
-    > y0
-    <Float64Array>[ 0.0, 0.0, 0.0, -2.0, 2.0, 2.0 ]
-
-{{alias}}.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )
-    Computes the cumulative maximum of a strided array using 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.
-
-    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, x, 1, 0, y, 1, 0 )
-    [ 1.0, 1.0, 2.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, x, 2, 1, y, -1, y.length-1 )
-    [ 0.0, 0.0, 0.0, 2.0, 2.0, -2.0 ]
-
-    See Also
-    --------
-

package/docs/types/test.ts

@@ -1,248 +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 cumax = require( './index' );
-
-
-// TESTS //
-
-// The function returns a numeric array...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	cumax( x.length, 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 );
-
-	cumax( '10', x, 1, y, 1 ); // $ExpectError
-	cumax( true, x, 1, y, 1 ); // $ExpectError
-	cumax( false, x, 1, y, 1 ); // $ExpectError
-	cumax( null, x, 1, y, 1 ); // $ExpectError
-	cumax( undefined, x, 1, y, 1 ); // $ExpectError
-	cumax( [], x, 1, y, 1 ); // $ExpectError
-	cumax( {}, x, 1, y, 1 ); // $ExpectError
-	cumax( ( x: number ): number => x, x, 1, y, 1 ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a second argument which is not a numeric array...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	cumax( x.length, 10, 1, y, 1 ); // $ExpectError
-	cumax( x.length, '10', 1, y, 1 ); // $ExpectError
-	cumax( x.length, true, 1, y, 1 ); // $ExpectError
-	cumax( x.length, false, 1, y, 1 ); // $ExpectError
-	cumax( x.length, null, 1, y, 1 ); // $ExpectError
-	cumax( x.length, undefined, 1, y, 1 ); // $ExpectError
-	cumax( x.length, [ '1' ], 1, y, 1 ); // $ExpectError
-	cumax( x.length, {}, 1, y, 1 ); // $ExpectError
-	cumax( x.length, ( x: number ): number => x, 1, y, 1 ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a third argument which is not a number...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	cumax( x.length, x, '10', y, 1 ); // $ExpectError
-	cumax( x.length, x, true, y, 1 ); // $ExpectError
-	cumax( x.length, x, false, y, 1 ); // $ExpectError
-	cumax( x.length, x, null, y, 1 ); // $ExpectError
-	cumax( x.length, x, undefined, y, 1 ); // $ExpectError
-	cumax( x.length, x, [], y, 1 ); // $ExpectError
-	cumax( x.length, x, {}, y, 1 ); // $ExpectError
-	cumax( x.length, x, ( x: number ): number => x, y, 1 ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a fourth argument which is not a numeric array...
-{
-	const x = new Float64Array( 10 );
-
-	cumax( x.length, x, 1, 10, 1 ); // $ExpectError
-	cumax( x.length, x, 1, '10', 1 ); // $ExpectError
-	cumax( x.length, x, 1, true, 1 ); // $ExpectError
-	cumax( x.length, x, 1, false, 1 ); // $ExpectError
-	cumax( x.length, x, 1, null, 1 ); // $ExpectError
-	cumax( x.length, x, 1, undefined, 1 ); // $ExpectError
-	cumax( x.length, x, 1, [ '1' ], 1 ); // $ExpectError
-	cumax( x.length, x, 1, {}, 1 ); // $ExpectError
-	cumax( x.length, x, 1, ( x: number ): number => x, 1 ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided a fifth argument which is not a number...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	cumax( x.length, x, 1, y, '10' ); // $ExpectError
-	cumax( x.length, x, 1, y, true ); // $ExpectError
-	cumax( x.length, x, 1, y, false ); // $ExpectError
-	cumax( x.length, x, 1, y, null ); // $ExpectError
-	cumax( x.length, x, 1, y, undefined ); // $ExpectError
-	cumax( x.length, x, 1, y, [] ); // $ExpectError
-	cumax( x.length, x, 1, y, {} ); // $ExpectError
-	cumax( x.length, 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 );
-
-	cumax(); // $ExpectError
-	cumax( x.length ); // $ExpectError
-	cumax( x.length, x ); // $ExpectError
-	cumax( x.length, x, 1 ); // $ExpectError
-	cumax( x.length, x, 1, y ); // $ExpectError
-	cumax( x.length, 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 );
-
-	cumax.ndarray( x.length, 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 );
-
-	cumax.ndarray( '10', x, 1, 0, y, 1, 0 ); // $ExpectError
-	cumax.ndarray( true, x, 1, 0, y, 1, 0 ); // $ExpectError
-	cumax.ndarray( false, x, 1, 0, y, 1, 0 ); // $ExpectError
-	cumax.ndarray( null, x, 1, 0, y, 1, 0 ); // $ExpectError
-	cumax.ndarray( undefined, x, 1, 0, y, 1, 0 ); // $ExpectError
-	cumax.ndarray( [], x, 1, 0, y, 1, 0 ); // $ExpectError
-	cumax.ndarray( {}, x, 1, 0, y, 1, 0 ); // $ExpectError
-	cumax.ndarray( ( x: number ): number => x, 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 numeric array...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	cumax.ndarray( x.length, 10, 1, 0, y, 1, 0 ); // $ExpectError
-	cumax.ndarray( x.length, '10', 1, 0, y, 1, 0 ); // $ExpectError
-	cumax.ndarray( x.length, true, 1, 0, y, 1, 0 ); // $ExpectError
-	cumax.ndarray( x.length, false, 1, 0, y, 1, 0 ); // $ExpectError
-	cumax.ndarray( x.length, null, 1, 0, y, 1, 0 ); // $ExpectError
-	cumax.ndarray( x.length, undefined, 1, 0, y, 1, 0 ); // $ExpectError
-	cumax.ndarray( x.length, [ '1' ], 1, 0, y, 1, 0 ); // $ExpectError
-	cumax.ndarray( x.length, {}, 1, 0, y, 1, 0 ); // $ExpectError
-	cumax.ndarray( x.length, ( x: number ): number => 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 number...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	cumax.ndarray( x.length, x, '10', 0, y, 1, 0 ); // $ExpectError
-	cumax.ndarray( x.length, x, true, 0, y, 1, 0 ); // $ExpectError
-	cumax.ndarray( x.length, x, false, 0, y, 1, 0 ); // $ExpectError
-	cumax.ndarray( x.length, x, null, 0, y, 1, 0 ); // $ExpectError
-	cumax.ndarray( x.length, x, undefined, 0, y, 1, 0 ); // $ExpectError
-	cumax.ndarray( x.length, x, [], 0, y, 1, 0 ); // $ExpectError
-	cumax.ndarray( x.length, x, {}, 0, y, 1, 0 ); // $ExpectError
-	cumax.ndarray( x.length, x, ( x: number ): number => x, 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 );
-
-	cumax.ndarray( x.length, x, 1, '10', y, 1, 0 ); // $ExpectError
-	cumax.ndarray( x.length, x, 1, true, y, 1, 0 ); // $ExpectError
-	cumax.ndarray( x.length, x, 1, false, y, 1, 0 ); // $ExpectError
-	cumax.ndarray( x.length, x, 1, null, y, 1, 0 ); // $ExpectError
-	cumax.ndarray( x.length, x, 1, undefined, y, 1, 0 ); // $ExpectError
-	cumax.ndarray( x.length, x, 1, [], y, 1, 0 ); // $ExpectError
-	cumax.ndarray( x.length, x, 1, {}, y, 1, 0 ); // $ExpectError
-	cumax.ndarray( x.length, x, 1, ( x: number ): number => x, y, 1, 0 ); // $ExpectError
-}
-
-// The compiler throws an error if the `ndarray` method is provided a fifth argument which is not a numeric array...
-{
-	const x = new Float64Array( 10 );
-
-	cumax.ndarray( x.length, x, 1, 0, 10, 1, 0 ); // $ExpectError
-	cumax.ndarray( x.length, x, 1, 0, '10', 1, 0 ); // $ExpectError
-	cumax.ndarray( x.length, x, 1, 0, true, 1, 0 ); // $ExpectError
-	cumax.ndarray( x.length, x, 1, 0, false, 1, 0 ); // $ExpectError
-	cumax.ndarray( x.length, x, 1, 0, null, 1, 0 ); // $ExpectError
-	cumax.ndarray( x.length, x, 1, 0, undefined, 1, 0 ); // $ExpectError
-	cumax.ndarray( x.length, x, 1, 0, [ '1' ], 1, 0 ); // $ExpectError
-	cumax.ndarray( x.length, x, 1, 0, {}, 1, 0 ); // $ExpectError
-	cumax.ndarray( x.length, x, 1, 0, ( x: number ): number => x, 1, 0 ); // $ExpectError
-}
-
-// The compiler throws an error if the `ndarray` method is provided a sixth argument which is not a number...
-{
-	const x = new Float64Array( 10 );
-	const y = new Float64Array( 10 );
-
-	cumax.ndarray( x.length, x, 1, 0, y, '10', 0 ); // $ExpectError
-	cumax.ndarray( x.length, x, 1, 0, y, true, 0 ); // $ExpectError
-	cumax.ndarray( x.length, x, 1, 0, y, false, 0 ); // $ExpectError
-	cumax.ndarray( x.length, x, 1, 0, y, null, 0 ); // $ExpectError
-	cumax.ndarray( x.length, x, 1, 0, y, undefined, 0 ); // $ExpectError
-	cumax.ndarray( x.length, x, 1, 0, y, [], 0 ); // $ExpectError
-	cumax.ndarray( x.length, x, 1, 0, y, {}, 0 ); // $ExpectError
-	cumax.ndarray( x.length, x, 1, 0, y, ( x: number ): number => x, 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 );
-
-	cumax.ndarray( x.length, x, 1, 0, y, 1, '10' ); // $ExpectError
-	cumax.ndarray( x.length, x, 1, 0, y, 1, true ); // $ExpectError
-	cumax.ndarray( x.length, x, 1, 0, y, 1, false ); // $ExpectError
-	cumax.ndarray( x.length, x, 1, 0, y, 1, null ); // $ExpectError
-	cumax.ndarray( x.length, x, 1, 0, y, 1, undefined ); // $ExpectError
-	cumax.ndarray( x.length, x, 1, 0, y, 1, [] ); // $ExpectError
-	cumax.ndarray( x.length, x, 1, 0, y, 1, {} ); // $ExpectError
-	cumax.ndarray( x.length, 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 );
-
-	cumax.ndarray(); // $ExpectError
-	cumax.ndarray( x.length ); // $ExpectError
-	cumax.ndarray( x.length, x ); // $ExpectError
-	cumax.ndarray( x.length, x, 1 ); // $ExpectError
-	cumax.ndarray( x.length, x, 1, 0 ); // $ExpectError
-	cumax.ndarray( x.length, x, 1, 0, y ); // $ExpectError
-	cumax.ndarray( x.length, x, 1, 0, y, 1 ); // $ExpectError
-	cumax.ndarray( x.length, x, 1, 0, y, 1, 0, 10 ); // $ExpectError
-}