{"id":23183476,"url":"https://github.com/stdlib-js/stats-base-nanrange-by","last_synced_at":"2025-08-18T15:31:48.354Z","repository":{"id":41354410,"uuid":"376838888","full_name":"stdlib-js/stats-base-nanrange-by","owner":"stdlib-js","description":"Calculate the range of a strided array via a callback function, ignoring NaN values.","archived":false,"fork":false,"pushed_at":"2024-12-01T02:16:06.000Z","size":529,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-12-01T02:31:57.910Z","etag":null,"topics":["dispersion","domain","extent","extremes","javascript","math","mathematics","max","maximum","min","minimum","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-14T13:48:02.000Z","updated_at":"2024-12-01T01:49:25.000Z","dependencies_parsed_at":"2023-02-17T09:15:55.891Z","dependency_job_id":"a1f0448a-18e1-40aa-9853-175ee68730a4","html_url":"https://github.com/stdlib-js/stats-base-nanrange-by","commit_stats":{"total_commits":69,"total_committers":1,"mean_commits":69.0,"dds":0.0,"last_synced_commit":"eb6d9d6bbc555b332a1b094bd6ad5c0f604091df"},"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-nanrange-by","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fstats-base-nanrange-by/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fstats-base-nanrange-by/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fstats-base-nanrange-by/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/stats-base-nanrange-by/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229964403,"owners_count":18152034,"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":["dispersion","domain","extent","extremes","javascript","math","mathematics","max","maximum","min","minimum","node","node-js","nodejs","range","statistics","stats","stdlib","strided","strided-array"],"created_at":"2024-12-18T09:13:09.051Z","updated_at":"2025-08-18T15:31:48.324Z","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# nanrangeBy\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 [range][range] of a strided array via a callback function, ignoring `NaN` values.\n\n\u003csection class=\"intro\"\u003e\n\nThe [**range**][range] is defined as the difference between the maximum and minimum values.\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-nanrange-by\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 nanrangeBy = require( '@stdlib/stats-base-nanrange-by' );\n```\n\n#### nanrangeBy( N, x, strideX, clbk\\[, thisArg] )\n\nComputes the [range][range] of a strided array via a callback function, ignoring `NaN` values.\n\n```javascript\nfunction accessor( v ) {\n    return v * 2.0;\n}\n\nvar x = [ -2.0, 1.0, 3.0, -5.0, 4.0, NaN, 0.0, -1.0, -3.0, NaN ];\n\nvar v = nanrangeBy( x.length, x, 1, accessor );\n// returns 18.0\n```\n\nThe function has the following parameters:\n\n-   **N**: number of indexed elements.\n-   **x**: input [`Array`][mdn-array], [`typed array`][mdn-typed-array], or an array-like object (excluding strings and functions).\n-   **strideX**: stride length.\n-   **clbk**: callback function.\n-   **thisArg**: execution context (_optional_).\n\nThe invoked callback is provided four arguments:\n\n-   **value**: array element.\n-   **aidx**: array index.\n-   **sidx**: strided index (`offset + aidx*stride`).\n-   **array**: input array/collection.\n\nTo set the callback execution context, provide a `thisArg`.\n\n```javascript\nfunction accessor( v ) {\n    this.count += 1;\n    return v * 2.0;\n}\n\nvar x = [ -2.0, 1.0, 3.0, -5.0, 4.0, NaN, 0.0, -1.0, -3.0, NaN ];\n\nvar context = {\n    'count': 0\n};\n\nvar v = nanrangeBy( x.length, x, 1, accessor, context );\n// returns 18.0\n\nvar cnt = context.count;\n// returns 10\n```\n\nThe `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to access every other element\n\n```javascript\nfunction accessor( v ) {\n    return v * 2.0;\n}\n\nvar x = [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0, NaN, NaN ];\n\nvar v = nanrangeBy( 5, x, 2, accessor );\n// returns 12.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```javascript\nvar Float64Array = require( '@stdlib/array-float64' );\n\nfunction accessor( v ) {\n    return v * 2.0;\n}\n\n// Initial array...\nvar x0 = new Float64Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );\n\n// Create an offset view...\nvar x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element\n\n// Access every other element...\nvar v = nanrangeBy( 3, x1, 2, accessor );\n// returns 8.0\n```\n\n#### nanrangeBy.ndarray( N, x, strideX, offsetX, clbk\\[, thisArg] )\n\nComputes the [range][range] of a strided array via a callback function, ignoring `NaN` values and using alternative indexing semantics.\n\n```javascript\nfunction accessor( v ) {\n    return v * 2.0;\n}\n\nvar x = [ -2.0, 1.0, 3.0, -5.0, 4.0, NaN, 0.0, -1.0, -3.0, NaN ];\n\nvar v = nanrangeBy.ndarray( x.length, x, 1, 0, accessor );\n// returns 18.0\n```\n\nThe function has the following additional parameters:\n\n-   **offsetX**: starting index.\n\nWhile [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to access only the last three elements of `x`\n\n```javascript\nfunction accessor( v ) {\n    return v * 2.0;\n}\n\nvar x = [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ];\n\nvar v = nanrangeBy.ndarray( 3, x, 1, x.length-3, accessor );\n// returns 22.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 `NaN`.\n-   A provided callback function should return a numeric value.\n-   If a provided callback function returns `NaN`, the value is ignored.\n-   If a provided callback function does not return any value (or equivalently, explicitly returns `undefined`), the value is ignored.\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-   When possible, prefer using [`dnanrange`][@stdlib/stats/strided/dnanrange], [`snanrange`][@stdlib/stats/strided/snanrange], and/or [`nanrange`][@stdlib/stats/base/nanrange], as, depending on the environment, these interfaces are likely to be significantly more performant.\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 uniform = require( '@stdlib/random-base-uniform' );\nvar filledarrayBy = require( '@stdlib/array-filled-by' );\nvar bernoulli = require( '@stdlib/random-base-bernoulli' );\nvar nanrangeBy = require( '@stdlib/stats-base-nanrange-by' );\n\nfunction rand() {\n    if ( bernoulli( 0.8 ) \u003c 0.2 ) {\n        return NaN;\n    }\n    return uniform( -50.0, 50.0 );\n}\n\nfunction accessor( v ) {\n    return v * 2.0;\n}\n\nvar x = filledarrayBy( 10, 'float64', rand );\nconsole.log( x );\n\nvar v = nanrangeBy( x.length, x, 1, accessor );\nconsole.log( v );\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.examples --\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-strided/dnanrange`][@stdlib/stats/strided/dnanrange]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003ecalculate the range of a double-precision floating-point strided array, ignoring NaN values.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/stats-strided/nanmax-by`][@stdlib/stats/strided/nanmax-by]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003ecalculate the maximum value of a strided array via a callback function, ignoring NaN values.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/stats-strided/nanmin-by`][@stdlib/stats/strided/nanmin-by]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003ecalculate the minimum value of a strided array via a callback function, ignoring NaN values.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/stats-base/nanrange`][@stdlib/stats/base/nanrange]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003ecalculate the range of a strided array, ignoring NaN values.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/stats-base/range-by`][@stdlib/stats/base/range-by]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003ecalculate the range of a strided array via a callback function.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/stats-strided/snanrange`][@stdlib/stats/strided/snanrange]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003ecalculate the range of a single-precision floating-point strided array, ignoring NaN values.\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-nanrange-by.svg\n[npm-url]: https://npmjs.org/package/@stdlib/stats-base-nanrange-by\n\n[test-image]: https://github.com/stdlib-js/stats-base-nanrange-by/actions/workflows/test.yml/badge.svg?branch=main\n[test-url]: https://github.com/stdlib-js/stats-base-nanrange-by/actions/workflows/test.yml?query=branch:main\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-nanrange-by/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/stats-base-nanrange-by?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/stats-base-nanrange-by.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/stats-base-nanrange-by/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-nanrange-by/tree/deno\n[deno-readme]: https://github.com/stdlib-js/stats-base-nanrange-by/blob/deno/README.md\n[umd-url]: https://github.com/stdlib-js/stats-base-nanrange-by/tree/umd\n[umd-readme]: https://github.com/stdlib-js/stats-base-nanrange-by/blob/umd/README.md\n[esm-url]: https://github.com/stdlib-js/stats-base-nanrange-by/tree/esm\n[esm-readme]: https://github.com/stdlib-js/stats-base-nanrange-by/blob/esm/README.md\n[branches-url]: https://github.com/stdlib-js/stats-base-nanrange-by/blob/main/branches.md\n\n[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-nanrange-by/main/LICENSE\n\n[range]: https://en.wikipedia.org/wiki/Range_%28statistics%29\n\n[mdn-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array\n\n[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray\n\n[@stdlib/array/base/accessor]: https://github.com/stdlib-js/array-base-accessor\n\n\u003c!-- \u003crelated-links\u003e --\u003e\n\n[@stdlib/stats/strided/dnanrange]: https://github.com/stdlib-js/stats-strided-dnanrange\n\n[@stdlib/stats/strided/nanmax-by]: https://github.com/stdlib-js/stats-strided-nanmax-by\n\n[@stdlib/stats/strided/nanmin-by]: https://github.com/stdlib-js/stats-strided-nanmin-by\n\n[@stdlib/stats/base/nanrange]: https://github.com/stdlib-js/stats-base-nanrange\n\n[@stdlib/stats/base/range-by]: https://github.com/stdlib-js/stats-base-range-by\n\n[@stdlib/stats/strided/snanrange]: https://github.com/stdlib-js/stats-strided-snanrange\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-nanrange-by","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Fstats-base-nanrange-by","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fstats-base-nanrange-by/lists"}