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!
Split values into two groups.
To use in Observable,
bifurcate = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-bifurcate@umd/browser.js' )To vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:
var bifurcate = require( 'path/to/vendor/umd/utils-bifurcate/index.js' )To include the bundle in a webpage,
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/utils-bifurcate@umd/browser.js"></script>If no recognized module system is present, access bundle contents via the global scope:
<script type="text/javascript">
(function () {
window.bifurcate;
})();
</script>Splits values into two groups. If an element in filter is truthy, the corresponding element in collection belongs to the first group; otherwise, the collection element belongs to the second group.
var arr = [ 'beep', 'boop', 'foo', 'bar' ];
var filter = [ true, true, false, true ];
var out = bifurcate( arr, filter );
// returns [ [ 'beep', 'boop', 'bar' ], [ 'foo' ] ]The function accepts the following options:
- returns: specifies the output format. If the option equals
'values', the function outputs element values. If the option equals'indices', the function outputs element indices. If the option equals'*', the function outputs both element indices and values. Default:'values'.
By default, the function returns element values. To return element indices, set the returns option to 'indices'.
var arr = [ 'beep', 'boop', 'foo', 'bar' ];
var filter = [ true, true, false, true ];
var opts = {
'returns': 'indices'
};
var out = bifurcate( arr, opts, filter );
// returns [ [ 0, 1, 3 ], [ 2 ] ]To return index-element pairs, set the returns option to '*'.
var arr = [ 'beep', 'boop', 'foo', 'bar' ];
var filter = [ true, true, false, true ];
var opts = {
'returns': '*'
};
var out = bifurcate( arr, opts, filter );
// returns [ [ [ 0, 'beep' ], [ 1, 'boop' ], [ 3, 'bar' ] ], [ [ 2, 'foo' ] ] ]- Both
collectionandfiltermust be collections. A collection may be either anArray,Typed Array, or an array-likeObject(excludingstringsandfunctions).
<!DOCTYPE html>
<html lang="en">
<body>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/random-base-randu@umd/browser.js"></script>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-floor@umd/browser.js"></script>
<script type="text/javascript" src="https://cdn.jsdelivr.net/gh/stdlib-js/utils-bifurcate@umd/browser.js"></script>
<script type="text/javascript">
(function () {
var vals;
var arr;
var out;
var f;
var i;
var j;
vals = [ 'beep', 'boop', 'foo', 'bar', 'woot', 'woot' ];
// Generate a random collection...
arr = new Array( 100 );
for ( i = 0; i < arr.length; i++ ) {
j = floor( randu()*vals.length );
arr[ i ] = vals[ j ];
}
// Randomly assign collection values to a group...
f = new Array( arr.length );
for ( i = 0; i < arr.length; i++ ) {
f[ i ] = ( randu() < 0.5 );
}
// Compute the groups:
out = bifurcate( arr, f );
console.log( out );
})();
</script>
</body>
</html>@stdlib/utils-bifurcate-by: split values into two groups according to a predicate function.@stdlib/utils-bifurcate-own: split an object's own property values into two groups according to a predicate function.@stdlib/utils-group: group values as arrays associated with distinct keys.
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.
See LICENSE.
Copyright © 2016-2024. The Stdlib Authors.