{"id":24194393,"url":"https://github.com/stdlib-js/stats-base-cumax","last_synced_at":"2025-07-26T13:33:30.135Z","repository":{"id":41362824,"uuid":"376890650","full_name":"stdlib-js/stats-base-cumax","owner":"stdlib-js","description":"Calculate the cumulative maximum of a strided array.","archived":false,"fork":false,"pushed_at":"2024-12-01T04:30:13.000Z","size":638,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-01-06T17:54:03.526Z","etag":null,"topics":["accumulate","array","cumulative","domain","extent","extremes","javascript","math","mathematics","max","maximum","node","node-js","nodejs","range","statistics","stats","stdlib","strided","strided-array"],"latest_commit_sha":null,"homepage":"https://github.com/stdlib-js/stdlib","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stdlib-js.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["stdlib-js"],"open_collective":"stdlib","tidelift":"npm/@stdlib/stdlib"}},"created_at":"2021-06-14T16:36:38.000Z","updated_at":"2024-12-01T02:02:26.000Z","dependencies_parsed_at":"2023-02-17T06:31:13.331Z","dependency_job_id":"6697bff7-e4c7-42e7-8087-b2398f3d9ad9","html_url":"https://github.com/stdlib-js/stats-base-cumax","commit_stats":{"total_commits":53,"total_committers":1,"mean_commits":53.0,"dds":0.0,"last_synced_commit":"f5620deca527db3e8d6a273bd126357d8519da76"},"previous_names":[],"tags_count":30,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fstats-base-cumax","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fstats-base-cumax/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fstats-base-cumax/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fstats-base-cumax/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/stats-base-cumax/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":233787996,"owners_count":18730249,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["accumulate","array","cumulative","domain","extent","extremes","javascript","math","mathematics","max","maximum","node","node-js","nodejs","range","statistics","stats","stdlib","strided","strided-array"],"created_at":"2025-01-13T18:25:36.037Z","updated_at":"2025-07-26T13:33:30.102Z","avatar_url":"https://github.com/stdlib-js.png","language":"JavaScript","readme":"\u003c!--\n\n@license Apache-2.0\n\nCopyright (c) 2020 The Stdlib Authors.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n--\u003e\n\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    About stdlib...\n  \u003c/summary\u003e\n  \u003cp\u003eWe 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.\u003c/p\u003e\n  \u003cp\u003eThe 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.\u003c/p\u003e\n  \u003cp\u003eWhen 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.\u003c/p\u003e\n  \u003cp\u003eTo join us in bringing numerical computing to the web, get started by checking us out on \u003ca href=\"https://github.com/stdlib-js/stdlib\"\u003eGitHub\u003c/a\u003e, and please consider \u003ca href=\"https://opencollective.com/stdlib\"\u003efinancially supporting stdlib\u003c/a\u003e. We greatly appreciate your continued support!\u003c/p\u003e\n\u003c/details\u003e\n\n# cumax\n\n[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] \u003c!-- [![dependencies][dependencies-image]][dependencies-url] --\u003e\n\n\u003e Calculate the cumulative maximum of a strided array.\n\n\u003csection class=\"intro\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.intro --\u003e\n\n\u003csection class=\"installation\"\u003e\n\n## Installation\n\n```bash\nnpm install @stdlib/stats-base-cumax\n```\n\nAlternatively,\n\n-   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).\n-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).\n-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).\n\nThe [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.\n\nTo view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.\n\n\u003c/section\u003e\n\n\u003csection class=\"usage\"\u003e\n\n## Usage\n\n```javascript\nvar cumax = require( '@stdlib/stats-base-cumax' );\n```\n\n#### cumax( N, x, strideX, y, strideY )\n\nComputes the cumulative maximum of a strided array.\n\n```javascript\nvar x = [ 1.0, -2.0, 2.0 ];\nvar y = [ 0.0, 0.0, 0.0 ];\n\ncumax( x.length, x, 1, y, 1 );\n// y =\u003e [ 1.0, 1.0, 2.0 ]\n```\n\nThe function has the following parameters:\n\n-   **N**: number of indexed elements.\n-   **x**: input [`Array`][mdn-array] or [`typed array`][mdn-typed-array].\n-   **strideX**: stride length for `x`.\n-   **y**: output [`Array`][mdn-array] or [`typed array`][mdn-typed-array].\n-   **strideY**: stride length for `y`.\n\nThe `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to compute the cumulative maximum of every other element in `x`,\n\n```javascript\nvar x = [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ];\nvar y = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];\n\nvar v = cumax( 4, x, 2, y, 1 );\n// y =\u003e [ 1.0, 2.0, 2.0, 4.0, 0.0, 0.0, 0.0, 0.0 ]\n```\n\nNote that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.\n\n\u003c!-- eslint-disable stdlib/capitalized-comments --\u003e\n\n```javascript\nvar Float64Array = require( '@stdlib/array-float64' );\n\n// Initial arrays...\nvar x0 = new Float64Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] );\nvar y0 = new Float64Array( x0.length );\n\n// Create offset views...\nvar x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element\nvar y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*3 ); // start at 4th element\n\ncumax( 4, x1, -2, y1, 1 );\n// y0 =\u003e \u003cFloat64Array\u003e[ 0.0, 0.0, 0.0, 4.0, 4.0, 4.0, 4.0, 0.0 ]\n```\n\n#### cumax.ndarray( N, x, strideX, offsetX, y, strideY, offsetY )\n\nComputes the cumulative maximum of a strided array using alternative indexing semantics.\n\n```javascript\nvar x = [ 1.0, -2.0, 2.0 ];\nvar y = [ 0.0, 0.0, 0.0 ];\n\ncumax.ndarray( x.length, x, 1, 0, y, 1, 0 );\n// y =\u003e [ 1.0, 1.0, 2.0 ]\n```\n\nThe function has the following additional parameters:\n\n-   **offsetX**: starting index for `x`.\n-   **offsetY**: starting index for `y`.\n\nWhile [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, offset parameters support indexing semantics based on starting indices. For example, to calculate the cumulative maximum of every other element in `x` starting from the second element and to store in the last `N` elements of `y` starting from the last element\n\n```javascript\nvar x = [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ];\nvar y = [ 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 ];\n\ncumax.ndarray( 4, x, 2, 1, y, -1, y.length-1 );\n// y =\u003e [ 0.0, 0.0, 0.0, 0.0, 4.0, 2.0, 1.0, 1.0 ]\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n\u003csection class=\"notes\"\u003e\n\n## Notes\n\n-   If `N \u003c= 0`, both functions return `y` unchanged.\n-   Depending on the environment, the typed versions ([`dcumax`][@stdlib/stats/strided/dcumax], [`scumax`][@stdlib/stats/strided/scumax], etc.) are likely to be significantly more performant.\n-   Both functions support array-like objects having getter and setter accessors for array element access (e.g., [`@stdlib/array-base/accessor`][@stdlib/array/base/accessor]).\n\n\u003c/section\u003e\n\n\u003c!-- /.notes --\u003e\n\n\u003csection class=\"examples\"\u003e\n\n## Examples\n\n\u003c!-- eslint no-undef: \"error\" --\u003e\n\n```javascript\nvar discreteUniform = require( '@stdlib/random-array-discrete-uniform' );\nvar Float64Array = require( '@stdlib/array-float64' );\nvar cumax = require( '@stdlib/stats-base-cumax' );\n\nvar x = discreteUniform( 10, 0, 100, {\n    'dtype': 'float64'\n});\nvar y = new Float64Array( x.length );\nconsole.log( x );\nconsole.log( y );\n\ncumax( x.length, x, 1, y, -1 );\nconsole.log( y );\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.examples --\u003e\n\n\u003csection class=\"references\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.references --\u003e\n\n\u003c!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --\u003e\n\n\u003csection class=\"related\"\u003e\n\n* * *\n\n## See Also\n\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/stats-base/cumin`][@stdlib/stats/base/cumin]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003ecalculate the cumulative minimum of a strided array.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/stats-strided/dcumax`][@stdlib/stats/strided/dcumax]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003ecalculate the cumulative maximum of double-precision floating-point strided array elements.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/stats-strided/scumax`][@stdlib/stats/strided/scumax]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003ecalculate the cumulative maximum of single-precision floating-point strided array elements.\u003c/span\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.related --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\n\u003csection class=\"main-repo\" \u003e\n\n* * *\n\n## Notice\n\nThis package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.\n\nFor 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].\n\n#### Community\n\n[![Chat][chat-image]][chat-url]\n\n---\n\n## License\n\nSee [LICENSE][stdlib-license].\n\n\n## Copyright\n\nCopyright \u0026copy; 2016-2025. The Stdlib [Authors][stdlib-authors].\n\n\u003c/section\u003e\n\n\u003c!-- /.stdlib --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"links\"\u003e\n\n[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-cumax.svg\n[npm-url]: https://npmjs.org/package/@stdlib/stats-base-cumax\n\n[test-image]: https://github.com/stdlib-js/stats-base-cumax/actions/workflows/test.yml/badge.svg?branch=main\n[test-url]: https://github.com/stdlib-js/stats-base-cumax/actions/workflows/test.yml?query=branch:main\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-cumax/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/stats-base-cumax?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/stats-base-cumax.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/stats-base-cumax/main\n\n--\u003e\n\n[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg\n[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im\n\n[stdlib]: https://github.com/stdlib-js/stdlib\n\n[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors\n\n[umd]: https://github.com/umdjs/umd\n[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules\n\n[deno-url]: https://github.com/stdlib-js/stats-base-cumax/tree/deno\n[deno-readme]: https://github.com/stdlib-js/stats-base-cumax/blob/deno/README.md\n[umd-url]: https://github.com/stdlib-js/stats-base-cumax/tree/umd\n[umd-readme]: https://github.com/stdlib-js/stats-base-cumax/blob/umd/README.md\n[esm-url]: https://github.com/stdlib-js/stats-base-cumax/tree/esm\n[esm-readme]: https://github.com/stdlib-js/stats-base-cumax/blob/esm/README.md\n[branches-url]: https://github.com/stdlib-js/stats-base-cumax/blob/main/branches.md\n\n[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-cumax/main/LICENSE\n\n[mdn-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array\n\n[@stdlib/array/base/accessor]: https://github.com/stdlib-js/array-base-accessor\n\n[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\n\n\u003c!-- \u003crelated-links\u003e --\u003e\n\n[@stdlib/stats/base/cumin]: https://github.com/stdlib-js/stats-base-cumin\n\n[@stdlib/stats/strided/dcumax]: https://github.com/stdlib-js/stats-strided-dcumax\n\n[@stdlib/stats/strided/scumax]: https://github.com/stdlib-js/stats-strided-scumax\n\n\u003c!-- \u003c/related-links\u003e --\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.links --\u003e\n","funding_links":["https://github.com/sponsors/stdlib-js","https://opencollective.com/stdlib","https://tidelift.com/funding/github/npm/@stdlib/stdlib"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fstats-base-cumax","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Fstats-base-cumax","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fstats-base-cumax/lists"}