Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stdlib-js/utils-zip

Generate array tuples from input arrays.
https://github.com/stdlib-js/utils-zip

array generic javascript node node-js nodejs stdlib util utilities utility utils zip

Last synced: 2 months ago
JSON representation

Generate array tuples from input arrays.

Awesome Lists containing this project

README 

        



  

    About stdlib...

  

  
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.


  
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.


  
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.


  
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!



# Zip



[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] 



> Generate array tuples from input arrays.



## Installation



```bash

npm install @stdlib/utils-zip

```



Alternatively,



-   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).

-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).

-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).



The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.



To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.



## Usage



```javascript

var zip = require( '@stdlib/utils-zip' );

```



#### zip( arr1, arr2,...\[, opts] )



Returns an `array` of `arrays`, where the ith element (tuple) in the returned `array` contains the ith elements of the input `arrays`.



```javascript

var zipped = zip( [ 1, 2 ], [ 'a', 'b' ] );

// returns [ [ 1, 'a' ], [ 2, 'b' ] ]

```



By default, the returned `array` length is the length of the shortest input `array`.



```javascript

var zipped = zip( [ 1, 2, 3 ], [ 'a', 'b' ] );

// returns [ [ 1, 'a' ], [ 2, 'b' ] ]

```



The function accepts an `options` object with optional properties:



-   **trunc**: `boolean` specifying whether the returned `array` should truncate `arrays` longer than the shortest `array`. Default: `true`.

-   **fill**: fill value used for unequal length `arrays`. Default: `null`.

-   **arrays**: `boolean` specifying whether, when provided a single input `array`, the function should interpret the argument as a list of `arrays` to be zipped (i.e., behavior similar to `zip.apply(null, arr)`). Default: `false`.



To turn off truncation,



```javascript

var opts = {

    'trunc': false

};



var zipped = zip( [ 1, 2, 3 ], [ 'a', 'b' ], opts );

// returns [ [ 1, 'a' ], [ 2, 'b' ], [ 3, null ] ]

```



A fill value is included in each tuple for each `array` which does not have an element at the ith index. By default, the fill value is `null`. To specify a different fill value, set the `fill` option.



```javascript

var opts = {

    'trunc': false,

    'fill': ''

};



var zipped = zip( [ 1, 2, 3 ], [ 'a', 'b' ], opts );

// returns [ [ 1, 'a' ], [ 2, 'b' ], [ 3, '' ] ]

```



If the function should interpret a single input `array` as an `array` of `arrays` to be zipped,



```javascript

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' ] ]

```



## Examples



```javascript

var randu = require( '@stdlib/random-base-randu' );

var zip = require( '@stdlib/utils-zip' );



var x = [];

var y1 = [];

var y2 = [];

var y3 = [];



// Simulate some data...

var i;

for ( i = 0; i < 100; i++ ) {

    x.push( Date.now() );

    y1.push( randu() * 100 );

    y2.push( randu() * 100 );

    y3.push( randu() );

}



var zipped = zip( x, y1, y2, y3 );



console.log( zipped.join( '\n' ) );

```



* * *



## See Also



-   [`@stdlib/utils-unzip`][@stdlib/utils/unzip]: unzip a zipped array (i.e., a nested array of tuples).



* * *



## Notice



This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.



For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].



#### Community



[![Chat][chat-image]][chat-url]



---



## License



See [LICENSE][stdlib-license].



## Copyright



Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].



[npm-image]: http://img.shields.io/npm/v/@stdlib/utils-zip.svg

[npm-url]: https://npmjs.org/package/@stdlib/utils-zip



[test-image]: https://github.com/stdlib-js/utils-zip/actions/workflows/test.yml/badge.svg?branch=main

[test-url]: https://github.com/stdlib-js/utils-zip/actions/workflows/test.yml?query=branch:main



[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/utils-zip/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/utils-zip?branch=main



[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg

[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im



[stdlib]: https://github.com/stdlib-js/stdlib



[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors



[umd]: https://github.com/umdjs/umd

[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules



[deno-url]: https://github.com/stdlib-js/utils-zip/tree/deno

[deno-readme]: https://github.com/stdlib-js/utils-zip/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/utils-zip/tree/umd

[umd-readme]: https://github.com/stdlib-js/utils-zip/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/utils-zip/tree/esm

[esm-readme]: https://github.com/stdlib-js/utils-zip/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/utils-zip/blob/main/branches.md



[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/utils-zip/main/LICENSE



[@stdlib/utils/unzip]: https://github.com/stdlib-js/utils-unzip