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

Merge pull request #3503 from quickfur/take_docs

Browse source 
[dox] Document what happens to take/takeExactly if the range is too short.
This commit is contained in:
Steven Schveighoffer 2015-07-20 17:16:08 -04:00
commit 033cdd8568
1 changed files with 18 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

18
std/range/package.d
View file

@ -1917,6 +1917,21 @@ if (isInputRange!(Unqual!R) && !isInfinite!(Unqual!R) && hasSlicing!(Unqual!R) &
assert(equal(s, [ 1, 2, 3, 4, 5 ][])); assert(equal(s, [ 1, 2, 3, 4, 5 ][]));
} }
/**
* If the range runs out before `n` elements, `take` simply returns the entire
* range (unlike $(LREF takeExactly), which will cause an assertion failure if
* the range ends prematurely):
*/
@safe unittest
{
import std.algorithm : equal;
int[] arr2 = [ 1, 2, 3 ];
auto t = take(arr2, 5);
assert(t.length == 3);
assert(equal(t, [ 1, 2, 3 ]));
}
// take(take(r, n1), n2) // take(take(r, n1), n2)
Take!R take(R)(R input, size_t n) Take!R take(R)(R input, size_t n)
if (is(R T == Take!T)) if (is(R T == Take!T))
@ -2044,6 +2059,9 @@ even when $(D range) itself does not define $(D length).
The result of $(D takeExactly) is identical to that of $(LREF take) in The result of $(D takeExactly) is identical to that of $(LREF take) in
cases where the original range defines $(D length) or is infinite. cases where the original range defines $(D length) or is infinite.
Unlike $(LREF take), however, it is illegal to pass a range with less than
$(D n) elements to $(D takeExactly); this will cause an assertion failure.
*/ */
auto takeExactly(R)(R range, size_t n) auto takeExactly(R)(R range, size_t n)
if (isInputRange!R) if (isInputRange!R)