MutableMap::zip

Returns a MutableMap where each value is a Pair that combines the value of the current MutableMap and the provided Traversable.

Description

public function zip(
  Traversable<Tu> $traversable,
): MutableMap<Tk,Pair<Tv,Tu>>

Returns a MutableMap where each value is a Pair that combines the value of the current MutableMap and the provided Traversable.

If the number of values of the current MutableMap are not equal to the number of elements in the Traversable, then only the combined elements up to and including the final element of the one with the least number of elements is included.

The keys associated with the current MutableMap remain unchanged in the returned MutableMap.

Parameters

  • Traversable<Tu> $traversable - The Traversable to use to combine with the elements of the current MutableMap.

Return Values