feat: add ndarray/ndarraylike2scalar

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

@@ -0,0 +1,121 @@
+<!--
+
+@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.
+
+-->
+
+# ndarraylike2scalar
+
+> Convert an ndarray-like object to a scalar value.
+
+<!-- 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 ndarraylike2scalar = require( '@stdlib/ndarray/ndarraylike2scalar' );
+```
+
+#### ndarraylike2scalar( x )
+
+Converts an ndarray-like object to a scalar value.
+
+```javascript
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+
+var x = scalar2ndarray( 1.0 );
+// returns <ndarray>[ 1.0 ]
+
+var out = ndarraylike2scalar( x );
+// returns 1.0
+```
+
+</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">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+var compose = require( '@stdlib/utils/compose' );
+var naryFunction = require( '@stdlib/utils/nary-function' );
+var oneTo = require( '@stdlib/array/one-to' );
+var logEachMap = require( '@stdlib/console/log-each-map' );
+var ndarraylike2scalar = require( '@stdlib/ndarray/ndarraylike2scalar' );
+
+// Create a list of scalars:
+var scalars = oneTo( 10 );
+
+// Create a composite function which round-trips a scalar to an ndarray and back:
+var f = compose( ndarraylike2scalar, naryFunction( scalar2ndarray, 1 ) );
+
+// Apply the function to the list of scalars:
+logEachMap( '%d => %d', scalars, f );
+```
+
+</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/ndarraylike2scalar/benchmark/benchmark.js

@@ -0,0 +1,91 @@
+/**
+* @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 scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+var isNumber = require( '@stdlib/assert/is-number' ).isPrimitive;
+var format = require( '@stdlib/string/format' );
+var pkg = require( './../package.json' ).name;
+var ndarraylike2scalar = require( './../lib' );
+
+
+// MAIN //
+
+bench( format( '%s:dtype=float64', pkg ), function benchmark( b ) {
+	var values;
+	var out;
+	var i;
+
+	values = [
+		scalar2ndarray( 1.0 ),
+		scalar2ndarray( 2.0 ),
+		scalar2ndarray( 3.0 ),
+		scalar2ndarray( 4.0 ),
+		scalar2ndarray( 5.0 )
+	];
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		out = ndarraylike2scalar( values[ i%values.length ] );
+		if ( typeof out !== 'number' ) {
+			b.fail( 'should return a number' );
+		}
+	}
+	b.toc();
+	if ( !isNumber( out ) ) {
+		b.fail( 'should return a number' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+bench( format( '%s:dtype=float32', pkg ), function benchmark( b ) {
+	var values;
+	var opts;
+	var out;
+	var i;
+
+	opts = {
+		'dtype': 'float32'
+	};
+	values = [
+		scalar2ndarray( 1.0, opts ),
+		scalar2ndarray( 2.0, opts ),
+		scalar2ndarray( 3.0, opts ),
+		scalar2ndarray( 4.0, opts ),
+		scalar2ndarray( 5.0, opts )
+	];
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		out = ndarraylike2scalar( values[ i%values.length ] );
+		if ( typeof out !== 'number' ) {
+			b.fail( 'should return a number' );
+		}
+	}
+	b.toc();
+	if ( !isNumber( out ) ) {
+		b.fail( 'should return a number' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

lib/node_modules/@stdlib/ndarray/ndarraylike2scalar/docs/repl.txt

@@ -0,0 +1,23 @@
+
+{{alias}}( x )
+    Converts an ndarray-like object to a scalar value.
+
+    Parameters
+    ----------
+    x: ndarrayLike
+        Input ndarray-like object.
+
+    Returns
+    -------
+    out: any
+        Scalar value.
+
+    Examples
+    --------
+    > var x = {{alias:@stdlib/ndarray/from-scalar}}( 1.0 );
+    > var out = {{alias}}( x )
+    1.0
+
+    See Also
+    --------
+

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

@@ -0,0 +1,45 @@
+/*
+* @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 { typedndarray } from '@stdlib/types/ndarray';
+
+/**
+* Converts an ndarray-like object to a scalar value.
+*
+* @param x - input ndarray
+* @returns scalar value
+*
+* @example
+* var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+*
+* var x = scalar2ndarray( 1.0 );
+* // returns <ndarray>[ 1.0 ]
+*
+* var out = ndarraylike2scalar( x );
+* // returns 1.0
+*/
+declare function ndarraylike2scalar<T = unknown>( x: typedndarray<T> ): T;
+
+
+// EXPORTS //
+
+export = ndarraylike2scalar;

lib/node_modules/@stdlib/ndarray/ndarraylike2scalar/docs/types/test.ts

@@ -0,0 +1,49 @@
+/*
+* @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.
+*/
+
+/// <reference types="@stdlib/types"/>
+
+import scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+import ndarraylike2scalar = require( './index' );
+
+
+// TESTS //
+
+// The function returns a scalar value...
+{
+	ndarraylike2scalar( scalar2ndarray( 1.0 ) ); // $ExpectType number
+}
+
+// The compiler throws an error if the function is not provided an ndarray...
+{
+	ndarraylike2scalar( '5' ); // $ExpectError
+	ndarraylike2scalar( 123 ); // $ExpectError
+	ndarraylike2scalar( true ); // $ExpectError
+	ndarraylike2scalar( false ); // $ExpectError
+	ndarraylike2scalar( null ); // $ExpectError
+	ndarraylike2scalar( undefined ); // $ExpectError
+	ndarraylike2scalar( [] ); // $ExpectError
+	ndarraylike2scalar( {} ); // $ExpectError
+	ndarraylike2scalar( ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	ndarraylike2scalar(); // $ExpectError
+	ndarraylike2scalar( scalar2ndarray( 1.0 ), {} ); // $ExpectError
+}

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

@@ -0,0 +1,35 @@
+/**
+* @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';
+
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+var compose = require( '@stdlib/utils/compose' );
+var naryFunction = require( '@stdlib/utils/nary-function' );
+var oneTo = require( '@stdlib/array/one-to' );
+var logEachMap = require( '@stdlib/console/log-each-map' );
+var ndarraylike2scalar = require( './../lib' );
+
+// Create a list of scalars:
+var scalars = oneTo( 10 );
+
+// Create a composite function which round-trips a scalar to an ndarray and back:
+var f = compose( ndarraylike2scalar, naryFunction( scalar2ndarray, 1 ) );
+
+// Apply the function to the list of scalars:
+logEachMap( '%d => %d', scalars, f );