npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@stdlib/stats-incr-mminmax

v0.2.2

Published

Compute a moving minimum and maximum incrementally.

Downloads

153

Readme

incrmminmax

NPM version Build Status Coverage Status

Compute a moving minimum and maximum incrementally.

Installation

npm install @stdlib/stats-incr-mminmax

Usage

var incrmminmax = require( '@stdlib/stats-incr-mminmax' );

incrmminmax( [out,] window )

Returns an accumulator function which incrementally computes a moving minimum and maximum. The window parameter defines the number of values over which to compute the moving minimum and maximum.

var accumulator = incrmminmax( 3 );

By default, the returned accumulator function returns the minimum and maximum as a two-element array. To avoid unnecessary memory allocation, the function supports providing an output (destination) object.

var Float64Array = require( '@stdlib/array-float64' );

var accumulator = incrmminmax( new Float64Array( 2 ), 3 );

accumulator( [x] )

If provided an input value x, the accumulator function returns updated minimum and maximum values. If not provided an input value x, the accumulator function returns the current minimum and maximum values.

var accumulator = incrmminmax( 3 );

var mm = accumulator();
// returns null

// Fill the window...
mm = accumulator( 2.0 ); // [2.0]
// returns [ 2.0, 2.0 ]

mm = accumulator( 1.0 ); // [2.0, 1.0]
// returns [ 1.0, 2.0 ]

mm = accumulator( 3.0 ); // [2.0, 1.0, 3.0]
// returns [ 1.0, 3.0 ]

// Window begins sliding...
mm = accumulator( -7.0 ); // [1.0, 3.0, -7.0]
// returns [ -7.0, 3.0 ]

mm = accumulator( -5.0 ); // [3.0, -7.0, -5.0]
// returns [ -7.0, 3.0 ]

mm = accumulator();
// returns [ -7.0, 3.0 ]

Notes

  • Input values are not type checked. If provided NaN, the accumulated minimum and maximum values are NaN for at least W-1 future invocations. If non-numeric inputs are possible, you are advised to type check and handle accordingly before passing the value to the accumulator function.
  • As W values are needed to fill the window buffer, the first W-1 returned minimum and maximum values are calculated from smaller sample sizes. Until the window is full, each returned minimum and maximum is calculated from all provided values.

Examples

var randu = require( '@stdlib/random-base-randu' );
var incrmminmax = require( '@stdlib/stats-incr-mminmax' );

var accumulator;
var v;
var i;

// Initialize an accumulator:
accumulator = incrmminmax( 5 );

// For each simulated datum, update the moving minimum and maximum...
for ( i = 0; i < 100; i++ ) {
    v = randu() * 100.0;
    accumulator( v );
}
console.log( accumulator() );

See Also


Notice

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.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.