feat: add blas/ext/join-between

lib/node_modules/@stdlib/blas/ext/join-between/README.md

@@ -0,0 +1,213 @@
+<!--
+
+@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.
+
+-->
+
+# joinBetween
+
+> Return an [ndarray][@stdlib/ndarray/ctor] created by joining elements using specified separators for each pair of consecutive elements along one or more [ndarray][@stdlib/ndarray/ctor] dimensions.
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var joinBetween = require( '@stdlib/blas/ext/join-between' );
+```
+
+#### joinBetween( x\[, options] )
+
+Returns an [ndarray][@stdlib/ndarray/ctor] created by joining elements using specified separators for each pair of consecutive elements along one or more [ndarray][@stdlib/ndarray/ctor] dimensions.
+
+```javascript
+var array = require( '@stdlib/ndarray/array' );
+
+// Create an input ndarray:
+var x = array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
+// returns <ndarray>[ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ]
+
+// Perform operation:
+var out = joinBetween( x );
+// returns <ndarray>[ '1,2,3,4,5,6' ]
+```
+
+The function has the following parameters:
+
+-   **x**: input [ndarray][@stdlib/ndarray/ctor].
+-   **options**: function options (_optional_).
+
+The function accepts the following options:
+
+-   **prefix**: prefix to prepend to each joined string. Default: `''`.
+-   **suffix**: suffix to append to each joined string. Default: `''`.
+-   **separators**: separators. Must be an array-like object. When provided an array containing a single element, the same separator is used between all consecutive pairs of elements. When containing multiple elements, each element specifies the separator to use between consecutive pairs, and the number of elements must equal one less than the number of elements along the reduced dimensions. Default: `[ ',' ]`.
+-   **dims**: list of dimensions over which to perform operation. If not provided, the function performs the operation over all elements in a provided input [ndarray][@stdlib/ndarray/ctor].
+-   **keepdims**: boolean indicating whether the reduced dimensions should be included in the returned [ndarray][@stdlib/ndarray/ctor] as singleton dimensions. Default: `false`.
+
+By default, the function joins [ndarray][@stdlib/ndarray/ctor] elements by using `,` as a separator between all consecutive pairs of elements. To perform the operation with a different separator, provide a `separators` option.
+
+```javascript
+var array = require( '@stdlib/ndarray/array' );
+
+var x = array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
+
+var out = joinBetween( x, {
+    'separators': [ '|' ]
+});
+// returns <ndarray>[ '1|2|3|4|5|6' ]
+```
+
+To specify a prefix and suffix to prepend and append to each joined string, provide `prefix` and `suffix` options.
+
+```javascript
+var array = require( '@stdlib/ndarray/array' );
+
+var x = array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
+// returns <ndarray>[ 1, 2, 3, 4, 5, 6 ]
+
+var out = joinBetween( x, {
+    'prefix': '[ ',
+    'suffix': ' ]',
+    'separators': [ ', ' ]
+});
+// returns <ndarray>[ '[ 1, 2, 3, 4, 5, 6 ]' ]
+```
+
+By default, the function performs the operation over all elements in a provided input [ndarray][@stdlib/ndarray/ctor]. To perform the operation over specific dimensions, provide a `dims` option.
+
+```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 out = joinBetween( x, {
+    'dims': [ 0 ]
+});
+// returns <ndarray>[ '1,3', '2,4' ]
+```
+
+By default, the function excludes reduced dimensions from the output [ndarray][@stdlib/ndarray/ctor]. To include the reduced dimensions as singleton dimensions, set the `keepdims` option to `true`.
+
+```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 out = joinBetween( x, {
+    'dims': [ 0 ],
+    'keepdims': true
+});
+// returns <ndarray>[ [ '1,3', '2,4' ] ]
+```
+
+#### joinBetween.assign( x, out\[, options] )
+
+Joins elements of an input [ndarray][@stdlib/ndarray/ctor] using specified separators for each pair of consecutive elements along one or more [ndarray][@stdlib/ndarray/ctor] dimensions and assigns results to a provided output [ndarray][@stdlib/ndarray/ctor].
+
+```javascript
+var array = require( '@stdlib/ndarray/array' );
+var scalar2ndarray = require( '@stdlib/ndarray/from-scalar' );
+
+var x = array( [ 1.0, 2.0, 3.0, 4.0 ] );
+var y = scalar2ndarray( '', {
+    'dtype': 'generic'
+});
+
+var out = joinBetween.assign( x, y );
+// returns <ndarray>[ '1,2,3,4' ]
+
+var bool = ( out === y );
+// returns true
+```
+
+The method has the following parameters:
+
+-   **x**: input [ndarray][@stdlib/ndarray/ctor].
+-   **out**: output [ndarray][@stdlib/ndarray/ctor].
+-   **options**: function options (_optional_).
+
+The method accepts the following options:
+
+-   **prefix**: prefix to prepend to each joined string. Default: `''`.
+-   **suffix**: suffix to append to each joined string. Default: `''`.
+-   **separators**: separators. Must be an array-like object. When provided an array containing a single element, the same separator is used between all consecutive pairs of elements. When containing multiple elements, each element specifies the separator to use between consecutive pairs, and the number of elements must equal one less than the number of elements along the reduced dimensions. Default: `[ ',' ]`.
+-   **dims**: list of dimensions over which to perform operation. If not provided, the function performs the operation over all elements in a provided input [ndarray][@stdlib/ndarray/ctor].
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   Setting the `keepdims` option to `true` can be useful when wanting to ensure that the output [ndarray][@stdlib/ndarray/ctor] is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with ndarrays having the same shape as the input [ndarray][@stdlib/ndarray/ctor].
+-   When providing an array containing multiple separators, each element specifies the separator to use between consecutive pairs. The same separators are used for every complement position when reducing specific dimensions.
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var uniform = require( '@stdlib/random/uniform' );
+var ndarray2array = require( '@stdlib/ndarray/to-array' );
+var joinBetween = require( '@stdlib/blas/ext/join-between' );
+
+var x = uniform( [ 5, 2 ], 0.0, 20.0 );
+console.log( ndarray2array( x ) );
+
+var out = joinBetween( x, {
+    'dims': [ -1 ],
+    'prefix': '[ ',
+    'suffix': ' ]',
+    'separators': [ ', ' ]
+});
+console.log( ndarray2array( out ) );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- 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/base/broadcast-shapes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/broadcast-shapes
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/blas/ext/join-between/benchmark/benchmark.assign.js

@@ -0,0 +1,114 @@
+/**
+* @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 isnan = require( '@stdlib/math/base/assert/is-nan' );
+var pow = require( '@stdlib/math/base/special/pow' );
+var uniform = require( '@stdlib/random/array/uniform' );
+var empty = require( '@stdlib/ndarray/empty' );
+var ndarray = require( '@stdlib/ndarray/base/ctor' );
+var format = require( '@stdlib/string/format' );
+var pkg = require( './../package.json' ).name;
+var joinBetween = require( './../lib' );
+
+
+// VARIABLES //
+
+var options = {
+	'dtype': 'float64'
+};
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var out;
+	var x;
+
+	x = uniform( len, -50.0, 50.0, options );
+	x = new ndarray( options.dtype, x, [ len ], [ 1 ], 0, 'row-major' );
+
+	out = empty( [], {
+		'dtype': 'generic'
+	});
+
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var o;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			o = joinBetween.assign( x, out );
+			if ( typeof o !== 'object' ) {
+				b.fail( 'should return an ndarray' );
+			}
+		}
+		b.toc();
+		if ( isnan( o.get() ) ) {
+			b.fail( 'should not return NaN' );
+		}
+		b.pass( 'benchmark finished' );
+		b.end();
+	}
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+	var len;
+	var min;
+	var max;
+	var f;
+	var i;
+
+	min = 1; // 10^min
+	max = 6; // 10^max
+
+	for ( i = min; i <= max; i++ ) {
+		len = pow( 10, i );
+		f = createBenchmark( len );
+		bench( format( '%s:assign:dtype=%s,len=%d', pkg, options.dtype, len ), f );
+	}
+}
+
+main();