feat: add ndarray/unshift

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

@@ -0,0 +1,152 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2025 The Stdlib Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+-->
+
+# unshift
+
+> Return a one-dimensional [ndarray][@stdlib/ndarray/ctor] formed by prepending provided scalar values to a one-dimensional input [ndarray][@stdlib/ndarray/ctor].
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- Package usage documentation. -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var unshift = require( '@stdlib/ndarray/unshift' );
+```
+
+#### unshift( x, ...values )
+
+Returns a one-dimensional [ndarray][@stdlib/ndarray/ctor] formed by prepending provided scalar values to a one-dimensional input [ndarray][@stdlib/ndarray/ctor].
+
+```javascript
+var array = require( '@stdlib/ndarray/array' );
+
+var x = array( [ 1.0, 2.0, 3.0, 4.0 ] );
+
+var out = unshift( x, -2.0, -1.0, 0.0 );
+// returns <ndarray>[ -2.0, -1.0, 0.0, 1.0, 2.0, 3.0, 4.0 ]
+```
+
+The function accepts the following arguments:
+
+-   **x**: input [ndarray][@stdlib/ndarray/ctor]. Must be one-dimensional.
+-   **...values**: scalar values to prepend.
+
+#### unshift.assign( x, ...values, out )
+
+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].
+
+```javascript
+var array = require( '@stdlib/ndarray/array' );
+var zeros = require( '@stdlib/ndarray/zeros' );
+
+var x = array( [ 1.0, 2.0, 3.0, 4.0 ] );
+var y = zeros( [ 7 ] );
+
+var out = unshift.assign( x, -2.0, -1.0, 0.0, y );
+// returns <ndarray>[ -2.0, -1.0, 0.0, 1.0, 2.0, 3.0, 4.0 ]
+
+var bool = ( out === y );
+// returns true
+```
+
+The function accepts the following arguments:
+
+-   **x**: input [ndarray][@stdlib/ndarray/ctor]. Must be one-dimensional.
+-   **...values**: scalar values to prepend.
+-   **out**: output [ndarray][@stdlib/ndarray/ctor]. Must be one-dimensional.
+
+</section>
+
+<!-- /.usage -->
+
+<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+## Notes
+
+-   Scalar values are cast to the [data type][@stdlib/ndarray/dtypes] of the input [ndarray][@stdlib/ndarray/ctor].
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+```javascript
+var discreteUniform = require( '@stdlib/random/discrete-uniform' );
+var ndarray2array = require( '@stdlib/ndarray/to-array' );
+var unshift = require( '@stdlib/ndarray/unshift' );
+
+var opts = {
+    'dtype': 'generic'
+};
+var x = discreteUniform( [ 6 ], 0, 10, opts );
+console.log( ndarray2array( x ) );
+
+var out = unshift( x, 12, 14 );
+console.log( ndarray2array( out ) );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="references">
+
+</section>
+
+<!-- /.references -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
+
+[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/dtypes
+
+</section>
+
+<!-- /.links -->

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

@@ -0,0 +1,115 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2025 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
+var zeros = require( '@stdlib/ndarray/zeros' );
+var format = require( '@stdlib/string/format' );
+var pkg = require( './../package.json' ).name;
+var unshift = require( './../lib/assign.js' );
+
+
+// MAIN //
+
+bench( format( '%s:assign:num_scalars=2', pkg ), function benchmark( b ) {
+	var opts;
+	var out;
+	var v;
+	var x;
+	var i;
+
+	opts = {
+		'dtype': 'float64'
+	};
+	x = zeros( [ 3 ], opts );
+	out = zeros( [ 5 ], opts );
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		v = unshift( x, 1.0, 2.0, out );
+		if ( typeof v !== 'object' ) {
+			b.fail( 'should return an ndarray' );
+		}
+	}
+	b.toc();
+	if ( !isndarrayLike( v ) ) {
+		b.fail( 'should return an ndarray' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+bench( format( '%s:assign:num_scalars=4', pkg ), function benchmark( b ) {
+	var opts;
+	var out;
+	var v;
+	var x;
+	var i;
+
+	opts = {
+		'dtype': 'float64'
+	};
+	x = zeros( [ 3 ], opts );
+	out = zeros( [ 7 ], opts );
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		v = unshift( x, 1.0, 2.0, 3.0, 4.0, out );
+		if ( typeof v !== 'object' ) {
+			b.fail( 'should return an ndarray' );
+		}
+	}
+	b.toc();
+	if ( !isndarrayLike( v ) ) {
+		b.fail( 'should return an ndarray' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+bench( format( '%s:assign:num_scalars=6', pkg ), function benchmark( b ) {
+	var opts;
+	var out;
+	var v;
+	var x;
+	var i;
+
+	opts = {
+		'dtype': 'float64'
+	};
+	x = zeros( [ 3 ], opts );
+	out = zeros( [ 9 ], opts );
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		v = unshift( x, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, out );
+		if ( typeof v !== 'object' ) {
+			b.fail( 'should return an ndarray' );
+		}
+	}
+	b.toc();
+	if ( !isndarrayLike( v ) ) {
+		b.fail( 'should return an ndarray' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

lib/node_modules/@stdlib/ndarray/unshift/benchmark/benchmark.js

@@ -0,0 +1,109 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2025 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
+var zeros = require( '@stdlib/ndarray/zeros' );
+var format = require( '@stdlib/string/format' );
+var pkg = require( './../package.json' ).name;
+var unshift = require( './../lib' );
+
+
+// MAIN //
+
+bench( format( '%s:num_scalars=2', pkg ), function benchmark( b ) {
+	var opts;
+	var v;
+	var x;
+	var i;
+
+	opts = {
+		'dtype': 'float64'
+	};
+	x = zeros( [ 3 ], opts );
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		v = unshift( x, 1.0, 2.0 );
+		if ( typeof v !== 'object' ) {
+			b.fail( 'should return an ndarray' );
+		}
+	}
+	b.toc();
+	if ( !isndarrayLike( v ) ) {
+		b.fail( 'should return an ndarray' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+bench( format( '%s:num_scalars=4', pkg ), function benchmark( b ) {
+	var opts;
+	var v;
+	var x;
+	var i;
+
+	opts = {
+		'dtype': 'float64'
+	};
+	x = zeros( [ 3 ], opts );
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		v = unshift( x, 1.0, 2.0, 3.0, 4.0 );
+		if ( typeof v !== 'object' ) {
+			b.fail( 'should return an ndarray' );
+		}
+	}
+	b.toc();
+	if ( !isndarrayLike( v ) ) {
+		b.fail( 'should return an ndarray' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+bench( format( '%s:num_scalars=6', pkg ), function benchmark( b ) {
+	var opts;
+	var v;
+	var x;
+	var i;
+
+	opts = {
+		'dtype': 'float64'
+	};
+	x = zeros( [ 3 ], opts );
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		v = unshift( x, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 );
+		if ( typeof v !== 'object' ) {
+			b.fail( 'should return an ndarray' );
+		}
+	}
+	b.toc();
+	if ( !isndarrayLike( v ) ) {
+		b.fail( 'should return an ndarray' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});