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

Improve docs for move(), moveAll(), moveSome().

Browse source
This commit is contained in:
H. S. Teoh 2015-01-07 16:41:16 -08:00
parent a2daf1a34e
commit 976cefb5a7
1 changed files with 30 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

38
std/algorithm.d
View file

@ -2287,8 +2287,15 @@ private struct FilterBidiResult(alias pred, Range)
// move // move
/** /**
Moves $(D source) into $(D target) via a destructive Moves $(D source) into $(D target) via a destructive copy.
copy.
Params:
source = Data to copy. If a destructor or postblit is defined, it is reset
to its $(D .init) value after it is moved into target. Note that data
with internal pointers that point to itself cannot be moved, and will
trigger an assertion failure.
target = Where to copy into. The destructor, if any, is invoked before the
copy is performed.
*/ */
void move(T)(ref T source, ref T target) void move(T)(ref T source, ref T target)
{ {
@ -2550,12 +2557,20 @@ unittest// Issue 8057
// moveAll // moveAll
/** /**
For each element $(D a) in $(D src) and each element $(D b) in $(D For each element $(D a) in $(D src) and each element $(D b) in $(D
tgt) in lockstep in increasing order, calls $(D move(a, b)). Returns tgt) in lockstep in increasing order, calls $(D move(a, b)).
the leftover portion of $(D tgt). Throws an exception if there is not
enough room in $(D tgt) to accommodate all of $(D src).
Preconditions: Preconditions:
$(D walkLength(src) <= walkLength(tgt)) $(D walkLength(src) <= walkLength(tgt)).
An exception will be thrown if this condition does not hold, i.e., there is not
enough room in $(D tgt) to accommodate all of $(D src).
Params:
src = An $(XREF2 range, isInputRange, input range) with movable elements.
tgt = An $(XREF2 range, isInputRange, input range) with elements that
elements from $(D src) can be moved into.
Returns: The leftover portion of $(D tgt) after all elements from $(D src) have
been moved.
*/ */
Range2 moveAll(Range1, Range2)(Range1 src, Range2 tgt) Range2 moveAll(Range1, Range2)(Range1 src, Range2 tgt)
if (isInputRange!Range1 && isInputRange!Range2 if (isInputRange!Range1 && isInputRange!Range2
@ -2598,8 +2613,15 @@ unittest
/** /**
For each element $(D a) in $(D src) and each element $(D b) in $(D For each element $(D a) in $(D src) and each element $(D b) in $(D
tgt) in lockstep in increasing order, calls $(D move(a, b)). Stops tgt) in lockstep in increasing order, calls $(D move(a, b)). Stops
when either $(D src) or $(D tgt) have been exhausted. Returns the when either $(D src) or $(D tgt) have been exhausted.
leftover portions of the two ranges.
Params:
src = An $(XREF2 range, isInputRange, input range) with movable elements.
tgt = An $(XREF2 range, isInputRange, input range) with elements that
elements from $(D src) can be moved into.
Returns: The leftover portions of the two ranges after one or the other of the
ranges have been exhausted.
*/ */
Tuple!(Range1, Range2) moveSome(Range1, Range2)(Range1 src, Range2 tgt) Tuple!(Range1, Range2) moveSome(Range1, Range2)(Range1 src, Range2 tgt)
if (isInputRange!Range1 && isInputRange!Range2 if (isInputRange!Range1 && isInputRange!Range2