index.js (1753B)
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 according to an indicator function. 23 * 24 * @module @stdlib/utils/group-by 25 * 26 * @example 27 * var groupBy = require( '@stdlib/utils/group-by' ); 28 * 29 * function indicator( v ) { 30 * return v[ 0 ]; 31 * } 32 * var arr = [ 'beep', 'boop', 'foo', 'bar' ]; 33 * 34 * var out = groupBy( arr, indicator ); 35 * // returns { 'b': [ 'beep', 'boop', 'bar' ], 'f': [ 'foo' ] } 36 * 37 * @example 38 * var groupBy = require( '@stdlib/utils/group-by' ); 39 * 40 * function indicator( v ) { 41 * return v[ 0 ]; 42 * } 43 * var arr = [ 'beep', 'boop', 'foo', 'bar' ]; 44 * 45 * var opts = { 46 * 'returns': 'indices' 47 * }; 48 * var out = groupBy( arr, opts, indicator ); 49 * // returns { 'b': [ 0, 1, 3 ], 'f': [ 2 ] } 50 * 51 * @example 52 * var groupBy = require( '@stdlib/utils/group-by' ); 53 * 54 * function indicator( v ) { 55 * return v[ 0 ]; 56 * } 57 * var arr = [ 'beep', 'boop', 'foo', 'bar' ]; 58 * 59 * var opts = { 60 * 'returns': '*' 61 * }; 62 * var out = groupBy( arr, opts, indicator ); 63 * // returns { 'b': [ [ 0, 'beep' ], [ 1, 'boop' ], [ 3, 'bar' ] ], 'f': [ [ 2, 'foo' ] ] } 64 */ 65 66 // MODULES // 67 68 var groupBy = require( './group_by.js' ); 69 70 71 // EXPORTS // 72 73 module.exports = groupBy;