Auto-generated commit

stdlib-js · Dec 30, 2023 · 935e78e · 935e78e
1 parent dc7ad92
commit 935e78e
Show file tree

Hide file tree

Showing 13 changed files with 792 additions and 5 deletions.
diff --git a/base/bifurcate-indices/README.md b/base/bifurcate-indices/README.md
@@ -0,0 +1,132 @@
+<!--
+
+@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.
+
+-->
+
+# bifurcateIndices
+
+> Split array element indices into two groups.
+
+<!-- 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 bifurcateIndices = require( '@stdlib/array/base/bifurcate-indices' );
+```
+
+#### bifurcateIndices( x, filter )
+
+Splits array element indices into two groups.
+
+```javascript
+var x = [ 'beep', 'boop', 'foo', 'bar' ];
+var filter = [ true, true, false, true ];
+
+var out = bifurcateIndices( x, filter );
+// returns [ [ 0, 1, 3 ], [ 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
+
+-   If an element in `filter` is truthy, the corresponding element in the input array `x` belongs to the first group; otherwise, the input array element belongs to the second group.
+
+</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 bifurcateIndices = require( '@stdlib/array/base/bifurcate-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, 1, {
+    'dtype': 'generic'
+});
+
+// Group the values:
+var out = bifurcateIndices( 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 -->
diff --git a/base/bifurcate-indices/benchmark/benchmark.length.js b/base/bifurcate-indices/benchmark/benchmark.length.js
@@ -0,0 +1,104 @@
+/**
+* @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 isArrayArray = require( '@stdlib/assert/is-array-array' );
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var zeroTo = require( './../../../base/zero-to' );
+var pkg = require( './../package.json' ).name;
+var bifurcateIndices = require( './../lib' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} len - array length
+* @returns {Function} benchmark function
+*/
+function createBenchmark( len ) {
+	var filter;
+	var x;
+
+	x = zeroTo( len );
+	filter = discreteUniform( len, 0, 1, {
+		'dtype': 'generic'
+	});
+
+	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 = bifurcateIndices( x, filter );
+			if ( typeof out !== 'object' ) {
+				b.fail( 'should return an object' );
+			}
+		}
+		b.toc();
+		if ( !isArrayArray( 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, f );
+	}
+}
+
+main();
diff --git a/base/bifurcate-indices/docs/repl.txt b/base/bifurcate-indices/docs/repl.txt
@@ -0,0 +1,39 @@
+
+{{alias}}( x, filter )
+    Splits array element indices into two groups.
+
+    If an element in `filter` is truthy, then the corresponding element in the
+    input array belongs to the first group; otherwise, the array element belongs
+    to the second group.
+
+    If provided an empty array, the function returns an empty array.
+
+    Parameters
+    ----------
+    x: ArrayLike
+        Input array.
+
+    filter: ArrayLike
+        An array indicating which group an element in the input array
+        belongs to. If an element in `filter` is truthy, the corresponding
+        element in the input array belongs to the first group; otherwise, the
+        array element belongs to the second group.
+
+    Returns
+    -------
+    out: Array<Array>
+        Group results.
+
+    Examples
+    --------
+    > var x = [ 'beep', 'boop', 'foo', 'bar' ];
+    > var f = [ true, true, false, true ];
+    > var out = {{alias}}( x, f )
+    [ [ 0, 1, 3 ], [ 2 ] ]
+    > f = [ 1, 1, 0, 1 ];
+    > out = {{alias}}( x, f )
+    [ [ 0, 1, 3 ], [ 2 ] ]
+
+    See Also
+    --------
+
diff --git a/base/bifurcate-indices/docs/types/index.d.ts b/base/bifurcate-indices/docs/types/index.d.ts
@@ -0,0 +1,44 @@
+/*
+* @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';
+
+/**
+* Splits array element indices into two groups.
+*
+* @param x - input array
+* @param filter - array indicating which group an element in the input array belongs to
+* @returns results
+*
+* @example
+* var x = [ 'beep', 'boop', 'foo', 'bar' ];
+* var filter = [ true, true, false, true ];
+*
+* var out = bifurcateIndices( arr, filter );
+* // returns [ [ 0, 1, 3 ], [ 2 ] ]
+*/
+declare function bifurcateIndices( x: Collection | AccessorArrayLike<any>, filter: Collection | AccessorArrayLike<any> ): [ Array<number>, Array<number> ]; // eslint-disable-line @typescript-eslint/no-explicit-any
+
+
+// EXPORTS //
+
+export = bifurcateIndices;
diff --git a/base/bifurcate-indices/docs/types/test.ts b/base/bifurcate-indices/docs/types/test.ts
@@ -0,0 +1,66 @@
+/*
+* @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.
+*/
+
+import bifurcateIndices = require( './index' );
+
+
+// TESTS //
+
+// The function returns group results...
+{
+	const x = [ 1, 2, 3 ];
+	const f = [ 0, 1, 0 ];
+
+	bifurcateIndices( x, f ); // $ExpectType [number[], number[]]
+}
+
+// The compiler throws an error if the function is provided a first argument which is not an array...
+{
+	const f = [ 0, 1, 0 ];
+
+	bifurcateIndices( 5, f ); // $ExpectError
+	bifurcateIndices( true, f ); // $ExpectError
+	bifurcateIndices( false, f ); // $ExpectError
+	bifurcateIndices( null, f ); // $ExpectError
+	bifurcateIndices( void 0, f ); // $ExpectError
+	bifurcateIndices( {}, f ); // $ExpectError
+	bifurcateIndices( ( x: number ): number => x, f ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided a second argument which is not an array...
+{
+	const x = [ 1, 2, 3 ];
+
+	bifurcateIndices( x, 5 ); // $ExpectError
+	bifurcateIndices( x, true ); // $ExpectError
+	bifurcateIndices( x, false ); // $ExpectError
+	bifurcateIndices( x, null ); // $ExpectError
+	bifurcateIndices( x, void 0 ); // $ExpectError
+	bifurcateIndices( x, {} ); // $ExpectError
+	bifurcateIndices( x, ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	const x = [ 1, 2, 3 ];
+	const f = [ 0, 1, 0 ];
+
+	bifurcateIndices(); // $ExpectError
+	bifurcateIndices( x ); // $ExpectError
+	bifurcateIndices( x, f, {} ); // $ExpectError
+}