feat: add ndarray/base/atleastnd

lib/node_modules/@stdlib/ndarray/base/atleastnd/README.md

@@ -0,0 +1,131 @@
+<!--
+
+@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.
+
+-->
+
+# atleastnd
+
+> Convert a list of values (scalars and/or ndarrays) to ndarrays having at least a specified number of dimensions.
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var atleastnd = require( '@stdlib/ndarray/base/atleastnd' );
+```
+
+#### atleastnd( ndims, arrays )
+
+Converts a list of values (scalars and/or ndarrays) to ndarrays having at least a specified number of dimensions.
+
+```javascript
+var array = require( '@stdlib/ndarray/array' );
+
+var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ] ] );
+// returns <ndarray>[ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ] ]
+
+var y = array( [ [ 5.0, 6.0 ], [ 7.0, 8.0 ] ] );
+// returns <ndarray>[ [ 5.0, 6.0 ], [ 7.0, 8.0 ] ]
+
+var out = atleastnd( 3, [ x, y ] );
+// returns [ <ndarray>, <ndarray> ]
+```
+
+The function accepts the following arguments:
+
+-   **ndims**: minimum number of dimensions.
+-   **arrays**: array-like object containing a list of scalars and/or ndarrays.
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   If a provided ndarray has fewer dimensions than `ndims`, the returned ndarray is a view on the input ndarray data buffer. The view is typically **not** contiguous. As more than one element of a returned view may refer to the same memory location, writing to the view may affect multiple elements. If you need to write to the returned ndarray, copy the ndarray **before** performing operations which may mutate elements.
+
+-   The returned ndarray is a "base" [ndarray][@stdlib/ndarray/base/ctor], and, thus, the returned [ndarray][@stdlib/ndarray/base/ctor] does not perform bounds checking or afford any of the guarantees of the non-base [ndarray][@stdlib/ndarray/ctor] constructor. The primary intent of this function is to broadcast an ndarray-like object within internal implementations and to do so with minimal overhead.
+
+-   If provided a scalar value (i.e., a non-ndarray) and that value
+
+    -   is a number, the returned ndarray will have the [default][@stdlib/ndarray/defaults] real-valued floating-point data type.
+    -   is a boolean, the returned ndarray will have the [default][@stdlib/ndarray/defaults] boolean data type.
+    -   is a complex number object of a known data type, the data type of the returned ndarray will be the same as the provided value.
+    -   is a complex number object of an unknown data type, the returned ndarray will have the [default][@stdlib/ndarray/defaults] complex-valued floating-point data type.
+    -   is any other value type, the returned ndarray will have a `'generic'` data type.
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var discreteUniform = require( '@stdlib/random/discrete-uniform' );
+var ndarray2array = require( '@stdlib/ndarray/to-array' );
+var atleastnd = require( '@stdlib/ndarray/base/atleastnd' );
+
+var x = discreteUniform( [ 2, 2, 2 ], -100, 100 );
+// returns <ndarray>
+
+var y = discreteUniform( [ 5, 2 ], -100, 100 );
+// returns <ndarray>
+
+var out = atleastnd( 3, [ x, y ] );
+// returns [ <ndarray>, <ndarray> ]
+
+console.log( ndarray2array( out[ 0 ] ) );
+console.log( ndarray2array( out[ 1 ] ) );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<section class="links">
+
+[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor
+
+[@stdlib/ndarray/base/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/ctor
+
+[@stdlib/ndarray/defaults]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/defaults
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/ndarray/base/atleastnd/benchmark/benchmark.js

@@ -0,0 +1,103 @@
+/**
+* @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 atleastnd = require( './../lib' );
+
+
+// MAIN //
+
+bench( format( '%s::base_ndarray:ndims=2', pkg ), function benchmark( b ) {
+	var values;
+	var buffer;
+	var offset;
+	var dtype;
+	var order;
+	var out;
+	var i;
+
+	dtype = 'float64';
+	buffer = new Float64Array( 12 );
+	offset = 0;
+	order = 'row-major';
+
+	values = [
+		ndarrayBase( dtype, buffer, [ 3, 2, 2 ], [ 4, 2, 1 ], offset, order ),
+		ndarrayBase( dtype, buffer, [ 4, 3 ], [ 3, 1 ], offset, order ),
+		ndarrayBase( dtype, buffer, [ 12 ], [ 1 ], offset, order )
+	];
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		out = atleastnd( 2, [ 10.0, values[ i%values.length ] ] );
+		if ( typeof out !== 'object' ) {
+			b.fail( 'should return an object' );
+		}
+	}
+	b.toc();
+	if ( !isndarrayLike( out[ 0 ] ) || !isndarrayLike( out[ 1 ] ) ) {
+		b.fail( 'should return an array of ndarrays' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+bench( format( '%s::ndarray:ndims=2', pkg ), function benchmark( b ) {
+	var values;
+	var buffer;
+	var offset;
+	var dtype;
+	var order;
+	var out;
+	var i;
+
+	dtype = 'float64';
+	buffer = new Float64Array( 12 );
+	offset = 0;
+	order = 'row-major';
+
+	values = [
+		ndarray( dtype, buffer, [ 3, 2, 2 ], [ 4, 2, 1 ], offset, order ),
+		ndarray( dtype, buffer, [ 4, 3 ], [ 3, 1 ], offset, order ),
+		ndarray( dtype, buffer, [ 12 ], [ 1 ], offset, order )
+	];
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		out = atleastnd( 2, [ 10.0, values[ i%values.length ] ] );
+		if ( typeof out !== 'object' ) {
+			b.fail( 'should return an object' );
+		}
+	}
+	b.toc();
+	if ( !isndarrayLike( out[ 0 ] ) || !isndarrayLike( out[ 1 ] ) ) {
+		b.fail( 'should return an array of ndarrays' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

lib/node_modules/@stdlib/ndarray/base/atleastnd/docs/repl.txt

@@ -0,0 +1,29 @@
+
+{{alias}}( ndims, arrays )
+    Converts a list of values (scalars and/or ndarrays) to ndarrays having at
+    least a specified number of dimensions.
+
+    Parameters
+    ----------
+    ndims: number
+        Minimum number of dimensions.
+
+    arrays: ArrayLikeObject
+        List of scalars and/or ndarrays.
+
+    Returns
+    -------
+    out: Array<ndarray>
+        List of ndarrays.
+
+    Examples
+    --------
+    > var x = {{alias:@stdlib/ndarray/array}}( [ [ 1, 2 ], [ 3, 4 ] ] )
+    <ndarray>[ [ 1, 2 ], [ 3, 4 ] ]
+    > var y = {{alias:@stdlib/ndarray/array}}( [ 5, 6, 7, 8 ] )
+    <ndarray>[ 5, 6, 7, 8 ]
+    > var out = {{alias}}( 3, [ x, y ] )
+    [ <ndarray>, <ndarray> ]
+
+    See Also
+    --------

lib/node_modules/@stdlib/ndarray/base/atleastnd/docs/types/index.d.ts

@@ -0,0 +1,50 @@
+/*
+* @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.
+*/
+
+// TypeScript Version: 4.1
+
+/// <reference types="@stdlib/types"/>
+
+import { ArrayLike } from '@stdlib/types/array';
+import { ndarray } from '@stdlib/types/ndarray';
+
+/**
+* Converts a list of values (scalars and/or ndarrays) to ndarrays having at least a specified number of dimensions.
+*
+* @param ndims - minimum number of dimensions
+* @param arrays - array-like object containing a list of scalars and/or ndarrays
+* @returns an array of ndarrays
+*
+* @example
+* var array = require( '@stdlib/ndarray/array' );
+*
+* var x = array( [ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ] ] );
+* // returns <ndarray>[ [ [ 1.0, 2.0 ] ], [ [ 3.0, 4.0 ] ] ]
+*
+* var y = array( [ [ 5.0, 6.0 ], [ 7.0, 8.0 ] ] );
+* // returns <ndarray>[ [ 5.0, 6.0 ], [ 7.0, 8.0 ] ]
+*
+* var out = atleastnd( 3, [ x, y ] );
+* // returns [ <ndarray>, <ndarray> ]
+*/
+declare function atleastnd( ndims: number, arrays: ArrayLike<any> ): Array<ndarray>;
+
+
+// EXPORTS //
+
+export = atleastnd;

lib/node_modules/@stdlib/ndarray/base/atleastnd/docs/types/test.ts

@@ -0,0 +1,67 @@
+/*
+* @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.
+*/
+
+import zeros = require( '@stdlib/ndarray/zeros' );
+import atleastnd = require( './index' );
+
+
+// TESTS //
+
+// The function returns an array of ndarrays...
+{
+	const x = zeros( [ 2, 2 ] );
+	const y = zeros( [ 2, 2, 2 ] );
+
+	atleastnd( 3, [ x ] ); // $ExpectType ndarray[]
+	atleastnd( 3, [ x, y ] ); // $ExpectType ndarray[]
+	atleastnd( 3, [ x, y, x ] ); // $ExpectType ndarray[]
+}
+
+// The compiler throws an error if the function is provided a first argument which is not a number...
+{
+	const x = zeros( [ 2, 2 ] );
+	const y = zeros( [ 2, 2, 2 ] );
+
+	atleastnd( '5', [ x, y ] ); // $ExpectError
+	atleastnd( true, [ x, y ] ); // $ExpectError
+	atleastnd( false, [ x, y ] ); // $ExpectError
+	atleastnd( null, [ x, y ] ); // $ExpectError
+	atleastnd( {}, [ x, y ] ); // $ExpectError
+	atleastnd( [ '5' ], [ x, y ] ); // $ExpectError
+	atleastnd( ( x: number ): number => x, [ x, y ] ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided a second argument which is not an array ...
+{
+	atleastnd( 3, 5 ); // $ExpectError
+	atleastnd( 3, true ); // $ExpectError
+	atleastnd( 3, false ); // $ExpectError
+	atleastnd( 3, null ); // $ExpectError
+	atleastnd( 3, {} ); // $ExpectError
+	atleastnd( 3, ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	const x = zeros( [ 2, 2 ] );
+	const y = zeros( [ 2, 2, 2 ] );
+
+	atleastnd(); // $ExpectError
+	atleastnd( 3 ); // $ExpectError
+	atleastnd( 3, [ x, y ], {} ); // $ExpectError
+}