HH\ImmMap::zip

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

Description

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

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

If the number of values of the current ImmMap 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 ImmMap remain unchanged in the returned ImmMap.

Parameters

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

Return Values

Examples

See Map::zip for usage examples.