gleam/list · gleam_stdlib

all

pub fn all(
  in list: List(a),
  satisfying predicate: fn(a) -> Bool,
) -> Bool

Returns True if the given function returns True for all the elements in the given list. If the function returns False for any of the elements it immediately returns False without checking the rest of the list.

Examples

assert all([], fn(x) { x > 3 })

assert all([4, 5], fn(x) { x > 3 })

assert !all([4, 3], fn(x) { x > 3 })

any

</>

pub fn any(
  in list: List(a),
  satisfying predicate: fn(a) -> Bool,
) -> Bool

Returns True if the given function returns True for any the elements in the given list. If the function returns True for any of the elements it immediately returns True without checking the rest of the list.

Examples

assert !any([], fn(x) { x > 3 })

assert any([4, 5], fn(x) { x > 3 })

assert any([4, 3], fn(x) { x > 4 })

assert any([3, 4], fn(x) { x > 3 })

append

</>

pub fn append(first: List(a), second: List(a)) -> List(a)

Joins one list onto the end of another.

This function runs in linear time, and it traverses and copies the first list.

Examples

assert append([1, 2], [3]) == [1, 2, 3]

chunk

</>

pub fn chunk(in list: List(a), by f: fn(a) -> k) -> List(List(a))

Returns a list of chunks in which the return value of calling f on each element is the same.

Examples

assert [1, 2, 2, 3, 4, 4, 6, 7, 7] |> chunk(by: fn(n) { n % 2 })
  == [[1], [2, 2], [3], [4, 4, 6], [7, 7]]

combination_pairs

</>

pub fn combination_pairs(items: List(a)) -> List(#(a, a))

Return unique pair combinations of elements in the list.

Examples

assert combination_pairs([1, 2, 3]) == [#(1, 2), #(1, 3), #(2, 3)]

combinations

</>

pub fn combinations(items: List(a), by n: Int) -> List(List(a))

Return unique combinations of elements in the list.

Examples

assert combinations([1, 2, 3], 2) == [[1, 2], [1, 3], [2, 3]]

assert combinations([1, 2, 3, 4], 3)
  == [[1, 2, 3], [1, 2, 4], [1, 3, 4], [2, 3, 4]]

contains

</>

pub fn contains(list: List(a), any elem: a) -> Bool

Determines whether or not a given element exists within a given list.

This function traverses the list to find the element, so it runs in linear time.

Examples

assert !contains([], any: 0)

assert [0] |> contains(any: 0)

assert !contains([1], any: 0)

assert !contains([1, 1], any: 0)

assert [1, 0] |> contains(any: 0)

count

</>

pub fn count(
  list: List(a),
  where predicate: fn(a) -> Bool,
) -> Int

Counts the number of elements in a given list satisfying a given predicate.

This function has to traverse the list to determine the number of elements, so it runs in linear time.

Examples

assert count([], fn(a) { a > 0 }) == 0

assert count([1], fn(a) { a > 0 }) == 1

assert count([1, 2, 3], int.is_odd) == 2

drop

</>

pub fn drop(from list: List(a), up_to n: Int) -> List(a)

Returns a list that is the given list with up to the given number of elements removed from the front of the list.

If the list has less than the number of elements an empty list is returned.

This function runs in linear time but does not copy the list.

Examples

assert drop([1, 2, 3, 4], 2) == [3, 4]

assert drop([1, 2, 3, 4], 9) == []

drop_while

</>

pub fn drop_while(
  in list: List(a),
  satisfying predicate: fn(a) -> Bool,
) -> List(a)

Drops the first elements in a given list for which the predicate function returns True.

Examples

assert drop_while([1, 2, 3, 4], fn (x) { x < 3 }) == [3, 4]

each

</>

pub fn each(list: List(a), f: fn(a) -> b) -> Nil

Calls a function for each element in a list, discarding the return value.

Useful for calling a side effect for every item of a list.

import gleam/io

assert each(["1", "2", "3"], io.println) == Nil
// 1
// 2
// 3

filter

</>

pub fn filter(
  list: List(a),
  keeping predicate: fn(a) -> Bool,
) -> List(a)

Returns a new list containing only the elements from the first list for which the given functions returns True.

Examples

assert filter([2, 4, 6, 1], fn(x) { x > 2 }) == [4, 6]

assert filter([2, 4, 6, 1], fn(x) { x > 6 }) == []

filter_map

</>

pub fn filter_map(
  list: List(a),
  with fun: fn(a) -> Result(b, e),
) -> List(b)

Returns a new list containing only the elements from the first list for which the given functions returns Ok(_).

Examples

assert filter_map([2, 4, 6, 1], Error) == []

assert filter_map([2, 4, 6, 1], fn(x) { Ok(x + 1) }) == [3, 5, 7, 2]

find

</>

pub fn find(
  in list: List(a),
  one_that is_desired: fn(a) -> Bool,
) -> Result(a, Nil)

Finds the first element in a given list for which the given function returns True.

Returns Error(Nil) if no such element is found.

Examples

assert find([1, 2, 3], fn(x) { x > 2 }) == Ok(3)

assert find([1, 2, 3], fn(x) { x > 4 }) == Error(Nil)

assert find([], fn(_) { True }) == Error(Nil)

find_map

</>

pub fn find_map(
  in list: List(a),
  with fun: fn(a) -> Result(b, c),
) -> Result(b, Nil)

Finds the first element in a given list for which the given function returns Ok(new_value), then returns the wrapped new_value.

Returns Error(Nil) if no such element is found.

Examples

assert find_map([[], [2], [3]], first) == Ok(2)

assert find_map([[], []], first) == Error(Nil)

assert find_map([], first) == Error(Nil)

first

</>

pub fn first(list: List(a)) -> Result(a, Nil)

Gets the first element from the start of the list, if there is one.

Examples

assert first([]) == Error(Nil)

assert first([0]) == Ok(0)

assert first([1, 2]) == Ok(1)

flat_map

</>

pub fn flat_map(
  over list: List(a),
  with fun: fn(a) -> List(b),
) -> List(b)

Maps the list with the given function into a list of lists, and then flattens it.

Examples

assert flat_map([2, 4, 6], fn(x) { [x, x + 1] }) == [2, 3, 4, 5, 6, 7]

flatten

</>

pub fn flatten(lists: List(List(a))) -> List(a)

Joins a list of lists into a single list.

This function traverses all elements twice on the JavaScript target. This function traverses all elements once on the Erlang target.

Examples

assert flatten([[1], [2, 3], []]) == [1, 2, 3]

fold

</>

pub fn fold(
  over list: List(a),
  from initial: acc,
  with fun: fn(acc, a) -> acc,
) -> acc

Reduces a list of elements into a single value by calling a given function on each element, going from left to right.

fold([1, 2, 3], 0, add) is the equivalent of add(add(add(0, 1), 2), 3).

This function runs in linear time.

fold_right

</>

pub fn fold_right(
  over list: List(a),
  from initial: acc,
  with fun: fn(acc, a) -> acc,
) -> acc

Reduces a list of elements into a single value by calling a given function on each element, going from right to left.

fold_right([1, 2, 3], 0, add) is the equivalent of add(add(add(0, 3), 2), 1).

This function runs in linear time.

Unlike fold this function is not tail recursive. Where possible use fold instead as it will use less memory.

fold_until

</>

pub fn fold_until(
  over list: List(a),
  from initial: acc,
  with fun: fn(acc, a) -> ContinueOrStop(acc),
) -> acc

A variant of fold that allows to stop folding earlier.

The folding function should return ContinueOrStop(accumulator). If the returned value is Continue(accumulator) fold_until will try the next value in the list. If the returned value is Stop(accumulator) fold_until will stop and return that accumulator.

Examples

assert [1, 2, 3, 4]
  |> fold_until(0, fn(acc, i) {
    case i < 3 {
      True -> Continue(acc + i)
      False -> Stop(acc)
    }
  })
  == 3

group

</>

pub fn group(
  list: List(v),
  by key: fn(v) -> k,
) -> dict.Dict(k, List(v))

Groups the elements from the given list by the given key function.

Does not preserve the initial value order.

Examples

import gleam/dict

assert
  [Ok(3), Error("Wrong"), Ok(200), Ok(73)]
  |> group(by: fn(i) {
    case i {
      Ok(_) -> "Successful"
      Error(_) -> "Failed"
    }
  })
  |> dict.to_list
  == [
    #("Failed", [Error("Wrong")]),
    #("Successful", [Ok(73), Ok(200), Ok(3)])
  ]

import gleam/dict

assert group([1,2,3,4,5], by: fn(i) { i - i / 3 * 3 })
  |> dict.to_list
  == [#(0, [3]), #(1, [4, 1]), #(2, [5, 2])]

index_fold

</>

pub fn index_fold(
  over list: List(a),
  from initial: acc,
  with fun: fn(acc, a, Int) -> acc,
) -> acc

Like fold but the folding function also receives the index of the current element.

Examples

assert ["a", "b", "c"]
  |> index_fold("", fn(acc, item, index) {
    acc <> int.to_string(index) <> ":" <> item <> " "
  })
  == "0:a 1:b 2:c"

assert [10, 20, 30]
  |> index_fold(0, fn(acc, item, index) { acc + item * index })
  == 80

index_map

</>

pub fn index_map(
  list: List(a),
  with fun: fn(a, Int) -> b,
) -> List(b)

Similar to map, but the supplied function will also be passed the index of the element being mapped as an additional argument.

The index starts at 0, so the first element is 0, the second is 1, and so on.

Examples

assert index_map(["a", "b"], fn(x, i) { #(i, x) }) == [#(0, "a"), #(1, "b")]

interleave

</>

pub fn interleave(list: List(List(a))) -> List(a)

Make a list alternating the elements from the given lists

Examples

assert interleave([[1, 2], [101, 102], [201, 202]])
  == [1, 101, 201, 2, 102, 202]

intersperse

</>

pub fn intersperse(list: List(a), with elem: a) -> List(a)

Inserts a given value between each existing element in a given list.

This function runs in linear time and copies the list.

Examples

assert intersperse([1, 1, 1], 2) == [1, 2, 1, 2, 1]

assert intersperse([], 2) == []

is_empty

</>

pub fn is_empty(list: List(a)) -> Bool

Determines whether or not the list is empty.

This function runs in constant time.

Examples

assert is_empty([])

assert !is_empty([1])

assert !is_empty([1, 1])

key_filter

</>

pub fn key_filter(
  in keyword_list: List(#(k, v)),
  find desired_key: k,
) -> List(v)

Given a list of 2-element tuples, finds all tuples that have a given key as the first element and returns the second element.

This function may be useful for interacting with Erlang code where lists of tuples are common.

Examples

assert key_filter([#("a", 0), #("b", 1), #("a", 2)], "a") == [0, 2]

assert key_filter([#("a", 0), #("b", 1)], "c") == []

key_find

</>

pub fn key_find(
  in keyword_list: List(#(k, v)),
  find desired_key: k,
) -> Result(v, Nil)

Given a list of 2-element tuples, finds the first tuple that has a given key as the first element and returns the second element.

If no tuple is found with the given key then Error(Nil) is returned.

This function may be useful for interacting with Erlang code where lists of tuples are common.

Examples

assert key_find([#("a", 0), #("b", 1)], "a") == Ok(0)

assert key_find([#("a", 0), #("b", 1)], "b") == Ok(1)

assert key_find([#("a", 0), #("b", 1)], "c") == Error(Nil)

key_pop

</>

pub fn key_pop(
  list: List(#(k, v)),
  key: k,
) -> Result(#(v, List(#(k, v))), Nil)

Given a list of 2-element tuples, finds the first tuple that has a given key as the first element. This function will return the second element of the found tuple and list with tuple removed.

If no tuple is found with the given key then Error(Nil) is returned.

Examples

assert key_pop([#("a", 0), #("b", 1)], "a") == Ok(#(0, [#("b", 1)]))

assert key_pop([#("a", 0), #("b", 1)], "b") == Ok(#(1, [#("a", 0)]))

assert key_pop([#("a", 0), #("b", 1)], "c") == Error(Nil)

key_set

</>

pub fn key_set(
  list: List(#(k, v)),
  key: k,
  value: v,
) -> List(#(k, v))

Given a list of 2-element tuples, inserts a key and value into the list.

If there was already a tuple with the key then it is replaced, otherwise it is added to the end of the list.

Examples

assert key_set([#(5, 0), #(4, 1)], 4, 100) == [#(5, 0), #(4, 100)]

assert key_set([#(5, 0), #(4, 1)], 1, 100) == [#(5, 0), #(4, 1), #(1, 100)]

last

</>

pub fn last(list: List(a)) -> Result(a, Nil)

Returns the last element in the given list.

Returns Error(Nil) if the list is empty.

This function runs in linear time.

Examples

assert last([]) == Error(Nil)

assert last([1, 2, 3, 4, 5]) == Ok(5)

length

</>

pub fn length(of list: List(a)) -> Int

Counts the number of elements in a given list.

This function has to traverse the list to determine the number of elements, so it runs in linear time.

This function is natively implemented by the virtual machine and is highly optimised.

Examples

assert length([]) == 0

assert length([1]) == 1

assert length([1, 2]) == 2

map

</>

pub fn map(list: List(a), with fun: fn(a) -> b) -> List(b)

Returns a new list containing the results of applying the supplied function to each element.

Examples

assert map([2, 4, 6], fn(x) { x * 2 }) == [4, 8, 12]

map2

</>

pub fn map2(
  list1: List(a),
  list2: List(b),
  with fun: fn(a, b) -> c,
) -> List(c)

Combines two lists into a single list using the given function.

If a list is longer than the other, the extra elements are dropped.

Examples

assert map2([1, 2, 3], [4, 5, 6], fn(x, y) { x + y }) == [5, 7, 9]

assert map2([1, 2], ["a", "b", "c"], fn(i, x) { #(i, x) })
  == [#(1, "a"), #(2, "b")]

map_fold

</>

pub fn map_fold(
  over list: List(a),
  from initial: acc,
  with fun: fn(acc, a) -> #(acc, b),
) -> #(acc, List(b))

Similar to map but also lets you pass around an accumulated value.

Examples

assert
  map_fold(
    over: [1, 2, 3],
    from: 100,
    with: fn(memo, i) { #(memo + i, i * 2) }
  )
  == #(106, [2, 4, 6])

max

</>

pub fn max(
  over list: List(a),
  with compare: fn(a, a) -> order.Order,
) -> Result(a, Nil)

Takes a list and a comparator, and returns the maximum element in the list

Examples

assert [1, 2, 3, 4, 5] |> list.max(int.compare) == Ok(5)

assert ["a", "c", "b"] |> list.max(string.compare) == Ok("c")

new

</>

pub fn new() -> List(a)

Returns a new empty list.

Examples

assert new() == []

partition

</>

pub fn partition(
  list: List(a),
  with categorise: fn(a) -> Bool,
) -> #(List(a), List(a))

Partitions a list into a tuple/pair of lists by a given categorisation function.

Examples

import gleam/int

assert [1, 2, 3, 4, 5] |> partition(int.is_odd) == #([1, 3, 5], [2, 4])

permutations

</>

pub fn permutations(list: List(a)) -> List(List(a))

Returns all the permutations of a list.

Examples

assert permutations([1, 2]) == [[1, 2], [2, 1]]

prepend

</>

pub fn prepend(to list: List(a), this item: a) -> List(a)

Prefixes an item to a list. This can also be done using the dedicated syntax instead.

let existing_list = [2, 3, 4]
assert [1, ..existing_list] == [1, 2, 3, 4]

let existing_list = [2, 3, 4]
assert prepend(to: existing_list, this: 1) == [1, 2, 3, 4]

range

</>

pub fn range(from start: Int, to stop: Int) -> List(Int)

Deprecated: Use int.range instead

reduce

</>

pub fn reduce(
  over list: List(a),
  with fun: fn(a, a) -> a,
) -> Result(a, Nil)

This function acts similar to fold, but does not take an initial state. Instead, it starts from the first element in the list and combines it with each subsequent element in turn using the given function. The function is called as fun(accumulator, current_element).

Returns Ok to indicate a successful run, and Error if called on an empty list.

Examples

assert [] |> reduce(fn(acc, x) { acc + x }) == Error(Nil)

assert [1, 2, 3, 4, 5] |> reduce(fn(acc, x) { acc + x }) == Ok(15)

repeat

</>

pub fn repeat(item a: a, times times: Int) -> List(a)

Builds a list of a given value a given number of times.

Examples

assert repeat("a", times: 0) == []

assert repeat("a", times: 5) == ["a", "a", "a", "a", "a"]

rest

</>

pub fn rest(list: List(a)) -> Result(List(a), Nil)

Returns the list minus the first element. If the list is empty, Error(Nil) is returned.

This function runs in constant time and does not make a copy of the list.

Examples

assert rest([]) == Error(Nil)

assert rest([0]) == Ok([])

assert rest([1, 2]) == Ok([2])

reverse

</>

pub fn reverse(list: List(a)) -> List(a)

Creates a new list from a given list containing the same elements but in the opposite order.

This function has to traverse the list to create the new reversed list, so it runs in linear time.

This function is natively implemented by the virtual machine and is highly optimised.

Examples

assert reverse([]) == []

assert reverse([1]) == [1]

assert reverse([1, 2]) == [2, 1]

sample

</>

pub fn sample(from list: List(a), up_to n: Int) -> List(a)

Returns a random sample of up to n elements from a list using reservoir sampling via Algorithm L. Returns an empty list if the sample size is less than or equal to 0.

Order is not random, only selection is.

Examples

sample([1, 2, 3, 4, 5], 3)
// -> [2, 4, 5]  // A random sample of 3 items

scan

</>

pub fn scan(
  over list: List(a),
  from initial: acc,
  with fun: fn(acc, a) -> acc,
) -> List(acc)

Similar to fold, but yields the state of the accumulator at each stage.

Examples

assert scan(over: [1, 2, 3], from: 100, with: fn(acc, i) { acc + i })
  == [101, 103, 106]

shuffle

</>

pub fn shuffle(list: List(a)) -> List(a)

Takes a list, randomly sorts all items and returns the shuffled list.

This function uses float.random to decide the order of the elements.

Example

[1, 2, 3, 4, 5, 6, 7, 8, 9, 10] |> shuffle
// -> [1, 6, 9, 10, 3, 8, 4, 2, 7, 5]

sized_chunk

</>

pub fn sized_chunk(
  in list: List(a),
  into count: Int,
) -> List(List(a))

Returns a list of chunks containing count elements each.

If the last chunk does not have count elements, it is instead a partial chunk, with less than count elements.

For any count less than 1 this function behaves as if it was set to 1.

Examples

assert [1, 2, 3, 4, 5, 6] |> sized_chunk(into: 2)
  == [[1, 2], [3, 4], [5, 6]]

assert [1, 2, 3, 4, 5, 6, 7, 8] |> sized_chunk(into: 3)
  == [[1, 2, 3], [4, 5, 6], [7, 8]]

sort

</>

pub fn sort(
  list: List(a),
  by compare: fn(a, a) -> order.Order,
) -> List(a)

Sorts from smallest to largest based upon the ordering specified by a given function.

Examples

import gleam/int

assert sort([4, 3, 6, 5, 4, 1, 2], by: int.compare) == [1, 2, 3, 4, 4, 5, 6]

split

</>

pub fn split(
  list list: List(a),
  at index: Int,
) -> #(List(a), List(a))

Splits a list in two before the given index.

If the list is not long enough to have the given index the before list will be the input list, and the after list will be empty.

Examples

assert split([6, 7, 8, 9], 0) == #([], [6, 7, 8, 9])

assert split([6, 7, 8, 9], 2) == #([6, 7], [8, 9])

assert split([6, 7, 8, 9], 4) == #([6, 7, 8, 9], [])

split_while

</>

pub fn split_while(
  list list: List(a),
  satisfying predicate: fn(a) -> Bool,
) -> #(List(a), List(a))

Splits a list in two before the first element that a given function returns False for.

If the function returns True for all elements the first list will be the input list, and the second list will be empty.

Examples

assert split_while([1, 2, 3, 4, 5], fn(x) { x <= 3 })
  == #([1, 2, 3], [4, 5])

assert split_while([1, 2, 3, 4, 5], fn(x) { x <= 5 })
  == #([1, 2, 3, 4, 5], [])

strict_zip

</>

pub fn strict_zip(
  list: List(a),
  with other: List(b),
) -> Result(List(#(a, b)), Nil)

Takes two lists and returns a single list of 2-element tuples.

If one of the lists is longer than the other, an Error is returned.

Examples

assert strict_zip([], []) == Ok([])

assert strict_zip([1, 2], [3]) == Error(Nil)

assert strict_zip([1], [3, 4]) == Error(Nil)

assert strict_zip([1, 2], [3, 4]) == Ok([#(1, 3), #(2, 4)])

take

</>

pub fn take(from list: List(a), up_to n: Int) -> List(a)

Returns a list containing the first given number of elements from the given list.

If the list has less than the number of elements then the full list is returned.

This function runs in linear time.

Examples

assert take([1, 2, 3, 4], 2) == [1, 2]

assert take([1, 2, 3, 4], 9) == [1, 2, 3, 4]

take_while

</>

pub fn take_while(
  in list: List(a),
  satisfying predicate: fn(a) -> Bool,
) -> List(a)

Takes the first elements in a given list for which the predicate function returns True.

Examples

assert take_while([1, 2, 3, 2, 4], fn (x) { x < 3 }) == [1, 2]

transpose

</>

pub fn transpose(list_of_lists: List(List(a))) -> List(List(a))

Transpose rows and columns of the list of lists.

Notice: This function is not tail recursive, and thus may exceed stack size if called, with large lists (on the JavaScript target).

Examples

assert transpose([[1, 2, 3], [101, 102, 103]])
  == [[1, 101], [2, 102], [3, 103]]

try_each

</>

pub fn try_each(
  over list: List(a),
  with fun: fn(a) -> Result(b, e),
) -> Result(Nil, e)

Calls a Result returning function for each element in a list, discarding the return value. If the function returns Error then the iteration is stopped and the error is returned.

Useful for calling a side effect for every item of a list.

Examples

assert
  try_each(
    over: [1, 2, 3],
    with: function_that_might_fail,
  )
  == Ok(Nil)

try_fold

</>

pub fn try_fold(
  over list: List(a),
  from initial: acc,
  with fun: fn(acc, a) -> Result(acc, e),
) -> Result(acc, e)

A variant of fold that might fail.

The folding function should return Result(accumulator, error). If the returned value is Ok(accumulator) try_fold will try the next value in the list. If the returned value is Error(error) try_fold will stop and return that error.

Examples

assert [1, 2, 3, 4]
  |> try_fold(0, fn(acc, i) {
    case i < 3 {
      True -> Ok(acc + i)
      False -> Error(Nil)
    }
  })
  == Error(Nil)

try_map

</>

pub fn try_map(
  over list: List(a),
  with fun: fn(a) -> Result(b, e),
) -> Result(List(b), e)

Takes a function that returns a Result and applies it to each element in a given list in turn.

If the function returns Ok(new_value) for all elements in the list then a list of the new values is returned.

If the function returns Error(reason) for any of the elements then it is returned immediately. None of the elements in the list are processed after one returns an Error.

Examples

assert try_map([1, 2, 3], fn(x) { Ok(x + 2) }) == Ok([3, 4, 5])

assert try_map([1, 2, 3], fn(_) { Error(0) }) == Error(0)

assert try_map([[1], [2, 3]], first) == Ok([1, 2])

assert try_map([[1], [], [2]], first) == Error(Nil)

unique

</>

pub fn unique(list: List(a)) -> List(a)

Removes any duplicate elements from a given list.

This function returns in loglinear time.

Examples

assert unique([1, 1, 1, 4, 7, 3, 3, 4]) == [1, 4, 7, 3]

unzip

</>

pub fn unzip(input: List(#(a, b))) -> #(List(a), List(b))

Takes a single list of 2-element tuples and returns two lists.

Examples

assert unzip([#(1, 2), #(3, 4)]) == #([1, 3], [2, 4])

assert unzip([]) == #([], [])

window

</>

pub fn window(list: List(a), by n: Int) -> List(List(a))

Returns a list of sliding windows.

Examples

assert window([1,2,3,4,5], 3) == [[1, 2, 3], [2, 3, 4], [3, 4, 5]]

assert window([1, 2], 4) == []

window_by_2

</>

pub fn window_by_2(list: List(a)) -> List(#(a, a))

Returns a list of tuples containing two contiguous elements.

Examples

assert window_by_2([1,2,3,4]) == [#(1, 2), #(2, 3), #(3, 4)]

assert window_by_2([1]) == []

wrap

</>

pub fn wrap(item: a) -> List(a)

Returns the given item wrapped in a list.

Examples

assert wrap(1) == [1]

assert wrap(["a", "b", "c"]) == [["a", "b", "c"]]

assert wrap([[]]) == [[[]]]

zip

</>

pub fn zip(list: List(a), with other: List(b)) -> List(#(a, b))

Takes two lists and returns a single list of 2-element tuples.

If one of the lists is longer than the other, the remaining elements from the longer list are not used.

Examples

assert zip([], []) == []

assert zip([1, 2], [3]) == [#(1, 3)]

assert zip([1], [3, 4]) == [#(1, 3)]

assert zip([1, 2], [3, 4]) == [#(1, 3), #(2, 4)]

Constructors

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Example

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples

Examples