Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,12 +4,16 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-07-27)
+## Unreleased (2025-07-28)
 
 <section class="features">
 
 ### Features
 
+-   [`0482e74`](https://github.com/stdlib-js/stdlib/commit/0482e7449c3d3d59fd0f89f1352cb90e59127756) - add `entries2views` to namespace
+-   [`7e5f17b`](https://github.com/stdlib-js/stdlib/commit/7e5f17bf1d04ec84b0c137454a467ebee1370cf0) - add `array/base/entries2views`
+-   [`62be202`](https://github.com/stdlib-js/stdlib/commit/62be202d080ca6b785ae018c95570242cbbf5873) - add `entries2objects` to namespace
+-   [`f3d7a2f`](https://github.com/stdlib-js/stdlib/commit/f3d7a2fbe39b5aa81ed02f702bdd86103a2fd31b) - add `array/base/entries2objects`
 -   [`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
@@ -227,6 +231,10 @@ A total of 32 issues were closed in this release:
 
 <details>
 
+-   [`0482e74`](https://github.com/stdlib-js/stdlib/commit/0482e7449c3d3d59fd0f89f1352cb90e59127756) - **feat:** add `entries2views` to namespace _(by Athan Reines)_
+-   [`7e5f17b`](https://github.com/stdlib-js/stdlib/commit/7e5f17bf1d04ec84b0c137454a467ebee1370cf0) - **feat:** add `array/base/entries2views` _(by Athan Reines)_
+-   [`62be202`](https://github.com/stdlib-js/stdlib/commit/62be202d080ca6b785ae018c95570242cbbf5873) - **feat:** add `entries2objects` to namespace _(by Athan Reines)_
+-   [`f3d7a2f`](https://github.com/stdlib-js/stdlib/commit/f3d7a2fbe39b5aa81ed02f702bdd86103a2fd31b) - **feat:** add `array/base/entries2objects` _(by Athan Reines)_
 -   [`c95312a`](https://github.com/stdlib-js/stdlib/commit/c95312a79a73fb3424d20e2aa76a869304baa4d2) - **test:** add tests _(by Athan Reines)_
 -   [`1d9b865`](https://github.com/stdlib-js/stdlib/commit/1d9b865020ea004692013ee403cbcc4580d9bbab) - **test:** add mutation tests _(by Athan Reines)_
 -   [`53948cc`](https://github.com/stdlib-js/stdlib/commit/53948cc063bbf85d538b84ae678c1dc5117f864b) - **docs:** fix missing variable declaration _(by Athan Reines)_

base/entries2objects/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.
+
+-->
+
+# entries2objects
+
+> Convert array entries to an array of objects.
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var entries2objects = require( '@stdlib/array/base/entries2objects' );
+```
+
+#### entries2objects( arr, fields )
+
+Converts array entries to an array of objects.
+
+```javascript
+var x = [ 1, 2 ];
+
+var fields = [ 'x', 'y' ];
+
+var out = entries2objects( x, fields );
+// returns [ { 'x': 0, 'y': 1 }, { 'x': 1, 'y': 2 } ]
+```
+
+The function supports the following parameters:
+
+-   **arr**: input array.
+-   **fields**: list of field names.
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+-   The list of field names should be a two-element array where the first element corresponds to the field name of input array element index and the second element corresponds to the field name of the input array element value.
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var entries2objects = require( '@stdlib/array/base/entries2objects' );
+
+var x = discreteUniform( 10, -100, 100 );
+var fields = [ 'x', 'y' ];
+
+var out = entries2objects( x, fields );
+// 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/entries2objects/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 entries2objects = 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 = entries2objects( 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/entries2objects/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 entries2objects = 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 = entries2objects( 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/entries2objects/docs/repl.txt

@@ -0,0 +1,32 @@
+
+{{alias}}( arr, fields )
+    Converts array entries to an array of objects.
+
+    The list of field names should be a two-element array where the first
+    element corresponds to the field name of input array element index and the
+    second element corresponds to the field name of the input array element
+    value.
+
+    Parameters
+    ----------
+    arr: ArrayLikeObject
+        Input array.
+
+    fields: ArrayLikeObject
+        List of field names.
+
+    Returns
+    -------
+    out: Array<Object>
+        Output array.
+
+    Examples
+    --------
+    > var x = [ 1, 2 ];
+    > var f = [ 'x', 'y' ];
+    > var out = {{alias}}( x, f )
+    [ { 'x': 0, 'y': 1 }, { 'x': 1, 'y': 2 } ]
+
+    See Also
+    --------
+

base/entries2objects/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;
+
+/**
+* Converts array entries to an array of objects.
+*
+* ## Notes
+*
+* -   The list of field names should be a two-element array where the first element corresponds to the field name of input array element index and the second element corresponds to the field name of the input array element value.
+*
+* @param arr - input array
+* @param fields - list of field names
+* @returns output array
+*
+* @example
+* var x = [ 1, 2, 3 ];
+* var fields = [ 'x', 'y' ];
+*
+* var out = entries2objects( x, fields );
+* // returns [ { 'x': 0, 'y': 1 }, { 'x': 1, 'y': 2 }, { 'x': 2, 'y': 3 } ]
+*/
+declare function entries2objects<T = unknown, U extends PropertyKey = PropertyKey>( arr: Collection<T> | AccessorArrayLike<T>, fields: Collection<U> | AccessorArrayLike<U> ): Array<Record<U, T>>;
+
+
+// EXPORTS //
+
+export = entries2objects;