@stdlib/array-base-bifurcate-entries
v0.2.2
Published
Split array element entries into two groups.
Downloads
21
Readme
bifurcateEntries
Split array element entries into two groups.
Installation
npm install @stdlib/array-base-bifurcate-entries
Usage
var bifurcateEntries = require( '@stdlib/array-base-bifurcate-entries' );
bifurcateEntries( x, filter )
Splits array element entries into two groups.
var x = [ 'beep', 'boop', 'foo', 'bar' ];
var filter = [ true, true, false, true ];
var out = bifurcateEntries( x, filter );
// returns [ [ [ 0, 'beep' ], [ 1, 'boop' ], [ 3, 'bar' ] ], [ [ 2, 'foo' ] ] ]
Notes
- If an element in
filter
is truthy, the corresponding element in the input arrayx
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 bifurcateEntries = require( '@stdlib/array-base-bifurcate-entries' );
// 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 = bifurcateEntries( 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.