refactor(stats/base/cuminabs): add accessor protocol support #6067

jsndz · 2025-03-15T10:20:44Z

Refactored cuminabs implementation to support accessor protocol.
Standardized descriptions and parameter documentation.
Updated examples and benchmarks to align with stdlib conventions.
Reduced code duplication by delegating main entry point to ndarray API.
Added explicit tests for accessor arrays.
Ensured compatibility with strided array dependencies.

Resolves #5645.

Description

What is the purpose of this pull request?

This pull request:

{{TODO: add description describing what this pull request does}}
Refactors stats/base/cuminabs to support the accessor protocol.
Standardizes descriptions and parameter documentation.
Updates examples and benchmarks to align with stdlib conventions.
Reduces code duplication by delegating the main entry point to the ndarray API.
Adds explicit tests for accessor arrays.
Ensures compatibility with strided array dependencies.

Related Issues

Does this pull request have any related issues?

This pull request:

resolves [RFC]: refactor and add protocol support to stats/base/cuminabs #5645

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.

Benchmark:

tests:

examples:

Checklist

Please ensure the following tasks are completed before submitting this pull request.

Read, understood, and followed the contributing guidelines.

@stdlib-js/reviewers

- Refactored cuminabs implementation to support accessor protocol. - Standardized descriptions and parameter documentation. - Updated examples and benchmarks to align with stdlib conventions. - Reduced code duplication by delegating main entry point to ndarray API. - Added explicit tests for accessor arrays. - Ensured compatibility with strided array dependencies.

stdlib-bot · 2025-03-15T10:21:48Z

Coverage Report

Package	Statements	Branches	Functions	Lines
stats/base/cuminabs	$\color{green}363/363$ $\color{green}+100.00\%$	$\color{green}30/30$ $\color{green}+100.00\%$	$\color{green}3/3$ $\color{green}+100.00\%$	$\color{green}363/363$ $\color{green}+100.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: 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: 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: 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 ---

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

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

lib/node_modules/@stdlib/stats/base/cuminabs/lib/accessors.js

Co-authored-by: Aayush Khanna <96649223+aayush0325@users.noreply.github.com> Signed-off-by: Jaison D Souza <123267719+jsndz@users.noreply.github.com>

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

Signed-off-by: Athan <kgryte@gmail.com>

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

Signed-off-by: Athan <kgryte@gmail.com>

lib/node_modules/@stdlib/stats/base/cuminabs/lib/accessors.js

Signed-off-by: Athan <kgryte@gmail.com>

lib/node_modules/@stdlib/stats/base/cuminabs/test/test.cuminabs.js

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

kgryte · 2025-03-19T10:03:14Z

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

+	];
+	N = 3;
+
+	cuminabs(N, toAccessorArray(x), -2, x.length - 1, toAccessorArray(y), -1, 2);


Same comment.

Thank you for you patience and time

kgryte

Apart from some minor nitpicks, this is looking good. Once resolved, it should be ready for merge.

…s.js Co-authored-by: Athan <kgryte@gmail.com> Signed-off-by: Jaison D Souza <123267719+jsndz@users.noreply.github.com>

Co-authored-by: Athan <kgryte@gmail.com> Signed-off-by: Jaison D Souza <123267719+jsndz@users.noreply.github.com>

Signed-off-by: Jaison D Souza <123267719+jsndz@users.noreply.github.com>

stdlib-bot added Statistics Issue or pull request related to statistical functionality. Needs Review A pull request which needs code review. Good First PR A pull request resolving a Good First Issue. labels Mar 15, 2025

jsndz added 15 commits March 15, 2025 16:22

fixup! refactor(stats/base/cuminabs): Fixed README example

7e7602e

fixup! refactor(stats/base/cuminabs): Fixed lint error

044a99c

fixup! refactor(stats/base/cuminabs): Fixed lint error 2

f385c11

fixup! refactor(stats/base/cuminabs): Fixed lint error 3

931d23b

fixup! refactor(stats/base/cuminabs): Fixed lint error 4

f16941b

aayush0325 requested changes Mar 16, 2025

View reviewed changes

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

lib/node_modules/@stdlib/stats/base/cuminabs/lib/accessors.js Outdated Show resolved Hide resolved

lib/node_modules/@stdlib/stats/base/cuminabs/lib/accessors.js Outdated Show resolved Hide resolved

aayush0325 requested a review from kgryte March 16, 2025 11:42

jsndz and others added 3 commits March 16, 2025 17:29

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

6d26282

Co-authored-by: Aayush Khanna <96649223+aayush0325@users.noreply.github.com> Signed-off-by: Jaison D Souza <123267719+jsndz@users.noreply.github.com>

Update lib/node_modules/@stdlib/stats/base/cuminabs/lib/accessors.js

594cc53

Co-authored-by: Aayush Khanna <96649223+aayush0325@users.noreply.github.com> Signed-off-by: Jaison D Souza <123267719+jsndz@users.noreply.github.com>

Update lib/node_modules/@stdlib/stats/base/cuminabs/lib/accessors.js

ab41736

Co-authored-by: Aayush Khanna <96649223+aayush0325@users.noreply.github.com> Signed-off-by: Jaison D Souza <123267719+jsndz@users.noreply.github.com>

aayush0325 previously approved these changes Mar 18, 2025

View reviewed changes