feat: add C ndarray interface and refactor implementation for `stats/base/dnanmeanpw` #4763

aayush0325 · 2025-01-15T13:58:25Z

Description

What is the purpose of this pull request?

This pull request:

adds C ndarray interface for stats/base/dnanmeanpw
refactors JavaScript implementation
updates tests, docs, examples and benchmarks

Related Issues

Does this pull request have any related issues?

No.

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: 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: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - 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-01-15T13:59:51Z

Coverage Report

Package	Statements	Branches	Functions	Lines
stats/base/dnanmeanpw	$\color{green}354/354$ $\color{green}+100.00\%$	$\color{green}13/13$ $\color{green}+100.00\%$	$\color{green}4/4$ $\color{green}+100.00\%$	$\color{green}354/354$ $\color{green}+100.00\%$

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

headlessNode

The pointer should be CBLAS_INT type here.

See: https://github.com/stdlib-js/stdlib/blob/develop/lib/node_modules/%40stdlib/blas/ext/base/dnannsumpw/README.md?plain=1#L242

EDIT: Looks like the JavaScript also needs to refactored.

lib/node_modules/@stdlib/stats/base/dnanmeanpw/src/main.c

aayush0325 · 2025-01-15T14:36:48Z

EDIT: Looks like the JavaScript also needs to refactored.

yes, i'm aware of that. i forgot to mark this as a draft 😅

--- 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: 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_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: failed ---

lib/node_modules/@stdlib/stats/base/dnanmeanpw/lib/ndarray.js

lib/node_modules/@stdlib/stats/base/dnanmeanpw/test/test.ndarray.js

lib/node_modules/@stdlib/stats/base/dnanmeanpw/lib/ndarray.js

lib/node_modules/@stdlib/stats/base/dnanmeanpw/test/test.ndarray.js

lib/node_modules/@stdlib/stats/base/dnanmeanpw/test/test.ndarray.native.js

--- 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: 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: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - 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: passed - task: lint_c_benchmarks status: passed - 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 ---

lib/node_modules/@stdlib/stats/base/dnanmeanpw/README.md

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

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

headlessNode

@aayush0325 A few documentation related suggestions.

1 - Use consistent terminology across similar packages and within the files of a single package. Notice that some files in this package use "stride length" and "starting index" instead of "stride length for x" and "starting index for x"

2 - For cases with multiple input arrays, we can then use specific terms like "stride length for x" and "stride length for y" to maintain clarity.

cc @kgryte

lib/node_modules/@stdlib/stats/base/dnanmeanpw/README.md

lib/node_modules/@stdlib/stats/base/dnanmeanpw/lib/ndarray.js

lib/node_modules/@stdlib/stats/base/dnanmeanpw/src/main.c

aayush0325 · 2025-01-17T11:55:02Z

@aayush0325 A few documentation related suggestions

That makes a lot of sense. We'd have to update the documentation for the existing packages as well. Dropping a patch soon!

Co-authored-by: Muhammad Haris <[email protected]> Signed-off-by: Aayush Khanna <[email protected]>

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

aayush0325 · 2025-01-19T00:09:02Z

kindly take a look at the examples here, we'd have to update this in existing packages as well, dropping a patch for that soon!

kgryte · 2025-01-19T01:18:20Z

@aayush0325 README examples LGTM

aayush0325 · 2025-01-19T09:51:58Z

@aayush0325 README examples LGTM

few other places where we had to make similar changes as well, see this commit, i will then make similar changes across existing packages

kgryte · 2025-01-19T23:03:05Z

few other places where we had to make similar changes as well

Those look fine to me, as well.

lib/node_modules/@stdlib/stats/base/dnanmeanpw/README.md

Signed-off-by: Athan <[email protected]>

kgryte · 2025-01-19T23:13:00Z

lib/node_modules/@stdlib/stats/base/dnanmeanpw/lib/ndarray.js

-	dnansumpw( N, WORKSPACE, x, stride, offset );
-	return WORKSPACE[ 0 ] / WORKSPACE[ 1 ];
+function dnanmeanpw( N, x, strideX, offsetX ) {
+	var out = new Float64Array( 2 );


@aayush0325 The WORKSPACE idea is still valid here. Namely, we can avoid allocating a new out array for each call to dnanmeanpw and just reuse the same workspace each time. While not thread safe in C, this is perfectly fine in JS.

i'll keep this in mind!

Signed-off-by: Athan <[email protected]>

kgryte

LGTM

…base/dnanmeanpw` PR-URL: stdlib-js#4763 Co-authored-by: Athan Reines <[email protected]> Co-authored-by: Muhammad Haris <[email protected]> Reviewed-by: Athan Reines <[email protected]> Reviewed-by: Muhammad Haris <[email protected]>

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

headlessNode reviewed Jan 15, 2025

View reviewed changes

lib/node_modules/@stdlib/stats/base/dnanmeanpw/src/main.c Outdated Show resolved Hide resolved

lib/node_modules/@stdlib/stats/base/dnanmeanpw/src/main.c Outdated Show resolved Hide resolved

aayush0325 marked this pull request as draft January 15, 2025 14:34

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

aayush0325 and others added 2 commits January 15, 2025 20:08

fix: use CBLAS_INT instead of int32_t

483045f

aayush0325 commented Jan 16, 2025

View reviewed changes

lib/node_modules/@stdlib/stats/base/dnanmeanpw/lib/ndarray.js Outdated Show resolved Hide resolved

lib/node_modules/@stdlib/stats/base/dnanmeanpw/test/test.ndarray.js Show resolved Hide resolved

headlessNode reviewed Jan 16, 2025

View reviewed changes

aayush0325 added 3 commits January 16, 2025 16:45

docs: update readme

5352d04

aayush0325 commented Jan 17, 2025

View reviewed changes

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

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

aayush0325 added 2 commits January 17, 2025 10:17

aayush0325 marked this pull request as ready for review January 17, 2025 10:24

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

headlessNode reviewed Jan 17, 2025

View reviewed changes

aayush0325 and others added 8 commits January 17, 2025 21:48

Update lib/node_modules/@stdlib/stats/base/dnanmeanpw/README.md

6905209

Co-authored-by: Muhammad Haris <[email protected]> Signed-off-by: Aayush Khanna <[email protected]>

Update lib/node_modules/@stdlib/stats/base/dnanmeanpw/README.md

d628f06

Co-authored-by: Muhammad Haris <[email protected]> Signed-off-by: Aayush Khanna <[email protected]>

Update lib/node_modules/@stdlib/stats/base/dnanmeanpw/README.md

8d9eb1f

Co-authored-by: Muhammad Haris <[email protected]> Signed-off-by: Aayush Khanna <[email protected]>

Update lib/node_modules/@stdlib/stats/base/dnanmeanpw/README.md

7ce536f

Co-authored-by: Muhammad Haris <[email protected]> Signed-off-by: Aayush Khanna <[email protected]>

Update lib/node_modules/@stdlib/stats/base/dnanmeanpw/README.md

3286c79

Co-authored-by: Muhammad Haris <[email protected]> Signed-off-by: Aayush Khanna <[email protected]>

Update lib/node_modules/@stdlib/stats/base/dnanmeanpw/README.md

a2f5a64

Co-authored-by: Muhammad Haris <[email protected]> Signed-off-by: Aayush Khanna <[email protected]>

Update lib/node_modules/@stdlib/stats/base/dnanmeanpw/lib/ndarray.js

2e6e724

Co-authored-by: Muhammad Haris <[email protected]> Signed-off-by: Aayush Khanna <[email protected]>

Update lib/node_modules/@stdlib/stats/base/dnanmeanpw/src/main.c

696c3f2

Co-authored-by: Muhammad Haris <[email protected]> Signed-off-by: Aayush Khanna <[email protected]>

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

chore: fix readme tests

473ceb6

aayush0325 requested a review from kgryte January 18, 2025 16:24

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

aayush0325 marked this pull request as draft January 18, 2025 16:28

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

aayush0325 marked this pull request as ready for review January 19, 2025 00:08

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

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

kgryte reviewed Jan 19, 2025

View reviewed changes

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

kgryte added 2 commits January 19, 2025 15:04

style: enable lint rule

21b4bf0

Signed-off-by: Athan <[email protected]>

style: disable ESLint rules

821d72b

Signed-off-by: Athan <[email protected]>

kgryte reviewed Jan 19, 2025

View reviewed changes

refactor: avoid repeated temporary array allocation

bc9fea3

Signed-off-by: Athan <[email protected]>

kgryte approved these changes Jan 19, 2025

View reviewed changes

kgryte added Feature Issue or pull request for adding a new feature. C Issue involves or relates to C. and removed Needs Review A pull request which needs code review. labels Jan 19, 2025

kgryte merged commit be4a2ee into stdlib-js:develop Jan 19, 2025
43 checks passed

aayush0325 deleted the ndarray-dnanmeanpw branch January 20, 2025 02:41

aayush0325 mentioned this pull request Jan 31, 2025

feat: add C ndarray interface and refactor implementation for stats/base/dnanvariancepn #4838

Merged

1 task

aayush0325 mentioned this pull request Mar 25, 2025

Office Hours (2025-03-25) stdlib-js/meetings#12

Closed

Uh oh!

feat: add C ndarray interface and refactor implementation for stats/base/dnanmeanpw #4763

feat: add C ndarray interface and refactor implementation for stats/base/dnanmeanpw #4763

Uh oh!

Conversation

aayush0325 commented Jan 15, 2025

Description

Related Issues

Questions

Other

Checklist

Uh oh!

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

Uh oh!

Coverage Report

Uh oh!

headlessNode left a comment • 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!

aayush0325 commented Jan 15, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

headlessNode left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aayush0325 commented Jan 17, 2025

Uh oh!

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

Uh oh!

Uh oh!

kgryte commented Jan 19, 2025

Uh oh!

aayush0325 commented Jan 19, 2025

Uh oh!

kgryte commented Jan 19, 2025

Uh oh!

Uh oh!

kgryte Jan 19, 2025

Choose a reason for hiding this comment

Uh oh!

aayush0325 Jan 20, 2025

Choose a reason for hiding this comment

Uh oh!

kgryte left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

feat: add C ndarray interface and refactor implementation for `stats/base/dnanmeanpw` #4763

feat: add C ndarray interface and refactor implementation for `stats/base/dnanmeanpw` #4763

stdlib-bot commented Jan 15, 2025 •

edited

Loading

headlessNode left a comment •

edited

Loading

aayush0325 commented Jan 19, 2025 •

edited

Loading