feat: add `ndarray/unshift` #9066

headlessNode · 2025-12-15T15:14:06Z

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#134.

Description

What is the purpose of this pull request?

This pull request:

{{TODO: add description describing what this pull request does}}

Related Issues

Does this pull request have any related issues?

This pull request has the following related issues:

Resolves [RFC]: add ndarray/unshift metr-issue-tracker#134
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-15T15:15:50Z

Coverage Report

Package	Statements	Branches	Functions	Lines
ndarray/unshift	$\color{green}218/218$ $\color{green}+0.00%$	$\color{green}22/22$ $\color{green}+0.00%$	$\color{green}2/2$ $\color{green}+0.00%$	$\color{green}218/218$ $\color{green}+0.00%$

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

kgryte · 2025-12-19T10:35:06Z

@headlessNode The changes made in #9054 will likely carry over to 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: 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 ---

--- 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: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---

headlessNode · 2025-12-21T09:17:22Z

@kgryte in #9054 you changes the function description in the README.md and the package.json. But in the README.md the "Return..." and "Returns..." versions are a little different. Is that intentional or do we need to fix that?

kgryte · 2025-12-21T09:43:19Z

Yeah, we should update the main README and package description to include "one-dimensional".

kgryte · 2025-12-21T21:45:24Z

@headlessNode Is this ready for review or do you still need to make additional changes? I went ahead and updated the main README description in ndarray/push.

headlessNode · 2025-12-22T06:40:07Z

@kgryte yeah, ready for review.

kgryte · 2025-12-23T08:25:42Z

lib/node_modules/@stdlib/ndarray/unshift/README.md

+
+# unshift
+
+> Return a one-dimensional [ndarray][@stdlib/ndarray/ctor] formed by prepending the provided scalar values to a one-dimensional input [ndarray][@stdlib/ndarray/ctor].


Suggested change

> Return a one-dimensional [ndarray][@stdlib/ndarray/ctor] formed by prepending the provided scalar values to a one-dimensional input [ndarray][@stdlib/ndarray/ctor].

> Return a one-dimensional [ndarray][@stdlib/ndarray/ctor] formed by prepending provided scalar values to a one-dimensional input [ndarray][@stdlib/ndarray/ctor].

This change applies throughout this PR.

kgryte · 2025-12-23T08:26:11Z

lib/node_modules/@stdlib/ndarray/unshift/README.md

+
+#### unshift.assign( x, ...values, out )
+
+Prepends the provided scalar values to a one-dimensional input [ndarray][@stdlib/ndarray/ctor] and assigns the result to a provided one-dimensional output [ndarray][@stdlib/ndarray/ctor].


Suggested change

Prepends the provided scalar values to a one-dimensional input [ndarray][@stdlib/ndarray/ctor] and assigns the result to a provided one-dimensional output [ndarray][@stdlib/ndarray/ctor].

Prepends provided scalar values to a one-dimensional input [ndarray][@stdlib/ndarray/ctor] and assigns the result to a provided one-dimensional output [ndarray][@stdlib/ndarray/ctor].

This change applies throughout this PR.

kgryte · 2025-12-23T08:29:06Z

lib/node_modules/@stdlib/ndarray/unshift/examples/index.js

+
+'use strict';
+
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );


@headlessNode Use random/discrete-uniform directly.

discreteUniform( [ 6 ], 0, 10, opts );

kgryte · 2025-12-23T08:33:21Z

lib/node_modules/@stdlib/ndarray/unshift/test/test.assign.js

+
+	function badValue( value ) {
+		return function badValue() {
+			unshift( zeros( [ 2 ]), 0.0, value );


Suggested change

unshift( zeros( [ 2 ]), 0.0, value );

unshift( zeros( [ 2 ] ), 0.0, value );

kgryte · 2025-12-23T08:34:25Z

lib/node_modules/@stdlib/ndarray/unshift/test/test.assign.js

+	}
+});
+
+tape( 'the function prepends the provided provided scalar values to the input ndarray and assigns results to an output ndarray (row-major, contiguous)', function test( t ) {


Suggested change

tape( 'the function prepends the provided provided scalar values to the input ndarray and assigns results to an output ndarray (row-major, contiguous)', function test( t ) {

tape( 'the function prepends provided provided scalar values to the input ndarray and assigns results to an output ndarray (row-major, contiguous)', function test( t ) {

Applies here and elsewhere.

kgryte · 2025-12-23T08:34:57Z

lib/node_modules/@stdlib/ndarray/unshift/README.md

+## Examples
+
+```javascript
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );


Use random/discrete-uniform directly.

kgryte

Left an initial round of comments.

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

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

headlessNode requested a review from kgryte December 15, 2025 15:16

kgryte added Needs Changes Pull request which needs changes before being merged. and removed Needs Review A pull request which needs code review. labels Dec 19, 2025

headlessNode and others added 3 commits December 21, 2025 13:13

Merge branch 'stdlib-js:develop' into nd-unshift

edc6b22

Merge branch 'stdlib-js:develop' into nd-unshift

d6e59dc

headlessNode added Needs Review A pull request which needs code review. and removed Needs Changes Pull request which needs changes before being merged. labels Dec 22, 2025

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

kgryte reviewed Dec 23, 2025

View reviewed changes

kgryte requested changes Dec 23, 2025

View reviewed changes

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


		# unshift

		> Return a one-dimensional [ndarray][@stdlib/ndarray/ctor] formed by prepending the provided scalar values to a one-dimensional input [ndarray][@stdlib/ndarray/ctor].


		#### unshift.assign( x, ...values, out )

		Prepends the provided scalar values to a one-dimensional input [ndarray][@stdlib/ndarray/ctor] and assigns the result to a provided one-dimensional output [ndarray][@stdlib/ndarray/ctor].

	Prepends the provided scalar values to a one-dimensional input [ndarray][@stdlib/ndarray/ctor] and assigns the result to a provided one-dimensional output [ndarray][@stdlib/ndarray/ctor].
	Prepends provided scalar values to a one-dimensional input [ndarray][@stdlib/ndarray/ctor] and assigns the result to a provided one-dimensional output [ndarray][@stdlib/ndarray/ctor].


		'use strict';

		var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );

	unshift( zeros( [ 2 ]), 0.0, value );
	unshift( zeros( [ 2 ] ), 0.0, value );

	tape( 'the function prepends the provided provided scalar values to the input ndarray and assigns results to an output ndarray (row-major, contiguous)', function test( t ) {
	tape( 'the function prepends provided provided scalar values to the input ndarray and assigns results to an output ndarray (row-major, contiguous)', function test( t ) {

Uh oh!

feat: add ndarray/unshift #9066

Are you sure you want to change the base?

feat: add ndarray/unshift #9066

Conversation

headlessNode commented Dec 15, 2025

Description

Related Issues

Questions

Other

Checklist

AI Assistance

Disclosure

Uh oh!

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

Uh oh!

Coverage Report

Uh oh!

kgryte commented Dec 19, 2025

Uh oh!

headlessNode commented Dec 21, 2025

Uh oh!

kgryte commented Dec 21, 2025

Uh oh!

kgryte commented Dec 21, 2025

Uh oh!

headlessNode commented Dec 22, 2025

Uh oh!

kgryte Dec 23, 2025

Choose a reason for hiding this comment

Uh oh!

kgryte Dec 23, 2025

Choose a reason for hiding this comment

Uh oh!

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

kgryte Dec 23, 2025

Choose a reason for hiding this comment

Uh oh!

kgryte Dec 23, 2025

Choose a reason for hiding this comment

Uh oh!

kgryte Dec 23, 2025

Choose a reason for hiding this comment

Uh oh!

kgryte Dec 23, 2025

Choose a reason for hiding this comment

Uh oh!

kgryte left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

feat: add `ndarray/unshift` #9066

feat: add `ndarray/unshift` #9066

stdlib-bot commented Dec 15, 2025 •

edited

Loading

kgryte Dec 23, 2025 •

edited

Loading