feat: add ndarray/base/every-by

[headlessNode]

---

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

Description

What is the purpose of this pull request?

This pull request:

• adds ndarray/base/every-by

Related Issues

Does this pull request have any related issues?

This pull request:

• progresses [RFC]: achieve ndarray API parity with built-in JavaScript arrays  #2656

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

[stdlib-bot]

Coverage Report

Package	Statements	Branches	Functions	Lines
ndarray/base/every-by	$3947/8574$ $+46.03\mathrm{\%}$	$51/53$ $+96.23\mathrm{\%}$	$3/43$ $+6.98\mathrm{\%}$	$3947/8574$ $+46.03\mathrm{\%}$

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

[kgryte]

@headlessNode A couple of comments:

1. I updated all the descriptions and parameters to match what we already use in @stdlib/ndarray/base/every-by. As a general rule of thumb, it can be useful to cross reference what we already have elsewhere. It can be useful when ensuring that we are consistent in our descriptions and parameter naming.
2. You needed to think a bit more clearly in main.js. Namely, we cannot flatten or pursue other iteration patterns. We need to choose the loop which exactly matches the dimensionality of the input ndarray. Why? Otherwise, this violates user expectations when it comes to the indices argument passed along to the predicate function. If I give as input a 10d ndarray, the callback should not be invoked with only a single element index. It should always have 10 indices. As a general rule, anytime a user provides a callback which is explicit dependent on dimensionality, we cannot flatten. We did the same thing in ndarray/base/map and ndarray/base/for-each--both of which you previously worked on.
3. Be careful copy-paste mistakes.
4. For your accessor examples, I updated to actually use the entire data buffer. It is a bit odd to only use half the buffer. This likely stemmed from converting an example for complex numbers to one involving real numbers. Something to keep in mind. In short, we want to avoid doing odd things in examples, lest we make readers think they are missing something.
5. Are you wanting to add additional tests in this PR or in a follow-up PR?

[headlessNode]

@kgryte Understood. And yes, I was planning on adding tests for both every-by and unary-reduce-subarray-by in separate PRs than main implementation.

[kgryte]

@headlessNode In that case, I'll go ahead and merge this one.