feat(array/base): add join function

In progress on issue stdlib-js#1327.

Author: adityacodes30

lib/node_modules/@stdlib/array/base/join/README.md

@@ -0,0 +1,122 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2024 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.
+
+-->
+
+# join
+
+> Returns a string created by joining array elements using a specified separator.
+
+<!-- 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 join = require( '@stdlib/array/base/join' );
+```
+
+#### join( x, separator )
+
+Returns a string which is the concatenation of all the elements in an array with a given separator
+
+```javascript
+var x = [ 1, 2, 3, 4, 5, 6 ];
+
+var out = join( x, ',' );
+// returns '1,2,3,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 provided an array-like object having a `join` method, the function defers execution to that method and assumes that the method API has the following signature:
+
+    ```text
+    x.join( separator )
+    ```
+
+-   If provided an array with null and undefined elements present in it, it will treat them as an empty string 
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var join = require( '@stdlib/array/base/join' );
+
+var x = [ 0, 1, 2, 3, 4, 5 ];
+
+var s = join( x, ',' );
+// returns '0,1,2,3,4,5'
+
+s = join( x, '-' );
+// returns '0-1-2-3-4-5'
+```
+
+</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/array/base/join/benchmark/benchmark.length.js

@@ -0,0 +1,93 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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' );
+var ones = require( '@stdlib/array/base/ones' );
+var pkg = require( './../package.json' ).name;
+var join = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var x = ones( len );
+	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 = join( x, ',' );
+			if ( !isString( out ) ) {
+				b.fail( 'should return a string' );
+			}
+		}
+		b.toc();
+		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( pkg+':dtype=generic,len='+len, f );
+	}
+}
+
+main();

lib/node_modules/@stdlib/array/base/join/docs/repl.txt

@@ -0,0 +1,35 @@
+
+{{alias}}( x, separator )
+    Returns a string which is the concatenation of all the elements in 
+    an array with a given separator
+
+    If provided an array-like object having a `join` method, the function
+    defers execution to that method and assumes that the method has the
+    following signature:
+
+      x.join( separator )
+
+    If provided an array-like object without a `join` method, the function
+    manually constructs the output string.
+
+    Parameters
+    ----------
+    x: ArrayLikeObject
+        Input array.
+
+    separator: string
+        Separator to be used.
+
+    Returns
+    -------
+    out: string
+        Concatenated string.
+
+    Examples
+    --------
+    > var out = {{alias}}( [ 1, 2, 3, 4 ], ',' )
+    '1,2,3,4'
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/array/base/join/docs/types/index.d.ts

@@ -0,0 +1,75 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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 { Collection, TypedArray, ComplexTypedArray } from '@stdlib/types/array';
+
+/**
+* Returns a string which concatenates array elements using a specified separator.
+*
+* @param x - input array
+* @param separator - separator element
+* @returns string
+*
+* @example
+* var Float64Array = require( '@stdlib/array/float64' );
+*
+* var x = new Float64Array( [ 1.0, 2.0, 3.0 ] );
+*
+* var out = join( x, ',' );
+* // returns '1,2,3'
+*
+* @example
+* var Complex128Array = require( '@stdlib/array/complex128' );
+*
+* var x = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
+*
+* var out = slice( x, '-' );
+* // returns '1-2-3-4-5-6'
+*/
+declare function join<T extends TypedArray | ComplexTypedArray>( x: T, separator: string ): string;
+
+/**
+* Returns a string which concatenates array elements using a specified separator.
+*
+* @param x - input array
+* @param start - starting index (inclusive)
+* @param end - ending index (exclusive)
+* @returns output array
+*
+* @example
+* var x = [ 1, 2, 3 ];
+*
+* var out = join( x, ',' );
+* // returns '1,2,3'
+*
+* @example
+* var x = [ 1, 2, 3, 4, 5, 6 ];
+*
+* var out = slice( x, '-' );
+* // returns '1-2-3-4-5-6'
+*/
+declare function join<T = unknown>( x: Collection<T>, separator: string ): string;
+
+
+// EXPORTS //
+
+export = join;

lib/node_modules/@stdlib/array/base/join/docs/types/test.ts

@@ -0,0 +1,68 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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 Complex128Array = require( '@stdlib/array/complex128' );
+import Complex64Array = require( '@stdlib/array/complex64' );
+import join = require( './index' );
+
+
+// TESTS //
+
+// The function returns an array...
+{
+	join( [ 1, 2, 3 ], ',' ); // $ExpectType string
+	join( new Float64Array( [ 1, 2, 3 ] ), ',' ); // $ExpectType string
+	join( new Float32Array( [ 1, 2, 3 ] ), ',' ); // $ExpectType string
+	join( new Int32Array( [ 1, 2, 3 ] ), ',' ); // $ExpectType string
+	join( new Int16Array( [ 1, 2, 3 ] ), ',' ); // $ExpectType string
+	join( new Int8Array( [ 1, 2, 3 ] ), ',' ); // $ExpectType string
+	join( new Uint32Array( [ 1, 2, 3 ] ), ',' ); // $ExpectType string
+	join( new Uint16Array( [ 1, 2, 3 ] ), ',' ); // $ExpectType string
+	join( new Uint8Array( [ 1, 2, 3 ] ), ',' ); // $ExpectType string
+	join( new Uint8ClampedArray( [ 1, 2, 3 ] ), ',' ); // $ExpectType string
+	join( new Complex128Array( [ 1, 2, 3, 4, 5, 6 ] ), ',' ); // $ExpectType string
+	join( new Complex64Array( [ 1, 2, 3, 4, 5, 6 ] ), ',' ); // $ExpectType string
+}
+
+// The compiler throws an error if the function is provided a first argument which is not a collection...
+{
+	join( 5, ',' ); // $ExpectError
+	join( true, ',' ); // $ExpectError
+	join( false, ',' ); // $ExpectError
+	join( null, ',' ); // $ExpectError
+	join( void 0, ',' ); // $ExpectError
+	join( {}, ',' ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided a second argument which is not a string...
+{
+	const x = [ 1, 2, 3 ];
+
+	join( x, true ); // $ExpectError
+	join( x, false ); // $ExpectError
+	join( x, null ); // $ExpectError
+	join( x, {} ); // $ExpectError
+	join( x, ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	join(); // $ExpectError
+	join( [ 1, 2, 3 ] ); // $ExpectError
+	join( [ 1, 2, 3 ], 0, 3, {} ); // $ExpectError
+}