Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,12 +4,14 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-07-16)
+## Unreleased (2025-07-26)
 
 <section class="features">
 
 ### Features
 
+-   [`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
 -   [`fee6898`](https://github.com/stdlib-js/stdlib/commit/fee68983980c006c27c7f1f5d1f3f11b20602974) - add `array/base/assert/has-almost-equal-values`
 -   [`7f0421e`](https://github.com/stdlib-js/stdlib/commit/7f0421e54502fdd9e92758d9c9123216372287fd) - add inital implementation of `array/struct-factory`
@@ -219,6 +221,8 @@ A total of 32 issues were closed in this release:
 
 <details>
 
+-   [`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)_
 -   [`0b89b56`](https://github.com/stdlib-js/stdlib/commit/0b89b56db0aa040a643ef859ac71795462e947d5) - **feat:** add `hasAlmostEqualValues` to namespace _(by Athan Reines)_
 -   [`fee6898`](https://github.com/stdlib-js/stdlib/commit/fee68983980c006c27c7f1f5d1f3f11b20602974) - **feat:** add `array/base/assert/has-almost-equal-values` _(by Athan Reines)_

CONTRIBUTORS

@@ -30,6 +30,7 @@ Anshu Kumar <[email protected]>
 Anudeep Sanapala <[email protected]>
 Arihant Pal <[email protected]>
 Aryan Bhirud <[email protected]>
+AryanJ18 <[email protected]>
 Athan Reines <[email protected]>
 Atharva Patil <[email protected]>
 Ayaka <[email protected]>
@@ -167,6 +168,7 @@ Sai Avinash <[email protected]>
 Sai Srikar Dumpeti <[email protected]>
 Sanchay Ketan Sinha <[email protected]>
 Sarthak Paandey <[email protected]>
+Satyajeet Chavan <[email protected]>
 Saurabh Singh <[email protected]>
 Seyyed Parsa Neshaei <[email protected]>
 Shabareesh Shetty <[email protected]>
@@ -176,6 +178,7 @@ Shivansh <[email protected]>
 Shraddheya Shendre <[email protected]>
 Shubh Mehta <[email protected]>
 Shubham Mishra <[email protected]>
+Siddhesh waje <[email protected]>
 Sivam Das <[email protected]>
 Snehil Shah <[email protected]>
 Soumajit Chatterjee <[email protected]>

base/lib/index.js

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

base/zip2object/README.md

@@ -0,0 +1,98 @@
+<!--
+
+@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.
+
+-->
+
+# zip2object
+
+> Create an object from a provided list of properties and a provided list of corresponding values.
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var zip2object = require( '@stdlib/array/base/zip2object' );
+```
+
+#### zip2object( properties, values )
+
+Returns an object from a provided list of properties and a provided list of corresponding values.
+
+```javascript
+var properties = [ 'a', 'b' ];
+var values = [ 1, 2 ];
+
+var out = zip2object( properties, values );
+// returns { 'a': 1, 'b': 2 }
+```
+
+The function supports the following parameters:
+
+-   **properties**: list of properties.
+-   **values**: list of values.
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+-   The function assumes that both input arrays 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 zip2object = require( '@stdlib/array/base/zip2object' );
+
+var x1 = zeroTo( 10 );
+var x2 = discreteUniform( x1.length, -100, 100 );
+
+var out = zip2object( x1, x2 );
+// 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/zip2object/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 isPlainObject = require( '@stdlib/assert/is-plain-object' );
+var zeroTo = require( './../../../base/zero-to' );
+var pkg = require( './../package.json' ).name;
+var zip2object = 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 = zip2object( x, x );
+		if ( typeof v !== 'object' ) {
+			b.fail( 'should return an object' );
+		}
+	}
+	b.toc();
+	if ( !isPlainObject( v ) ) {
+		b.fail( 'should return an object' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

base/zip2object/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 isPlainObject = require( '@stdlib/assert/is-plain-object' );
+var pkg = require( './../package.json' ).name;
+var zip2object = 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 = zip2object( x, x );
+			if ( typeof v !== 'object' ) {
+				b.fail( 'should return an object' );
+			}
+		}
+		b.toc();
+		if ( !isPlainObject( v ) ) {
+			b.fail( 'should return an object' );
+		}
+		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/zip2object/docs/repl.txt

@@ -0,0 +1,30 @@
+
+{{alias}}( properties, values )
+    Creates an object from a provided list of properties and a provided list of
+    corresponding values.
+
+    The function assumes that both input arrays are the same length.
+
+    Parameters
+    ----------
+    properties: ArrayLikeObject
+        List of properties.
+
+    values: ArrayLikeObject
+        List of values.
+
+    Returns
+    -------
+    out: Object
+        Result.
+
+    Examples
+    --------
+    > var x1 = [ 1, 2 ];
+    > var x2 = [ 3, 4 ];
+    > var out = {{alias}}( x1, x2 )
+    { '1': 3, '2': 4 }
+
+    See Also
+    --------
+

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

@@ -0,0 +1,53 @@
+/*
+* @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 } from '@stdlib/types/array';
+
+/**
+* Property key.
+*/
+type PropertyKey = string | number | symbol;
+
+/**
+* Creates an object from a provided list of properties and a provided list of corresponding values.
+*
+* ## Notes
+*
+* -   The function assumes that both input arrays are the same length.
+*
+* @param properties - list of properties
+* @param values - list of values
+* @returns result
+*
+* @example
+* var properties = [ 1, 2 ];
+* var values = [ 3, 4 ];
+*
+* var out = zip2object( properties, values );
+* // returns { '1': 3, '2': 4 }
+*/
+declare function zip2object<T extends PropertyKey = PropertyKey, U = unknown>( properties: Collection<T> | AccessorArrayLike<T>, values: Collection<U> | AccessorArrayLike<U> ): Record<T, U>;
+
+
+// EXPORTS //
+
+export = zip2object;