time-to-botec

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

index.js (1133B)

      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 * Generate a frequency table according to an indicator function.
     23 *
     24 * @module @stdlib/utils/tabulate-by
     25 *
     26 * @example
     27 * var tabulateBy = require( '@stdlib/utils/tabulate-by' );
     28 *
     29 * function indicator( value ) {
     30 *     return value[ 0 ];
     31 * }
     32 *
     33 * var arr = [ 'beep', 'boop', 'foo', 'beep' ];
     34 *
     35 * var out = tabulateBy( arr, indicator );
     36 * // returns [ [ 'b', 3, 0.75 ], [ 'f', 1, 0.25 ] ]
     37 */
     38 
     39 // MODULES //
     40 
     41 var tabulateBy = require( './tabulate_by.js' );
     42 
     43 
     44 // EXPORTS //
     45 
     46 module.exports = tabulateBy;