https://github.com/stdlib-js/stats-iter-midrange
Compute the mid-range of all iterated values.
https://github.com/stdlib-js/stats-iter-midrange
central-tendency iterator javascript math mathematics max maximum mean mid mid-extreme mid-range min minimum node node-js nodejs range statistics stats stdlib
Last synced: 4 days ago
JSON representation
Compute the mid-range of all iterated values.
- Host: GitHub
- URL: https://github.com/stdlib-js/stats-iter-midrange
- Owner: stdlib-js
- License: apache-2.0
- Created: 2021-06-14T13:47:06.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2026-02-07T22:07:43.000Z (about 2 months ago)
- Last Synced: 2026-02-08T05:00:54.507Z (about 2 months ago)
- Topics: central-tendency, iterator, javascript, math, mathematics, max, maximum, mean, mid, mid-extreme, mid-range, min, minimum, node, node-js, nodejs, range, statistics, stats, stdlib
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 1.16 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
- Notice: NOTICE
Awesome Lists containing this project
README
About stdlib...
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.
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.
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.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
# itermidrange
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Compute the [mid-range][mid-range] of all [iterated][mdn-iterator-protocol] values.
The [**mid-range**][mid-range], or **mid-extreme**, is the arithmetic mean of maximum and minimum values. Accordingly, the [mid-range][mid-range] is the midpoint of the [range][range] and a measure of central tendency.
## Installation
```bash
npm install @stdlib/stats-iter-midrange
```
Alternatively,
- 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]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- 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]).
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To 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.
## Usage
```javascript
var itermidrange = require( '@stdlib/stats-iter-midrange' );
```
#### itermidrange( iterator )
Computes the [mid-range][mid-range] of all [iterated][mdn-iterator-protocol] values.
```javascript
var array2iterator = require( '@stdlib/array-to-iterator' );
var arr = array2iterator( [ 1.0, -2.0, 3.0, -4.0 ] );
var v = itermidrange( arr );
// returns -0.5
```
## Notes
- If an iterated value is non-numeric (including `NaN`), the returned [`iterator`][mdn-iterator-protocol] returns `NaN`. If non-numeric iterated values are possible, you are advised to provide an [`iterator`][mdn-iterator-protocol] which type checks and handles non-numeric values accordingly.
## Examples
```javascript
var runif = require( '@stdlib/random-iter-uniform' );
var itermidrange = require( '@stdlib/stats-iter-midrange' );
// Create an iterator for generating uniformly distributed pseudorandom numbers:
var rand = runif( -10.0, 10.0, {
'seed': 1234,
'iter': 100
});
// Compute the mid-range:
var v = itermidrange( rand );
// returns
console.log( 'mid-range: %d.', v );
```
* * *
## See Also
- [`@stdlib/stats-iter/mean`][@stdlib/stats/iter/mean]: compute the arithmetic mean over all iterated values.
- [`@stdlib/stats-iter/max`][@stdlib/stats/iter/max]: compute the maximum value of all iterated values.
- [`@stdlib/stats-iter/min`][@stdlib/stats/iter/min]: compute the minimum value of all iterated values.
- [`@stdlib/stats-iter/range`][@stdlib/stats/iter/range]: compute the range of all iterated values.
* * *
## Notice
This 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.
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
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-iter-midrange.svg
[npm-url]: https://npmjs.org/package/@stdlib/stats-iter-midrange
[test-image]: https://github.com/stdlib-js/stats-iter-midrange/actions/workflows/test.yml/badge.svg?branch=v0.2.3
[test-url]: https://github.com/stdlib-js/stats-iter-midrange/actions/workflows/test.yml?query=branch:v0.2.3
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-iter-midrange/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/stats-iter-midrange?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[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-iter-midrange/tree/deno
[deno-readme]: https://github.com/stdlib-js/stats-iter-midrange/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/stats-iter-midrange/tree/umd
[umd-readme]: https://github.com/stdlib-js/stats-iter-midrange/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/stats-iter-midrange/tree/esm
[esm-readme]: https://github.com/stdlib-js/stats-iter-midrange/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/stats-iter-midrange/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-iter-midrange/main/LICENSE
[range]: https://en.wikipedia.org/wiki/Range_%28statistics%29
[mid-range]: https://en.wikipedia.org/wiki/Mid-range
[mdn-iterator-protocol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol
[@stdlib/stats/iter/mean]: https://github.com/stdlib-js/stats-iter-mean
[@stdlib/stats/iter/max]: https://github.com/stdlib-js/stats-iter-max
[@stdlib/stats/iter/min]: https://github.com/stdlib-js/stats-iter-min
[@stdlib/stats/iter/range]: https://github.com/stdlib-js/stats-iter-range