@stdlib/array-base-bifurcate-indices v0.2.1

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.