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!
Create an iterator which iteratively computes a cumulative maximum value.
To use in Observable,
itercumax = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/stats-iter-cumax@umd/browser.js' )To vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:
var itercumax = require( 'path/to/vendor/umd/stats-iter-cumax/index.js' )To include the bundle in a webpage,
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/stats-iter-cumax@umd/browser.js"></script>If no recognized module system is present, access bundle contents via the global scope:
<script type="text/javascript">
(function () {
window.itercumax;
})();
</script>Returns an iterator which iteratively computes a cumulative maximum value.
var array2iterator = require( '@stdlib/array-to-iterator' );
var arr = array2iterator( [ 2.0, 1.0, 3.0, -7.0, -5.0 ] );
var it = itercumax( arr );
var m = it.next().value;
// returns 2.0
m = it.next().value;
// returns 2.0
m = it.next().value;
// returns 3.0
m = it.next().value;
// returns 3.0
m = it.next().value;
// returns 3.0- If an iterated value is non-numeric (including
NaN), the function returnsNaNfor all future iterations. If non-numeric iterated values are possible, you are advised to provide aniteratorwhich type checks and handles non-numeric values accordingly.
<!DOCTYPE html>
<html lang="en">
<body>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/random-iter-uniform@umd/browser.js"></script>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/stats-iter-cumax@umd/browser.js"></script>
<script type="text/javascript">
(function () {
// Create an iterator for generating uniformly distributed pseudorandom numbers:
var rand = runif( -10.0, 10.0, {
'seed': 1234,
'iter': 100
});
// Create an iterator for iteratively computing a cumulative maximum value:
var it = itercumax( rand );
// Perform manual iteration...
var v;
while ( true ) {
v = it.next();
if ( typeof v.value === 'number' ) {
console.log( 'max: %d', v.value );
}
if ( v.done ) {
break;
}
}
})();
</script>
</body>
</html>@stdlib/stats-iter/cumidrange: create an iterator which iteratively computes a cumulative mid-range.@stdlib/stats-iter/cumin: create an iterator which iteratively computes a cumulative minimum value.@stdlib/stats-iter/curange: create an iterator which iteratively computes a cumulative range.@stdlib/stats-iter/max: compute the maximum value of all iterated values.
This package is part of 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, see the main project repository.
See LICENSE.
Copyright © 2016-2024. The Stdlib Authors.