feat: add `blas/ext/join` #9009

headlessNode · 2025-12-12T17:07:49Z

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 stdlib-js/metr-issue-tracker#124.

Description

What is the purpose of this pull request?

This pull request:

add blas/ext/join

Related Issues

Does this pull request have any related issues?

This pull request has the following related issues:

Resolves [RFC]: add blas/ext/join metr-issue-tracker#124
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.

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

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

stdlib-bot · 2025-12-12T17:09:35Z

Coverage Report

Package	Statements	Branches	Functions	Lines
blas/ext/join	$\color{red}453/459$ $\color{green}+0.00%$	$\color{red}35/38$ $\color{green}+0.00%$	$\color{green}2/2$ $\color{green}+0.00%$	$\color{red}453/459$ $\color{green}+0.00%$

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

lib/node_modules/@stdlib/blas/ext/join/benchmark/benchmark.assign.js

Signed-off-by: Muhammad Haris <[email protected]>

lib/node_modules/@stdlib/blas/ext/join/lib/assign.js

Signed-off-by: Muhammad Haris <[email protected]>

lib/node_modules/@stdlib/blas/ext/join/lib/assign.js

Signed-off-by: Muhammad Haris <[email protected]>

lib/node_modules/@stdlib/blas/ext/join/benchmark/benchmark.assign.js

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

lib/node_modules/@stdlib/blas/ext/join/docs/types/index.d.ts

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

lib/node_modules/@stdlib/blas/ext/join/docs/types/test.ts

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

kgryte · 2025-12-16T03:11:13Z

lib/node_modules/@stdlib/blas/ext/join/lib/base.js

+var odtypes = dtypes( 'all' );
+var policies = {
+	'output': 'same',
+	'casting': 'promoted'
+};


@headlessNode What is the rationale behind this configuration? Why is "promotion" being used here? Why is the output policy to return an ndarray having the "same" dtype?

Also, this is a unary API. What exactly is supposed to be promoted? Between what arrays?

@kgryte I was trying to create a 'default' output policy here i.e. If input dtype is generic. promotion to "promote" say float64 to generic if input is float64 but that doesn't work.

kgryte · 2025-12-16T03:11:42Z

lib/node_modules/@stdlib/blas/ext/join/lib/assign.js

+	if ( getDType( out ) !== 'generic' ) {
+		throw new TypeError( format( 'invalid argument. Third argument must be an ndarray-like object having the generic data type. Value: `%s`.', out ) );
+	}
+


Suggested change

if ( getDType( out ) !== 'generic' ) {

throw new TypeError( format( 'invalid argument. Third argument must be an ndarray-like object having the generic data type. Value: `%s`.', out ) );

}

This check is not necessary. It should be delegated to the dispatcher.

kgryte · 2025-12-16T03:12:49Z

lib/node_modules/@stdlib/blas/ext/join/lib/assign.js

+* @throws {TypeError} first argument must be an ndarray-like object
+* @throws {TypeError} second argument must be either an ndarray-like object or a scalar value
+* @throws {TypeError} third argument must be an ndarray-like object
+* @throws {TypeError} third argument must be an ndarray-like object having the generic data type


Suggested change

* @throws {TypeError} third argument must be an ndarray-like object having the generic data type

kgryte · 2025-12-16T03:14:31Z

lib/node_modules/@stdlib/blas/ext/join/lib/assign.js

+	if ( nargs < 3 ) {
+		throw new TypeError( format( 'invalid argument. Third argument must be an ndarray-like object. Value: `%s`.', out ) );
+	}


Why are you validating this way? Why not !isndarrayLike( out )? Given that >=3 args must always be provided, you can validate out explicitly.

However, as commented in the README, I am not sure I agree with the requirement that a separator argument always be provided. Not clear why we are not defaulting to ',' for the separator, similar to Array.prototype.join.

For an API which also has an optional second positional argument, see https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/cusum.

@kgryte Yes, also in the sentinelValue in ndarray/find. Whose initial implementation(sentinel not optional) was stuck in my mind but I should've checked.

The argument juggling done there should be informative.

I suppose, in principle, one could have a custom separator "object" with a custom toPrimitive method, which might be confusing when trying to distinguish from an options object during argument juggling, but this seems like a niche use case that we shouldn't bend over backward to accommodate. In this scenario, a user could always do join( x, String( sep ) ) to force string serialization.

kgryte · 2025-12-16T03:15:33Z

lib/node_modules/@stdlib/blas/ext/join/README.md

+var join = require( '@stdlib/blas/ext/join' );
+```
+
+#### join( x, separator\[, options] )


@headlessNode Why is a separator argument required for the top-level API? Why aren't we defaulting to the most common scenario of , and having separator be an optional positional argument?

kgryte · 2025-12-16T03:17:35Z

lib/node_modules/@stdlib/blas/ext/join/lib/main.js

+* Returns an ndarray created by joining elements using a specified separator along an ndarray dimension.
+*
+* @param {ndarrayLike} x - input ndarray
+* @param {(ndarrayLike|*)} separator - separator


Same comment regarding whether this should be a required argument.

kgryte

Left initial comments.

kgryte · 2025-12-16T03:29:13Z

lib/node_modules/@stdlib/blas/ext/join/lib/base.js

+var idtypes0 = dtypes( 'all' ); // input ndarray
+var idtypes1 = dtypes( 'all' ); // separator ndarray
+var odtypes = dtypes( 'all' );
+var policies = {
+	'output': 'same',
+	'casting': 'promoted'
+};


Suggested change

var idtypes0 = dtypes( 'all' ); // input ndarray

var idtypes1 = dtypes( 'all' ); // separator ndarray

var odtypes = dtypes( 'all' );

var policies = {

'output': 'same',

'casting': 'promoted'

};

var idtypes0 = dtypes( 'all' ); // input ndarray

var idtypes1 = [ 'generic' ]; // separator ndarray

var odtypes = [ 'generic' ];

var policies = {

'output': 'same', // note: because we always return a "generic" ndarray, this policy is effectively ignored

'casting': 'none'

};

~~@kgryte I think we'll get an error if x = float64ndarray~~

The solution here is not to explicitly cast the input array, thus copying the input array to a temporary buffer, as that is definitely not necessary.

Instead, in main.js, you just need to explicitly pass down a dtype option equal to generic, which you already do.

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 12, 2025

headlessNode added the Feature Issue or pull request for adding a new feature. label Dec 12, 2025

headlessNode commented Dec 12, 2025

View reviewed changes

lib/node_modules/@stdlib/blas/ext/join/benchmark/benchmark.assign.js Show resolved Hide resolved

refactor: apply suggestions from code review

f24e125

Signed-off-by: Muhammad Haris <[email protected]>

headlessNode commented Dec 12, 2025

View reviewed changes

lib/node_modules/@stdlib/blas/ext/join/lib/assign.js Outdated Show resolved Hide resolved

Merge branch 'stdlib-js:develop' into j-b

a21b835

headlessNode commented Dec 13, 2025

View reviewed changes

lib/node_modules/@stdlib/blas/ext/join/lib/assign.js Show resolved Hide resolved

chore: apply suggestion from code review

a25a3a4

Signed-off-by: Muhammad Haris <[email protected]>

headlessNode commented Dec 14, 2025

View reviewed changes

lib/node_modules/@stdlib/blas/ext/join/lib/assign.js Show resolved Hide resolved

fix: lint error

a945261

Signed-off-by: Muhammad Haris <[email protected]>

kgryte removed the Needs Review A pull request which needs code review. label Dec 16, 2025

kgryte reviewed Dec 16, 2025

View reviewed changes

lib/node_modules/@stdlib/blas/ext/join/benchmark/benchmark.assign.js Outdated Show resolved Hide resolved

kgryte added 2 commits December 15, 2025 19:01

bench: use consistent dtype between benchmarks

7df7541

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

fix: increase type specificity

5b6b5c0

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

kgryte reviewed Dec 16, 2025

View reviewed changes

lib/node_modules/@stdlib/blas/ext/join/docs/types/index.d.ts Outdated Show resolved Hide resolved

fix: allow non-"generic" output ndarrays

14fc1ac

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

kgryte reviewed Dec 16, 2025

View reviewed changes

lib/node_modules/@stdlib/blas/ext/join/docs/types/test.ts Outdated Show resolved Hide resolved

test: fix return values

7007cf4

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

kgryte reviewed Dec 16, 2025

View reviewed changes

kgryte requested changes Dec 16, 2025

View reviewed changes

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

kgryte reviewed Dec 16, 2025

View reviewed changes

	if ( getDType( out ) !== 'generic' ) {
	throw new TypeError( format( 'invalid argument. Third argument must be an ndarray-like object having the generic data type. Value: `%s`.', out ) );
	}

Uh oh!

feat: add blas/ext/join #9009

Are you sure you want to change the base?

feat: add blas/ext/join #9009

Conversation

headlessNode commented Dec 12, 2025

Description

Related Issues

Questions

Other

Checklist

AI Assistance

Disclosure

Uh oh!

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

Uh oh!

Coverage Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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!

Choose a reason for hiding this comment

Uh oh!

kgryte left a comment

Choose a reason for hiding this comment

Uh oh!

kgryte Dec 16, 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!

headlessNode Dec 16, 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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

feat: add `blas/ext/join` #9009

feat: add `blas/ext/join` #9009

stdlib-bot commented Dec 12, 2025 •

edited

Loading

kgryte Dec 16, 2025 •

edited

Loading

headlessNode Dec 16, 2025 •

edited

Loading