feat: add `stats/incr/nanmmean` #6185

satansin123 · 2025-03-19T08:08:53Z

type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes. report:

task: lint_filenames status: passed
task: lint_editorconfig status: passed
task: lint_markdown status: passed
task: lint_package_json status: passed
task: lint_repl_help status: passed
task: lint_javascript_src status: passed
task: lint_javascript_cli status: na
task: lint_javascript_examples status: passed
task: lint_javascript_tests status: passed
task: lint_javascript_benchmarks status: passed
task: lint_python status: na
task: lint_r status: na
task: lint_c_src status: na
task: lint_c_examples status: na
task: lint_c_benchmarks status: na
task: lint_c_tests_fixtures status: na
task: lint_shell status: na
task: lint_typescript_declarations status: passed
task: lint_typescript_tests status: passed
task: lint_license_headers status: passed ---

Resolves #5588.

Description

What is the purpose of this pull request?

This pull request:

Adds the @stdlib/stats/incr/nanmmean package, which computes an incremental mean while handling NaN values by skipping them.

Related Issues

Does this pull request have any related issues?

This pull request:

resolves [RFC]: add stats/incr/nanmmean #5588

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

test -

benchmark -

examples -

Checklist

Please ensure the following tasks are completed before submitting this pull request.

Read, understood, and followed the contributing guidelines.

@stdlib-js/reviewers

--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed ---

stdlib-bot · 2025-03-19T08:09:05Z

Hello! Thank you for your contribution to stdlib.

We noticed that the contributing guidelines acknowledgment is missing from your pull request. Here's what you need to do:

Please read our contributing guidelines.
Update your pull request description to include this checked box:

- [x] Read, understood, and followed the [contributing guidelines](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md)

This acknowledgment confirms that you've read the guidelines, which include:

The developer's certificate of origin
Your agreement to license your contributions under the project's terms

We can't review or accept contributions without this acknowledgment.

Thank you for your understanding and cooperation. We look forward to reviewing your contribution!

stdlib-bot · 2025-03-19T08:10:32Z

Coverage Report

Package	Statements	Branches	Functions	Lines
stats/incr/nanmmean	$\color{green}182/182$ $\color{green}+100.00\%$	$\color{green}14/14$ $\color{green}+100.00\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{green}182/182$ $\color{green}+100.00\%$

The above coverage report was generated for the changes in this PR.

ShabiShett07 · 2025-05-05T13:06:10Z

lib/node_modules/@stdlib/stats/incr/nanmmean/README.md

+
+#### incrnanmmean( window )
+
+Returns an accumulator `function` which incrementally computes a moving [arithmetic mean][arithmetic-mean]. The `window` parameter defines the number of values over which to compute the moving mean.


Suggested change

Returns an accumulator `function` which incrementally computes a moving [arithmetic mean][arithmetic-mean]. The `window` parameter defines the number of values over which to compute the moving mean.

Returns an accumulator function which incrementally computes a moving [arithmetic mean][arithmetic-mean], ignoring `NaN` values.. The `window` parameter defines the number of values over which to compute the moving mean.

ShabiShett07 · 2025-05-05T13:10:58Z

lib/node_modules/@stdlib/stats/incr/nanmmean/README.md

+var randu = require( '@stdlib/random/base/randu' );
+var incrnanmmean = require( '@stdlib/stats/incr/nanmmean' );
+
+var accumulator;
+var v;
+var i;
+
+// Initialize an accumulator:
+accumulator = incrnanmmean( 5 );
+
+// For each simulated datum, update the moving mean...
+for ( i = 0; i < 100; i++ ) {
+    if ( randu() < 0.2 ) {
+        v = NaN;
+    } else {
+        v = randu() * 100.0;
+    }
+    accumulator( v );


Suggested change

var randu = require( '@stdlib/random/base/randu' );

var incrnanmmean = require( '@stdlib/stats/incr/nanmmean' );

var accumulator;

var v;

var i;

// Initialize an accumulator:

accumulator = incrnanmmean( 5 );

// For each simulated datum, update the moving mean...

for ( i = 0; i < 100; i++ ) {

if ( randu() < 0.2 ) {

v = NaN;

} else {

v = randu() * 100.0;

}

accumulator( v );

var uniform = require( '@stdlib/random/base/uniform' );

var bernoulli = require( '@stdlib/random/base/bernoulli' );

var incrnanmmean = require( '@stdlib/stats/incr/nanmmean' );

// Initialize an accumulator:

var accumulator = incrnanmmean( 5 );

// For each simulated datum, update the moving mean...

var I;

for ( i = 0; i < 100; i++ ) {

accumulator( ( bernoulli( 0.8 ) < 1 ) ? NaN : uniform( 0.0, 100.0 ) );

ShabiShett07 · 2025-05-05T13:13:34Z

lib/node_modules/@stdlib/stats/incr/nanmmean/benchmark/benchmark.js

+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var randu = require( '@stdlib/random/base/randu' );


Suggested change

var randu = require( '@stdlib/random/base/randu' );

We will be using iterations as the input

ShabiShett07 · 2025-05-05T13:14:42Z

lib/node_modules/@stdlib/stats/incr/nanmmean/benchmark/benchmark.js

+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		v = acc( randu() );


Suggested change

v = acc( randu() );

v = acc( i );

ShabiShett07 · 2025-05-05T13:15:59Z

lib/node_modules/@stdlib/stats/incr/nanmmean/examples/index.js

+
+'use strict';
+
+var randu = require( '@stdlib/random/base/randu' );


same as mentioned in the markdown file

ShabiShett07 · 2025-05-05T13:17:07Z

lib/node_modules/@stdlib/stats/incr/nanmmean/test/test.js

+// MODULES //
+
+var tape = require( 'tape' );
+var incrnanmmean = require( '@stdlib/stats/incr/nanmmean/lib' );


Suggested change

var incrnanmmean = require( '@stdlib/stats/incr/nanmmean/lib' );

var incrnanmmean = require( './../lib' );

ShabiShett07 · 2025-05-05T13:18:19Z

@satansin123, the PR looks good, left some comments to make some changes

stdlib-bot added Good First PR A pull request resolving a Good First Issue. Statistics Issue or pull request related to statistical functionality. Needs Review A pull request which needs code review. and removed Good First PR A pull request resolving a Good First Issue. labels Mar 19, 2025

ShabiShett07 reviewed May 5, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat: add `stats/incr/nanmmean` #6185

feat: add `stats/incr/nanmmean` #6185

satansin123 commented Mar 19, 2025 •

edited

Loading

Uh oh!

stdlib-bot commented Mar 19, 2025

Uh oh!

stdlib-bot commented Mar 19, 2025

Uh oh!

ShabiShett07 May 5, 2025

Uh oh!

ShabiShett07 May 5, 2025

Uh oh!

ShabiShett07 May 5, 2025

Uh oh!

ShabiShett07 May 5, 2025

Uh oh!

ShabiShett07 May 5, 2025

Uh oh!

ShabiShett07 May 5, 2025

Uh oh!

ShabiShett07 May 5, 2025

Uh oh!

ShabiShett07 commented May 5, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants


		#### incrnanmmean( window )

		Returns an accumulator `function` which incrementally computes a moving [arithmetic mean][arithmetic-mean]. The `window` parameter defines the number of values over which to compute the moving mean.

	Returns an accumulator `function` which incrementally computes a moving [arithmetic mean][arithmetic-mean]. The `window` parameter defines the number of values over which to compute the moving mean.
	Returns an accumulator function which incrementally computes a moving [arithmetic mean][arithmetic-mean], ignoring `NaN` values.. The `window` parameter defines the number of values over which to compute the moving mean.


		'use strict';

		var randu = require( '@stdlib/random/base/randu' );

	var incrnanmmean = require( '@stdlib/stats/incr/nanmmean/lib' );
	var incrnanmmean = require( './../lib' );

Uh oh!

feat: add stats/incr/nanmmean #6185

Are you sure you want to change the base?

feat: add stats/incr/nanmmean #6185

Conversation

satansin123 commented Mar 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issues

Questions

Other

Checklist

Uh oh!

stdlib-bot commented Mar 19, 2025

Uh oh!

stdlib-bot commented Mar 19, 2025

Coverage Report

Uh oh!

ShabiShett07 May 5, 2025

Choose a reason for hiding this comment

Uh oh!

ShabiShett07 May 5, 2025

Choose a reason for hiding this comment

Uh oh!

ShabiShett07 May 5, 2025

Choose a reason for hiding this comment

Uh oh!

ShabiShett07 May 5, 2025

Choose a reason for hiding this comment

Uh oh!

ShabiShett07 May 5, 2025

Choose a reason for hiding this comment

Uh oh!

ShabiShett07 May 5, 2025

Choose a reason for hiding this comment

Uh oh!

ShabiShett07 May 5, 2025

Choose a reason for hiding this comment

Uh oh!

ShabiShett07 commented May 5, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

feat: add `stats/incr/nanmmean` #6185

feat: add `stats/incr/nanmmean` #6185

satansin123 commented Mar 19, 2025 •

edited

Loading