Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "iter/zip"

Index

Functions

Functions

zip

  • zip<A>(a: Iterable<A>): IterableIterator<[A]>
  • zip<A, B>(a: Iterable<A>, b: Iterable<B>): IterableIterator<[A, B]>
  • zip<A, B, C>(a: Iterable<A>, b: Iterable<B>, c: Iterable<C>): IterableIterator<[A, B, C]>
  • zip<A, B, C, D>(a: Iterable<A>, b: Iterable<B>, c: Iterable<C>, d: Iterable<D>): IterableIterator<[A, B, C, D]>
  • zip<A, B, C, D, E>(a: Iterable<A>, b: Iterable<B>, c: Iterable<C>, d: Iterable<D>, e: Iterable<E>): IterableIterator<[A, B, C, D, E]>
  • zip<A, B, C, D, E, F>(a: Iterable<A>, b: Iterable<B>, c: Iterable<C>, d: Iterable<D>, e: Iterable<E>, f: Iterable<F>): IterableIterator<[A, B, C, D, E, F]>
  • zip<A, B, C, D, E, F, G>(a: Iterable<A>, b: Iterable<B>, c: Iterable<C>, d: Iterable<D>, e: Iterable<E>, f: Iterable<F>, g: Iterable<G>): IterableIterator<[A, B, C, D, E, F, G]>
  • zip<A, B, C, D, E, F, G, H>(a: Iterable<A>, b: Iterable<B>, c: Iterable<C>, d: Iterable<D>, e: Iterable<E>, f: Iterable<F>, g: Iterable<G>, h: Iterable<H>): IterableIterator<[A, B, C, D, E, F, G, H]>
  • Accepts a number of iterables and combines them into an iterable of tuples of successively consumed input values.

    remarks

    Tuples are formed by merging each value of each input iterable, such that the first yielded tuple contains the first elements of the given inputs, the second tuple contains the second elements of the inputs, etc.

    The number of resulting tuples will be the same as the length of the shortest input iterable. Given only a single argument, zip yields a sequence of 1-tuples.

    example
    zip([1, 2, 3], [3, 4, 5, 0, 9])
    // [ 1, 3 ] [ 2, 4 ] [ 3, 5 ]
    
    zip([1, 2, 3])
    // [ 1 ] [ 2 ] [ 3 ]

    Type parameters

    • A

    Parameters

    • a: Iterable<A>

    Returns IterableIterator<[A]>

  • Type parameters

    • A

    • B

    Parameters

    • a: Iterable<A>
    • b: Iterable<B>

    Returns IterableIterator<[A, B]>

  • Type parameters

    • A

    • B

    • C

    Parameters

    • a: Iterable<A>
    • b: Iterable<B>
    • c: Iterable<C>

    Returns IterableIterator<[A, B, C]>

  • Type parameters

    • A

    • B

    • C

    • D

    Parameters

    • a: Iterable<A>
    • b: Iterable<B>
    • c: Iterable<C>
    • d: Iterable<D>

    Returns IterableIterator<[A, B, C, D]>

  • Type parameters

    • A

    • B

    • C

    • D

    • E

    Parameters

    • a: Iterable<A>
    • b: Iterable<B>
    • c: Iterable<C>
    • d: Iterable<D>
    • e: Iterable<E>

    Returns IterableIterator<[A, B, C, D, E]>

  • Type parameters

    • A

    • B

    • C

    • D

    • E

    • F

    Parameters

    • a: Iterable<A>
    • b: Iterable<B>
    • c: Iterable<C>
    • d: Iterable<D>
    • e: Iterable<E>
    • f: Iterable<F>

    Returns IterableIterator<[A, B, C, D, E, F]>

  • Type parameters

    • A

    • B

    • C

    • D

    • E

    • F

    • G

    Parameters

    • a: Iterable<A>
    • b: Iterable<B>
    • c: Iterable<C>
    • d: Iterable<D>
    • e: Iterable<E>
    • f: Iterable<F>
    • g: Iterable<G>

    Returns IterableIterator<[A, B, C, D, E, F, G]>

  • Type parameters

    • A

    • B

    • C

    • D

    • E

    • F

    • G

    • H

    Parameters

    • a: Iterable<A>
    • b: Iterable<B>
    • c: Iterable<C>
    • d: Iterable<D>
    • e: Iterable<E>
    • f: Iterable<F>
    • g: Iterable<G>
    • h: Iterable<H>

    Returns IterableIterator<[A, B, C, D, E, F, G, H]>

Generated using TypeDoc