Package Exports

@stdlib/array-base-group-values-by
@stdlib/array-base-group-values-by/dist
@stdlib/array-base-group-values-by/dist/index.js
@stdlib/array-base-group-values-by/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/array-base-group-values-by) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

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!

groupValuesBy

Group element values according to an indicator function.

Installation

npm install @stdlib/array-base-group-values-by

Usage

var groupValuesBy = require( '@stdlib/array-base-group-values-by' );

groupValuesBy( x, indicator[, thisArg] )

Groups element values according to an indicator function.

function indicator( v ) {
    return v[ 0 ];
}

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

var out = groupValuesBy( x, indicator );
// returns { 'b': [ 'beep', 'boop', 'bar' ], 'f': [ 'foo' ] }

An indicator function is provided the following arguments:

value: current array element.
index: current array element index.
arr: input array.

To set the indicator function execution context, provide a thisArg.

function indicator( v ) {
    this.count += 1;
    return v[ 0 ];
}

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

var context = {
    'count': 0
};
var out = groupValuesBy( x, indicator, context );
// returns { 'b': [ 'beep', 'boop', 'bar' ], 'f': [ 'foo' ] }

var cnt = context.count;
// returns 4

Notes

The value returned by an indicator function should be a value which can be serialized as an object key. As a counterexample,
```
function indicator( v ) {
    return {};
}
var x = [ 'beep', 'boop', 'foo', 'bar' ];

var out = groupValuesBy( x, indicator );
// returns { '[object Object]': [ 'beep', 'boop', 'foo', 'bar' ] }
```
while each group identifier is unique, all input array elements resolve to the same group because each group identifier serializes to the same string.

Examples

var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var take = require( '@stdlib/array-base-take-indexed' );
var groupValuesBy = require( '@stdlib/array-base-group-values-by' );

function indicator( v ) {
    // Use the first letter of each element to define groups:
    return v[ 0 ];
}

// 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 [...]

// Group the values:
var out = groupValuesBy( x, indicator );
// 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.

@stdlib/array-base-group-values-by