index.js (1680B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 /** 22 * Group values as arrays associated with distinct keys. 23 * 24 * @module @stdlib/utils/group 25 * 26 * @example 27 * var group = require( '@stdlib/utils/group' ); 28 * 29 * var arr = [ 'beep', 'boop', 'foo', 'bar' ]; 30 * var groups = [ 'b', 'b', 'f', 'b' ]; 31 * 32 * var out = group( arr, groups ); 33 * // returns { 'b': [ 'beep', 'boop', 'bar' ], 'f': [ 'foo' ] } 34 * 35 * @example 36 * var group = require( '@stdlib/utils/group' ); 37 * 38 * var arr = [ 'beep', 'boop', 'foo', 'bar' ]; 39 * var groups = [ 'b', 'b', 'f', 'b' ]; 40 * 41 * var opts = { 42 * 'returns': 'indices' 43 * }; 44 * 45 * var out = group( arr, opts, groups ); 46 * // returns { 'b': [ 0, 1, 3 ], 'f': [ 2 ] } 47 * 48 * @example 49 * var group = require( '@stdlib/utils/group' ); 50 * 51 * var arr = [ 'beep', 'boop', 'foo', 'bar' ]; 52 * var groups = [ 'b', 'b', 'f', 'b' ]; 53 * 54 * var opts = { 55 * 'returns': '*' 56 * }; 57 * 58 * var out = group( arr, opts, groups ); 59 * // returns { 'b': [ [ 0, 'beep' ], [ 1, 'boop' ], [ 3, 'bar' ] ], 'f': [ [ 2, 'foo' ] ] } 60 */ 61 62 // MODULES // 63 64 var group = require( './group.js' ); 65 66 67 // EXPORTS // 68 69 module.exports = group;