Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,12 +4,16 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-07-26)
+## Unreleased (2025-07-27)
 
 <section class="features">
 
 ### Features
 
+-   [`302966e`](https://github.com/stdlib-js/stdlib/commit/302966e9b30769c05537f07169c2bda2fbee83f1) - add `zip` to namespace
+-   [`e669353`](https://github.com/stdlib-js/stdlib/commit/e669353fc68d57800199dcb773accd5ce9943cef) - add `array/base/zip`
+-   [`1626ce4`](https://github.com/stdlib-js/stdlib/commit/1626ce436f5b49949f6f49c70f351d3d25149097) - add `zip2objects` to namespace
+-   [`44a8a87`](https://github.com/stdlib-js/stdlib/commit/44a8a871353908788328432c303704843c4a5eb4) - add `array/base/zip2objects`
 -   [`44d590b`](https://github.com/stdlib-js/stdlib/commit/44d590b9dd5f64e263fc3687ba12a52c14bccb8d) - add `zip2object` to namespace
 -   [`455c0d4`](https://github.com/stdlib-js/stdlib/commit/455c0d44ca137051ceb8a331ef66890ee74bd45c) - add `array/base/zip2object`
 -   [`0b89b56`](https://github.com/stdlib-js/stdlib/commit/0b89b56db0aa040a643ef859ac71795462e947d5) - add `hasAlmostEqualValues` to namespace
@@ -221,6 +225,11 @@ A total of 32 issues were closed in this release:
 
 <details>
 
+-   [`302966e`](https://github.com/stdlib-js/stdlib/commit/302966e9b30769c05537f07169c2bda2fbee83f1) - **feat:** add `zip` to namespace _(by Athan Reines)_
+-   [`e669353`](https://github.com/stdlib-js/stdlib/commit/e669353fc68d57800199dcb773accd5ce9943cef) - **feat:** add `array/base/zip` _(by Athan Reines)_
+-   [`73b048a`](https://github.com/stdlib-js/stdlib/commit/73b048a2cef0d2e2ab0ea10887f45fe7365c71bb) - **bench:** fix assertions _(by Athan Reines)_
+-   [`1626ce4`](https://github.com/stdlib-js/stdlib/commit/1626ce436f5b49949f6f49c70f351d3d25149097) - **feat:** add `zip2objects` to namespace _(by Athan Reines)_
+-   [`44a8a87`](https://github.com/stdlib-js/stdlib/commit/44a8a871353908788328432c303704843c4a5eb4) - **feat:** add `array/base/zip2objects` _(by Athan Reines)_
 -   [`44d590b`](https://github.com/stdlib-js/stdlib/commit/44d590b9dd5f64e263fc3687ba12a52c14bccb8d) - **feat:** add `zip2object` to namespace _(by Athan Reines)_
 -   [`455c0d4`](https://github.com/stdlib-js/stdlib/commit/455c0d44ca137051ceb8a331ef66890ee74bd45c) - **feat:** add `array/base/zip2object` _(by Athan Reines)_
 -   [`5388bba`](https://github.com/stdlib-js/stdlib/commit/5388bba36044d2de93dacb0134c6e5539b02928c) - **chore:** minor clean-up _(by Philipp Burckhardt)_

base/lib/index.js

@@ -1953,6 +1953,15 @@ setReadOnly( ns, 'zeros5d', require( './../../base/zeros5d' ) );
 */
 setReadOnly( ns, 'zerosnd', require( './../../base/zerosnd' ) );
 
+/**
+* @name zip
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/array/base/zip}
+*/
+setReadOnly( ns, 'zip', require( './../../base/zip' ) );
+
 /**
 * @name zip2object
 * @memberof ns
@@ -1962,6 +1971,15 @@ setReadOnly( ns, 'zerosnd', require( './../../base/zerosnd' ) );
 */
 setReadOnly( ns, 'zip2object', require( './../../base/zip2object' ) );
 
+/**
+* @name zip2objects
+* @memberof ns
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/array/base/zip2objects}
+*/
+setReadOnly( ns, 'zip2objects', require( './../../base/zip2objects' ) );
+
 
 // EXPORTS //
 

base/zip/README.md

@@ -0,0 +1,97 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2025 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.
+
+-->
+
+# zip
+
+> Zip one or more arrays.
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var zip = require( '@stdlib/array/base/zip' );
+```
+
+#### zip( arrays )
+
+Zips one or more arrays.
+
+```javascript
+var x = [ 1, 2 ];
+var y = [ 3, 4 ];
+
+var out = zip( [ x, y ] );
+// returns [ [ 1, 3 ], [ 2, 4 ] ]
+```
+
+The function supports the following parameters:
+
+-   **arrays**: list of arrays to zip.
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+-   The function assumes that the list of arrays to be zipped all have the same length.
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var zeroTo = require( '@stdlib/array/base/zero-to' );
+var zip = require( '@stdlib/array/base/zip' );
+
+var x = zeroTo( 10 );
+var y = discreteUniform( x.length, -100, 100 );
+
+var out = zip( [ x, y ] );
+// returns [...]
+```
+
+</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">
+
+</section>
+
+<!-- /.links -->

base/zip/benchmark/benchmark.js

@@ -0,0 +1,52 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2025 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 isArrayArray = require( '@stdlib/assert/is-array-array' );
+var zeroTo = require( './../../../base/zero-to' );
+var pkg = require( './../package.json' ).name;
+var zip = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg+':len=100', function benchmark( b ) {
+	var x;
+	var i;
+	var v;
+
+	x = zeroTo( 10 );
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		v = zip( [ x, x ] );
+		if ( typeof v !== 'object' ) {
+			b.fail( 'should return an array of arrays' );
+		}
+	}
+	b.toc();
+	if ( !isArrayArray( v ) ) {
+		b.fail( 'should return an array of arrays' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

base/zip/benchmark/benchmark.length.js

@@ -0,0 +1,95 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2025 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 zeroTo = require( './../../../base/zero-to' );
+var isArrayArray = require( '@stdlib/assert/is-array-array' );
+var pkg = require( './../package.json' ).name;
+var zip = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var x = zeroTo( len );
+	return benchmark;
+
+	/**
+	* Benchmark function.
+	*
+	* @private
+	* @param {Benchmark} b - benchmark instance
+	*/
+	function benchmark( b ) {
+		var v;
+		var i;
+
+		b.tic();
+		for ( i = 0; i < b.iterations; i++ ) {
+			v = zip( [ x, x ] );
+			if ( typeof v !== 'object' ) {
+				b.fail( 'should return an array of arrays' );
+			}
+		}
+		b.toc();
+		if ( !isArrayArray( v ) ) {
+			b.fail( 'should return an array of arrays' );
+		}
+		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+':len='+len, f );
+	}
+}
+
+main();

base/zip/docs/repl.txt

@@ -0,0 +1,27 @@
+
+{{alias}}( arrays )
+    Zips one or more arrays.
+
+    The function assumes that the list of arrays to be zipped all have the same
+    length.
+
+    Parameters
+    ----------
+    arrays: ArrayLikeObject<ArrayLikeObject>
+        List of arrays to zip.
+
+    Returns
+    -------
+    out: Array<Array>
+        Output array.
+
+    Examples
+    --------
+    > var x = [ 1, 2 ];
+    > var y = [ 3, 4 ];
+    > var out = {{alias}}( [ x, y ] )
+    [ [ 1, 3 ], [ 2, 4 ] ]
+
+    See Also
+    --------
+

base/zip/docs/types/index.d.ts

@@ -0,0 +1,47 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2025 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, AccessorArrayLike, ArrayLike } from '@stdlib/types/array';
+
+/**
+* Zips one or more arrays.
+*
+* ## Notes
+*
+* -   The function assumes that the list of arrays to be zipped all have the same length.
+*
+* @param arrays - list of arrays to be zipped
+* @returns output array
+*
+* @example
+* var x = [ 1, 2, 3 ];
+* var y = [ 'a', 'b', 'c' ];
+*
+* var z = zip( [ x, y ] );
+* // returns [ [ 1, 'a' ], [ 2, 'b' ], [ 3, 'c' ] ]
+*/
+declare function zip<T = unknown>( arrays: ArrayLike<Collection<T> | AccessorArrayLike<T>> ): Array<Array<T>>;
+
+
+// EXPORTS //
+
+export = zip;