Skip to content

feat(stats): add nanpcorrdist package#6201

Merged
Planeshifter merged 6 commits into
stdlib-js:developfrom
hans2001:feat/stats_incr_nanpcorrdist
Jul 12, 2026
Merged

feat(stats): add nanpcorrdist package#6201
Planeshifter merged 6 commits into
stdlib-js:developfrom
hans2001:feat/stats_incr_nanpcorrdist

Conversation

@hans2001

@hans2001 hans2001 commented Mar 19, 2025

Copy link
Copy Markdown
Contributor

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 #5618 .

Description

What is the purpose of this pull request?

This PR introduces the nanpcorrdist package—a thin wrapper around pcorrdist that skips updates when either input is NaN, ensuring robust incremental computation of the Pearson correlation distance.

This pull request:

test coverage:
Screenshot 2025-03-19 at 1 40 00 PM

example:
Screenshot 2025-03-19 at 1 39 51 PM

benchmark:
Screenshot 2025-03-19 at 1 39 09 PM

Related Issues

Does this pull request have any related issues?

This pull request:

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.


@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 stdlib-bot added Statistics Issue or pull request related to statistical functionality. First-time Contributor A pull request from a contributor who has never previously committed to the project repository. Good First PR A pull request resolving a Good First Issue. Needs Review A pull request which needs code review. labels Mar 19, 2025
@stdlib-bot

stdlib-bot commented Mar 19, 2025

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
stats/incr/nanpcorrdist $\\color{green}158/158$
$\\color{green}+0.00\\%$
$\\color{green}13/13$
$\\color{green}+0.00\\%$
$\\color{green}2/2$
$\\color{green}+0.00\\%$
$\\color{green}158/158$
$\\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: 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
---

@Planeshifter Planeshifter left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! If you are still interested to move this PR forward, here are some comments.

Comment thread lib/node_modules/@stdlib/stats/incr/nanpcorrdist/lib/main.js Outdated
Comment thread lib/node_modules/@stdlib/stats/incr/nanpcorrdist/docs/repl.txt Outdated
Comment thread lib/node_modules/@stdlib/stats/incr/nanpcorrdist/docs/repl.txt Outdated
Comment thread lib/node_modules/@stdlib/stats/incr/nanpcorrdist/docs/types/index.d.ts Outdated
Comment thread lib/node_modules/@stdlib/stats/incr/nanpcorrdist/docs/types/index.d.ts Outdated
Comment thread lib/node_modules/@stdlib/stats/incr/nanpcorrdist/test/test.js Outdated
Comment thread lib/node_modules/@stdlib/stats/incr/nanpcorrdist/README.md Outdated
Comment thread lib/node_modules/@stdlib/stats/incr/nanpcorrdist/README.md Outdated
@Planeshifter 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 9, 2026
@Planeshifter Planeshifter requested a review from a team July 12, 2026 03:37
@Planeshifter

Copy link
Copy Markdown
Member

/stdlib merge

@stdlib-bot 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
@stdlib-bot stdlib-bot removed the bot: In Progress Pull request is currently awaiting automation. label Jul 12, 2026

@Planeshifter Planeshifter left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be good to go.

@Planeshifter Planeshifter added the Ready To Merge A pull request which is ready to be merged. label Jul 12, 2026
@stdlib-bot 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

stdlib-bot commented Jul 12, 2026

Copy link
Copy Markdown
Contributor

PR Commit Message

feat(stats): add `stats/incr/nanpcorrdist`

PR-URL: https://github.com/stdlib-js/stdlib/pull/6201
Closes: https://github.com/stdlib-js/stdlib/issues/5618

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

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

@stdlib-bot 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 Planeshifter merged commit ab07081 into stdlib-js:develop Jul 12, 2026
33 checks passed
@stdlib-bot stdlib-bot removed the Ready To Merge A pull request which is ready to be merged. label Jul 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Good First PR A pull request resolving a Good First Issue. Statistics Issue or pull request related to statistical functionality.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[RFC]: add stats/incr/nanpcorrdist

3 participants