Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x | /**
* @license Apache-2.0
*
* Copyright (c) 2018 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
'use strict';
// MODULES //
var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
var isObject = require( '@stdlib/assert/is-plain-object' );
var isArray = require( '@stdlib/assert/is-array' );
var hasOwnProp = require( '@stdlib/assert/has-own-property' );
var format = require( '@stdlib/string/format' );
// MAIN //
/**
* Generates array tuples from input arrays.
*
* @param {...Array} arr - input arrays to be zipped
* @param {Object} [opts] - function options
* @param {boolean} [opts.trunc=true] - boolean indicating whether to truncate arrays longer than the shortest input array
* @param {*} [opts.fill=null] - fill value used for arrays of unequal length
* @param {boolean} [opts.arrays=false] - boolean indicating whether an input array should be interpreted as an array of arrays to be zipped
* @throws {TypeError} must provide array arguments
* @throws {Error} must provide at least one array
* @throws {TypeError} options argument must be an object
* @throws {TypeError} must provide valid options
* @returns {Array} output array of arrays
*
* @example
* var zipped = zip( [ 1, 2 ], [ 'a', 'b' ] );
* // returns [ [ 1, 'a' ], [ 2, 'b' ] ]
*
* @example
* var zipped = zip( [ 1, 2, 3 ], [ 'a', 'b' ] );
* // returns [ [ 1, 'a' ], [ 2, 'b' ] ]
*
* @example
* var opts = {
* 'trunc': false
* };
*
* var zipped = zip( [ 1, 2, 3 ], [ 'a', 'b' ], opts );
* // returns [ [ 1, 'a' ], [ 2, 'b' ], [ 3, null ] ]
*
* @example
* var opts = {
* 'trunc': false,
* 'fill': ''
* };
*
* var zipped = zip( [ 1, 2, 3 ], [ 'a', 'b' ], opts );
* // returns [ [ 1, 'a' ], [ 2, 'b' ], [ 3, '' ] ]
*
* @example
* var arr = [ [ 1, 2 ], [ 'a', 'b' ] ];
*
* // Default behavior:
* var zipped = zip( arr );
* // returns [ [ [ 1, 2 ] ], [ [ 'a', 'b' ] ] ]
*
* // Array of arrays:
* zipped = zip( arr, { 'arrays': true } );
* // returns [ [ 1, 'a' ], [ 2, 'b' ] ]
*/
function zip() {
var nargs;
var args;
var fill;
var opts;
var arg;
var flg;
var len;
var arr;
var out;
var val;
var i;
var j;
opts = {};
fill = null;
args = Array.prototype.slice.call( arguments );
nargs = args.length;
for ( i = 0; i < nargs-1; i++ ) {
if ( !isArray( args[i] ) ) {
throw new TypeError( format( 'invalid argument. Must provide array arguments. Value: `%s`.', args[i] ) );
}
}
arg = args[ nargs-1 ];
flg = isObject( arg );
if ( !flg && !isArray( arg ) ) {
throw new TypeError( format( 'invalid argument. Last argument must be either an array or an options object. Value: `%s`.', arg ) );
}
if ( flg ) {
opts = args.pop();
}
nargs = args.length;
if ( nargs === 0 ) {
throw new Error( 'insufficient arguments. Must provide at least one array.' );
}
if ( hasOwnProp( opts, 'trunc' ) ) {
if ( !isBoolean( opts.trunc ) ) {
throw new TypeError( format( 'invalid option. `%s` option must be a boolean. Option: `%s`.', 'trunc', opts.trunc ) );
}
} else {
opts.trunc = true;
}
if ( hasOwnProp( opts, 'fill' ) ) {
fill = opts.fill;
}
if ( hasOwnProp( opts, 'arrays' ) ) {
if ( !isBoolean( opts.arrays ) ) {
throw new TypeError( format( 'invalid option. `%s` option must be a boolean. Option: `%s`.', 'arrays', opts.arrays ) );
}
} else {
opts.arrays = false;
}
if ( nargs === 1 && opts.arrays ) {
// Treat the lone array argument as an array of arrays to be zipped...
args = args[ 0 ];
nargs = args.length;
}
len = args[ 0 ].length;
if ( opts.trunc ) {
// Find the min array length...
for ( i = 0; i < nargs; i++ ) {
val = args[ i ].length;
if ( val < len ) {
len = val;
}
}
} else {
// Find the max array length...
for ( i = 0; i < nargs; i++ ) {
val = args[ i ].length;
if ( val > len ) {
len = val;
}
}
}
out = [];
for ( j = 0; j < len; j++ ) {
// Temporary array to store tuples...
arr = [];
// Create the tuples...
for ( i = 0; i < nargs; i++ ) {
arg = args[ i ];
// If an array is too short, use a fill value...
if ( arg.length <= j ) {
arr.push( fill );
continue;
}
arr.push( arg[ j ] );
}
out.push( arr );
}
return out;
}
// EXPORTS //
module.exports = zip;
|