feat(stats/incr): add nancovariance accumulator #5980

Adithya-jh · 2025-03-11T21:23:58Z

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

Resolves #5554.

Description

What is the purpose of this pull request?

This pull request:

This pull request adds the nancovariance module, which computes an incremental sample covariance while ignoring input pairs that contain NaN values.

Related Issues

Does this pull request have any related issues?

This pull request:

resolves [RFC]: add stats/incr/nancovariance #5554

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

stdlib-bot · 2025-03-11T21:24:33Z

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

👋 Hi there! 👋

And thank you for opening your first pull request! We will review it shortly. 🏃 💨

stdlib-bot · 2025-03-11T21:25:40Z

Coverage Report

Package	Statements	Branches	Functions	Lines
stats/incr/nancovariance	$\color{red}137/139$ $\color{green}+98.56\%$	$\color{red}9/11$ $\color{green}+81.82\%$	$\color{green}2/2$ $\color{green}+100.00\%$	$\color{red}137/139$ $\color{green}+98.56\%$

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

kgryte · 2025-03-12T07:29:43Z

lib/node_modules/@stdlib/stats/incr/nancovariance/lib/index.js

+/**
+* Compute an incremental sample covariance while ignoring NaN values.
+*
+* @module @stdlib/stats/incr/nancovariance


Suggested change

* @module @stdlib/stats/incr/nancovariance

kgryte · 2025-03-12T07:29:56Z

lib/node_modules/@stdlib/stats/incr/nancovariance/lib/index.js

+* @module @stdlib/stats/incr/nancovariance
+*
+* @example
+* var incrnancount = require( '@stdlib/stats/incr/nancovariance' );


This example is incorrect.

kgryte · 2025-03-12T07:30:21Z

lib/node_modules/@stdlib/stats/incr/nancovariance/lib/main.js

@@ -0,0 +1,87 @@
+/* eslint-disable stdlib/jsdoc-no-space-aligned-asterisks */


Do NOT disable this lint rule. The lint rule is telling you explicitly our conventions.

kgryte · 2025-03-12T07:30:36Z

lib/node_modules/@stdlib/stats/incr/nancovariance/lib/main.js

+// MAIN //
+
+/**
+ * Returns an accumulator function which incrementally computes a sample covariance.


This alignment is incorrect and does not follow our conventions.

kgryte · 2025-03-12T07:31:13Z

lib/node_modules/@stdlib/stats/incr/nancovariance/lib/main.js

+ * // returns 0
+ */
+function nancovariance() {
+	var meanX = 0.0;


This implementation is not what we want. The implementation should be a thin wrapper around incr/covariance.

kgryte · 2025-03-12T07:31:31Z

lib/node_modules/@stdlib/stats/incr/nancovariance/package.json

@@ -0,0 +1,60 @@
+{
+    "name": "@stdlib/stats/incr/nancovariance",


The indentation in this file is off. Should be 2-space indentation.

kgryte · 2025-03-12T07:32:21Z

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

+	t.end();
+});
+
+// Additional tests...


In order for this PR to move forward, you need to add the additional tests. I recommend you simply reuse and modify the tests in incr/covariance.

kgryte

Left an initial round of comments.

kgryte · 2025-03-12T07:33:27Z

You are also missing the following files:

README.md
docs/types/index.d.ts
docs/types/test.ts

stdlib-bot reviewed Mar 11, 2025

View reviewed changes

kgryte reviewed Mar 12, 2025

View reviewed changes

kgryte requested changes Mar 12, 2025

View reviewed changes

kgryte added Needs Changes Pull request which needs changes before being merged. and removed Needs Review A pull request which needs code review. labels Mar 12, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(stats/incr): add nancovariance accumulator #5980

feat(stats/incr): add nancovariance accumulator #5980

Adithya-jh commented Mar 11, 2025 •

edited

Loading

stdlib-bot commented Mar 11, 2025

stdlib-bot left a comment

stdlib-bot commented Mar 11, 2025

kgryte Mar 12, 2025

kgryte Mar 12, 2025

kgryte Mar 12, 2025

kgryte Mar 12, 2025

kgryte Mar 12, 2025

kgryte Mar 12, 2025

kgryte Mar 12, 2025

kgryte left a comment

kgryte commented Mar 12, 2025

		@@ -0,0 +1,87 @@
		/* eslint-disable stdlib/jsdoc-no-space-aligned-asterisks */

		@@ -0,0 +1,60 @@
		{
		"name": "@stdlib/stats/incr/nancovariance",

feat(stats/incr): add nancovariance accumulator #5980

Are you sure you want to change the base?

feat(stats/incr): add nancovariance accumulator #5980

Conversation

Adithya-jh commented Mar 11, 2025 • edited Loading

Description

Related Issues

Questions

Other

Checklist

stdlib-bot commented Mar 11, 2025

stdlib-bot left a comment

Choose a reason for hiding this comment

stdlib-bot commented Mar 11, 2025

Coverage Report

kgryte Mar 12, 2025

Choose a reason for hiding this comment

kgryte Mar 12, 2025

Choose a reason for hiding this comment

kgryte Mar 12, 2025

Choose a reason for hiding this comment

kgryte Mar 12, 2025

Choose a reason for hiding this comment

kgryte Mar 12, 2025

Choose a reason for hiding this comment

kgryte Mar 12, 2025

Choose a reason for hiding this comment

kgryte Mar 12, 2025

Choose a reason for hiding this comment

kgryte left a comment

Choose a reason for hiding this comment

kgryte commented Mar 12, 2025

Adithya-jh commented Mar 11, 2025 •

edited

Loading