mirrors/phobos
1
0
Fork 0
mirror of https://github.com/dlang/phobos.git synced 2025-05-08 20:19:43 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improved docs for std.range.zip

Browse source
This commit is contained in:
Jack Stouffer 2016-07-27 15:40:26 -04:00 • committed by GitHub
parent 52b694570c
commit c00e298ef6
1 changed files with 12 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

17
std/range/package.d
View file

@ -3759,11 +3759,18 @@ private alias lengthType(R) = typeof(R.init.length.init);
`lockstep` allows reference access to the elements in
`foreach` iterations.
$(D Zip) offers the lowest range facilities of all components, e.g. it
offers random access iff all ranges offer random access, and also
offers mutation and swapping if all ranges offer it. Due to this, $(D
Zip) is extremely powerful because it allows manipulating several
ranges in lockstep.
Params:
sp = controls what `zip` will do if the _ranges are different lengths
ranges = the ranges to zip together
Returns:
At minimum, an input range. `Zip` offers the lowest range facilities
of all components, e.g. it offers random access iff all ranges offer
random access, and also offers mutation and swapping if all ranges offer
it. Due to this, `Zip` is extremely powerful because it allows manipulating
several ranges in lockstep.
Throws:
An `Exception` if all of the _ranges are not the same length and
`sp` is set to `StoppingPolicy.requireSameLength`.
*/
struct Zip(Ranges...)
if (Ranges.length && allSatisfy!(isInputRange, Ranges))