Auto-generated commit

base/group-indices/README.md

@@ -0,0 +1,142 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2023 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.
+
+-->
+
+# groupIndices
+
+> Group element indices as arrays associated with distinct keys.
+
+<!-- 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 groupIndices = require( '@stdlib/array/base/group-indices' );
+```
+
+#### groupIndices( x, groups )
+
+Groups element indices as arrays associated with distinct keys.
+
+```javascript
+var x = [ 'beep', 'boop', 'foo', 'bar' ];
+var groups = [ 'b', 'b', 'f', 'b' ];
+
+var out = groupIndices( x, groups );
+// returns { 'b': [ 0, 1, 3 ], 'f': [ 2 ] }
+```
+
+</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
+
+-   Each value in `groups` should resolve to a value which can be serialized as an object key. As a counterexample,
+
+    ```javascript
+    var x = [ 'beep', 'boop', 'foo', 'bar' ];
+    var groups = [ {}, {}, {}, {} ];
+
+    var out = groupIndices( x, groups );
+    // returns { '[object Object]': [ 0, 1, 2, 3 ] }
+    ```
+
+    while each "group" is unique, all input array elements resolve to the same group because each group identifier serializes to the same string.
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var take = require( '@stdlib/array/base/take' );
+var groupIndices = require( '@stdlib/array/base/group-indices' );
+
+// Define an initial array of values:
+var values = [ 'beep', 'boop', 'foo', 'bar', 'woot', 'woot' ];
+
+// Sample from the initial array to generate a random collection:
+var indices = discreteUniform( 100, 0, values.length-1, {
+    'dtype': 'generic'
+});
+var x = take( values, indices );
+// returns [...]
+
+// Randomly assign collection values to groups:
+var groups = discreteUniform( x.length, 0, values.length, {
+    'dtype': 'generic'
+});
+
+// Group the values:
+var out = groupIndices( x, groups );
+// returns {...}
+
+console.log( out );
+```
+
+</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 -->

base/group-indices/benchmark/benchmark.length.js

@@ -0,0 +1,101 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2023 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 isPlainObject = require( '@stdlib/assert/is-plain-object' );
+var zeroTo = require( './../../../base/zero-to' );
+var pkg = require( './../package.json' ).name;
+var groupIndices = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var groups;
+	var x;
+
+	x = zeroTo( len );
+	groups = zeroTo( len ); // note: this corresponds to the extreme case where every element is in a distinct group
+
+	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 = groupIndices( x, groups );
+			if ( typeof out !== 'object' ) {
+				b.fail( 'should return an object' );
+			}
+		}
+		b.toc();
+		if ( !isPlainObject( out ) ) {
+			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+',num_groups='+len, f );
+	}
+}
+
+main();

base/group-indices/docs/repl.txt

@@ -0,0 +1,34 @@
+
+{{alias}}( x, groups )
+    Groups element indices as arrays associated with distinct keys.
+
+    If provided an empty array, the function returns an empty object.
+
+    Parameters
+    ----------
+    x: ArrayLike
+        Input array.
+
+    groups: ArrayLike
+        An array defining which group an element in the input array belongs to.
+        Each value in `groups` should resolve to a value which can be serialized
+        as an object key.
+
+    Returns
+    -------
+    out: Object
+        Group results.
+
+    Examples
+    --------
+    > var x = [ 'beep', 'boop', 'foo', 'bar' ];
+    > var g = [ 'b', 'b', 'f', 'b' ];
+    > var out = {{alias}}( x, g )
+    { 'b': [ 0, 1, 3 ], 'f': [ 2 ] }
+    > g = [ 1, 1, 2, 1 ];
+    > out = {{alias}}( x, g )
+    { '1': [ 0, 1, 3 ], '2': [ 2 ] }
+
+    See Also
+    --------
+

base/group-indices/docs/types/index.d.ts

@@ -0,0 +1,60 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2023 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';
+
+/**
+* Object key.
+*/
+type Key = string | symbol | number;
+
+/**
+* Interface describing returned group results.
+*/
+interface IndicesResults<K, T> {
+	/**
+	* Object properties.
+	*/
+	[key: K]: Array<T>;
+}
+
+
+/**
+* Groups element indices as arrays associated with distinct keys.
+*
+* @param x - input array
+* @param groups - array defining which group an element in the input array belongs to
+* @returns group results
+*
+* @example
+* var x = [ 'beep', 'boop', 'foo', 'bar' ];
+* var groups = [ 'b', 'b', 'f', 'b' ];
+*
+* var out = groupIndices( x, groups );
+* // returns { 'b': [ 0, 1, 3 ], 'f': [ 2 ] }
+*/
+declare function groupIndices<T = unknown>( x: Collection<T> | AccessorArrayLike<T>, groups: Collection<Key> | AccessorArrayLike<Key> ): IndicesResults<Key, number>;
+
+
+// EXPORTS //
+
+export = groupIndices;