Skip to content

Commit 6d42f09

Browse files
committed
Document the count argument in Gather should be the same on all processes.
Fixes #416.
1 parent f46414d commit 6d42f09

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/collective.jl

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -256,6 +256,8 @@ end
256256
Each process sends the first `count` elements of the buffer `sendbuf` to the `root`
257257
process. The `root` allocates the output buffer and stores elements in rank order.
258258
259+
`count` should be the same for all processes.
260+
259261
# See also
260262
- [`Gather!`](@ref) for the mutating operation.
261263
- [`Gatherv!`](@ref)/[`Gatherv`](@ref) if the number of elements varies between processes.
@@ -281,6 +283,8 @@ end
281283
Each process sends the first `count` elements of `sendbuf` to the other processes, who
282284
store the results in rank order into `recvbuf`.
283285
286+
`count` should be the same for all processes.
287+
284288
If only one buffer `sendrecvbuf` is provided, then each process send data is assumed to be
285289
in the area where it would receive it's own contribution.
286290
@@ -316,6 +320,8 @@ end
316320
Each process sends the first `count` elements of `sendbuf` to the other processes, who
317321
store the results in rank order allocating the output buffer.
318322
323+
`count` should be the same for all processes.
324+
319325
# See also
320326
- [`Allgather!`](@ref) for the mutating operation
321327
- [`Allgatherv!`](@ref)/[`Allgatherv`](@ref) if the number of elements varies between processes.

0 commit comments

Comments
 (0)