time-to-botec

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

repl.txt (1036B)


      1 
      2 {{alias}}( ...arr[, options] )
      3     Generates array tuples from input arrays.
      4 
      5     Parameters
      6     ----------
      7     arr: ...Array
      8         Input arrays to be zipped.
      9 
     10     options: Object (optional)
     11         Options.
     12 
     13     options.trunc: boolean (optional)
     14         Boolean indicating whether to truncate arrays longer than the shortest
     15         input array. Default: `true`.
     16 
     17     options.fill: any (optional)
     18         Fill value used for arrays of unequal length. Default: `null`.
     19 
     20     options.arrays: boolean (optional)
     21         Boolean indicating whether an input array should be interpreted as an
     22         array of arrays to be zipped. Default: `false`.
     23 
     24     Returns
     25     -------
     26     out: Array
     27         Array of arrays.
     28 
     29     Examples
     30     --------
     31     // Basic usage:
     32     > var out = {{alias}}( [ 1, 2 ], [ 'a', 'b' ] )
     33     [ [ 1, 'a' ], [ 2, 'b' ] ]
     34 
     35     // Turn off truncation:
     36     > var opts = { 'trunc': false };
     37     > out = {{alias}}( [ 1, 2, 3 ], [ 'a', 'b' ], opts )
     38     [ [ 1, 'a' ], [ 2, 'b' ], [ 3, null ] ]
     39 
     40     See Also
     41     --------
     42