feat: add `blas/ext/base/ndarray/dsort2hp` #9272

MeKaustubh07 · 2025-12-20T07:30:11Z

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 blas/ext/base/ndarray/dsort2hp

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

This PR was created by duplicating the dsorthp package and adapting it to compute the maximum absolute value instead of the maximum value. GitHub Copilot assisted with updating test cases, documentation, and verifying consistency across all files.

@stdlib-js/reviewers

stdlib-bot · 2025-12-20T07:31:48Z

Coverage Report

Package	Statements	Branches	Functions	Lines
blas/ext/base/ndarray/dsort2hp	$\color{green}143/143$ $\color{green}+0.00%$	$\color{green}3/3$ $\color{green}+0.00%$	$\color{green}1/1$ $\color{green}+0.00%$	$\color{green}143/143$ $\color{green}+0.00%$

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

kgryte · 2025-12-20T07:59:27Z

lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort2hp/README.md

+    'dtype': 'generic'
+});
+
+var out = dsort2hp( [ x, y, order ] );


You should probably show that the return array is the first input array.

var bool = ( out === x ); // returns true

kgryte · 2025-12-20T08:00:17Z

lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort2hp/README.md

+var out = dsort2hp( [ x, y, order ] );
+// returns <ndarray>
+
+var arrX = ndarray2array( out );


Using ndarray2array here is fine, as it is not readily doable to use <ndarray>[ ... ] notation above.

kgryte · 2025-12-20T08:01:45Z

lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort2hp/benchmark/benchmark.js

+	for ( i = min; i <= max; i++ ) {
+		len = pow( 10, i );
+		f = createBenchmark( len );
+		bench( pkg+':len='+len, f );


@MeKaustubh07 Mind for all future PRs going ahead and heeding the lint warning here? Namely, using @string/string/format for benchmark descriptions. This will save ourselves future work.

kgryte · 2025-12-20T08:03:18Z

lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort2hp/docs/repl.txt

+    Simultaneously sorts two one-dimensional double-precision floating-point
+    ndarrays based on the sort order of the first array using heapsort.
+
+    When the sort order is less than zero, the input ndarrays are sorted in


This note is not accurate. We only sort the first input ndarray in decreasing order. The second input ndarray is sorted based on the first and that likely means it is not sorted in either ascending or descending order.

kgryte · 2025-12-20T08:03:58Z

lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort2hp/docs/repl.txt

+    decreasing order. When the sort order is greater than zero, the input
+    ndarrays are sorted in increasing order. When the sort order is equal to
+    zero, the input ndarrays are left unchanged.
+


Compared to blas/ext/base/dsort2hp, you've left out a number of the notes regarding sort properties. Why?

We should likely include those notes, with some modification, as well as include the omitted notes in the sorting packages you've already landed.

kgryte · 2025-12-20T08:04:41Z

lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort2hp/docs/types/index.d.ts

+*
+* ## Notes
+*
+* -   When the sort order is less than zero, the input ndarrays are sorted in **decreasing** order. When the sort order is greater than zero, the input ndarrays are sorted in **increasing** order. When the sort order is equal to zero, the input ndarrays are left unchanged.


This note isn't accurate.

kgryte · 2025-12-20T08:06:48Z

lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort2hp/lib/main.js

+*
+* ## Notes
+*
+* -   When the sort order is less than zero, the input ndarrays are sorted in **decreasing** order. When the sort order is greater than zero, the input ndarrays are sorted in **increasing** order. When the sort order is equal to zero, the input ndarrays are left unchanged.


This note isn't accurate.

kgryte · 2025-12-20T08:07:02Z

lib/node_modules/@stdlib/blas/ext/base/ndarray/dsort2hp/lib/main.js

+* -   When the sort order is less than zero, the input ndarrays are sorted in **decreasing** order. When the sort order is greater than zero, the input ndarrays are sorted in **increasing** order. When the sort order is equal to zero, the input ndarrays are left unchanged.
+*
+* @param {ArrayLikeObject<Object>} arrays - array-like object containing two one-dimensional input ndarrays and a zero-dimensional ndarray specifying the sort order
+* @returns {ndarray} first input ndarray


Suggested change

* @returns {ndarray} first input ndarray

* @returns {Object} first input ndarray

Why do we use Object here? The reason is due to how these packages are used. Namely, they are consumed by higher-order machinery which doesn't actually pass in an ndarray here, but an object with ndarray-like properties. Hence, we use Object, rather than ndarray, where the latter conveys an instance.

We could use ndarrayLike, but we've already established precedent with ArrayLikeObject<Object>.

kgryte

Left an initial review.

MeKaustubh07 · 2025-12-20T08:14:51Z

@kgryte: I understand the concerns.I’ll address all of the suggested changes and ensure greater consistency going forward to avoid this in future PRs.

MeKaustubh07 added 2 commits December 20, 2025 11:50

initial changes

e7efc6b

feat: add blas/ext/base/ndarray/dsort2hp

f1e7758

stdlib-bot added BLAS Issue or pull request related to Basic Linear Algebra Subprograms (BLAS). Needs Review A pull request which needs code review. labels Dec 20, 2025

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

kgryte reviewed Dec 20, 2025

View reviewed changes

kgryte requested changes Dec 20, 2025

View reviewed changes

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

fix: address review feedback for dsort2hp ndarray wrapper

c140521

MeKaustubh07 force-pushed the blas/dsort2hp branch from a958d5e to c140521 Compare December 20, 2025 10:09

	* @returns {ndarray} first input ndarray
	* @returns {Object} first input ndarray

Uh oh!

feat: add blas/ext/base/ndarray/dsort2hp #9272

Are you sure you want to change the base?

feat: add blas/ext/base/ndarray/dsort2hp #9272

Conversation

MeKaustubh07 commented Dec 20, 2025

Description

Related Issues

Questions

Other

Checklist

AI Assistance

Disclosure

Uh oh!

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

Uh oh!

Coverage Report

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!

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!

MeKaustubh07 commented Dec 20, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

feat: add `blas/ext/base/ndarray/dsort2hp` #9272

feat: add `blas/ext/base/ndarray/dsort2hp` #9272

stdlib-bot commented Dec 20, 2025 •

edited

Loading