feat: add `stats/incr/nanmpcorr` by hans2001 · Pull Request #6155 · stdlib-js/stdlib

hans2001 · 2025-03-18T15:17:22Z

Resolves #5600 .

Description

What is the purpose of this pull request?

This pull request is a thin wrapper around the existing @stdlib/stats/incr/mpcorr package. Unlike how NaN values are handled in mpcorr, where the entire window will be invalidated when a NaN is encountered - this new wrapper intercepts any update containing a NaN and skips it.(i.e. when a NaN is passed, the accumulator does not update its state and continues to return the last valid correlation value.)

This pull request:
test coverage:

example( sliding window size: 3 )

benchmarks:

Related Issues

Does this pull request have any related issues?

This pull request:

resolves [RFC]: add stats/incr/nanmpcorr #5600

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.

No.

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 ---

--- 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: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - 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: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---

--- 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: na - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - 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: na - task: lint_license_headers status: passed ---

stdlib-bot · 2025-03-18T15:18:30Z

Coverage Report

Package	Statements	Branches	Functions	Lines
stats/incr/nanmpcorr	$\\color{green}168/168$ $\\color{green}+0.00\\%$	$\\color{green}13/13$ $\\color{green}+0.00\\%$	$\\color{green}2/2$ $\\color{green}+0.00\\%$	$\\color{green}168/168$ $\\color{green}+0.00\\%$

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

--- 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: na - task: lint_package_json status: na - 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: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---

--- 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: na - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - 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 ---

--- 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: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - 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: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---

--- 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: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - 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: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---

--- 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: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - 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: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---

--- 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: na - task: lint_package_json status: passed - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - 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: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---

Planeshifter

Some late feedback; sorry we didn't get to it earlier.

Planeshifter · 2026-07-12T03:40:07Z

/stdlib merge

…nanmpcorr

--- 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_pkg_readmes status: passed - task: lint_markdown_docs status: na - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - 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 ---

--- 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_pkg_readmes status: passed - task: lint_markdown_docs status: na - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - 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 ---

Signed-off-by: Philipp Burckhardt <pburckhardt@outlook.com>

Planeshifter

Thanks, @hans2001, for your PRs! Finally landing them.

stdlib-bot · 2026-07-12T04:55:58Z

PR Commit Message

feat: add `stats/incr/nanmpcorr`

PR-URL: https://github.com/stdlib-js/stdlib/pull/6155
Closes: https://github.com/stdlib-js/stdlib/issues/5600

Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com>
Co-authored-by: stdlib-bot <noreply@stdlib.io>
Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
Signed-off-by: Philipp Burckhardt <pburckhardt@outlook.com>

Please review the above commit message and make any necessary adjustments.

hans2001 added 3 commits March 17, 2025 21:57

hans2001 marked this pull request as draft March 18, 2025 17:56

stdlib-bot removed the Needs Review A pull request which needs code review. label Mar 18, 2025

hans2001 added 2 commits March 18, 2025 15:16

hans2001 marked this pull request as ready for review March 18, 2025 21:09

stdlib-bot added the Needs Review A pull request which needs code review. label Mar 18, 2025

hans2001 added 4 commits March 19, 2025 12:32

Planeshifter requested changes Mar 10, 2026

View reviewed changes

Planeshifter added Needs Changes Pull request which needs changes before being merged. and removed Needs Review A pull request which needs code review. labels Mar 10, 2026

Planeshifter mentioned this pull request Jul 12, 2026

Land stats/incr PRs by hans2001 stdlib-js/metr-issue-tracker#1053

Closed

fix: address review feedback

d8be011

Planeshifter requested a review from a team July 12, 2026 03:38

stdlib-bot added bot: In Progress Pull request is currently awaiting automation. Needs Review A pull request which needs code review. labels Jul 12, 2026

Planeshifter changed the title ~~Feat/stats incr nanmpcorr~~ feat: add stats/incr/nanmpcorr Jul 12, 2026

stdlib-bot and others added 2 commits July 12, 2026 03:59

Merge remote-tracking branch 'upstream/develop' into feat/stats_incr_…

7c6c1e6

…nanmpcorr

stdlib-bot removed the bot: In Progress Pull request is currently awaiting automation. label Jul 12, 2026

Planeshifter reviewed Jul 12, 2026

View reviewed changes

Comment thread lib/node_modules/@stdlib/stats/incr/nanmpcorr/lib/main.js Resolved

style: add empty line

436ccad

Signed-off-by: Philipp Burckhardt <pburckhardt@outlook.com>

Planeshifter approved these changes Jul 12, 2026

View reviewed changes

Planeshifter added the Ready To Merge label Jul 12, 2026

stdlib-bot removed Needs Review A pull request which needs code review. Needs Changes Pull request which needs changes before being merged. labels Jul 12, 2026

stdlib-bot removed the First-time Contributor A pull request from a contributor who has never previously committed to the project repository. label Jul 12, 2026

Planeshifter merged commit 4038a2c into stdlib-js:develop Jul 12, 2026
33 checks passed

stdlib-bot removed the Ready To Merge label Jul 12, 2026

Navigation Menu

Repository navigation

feat: add `stats/incr/nanmpcorr` - #6155

feat: add `stats/incr/nanmpcorr`#6155
Planeshifter merged 14 commits into
stdlib-js:developfrom
hans2001:feat/stats_incr_nanmpcorr

hans2001 commented Mar 18, 2025 •

edited

Loading

Uh oh!

stdlib-bot commented Mar 18, 2025 •

edited

Loading

Uh oh!

Planeshifter left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Planeshifter commented Jul 12, 2026

Uh oh!

Uh oh!

Planeshifter left a comment

Uh oh!

stdlib-bot commented Jul 12, 2026

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

hans2001 commented Mar 18, 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 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Report

Uh oh!

Planeshifter left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Planeshifter commented Jul 12, 2026

Uh oh!

Uh oh!

Planeshifter left a comment

Choose a reason for hiding this comment

Uh oh!

stdlib-bot commented Jul 12, 2026

PR Commit Message

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

hans2001 commented Mar 18, 2025 •

edited

Loading

stdlib-bot commented Mar 18, 2025 •

edited

Loading