@stdlib/array-base-bifurcate-indices

About stdlib...

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

bifurcateIndices

Split array element indices into two groups.

Installation

npm install @stdlib/array-base-bifurcate-indices

Usage

var bifurcateIndices = require( '@stdlib/array-base-bifurcate-indices' );

bifurcateIndices( x, filter )

Splits array element indices into two groups.

var x = [ 'beep', 'boop', 'foo', 'bar' ];
var filter = [ true, true, false, true ];

var out = bifurcateIndices( x, filter );
// returns [ [ 0, 1, 3 ], [ 2 ] ]

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.

Examples

var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var take = require( '@stdlib/array-base-take-indexed' );
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 );

---

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

Community

---

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.