feat: add ndarray/base/insert-dimension

lib/node_modules/@stdlib/ndarray/base/insert-dimension/README.md

@@ -0,0 +1,146 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2026 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.
+
+-->
+
+# insertDimension
+
+> Insert a new dimension of size one at a specified dimension index of an input ndarray.
+
+<!-- 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 insertDimension = require( '@stdlib/ndarray/base/insert-dimension' );
+```
+
+#### insertDimension( x, dim, writable )
+
+Inserts a new dimension of size one at a specified dimension index of an input ndarray.
+
+```javascript
+var getShape = require( '@stdlib/ndarray/shape' );
+var array = require( '@stdlib/ndarray/array' );
+
+// Create a 2x2 ndarray:
+var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
+// returns <ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
+
+// Prepend a singleton dimension:
+var y = insertDimension( x, 0, false );
+// returns <ndarray>[ [ [ 1, 2 ], [ 3, 4 ] ] ]
+
+var sh = getShape( y );
+// returns [ 1, 2, 2 ]
+
+// Append a singleton dimension:
+y = insertDimension( x, 2, false );
+// returns <ndarray>[ [ [ 1 ], [ 2 ] ], [ [ 3 ], [ 4 ] ] ]
+
+sh = getShape( y );
+// returns [ 2, 2, 1 ]
+
+// Insert a singleton dimension:
+y = insertDimension( x, 1, false );
+// returns <ndarray>[ [ [ 1, 2 ] ], [ [ 3, 4 ] ] ]
+
+sh = getShape( y );
+// returns [ 2, 1, 2 ]
+```
+
+The function accepts the following arguments:
+
+-   **x**: input ndarray.
+-   **dim**: dimension index at which to insert a singleton dimension.
+-   **writable**: boolean indicating whether a returned ndarray should be writable.
+
+</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
+
+-   A provided dimension index must reside on the interval `[-N-1, N]`, where `N` is the rank (i.e., number of dimensions) of the provided input array. If provided a negative dimension index, the position at which to insert a singleton dimension is computed as `N + dim + 1`. Hence, if provided `-1`, the resolved position is `N` (i.e., a singleton dimension is appended to the input array).
+-   The `writable` parameter **only** applies to ndarray constructors supporting **read-only** instances.
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var uniform = require( '@stdlib/random/uniform' );
+var ndarray2array = require( '@stdlib/ndarray/to-array' );
+var insertDimension = require( '@stdlib/ndarray/base/insert-dimension' );
+
+var x = uniform( [ 3, 3, 3 ], -10.0, 10.0 );
+console.log( ndarray2array( x ) );
+
+var y = insertDimension( x, 1, false );
+console.log( ndarray2array( y ) );
+```
+
+</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">
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/ndarray/base/insert-dimension/benchmark/benchmark.js

@@ -0,0 +1,115 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2026 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 Float64Array = require( '@stdlib/array/float64' );
+var ndarrayBase = require( '@stdlib/ndarray/base/ctor' );
+var ndarray = require( '@stdlib/ndarray/ctor' );
+var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
+var format = require( '@stdlib/string/format' );
+var pkg = require( './../package.json' ).name;
+var insertDimension = require( './../lib' );
+
+
+// MAIN //
+
+bench( format( '%s::base_ndarray,2d', pkg ), function benchmark( b ) {
+	var strides;
+	var values;
+	var buffer;
+	var offset;
+	var dtype;
+	var shape;
+	var order;
+	var out;
+	var i;
+
+	dtype = 'float64';
+	buffer = new Float64Array( 2 );
+	shape = [ 2 ];
+	strides = [ 1 ];
+	offset = 0;
+	order = 'row-major';
+
+	values = [
+		ndarrayBase( dtype, buffer, shape, strides, offset, order ),
+		ndarrayBase( dtype, buffer, shape, strides, offset, order ),
+		ndarrayBase( dtype, buffer, shape, strides, offset, order ),
+		ndarrayBase( dtype, buffer, shape, strides, offset, order ),
+		ndarrayBase( dtype, buffer, shape, strides, offset, order )
+	];
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		out = insertDimension( values[ i%values.length ], 1, false );
+		if ( typeof out !== 'object' ) {
+			b.fail( 'should return an object' );
+		}
+	}
+	b.toc();
+	if ( !isndarrayLike( out ) ) {
+		b.fail( 'should return an ndarray' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+bench( format( '%s::ndarray,2d', pkg ), function benchmark( b ) {
+	var strides;
+	var values;
+	var buffer;
+	var offset;
+	var dtype;
+	var shape;
+	var order;
+	var out;
+	var i;
+
+	dtype = 'float64';
+	buffer = new Float64Array( 2 );
+	shape = [ 2 ];
+	strides = [ 1 ];
+	offset = 0;
+	order = 'row-major';
+
+	values = [
+		ndarray( dtype, buffer, shape, strides, offset, order ),
+		ndarray( dtype, buffer, shape, strides, offset, order ),
+		ndarray( dtype, buffer, shape, strides, offset, order ),
+		ndarray( dtype, buffer, shape, strides, offset, order ),
+		ndarray( dtype, buffer, shape, strides, offset, order )
+	];
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		out = insertDimension( values[ i%values.length ], 1, false );
+		if ( typeof out !== 'object' ) {
+			b.fail( 'should return an object' );
+		}
+	}
+	b.toc();
+	if ( !isndarrayLike( out ) ) {
+		b.fail( 'should return an ndarray' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

lib/node_modules/@stdlib/ndarray/base/insert-dimension/benchmark/benchmark.ndims.js

@@ -0,0 +1,95 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2026 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 array = require( '@stdlib/ndarray/array' );
+var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
+var format = require( '@stdlib/string/format' );
+var pkg = require( './../package.json' ).name;
+var insertDimension = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} ndims - number of dimensions
+* @returns {Function} benchmark function
+*/
+function createBenchmark( ndims ) {
+	var x = array( [ 1, 2, 3, 4 ], {
+		'ndmin': ndims - 1
+	});
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var out;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			out = insertDimension( x, i%(ndims-1), false );
+			if ( typeof out !== 'object' ) {
+				b.fail( 'should return an object' );
+			}
+		}
+		b.toc();
+		if ( !isndarrayLike( out ) ) {
+			b.fail( 'should return an ndarray' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var min;
+	var max;
+	var f;
+	var i;
+
+	min = 2;
+	max = 10;
+
+	for ( i = min; i <= max; i++ ) {
+		f = createBenchmark( i );
+		bench( format( '%s::ndarray:ndims=%d', pkg, i ), f );
+	}
+}
+
+main();