@stdlib/stats-base-cumax 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.
 
 # cumax
 
-[![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 maximum of a strided array.
 
@@ -71,14 +71,10 @@ The function has the following parameters:
 The `N` and `stride` parameters determine which elements in `x` and `y` are accessed at runtime. For example, to compute the cumulative maximum of every other element in `x`,
 
 ```javascript
-var floor = require( '@stdlib/math-base-special-floor' );
-
 var x = [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ];
 var y = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
 
-var N = floor( x.length / 2 );
-
-var v = cumax( N, x, 2, y, 1 );
+var v = cumax( 4, x, 2, y, 1 );
 // y => [ 1.0, 2.0, 2.0, 4.0, 0.0, 0.0, 0.0, 0.0 ]
 ```
 
@@ -88,7 +84,6 @@ Note that indexing is relative to the first index. To introduce an offset, use [
 
 ```javascript
 var Float64Array = require( '@stdlib/array-float64' );
-var floor = require( '@stdlib/math-base-special-floor' );
 
 // Initial arrays...
 var x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );
@@ -98,10 +93,8 @@ var y0 = new Float64Array( x0.length );
 var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
 var y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); // start at 4th element
 
-var N = floor( x0.length / 2 );
-
-cumax( N, x1, -2, y1, 1 );
-// y0 => <Float64Array>[ 0.0, 0.0, 0.0, 0.0, 4.0, 4.0, 4.0, 4.0 ]
+cumax( 4, x1, -2, y1, 1 );
+// y0 => <Float64Array>[ 0.0, 0.0, 0.0, 4.0, 4.0, 4.0, 4.0, 0.0 ]
 ```
 
 #### cumax.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )
@@ -124,14 +117,10 @@ The function has the following additional parameters:
 While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, `offsetX` and `offsetY` parameters support indexing semantics based on a starting indices. For example, to calculate the cumulative maximum of every other value in `x` starting from the second value and to store in the last `N` elements of `y` starting from the last element
 
 ```javascript
-var floor = require( '@stdlib/math-base-special-floor' );
-
 var x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ];
 var y = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];
 
-var N = floor( x.length / 2 );
-
-cumax.ndarray( N, x, 2, 1, y, -1, y.length-1 );
+cumax.ndarray( 4, x, 2, 1, y, -1, y.length-1 );
 // y => [ 0.0, 0.0, 0.0, 0.0, 4.0, 2.0, 1.0, 1.0 ]
 ```
 
@@ -188,6 +177,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/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>
+
+<!-- /.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" >
 
@@ -199,6 +206,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
@@ -208,7 +219,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>
 
@@ -227,9 +238,23 @@ Copyright &copy; 2016-2021. The Stdlib [Authors][stdlib-authors].
 [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
 
-[dependencies-image]: https://img.shields.io/david/stdlib-js/stats-base-cumax
+<!--
+
+[dependencies-image]: https://img.shields.io/david/stdlib-js/stats-base-cumax.svg
 [dependencies-url]: https://david-dm.org/stdlib-js/stats-base-cumax/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/stats-base-cumax/tree/deno
+[umd-url]: https://github.com/stdlib-js/stats-base-cumax/tree/umd
+[esm-url]: https://github.com/stdlib-js/stats-base-cumax/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
@@ -240,9 +265,15 @@ 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/stats/base/dcumax]: https://github.com/stdlib-js/stats-base-dcumax
+<!-- <related-links> -->
+
+[@stdlib/stats/base/cumin]: https://www.npmjs.com/package/@stdlib/stats-base-cumin
+
+[@stdlib/stats/base/dcumax]: https://www.npmjs.com/package/@stdlib/stats-base-dcumax
+
+[@stdlib/stats/base/scumax]: https://www.npmjs.com/package/@stdlib/stats-base-scumax
 
-[@stdlib/stats/base/scumax]: https://github.com/stdlib-js/stats-base-scumax
+<!-- </related-links> -->
 
 </section>
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/stats-base-cumax",
-  "version": "0.0.3",
+  "version": "0.0.7",
   "description": "Calculate the cumulative maximum of a strided array.",
   "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/stats-base-cumax.git"

package/CHANGELOG.md

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