time-to-botec

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

index.js (1831B)

      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 * Invert an object, such that keys become values and values become keys, according to a transform function.
     23 *
     24 * @module @stdlib/utils/object-inverse-by
     25 *
     26 * @example
     27 * var invertBy = require( '@stdlib/utils/object-inverse-by' );
     28 *
     29 * function transform( key, value ) {
     30 *     return key + value;
     31 * }
     32 * var obj = {
     33 *     'a': 'beep',
     34 *     'b': 'boop'
     35 * };
     36 * var out = invertBy( obj, transform );
     37 * // returns { 'abeep': 'a', 'bboop': 'b' }
     38 *
     39 * @example
     40 * var invertBy = require( '@stdlib/utils/object-inverse-by' );
     41 *
     42 * function transform( key, value ) {
     43 *     return value;
     44 * }
     45 * var obj = {
     46 *     'a': 'beep',
     47 *     'b': 'beep'
     48 * };
     49 * var out = invertBy( obj, transform );
     50 * // returns { 'beep': [ 'a', 'b' ] }
     51 *
     52 * @example
     53 * var invertBy = require( '@stdlib/utils/object-inverse-by' );
     54 *
     55 * function transform( key, value ) {
     56 *     return value;
     57 * }
     58 *
     59 * var obj = {};
     60 * obj.a = 'beep';
     61 * obj.b = 'boop';
     62 * obj.c = 'beep'; // inserted after `a`
     63 *
     64 * var opts = {
     65 *     'duplicates': false
     66 * };
     67 * var out = invertBy( obj, opts, transform );
     68 * // returns { 'beep': 'c', 'boop': 'b' }
     69 */
     70 
     71 // MODULES //
     72 
     73 var invertBy = require( './object_inverse_by.js' );
     74 
     75 
     76 // EXPORTS //
     77 
     78 module.exports = invertBy;