feat: add blas/ext/base/gjoin-between

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

@@ -0,0 +1,195 @@
+<!--
+
+@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.
+
+-->
+
+# gjoinBetween
+
+> Return a string by joining strided array elements using a specified separator for each pair of consecutive elements.
+
+<!-- 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 gjoinBetween = require( '@stdlib/blas/ext/base/gjoin-between' );
+```
+
+#### gjoinBetween( N, prefix, suffix, x, strideX, separators, strideS )
+
+Returns a string by joining strided array elements using a specified separator for each pair of consecutive elements.
+
+```javascript
+var x = [ 1, 2, 3, 4 ];
+var sep = [ ' + ', ' - ', ' != ' ];
+
+var str = gjoinBetween( x.length, 'op: ', '', x, 1, sep, 1 );
+// returns 'op: 1 + 2 - 3 != 4'
+```
+
+The function has the following parameters:
+
+-   **N**: number of indexed elements.
+-   **prefix**: string to prepend to the output string.
+-   **suffix**: string to append to the output string.
+-   **x**: input array.
+-   **strideX**: stride length for `x`.
+-   **separators**: separators array.
+-   **strideS**: stride length for `separators`.
+
+The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to join every other element:
+
+```javascript
+var x = [ 1, 2, 3, 4, 5, 6 ];
+var sep = [ ',', '-' ];
+
+var str = gjoinBetween( 3, '', '', x, 2, sep, 1 );
+// returns '1,3-5'
+```
+
+Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
+
+```javascript
+var Float64Array = require( '@stdlib/array/float64' );
+
+// Initial array:
+var x0 = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
+
+// Create an offset view:
+var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
+
+// Join elements:
+var sep = [ ' | ', ' | ' ];
+var str = gjoinBetween( 3, '[', ']', x1, 2, sep, 1 );
+// returns '[2 | 4 | 6]'
+```
+
+<!-- lint disable maximum-heading-length -->
+
+#### gjoinBetween.ndarray( N, prefix, suffix, x, strideX, offsetX, separators, strideS, offsetS )
+
+<!-- lint enable maximum-heading-length -->
+
+Returns a string by joining strided array elements using a specified separator for each pair of consecutive elements and alternative indexing semantics.
+
+```javascript
+var x = [ 1, 2, 3, 4 ];
+var sep = [ ' + ', ' - ', ' != ' ];
+
+var str = gjoinBetween.ndarray( x.length, 'op: ', '', x, 1, 0, sep, 1, 0 );
+// returns 'op: 1 + 2 - 3 != 4'
+```
+
+The function has the following additional parameters:
+
+-   **offsetX**: starting index for `x`.
+-   **offsetS**: starting index for `separators`.
+
+While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to access only the last three elements of the strided array:
+
+```javascript
+var x = [ 1, 2, 3, 4, 5, 6 ];
+var sep = [ ' | ', ' | ' ];
+
+var str = gjoinBetween.ndarray( 3, '[ ', ' ]', x, 1, x.length-3, sep, 1, 0 );
+// returns '[ 4 | 5 | 6 ]'
+```
+
+</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
+
+-   If `N <= 0`, both functions return the prefix and suffix joined together.
+-   The `separators` array is assumed to have at least `N-1` indexed elements (i.e., equal to the number of "gaps" between consecutive elements).
+-   If an array element is either `null` or `undefined`, both functions serialize the element as an empty string.
+-   Both functions support array-like objects having getter and setter accessors for array element access (e.g., [`@stdlib/array/base/accessor`][@stdlib/array/base/accessor]).
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var filled = require( '@stdlib/array/base/filled' );
+var gjoinBetween = require( '@stdlib/blas/ext/base/gjoin-between' );
+
+var x = discreteUniform( 10, -100, 100, {
+    'dtype': 'generic'
+});
+console.log( x );
+
+var sep = filled( ' | ', x.length - 1 );
+var out = gjoinBetween( x.length, '[ ', ' ]', x, 1, sep, 1 );
+console.log( 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">
+
+[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
+
+[@stdlib/array/base/accessor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/accessor
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/blas/ext/base/gjoin-between/benchmark/benchmark.js

@@ -0,0 +1,99 @@
+/**
+* @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 pow = require( '@stdlib/math/base/special/pow' );
+var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
+var oneTo = require( '@stdlib/array/one-to' );
+var filled = require( '@stdlib/array/base/filled' );
+var format = require( '@stdlib/string/format' );
+var pkg = require( './../package.json' ).name;
+var gjoinBetween = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var sep = filled( ',', len - 1 );
+	var x = oneTo( len, 'float64' );
+	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 = gjoinBetween( x.length, '', '', x, 1, sep, 1 );
+			if ( !isString( out ) ) {
+				b.fail( 'should return a string' );
+			}
+		}
+		b.toc();
+		if ( !isString( out ) ) {
+			b.fail( 'should return a string' );
+		}
+		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:len=%d', pkg, len ), f );
+	}
+}
+
+main();

lib/node_modules/@stdlib/blas/ext/base/gjoin-between/benchmark/benchmark.ndarray.js

@@ -0,0 +1,99 @@
+/**
+* @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 pow = require( '@stdlib/math/base/special/pow' );
+var isString = require( '@stdlib/assert/is-string' ).isPrimitive;
+var oneTo = require( '@stdlib/array/one-to' );
+var filled = require( '@stdlib/array/base/filled' );
+var format = require( '@stdlib/string/format' );
+var pkg = require( './../package.json' ).name;
+var gjoinBetween = require( './../lib/ndarray.js' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var sep = filled( ',', len - 1 );
+	var x = oneTo( len, 'float64' );
+	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 = gjoinBetween( x.length, '', '', x, 1, 0, sep, 1, 0 );
+			if ( !isString( out ) ) {
+				b.fail( 'should return a string' );
+			}
+		}
+		b.toc();
+		if ( !isString( out ) ) {
+			b.fail( 'should return a string' );
+		}
+		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:ndarray:len=%d', pkg, len ), f );
+	}
+}
+
+main();