Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -10,6 +10,8 @@
 
 ### Features
 
+-   [`cd23042`](https://github.com/stdlib-js/stdlib/commit/cd23042ad42089fb6b69783060bd67004d879ebe) - add `zip2views` to namespace
+-   [`4a651c7`](https://github.com/stdlib-js/stdlib/commit/4a651c7b6d1ea9a814ac420a91c0d94de3956917) - add `array/base/zip2views`
 -   [`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
@@ -225,6 +227,10 @@ A total of 32 issues were closed in this release:
 
 <details>
 
+-   [`53948cc`](https://github.com/stdlib-js/stdlib/commit/53948cc063bbf85d538b84ae678c1dc5117f864b) - **docs:** fix missing variable declaration _(by Athan Reines)_
+-   [`cd23042`](https://github.com/stdlib-js/stdlib/commit/cd23042ad42089fb6b69783060bd67004d879ebe) - **feat:** add `zip2views` to namespace _(by Athan Reines)_
+-   [`4a651c7`](https://github.com/stdlib-js/stdlib/commit/4a651c7b6d1ea9a814ac420a91c0d94de3956917) - **feat:** add `array/base/zip2views` _(by Athan Reines)_
+-   [`75a09fd`](https://github.com/stdlib-js/stdlib/commit/75a09fdda6729788ada783e66412521bbb03ba3e) - **docs:** update notes _(by Athan Reines)_
 -   [`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)_

base/lib/index.js

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

base/zip2objects/README.md

@@ -56,7 +56,7 @@ The function supports the following parameters:
 <section class="notes">
 
 -   The function assumes that the list of arrays to be zipped all have the same length.
--   The list of provided array labels should equal the number of arrays to be zipped.
+-   The number of provided array labels should equal the number of arrays to be zipped.
 
 </section>
 

base/zip2objects/docs/repl.txt

@@ -5,7 +5,7 @@
     The function assumes that the list of arrays to be zipped all have the same
     length.
 
-    The list of provided array labels should equal the number of arrays to be
+    The number of provided array labels should equal the number of arrays to be
     zipped.
 
     Parameters

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

@@ -33,7 +33,7 @@ type PropertyKey = string | number | symbol;
 * ## Notes
 *
 * -   The function assumes that the list of arrays to be zipped all have the same length.
-* -   The list of provided array labels should equal the number of arrays to be zipped.
+* -   The number of provided array labels should equal the number of arrays to be zipped.
 *
 * @param arrays - list of arrays to be zipped
 * @param labels - list of array labels

base/zip2objects/lib/main.js

@@ -31,7 +31,7 @@ var resolveGetter = require( './../../../base/resolve-getter' );
 * ## Notes
 *
 * -   The function assumes that the list of arrays to be zipped all have the same length.
-* -   The list of provided array labels should equal the number of arrays to be zipped.
+* -   The number of provided array labels should equal the number of arrays to be zipped.
 *
 * @param {Collection<Collection>} arrays - list of arrays to be zipped
 * @param {ArrayLikeObject<string>} labels - list of array labels

base/zip2views/README.md

@@ -0,0 +1,130 @@
+<!--
+
+@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.
+
+-->
+
+# zip2views
+
+> Zip one or more arrays to an array of composite views.
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var zip2views = require( '@stdlib/array/base/zip2views' );
+```
+
+#### zip2views( arrays, labels )
+
+Zips one or more arrays to an array of composite views.
+
+```javascript
+var x = [ 1, 2, 3 ];
+var y = [ 'a', 'b', 'c' ];
+
+var labels = [ 'x', 'y' ];
+
+var z = zip2views( [ x, y ], labels );
+// returns [ <Object>, <Object>, <Object> ]
+
+var v0 = z[ 0 ].toJSON();
+// returns { 'x': 1, 'y': 'a' }
+
+var v1 = z[ 1 ].toJSON();
+// returns { 'x': 2, 'y': 'b' }
+
+var v2 = z[ 2 ].toJSON();
+// returns { 'x': 3, 'y': 'c' }
+
+// Mutate one of the input arrays:
+x[ 0 ] = 5;
+
+v0 = z[ 0 ].toJSON();
+// returns { 'x': 5, 'y': 'a' }
+
+// Set a view property:
+z[ 1 ].y = 'beep';
+
+v1 = z[ 1 ].toJSON();
+// returns { 'x': 2, 'y': 'beep' }
+
+var y1 = y.slice();
+// returns [ 'a', 'beep', 'c' ]
+```
+
+The function supports the following parameters:
+
+-   **arrays**: list of arrays to zip.
+-   **labels**: list of array labels.
+
+Each element in the returned array is a class instance having prototype properties corresponding to the list of array labels. As demonstrated in the example above, to convert an element to a regular object, invoke an element's `toJSON` method. Note, however, that the object returned by an element's `toJSON` method no longer shares the same memory as the provided input arrays.
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+-   The function assumes that the list of arrays to be zipped all have the same length.
+-   The number of provided array labels should equal the number of arrays to be zipped.
+-   Each view in the returned array shares the same memory as the corresponding elements in the input arrays. Accordingly, mutation of either an input array or a view will mutate the other.
+
+</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 zip2views = require( '@stdlib/array/base/zip2views' );
+
+var x = zeroTo( 10 );
+var y = discreteUniform( x.length, -100, 100 );
+
+var labels = [ 'x', 'y' ];
+
+var out = zip2views( [ x, y ], labels );
+// 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/zip2views/benchmark/benchmark.js

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

base/zip2views/benchmark/benchmark.length.js

@@ -0,0 +1,96 @@
+/**
+* @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 isArray = require( '@stdlib/assert/is-array' );
+var pkg = require( './../package.json' ).name;
+var zip2views = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var labels = [ 'x', 'y' ];
+	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 = zip2views( [ x, x ], labels );
+			if ( typeof v !== 'object' ) {
+				b.fail( 'should return an array' );
+			}
+		}
+		b.toc();
+		if ( !isArray( v ) ) {
+			b.fail( 'should return an array' );
+		}
+		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/zip2views/docs/repl.txt

@@ -0,0 +1,41 @@
+
+{{alias}}( arrays, labels )
+    Zips one or more arrays to an array of composite views.
+
+    The function assumes that the list of arrays to be zipped all have the same
+    length.
+
+    The number of provided array labels should equal the number of arrays to be
+    zipped.
+
+    Each view in the returned array shares the same memory as the corresponding
+    elements in the input arrays. Accordingly, mutation of either an input array
+    or a view will mutate the other.
+
+    Parameters
+    ----------
+    arrays: ArrayLikeObject<ArrayLikeObject>
+        List of arrays to zip.
+
+    labels: ArrayLikeObject
+        List of array labels.
+
+    Returns
+    -------
+    out: Array<Object>
+        Output array.
+
+    Examples
+    --------
+    > var x = [ 1, 2 ];
+    > var y = [ 3, 4 ];
+    > var labels = [ 'x', 'y' ];
+    > var out = {{alias}}( [ x, y ], labels );
+    > var v = out[ 0 ].toJSON()
+    { 'x': 1, 'y': 3 }
+    > v = out[ 1 ].toJSON()
+    { 'x': 2, 'y': 4 }
+
+    See Also
+    --------
+