feat: add `stats/base/ndarray/dmeanstdev` #8525

Orthodox-64 · 2025-11-13T16:08:45Z

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

Description

What is the purpose of this pull request?

This pull request:

feat: add stats/base/ndarray/dmeanstdev

Related Issues

Does this pull request have any related issues?

This pull request has the following related issues:

None

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.

AI Assistance

When authoring the changes proposed in this PR, did you use any kind of AI assistance?

Yes
No

If you answered "yes" above, how did you use AI assistance?

Code generation (e.g., when writing an implementation or fixing a bug)
Test/benchmark generation
Documentation (including examples)
Research and understanding

Disclosure

If you answered "yes" to using AI assistance, please provide a short disclosure indicating how you used AI assistance. This helps reviewers determine how much scrutiny to apply when reviewing your contribution. Example disclosures: "This PR was written primarily by Claude Code." or "I consulted ChatGPT to understand the codebase, but the proposed changes were fully authored manually by myself.".

@stdlib-js/reviewers

stdlib-bot · 2025-11-13T16:10:29Z

Coverage Report

Package	Statements	Branches	Functions	Lines
stats/base/ndarray/dmeanstdev	$\color{green}126/126$ $color{green}+100.00%$	$\color{green}3/3$ $color{green}+100.00%$	$\color{green}1/1$ $color{green}+100.00%$	$\color{green}126/126$ $color{green}+100.00%$

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

kgryte · 2025-11-14T04:14:12Z

lib/node_modules/@stdlib/stats/base/ndarray/dmeanstdev/README.md

+
+<section class="intro">
+
+The [arithmetic mean][arithmetic-mean] and [standard deviation][standard-deviation] are defined as


You should just copy the introduction from stats/strided/dmeanstdev instead of rolling your own. This makes find-and-replace easier when we are consistent in our docs across similar packages.

This comment still needs to be addressed.

kgryte · 2025-11-14T04:15:34Z

lib/node_modules/@stdlib/stats/base/ndarray/dmeanstdev/lib/main.js

+function dmeanstdev( arrays ) {
+	var out = arrays[ 1 ];
+	var x = arrays[ 0 ];
+	return strided( numelDimension( x, 0 ), 1, getData( x ), getStride( x, 0 ), getOffset( x ), getData( out ), getStride( out, 0 ), getOffset( out ) ); // eslint-disable-line max-len


This is not what is desired. For a much more complicated API, see https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/ndarray/dztest. Notice there that scalar parameters, such as should be done for correction, are provided as ancillary arrays. Hardcoding 1 for the correction is not what we want.

lib/node_modules/@stdlib/stats/base/ndarray/dmeanstdev/README.md

kgryte

Left some initial comments.

Co-authored-by: Athan <[email protected]> Signed-off-by: Sachin Pangal <[email protected]>

Orthodox-64 · 2025-11-14T18:04:20Z

@kgryte Done — I’ve applied all the requested changes.

kgryte · 2025-11-18T08:38:34Z

lib/node_modules/@stdlib/stats/base/ndarray/dmeanstdev/docs/types/index.d.ts

+*
+* @param arrays - array-like object containing input and output ndarrays
+* @returns output ndarray containing [ mean, stdev ]
+*/


You're missing an example.

kgryte · 2025-11-18T08:39:12Z

lib/node_modules/@stdlib/stats/base/ndarray/dmeanstdev/docs/types/test.ts

+
+/* eslint-disable space-in-parens */
+
+import zeros = require( '@stdlib/ndarray/zeros' ); // eslint-disable-line import/no-unresolved


Suggested change

import zeros = require( '@stdlib/ndarray/zeros' ); // eslint-disable-line import/no-unresolved

import zeros = require( '@stdlib/ndarray/zeros' );

This and similar comments should be removed. They are not applicable.

kgryte · 2025-11-18T08:39:38Z

lib/node_modules/@stdlib/stats/base/ndarray/dmeanstdev/docs/types/test.ts

+		'dtype': 'float64'
+	});
+
+	dmeanstdev( [ x, out, correction ] ); // $ExpectType ndarray


Suggested change

dmeanstdev( [ x, out, correction ] ); // $ExpectType ndarray

dmeanstdev( [ x, out, correction ] ); // $ExpectType float64ndarray

kgryte · 2025-11-18T08:40:10Z

lib/node_modules/@stdlib/stats/base/ndarray/dmeanstdev/docs/types/index.d.ts

+* @param arrays - array-like object containing input and output ndarrays
+* @returns output ndarray containing [ mean, stdev ]
+*/
+declare function dmeanstdev( arrays: [ float64ndarray, float64ndarray ] ): float64ndarray;


This is missing the correction parameter ndarray.

kgryte · 2025-11-18T08:40:35Z

lib/node_modules/@stdlib/stats/base/ndarray/dmeanstdev/docs/types/test.ts

+	dmeanstdev( [ x, out ], {} ); // $ExpectError
+	dmeanstdev( [ x, out ] ); // $ExpectError


You are not providing the correction parameter in the list of arrays.

kgryte · 2025-11-18T08:41:37Z

lib/node_modules/@stdlib/stats/base/ndarray/dmeanstdev/lib/index.js

+* var correction = scalar2ndarray( 1.0, opts );
+*
+* var v = dmeanstdev( [ x, out, correction ] );
+* // returns <ndarray>


You should actually display the expected results (i.e., the mean and stdev) using ndarray2array.

kgryte · 2025-11-18T08:41:48Z

lib/node_modules/@stdlib/stats/base/ndarray/dmeanstdev/lib/main.js

+* var correction = scalar2ndarray( 1.0, opts );
+*
+* var v = dmeanstdev( [ x, out, correction ] );
+* // returns <ndarray>


Same comment.

kgryte

Left another round of comments.

feat: add stats/base/ndarray/dmeanstdev

d771bce

stdlib-bot added Statistics Issue or pull request related to statistical functionality. Needs Review A pull request which needs code review. labels Nov 13, 2025

Sachin Pangal added 7 commits November 13, 2025 21:57

fix: lint-error

c6afb79

fix: lint

5bd2d80

fix: repl.txt

b0a39ec

fix: benchmark.js

cf3109c

fix: lint

23bac11

Update: README.md

76d09aa

fix: README.md

23203ea

kgryte added Feature Issue or pull request for adding a new feature. and removed Needs Review A pull request which needs code review. labels Nov 14, 2025

kgryte reviewed Nov 14, 2025

View reviewed changes

lib/node_modules/@stdlib/stats/base/ndarray/dmeanstdev/README.md Outdated Show resolved Hide resolved

kgryte reviewed Nov 14, 2025

View reviewed changes

lib/node_modules/@stdlib/stats/base/ndarray/dmeanstdev/README.md Outdated Show resolved Hide resolved

kgryte reviewed Nov 14, 2025

View reviewed changes

lib/node_modules/@stdlib/stats/base/ndarray/dmeanstdev/README.md Outdated Show resolved Hide resolved

kgryte requested changes Nov 14, 2025

View reviewed changes

kgryte added the Needs Changes Pull request which needs changes before being merged. label Nov 14, 2025

Orthodox-64 and others added 5 commits November 14, 2025 14:40

Update lib/node_modules/@stdlib/stats/base/ndarray/dmeanstdev/README.md

0a92629

Co-authored-by: Athan <[email protected]> Signed-off-by: Sachin Pangal <[email protected]>

Update lib/node_modules/@stdlib/stats/base/ndarray/dmeanstdev/README.md

568f24b

Co-authored-by: Athan <[email protected]> Signed-off-by: Sachin Pangal <[email protected]>

Update lib/node_modules/@stdlib/stats/base/ndarray/dmeanstdev/README.md

731eb3a

Co-authored-by: Athan <[email protected]> Signed-off-by: Sachin Pangal <[email protected]>

fix: requested-changes

7039c2a

fix: lint

d1ca3f6

kgryte self-requested a review November 18, 2025 08:36

kgryte removed the Needs Changes Pull request which needs changes before being merged. label Nov 18, 2025

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

kgryte reviewed Nov 18, 2025

View reviewed changes

kgryte requested changes Nov 18, 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 Nov 18, 2025


		<section class="intro">

		The [arithmetic mean][arithmetic-mean] and [standard deviation][standard-deviation] are defined as


		/* eslint-disable space-in-parens */

		import zeros = require( '@stdlib/ndarray/zeros' ); // eslint-disable-line import/no-unresolved

	dmeanstdev( [ x, out, correction ] ); // $ExpectType ndarray
	dmeanstdev( [ x, out, correction ] ); // $ExpectType float64ndarray

		dmeanstdev( [ x, out ], {} ); // $ExpectError
		dmeanstdev( [ x, out ] ); // $ExpectError

Uh oh!

feat: add stats/base/ndarray/dmeanstdev #8525

Are you sure you want to change the base?

feat: add stats/base/ndarray/dmeanstdev #8525

Uh oh!

Conversation

Orthodox-64 commented Nov 13, 2025

Description

Related Issues

Questions

Other

Checklist

AI Assistance

Disclosure

Uh oh!

stdlib-bot commented Nov 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Report

Uh oh!

kgryte Nov 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kgryte Nov 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kgryte left a comment

Choose a reason for hiding this comment

Uh oh!

Orthodox-64 commented Nov 14, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kgryte left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

feat: add `stats/base/ndarray/dmeanstdev` #8525

feat: add `stats/base/ndarray/dmeanstdev` #8525

stdlib-bot commented Nov 13, 2025 •

edited

Loading

kgryte Nov 14, 2025 •

edited

Loading

kgryte Nov 14, 2025 •

edited

Loading