time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

index.js (1953B)

      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 an object's own property values according to an indicator function.
     23 *
     24 * @module @stdlib/utils/group-own
     25 *
     26 * @example
     27 * var groupOwn = require( '@stdlib/utils/group-own' );
     28 *
     29 * function indicator( v ) {
     30 *     return v[ 0 ];
     31 * }
     32 * var obj = {
     33 *     'a': 'beep',
     34 *     'b': 'boop',
     35 *     'c': 'foo',
     36 *     'd': 'bar'
     37 * };
     38 *
     39 * var out = groupOwn( obj, indicator );
     40 * // e.g., returns { 'b': [ 'beep', 'boop', 'bar' ], 'f': [ 'foo' ] }
     41 *
     42 * @example
     43 * var groupOwn = require( '@stdlib/utils/group-own' );
     44 *
     45 * function indicator( v ) {
     46 *     return v[ 0 ];
     47 * }
     48 * var obj = {
     49 *     'a': 'beep',
     50 *     'b': 'boop',
     51 *     'c': 'foo',
     52 *     'd': 'bar'
     53 * };
     54 *
     55 * var opts = {
     56 *     'returns': 'keys'
     57 * };
     58 * var out = groupOwn( obj, opts, indicator );
     59 * // e.g., returns { 'b': [ 'a', 'b', 'd' ], 'f': [ 'c' ] }
     60 *
     61 * @example
     62 * var groupOwn = require( '@stdlib/utils/group-own' );
     63 *
     64 * function indicator( v ) {
     65 *     return v[ 0 ];
     66 * }
     67 * var obj = {
     68 *     'a': 'beep',
     69 *     'b': 'boop',
     70 *     'c': 'foo',
     71 *     'd': 'bar'
     72 * };
     73 * var opts = {
     74 *     'returns': '*'
     75 * };
     76 * var out = groupOwn( obj, opts, indicator );
     77 * // e.g., returns { 'b': [ [ 'a', 'beep' ], [ 'b', 'boop' ], [ 'd', 'bar' ] ], 'f': [ [ 'c', 'foo' ] ] }
     78 */
     79 
     80 // MODULES //
     81 
     82 var groupOwn = require( './main.js' );
     83 
     84 
     85 // EXPORTS //
     86 
     87 module.exports = groupOwn;