Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stdlib-js/array-base-bifurcate-values

Split array element values into two groups.
https://github.com/stdlib-js/array-base-bifurcate-values

aggregate array base bifurcate bifurcation data group javascript node node-js nodejs partition split stdlib structure types

Last synced: about 2 months ago
JSON representation

Split array element values into two groups.

Awesome Lists containing this project

README

        


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!

# bifurcateValues

[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]

> Split array element values into two groups.

## Installation

```bash
npm install @stdlib/array-base-bifurcate-values
```

Alternatively,

- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).

The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.

To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

## Usage

```javascript
var bifurcateValues = require( '@stdlib/array-base-bifurcate-values' );
```

#### bifurcateValues( x, filter )

Splits array element values into two groups.

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

var out = bifurcateValues( x, filter );
// returns [ [ 'beep', 'boop', 'bar' ], [ 'foo' ] ]
```

## 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

```javascript
var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var take = require( '@stdlib/array-base-take-indexed' );
var bifurcateValues = require( '@stdlib/array-base-bifurcate-values' );

// 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 = bifurcateValues( x, groups );
// returns [...]

console.log( out );
```

* * *

## Notice

This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].

#### Community

[![Chat][chat-image]][chat-url]

---

## License

See [LICENSE][stdlib-license].

## Copyright

Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].

[npm-image]: http://img.shields.io/npm/v/@stdlib/array-base-bifurcate-values.svg
[npm-url]: https://npmjs.org/package/@stdlib/array-base-bifurcate-values

[test-image]: https://github.com/stdlib-js/array-base-bifurcate-values/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/array-base-bifurcate-values/actions/workflows/test.yml?query=branch:main

[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/array-base-bifurcate-values/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/array-base-bifurcate-values?branch=main

[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im

[stdlib]: https://github.com/stdlib-js/stdlib

[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors

[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules

[deno-url]: https://github.com/stdlib-js/array-base-bifurcate-values/tree/deno
[deno-readme]: https://github.com/stdlib-js/array-base-bifurcate-values/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/array-base-bifurcate-values/tree/umd
[umd-readme]: https://github.com/stdlib-js/array-base-bifurcate-values/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/array-base-bifurcate-values/tree/esm
[esm-readme]: https://github.com/stdlib-js/array-base-bifurcate-values/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/array-base-bifurcate-values/blob/main/branches.md

[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array-base-bifurcate-values/main/LICENSE