Table of contents
TOC
Collapse the table of content
Expand the table of content

List.zip<'T1,'T2> Function (F#)

Den Delimarsky|Last Updated: 3/15/2017
|
2 Contributors

Combines the two lists into a list of pairs. The two lists must have equal lengths.

Namespace/Module Path: Microsoft.FSharp.Collections.List

Assembly: FSharp.Core (in FSharp.Core.dll)

Syntax

// Signature:
List.zip : 'T1 list -> 'T2 list -> ('T1 * 'T2) list

// Usage:
List.zip list1 list2

Parameters

list1 Type: 'T1list

The first input list.

list2 Type: 'T2list

The second input list.

Return Value

A single list containing pairs of matching elements from the input lists.

Exceptions

ExceptionCondition
ArgumentExceptionThrown when the input lists differ in length.

Remarks

This function is named Zip in compiled assemblies. If you are accessing the function from a language other than F#, or through reflection, use this name.

Example

let list1 = [ 1; 2; 3 ]
let list2 = [ -1; -2; -3 ]
let listZip = List.zip list1 list2
printfn "%A" listZip

Output

[(1, -1); (2, -2); (3; -3)]

Platforms

Windows 8, Windows 7, Windows Server 2012, Windows Server 2008 R2

Version Information

F# Core Library Versions

Supported in: 2.0, 4.0, Portable

See Also

Collections.List Module (F#)

Microsoft.FSharp.Collections Namespace (F#)

© 2017 Microsoft