Documentation

gather

Transfer distributed array or gpuArray to local workspace

Syntax

X = gather(A)
X = gather(C,lab)

Description

X = gather(A)can operate inside anspmdstatement, pmode, or communicating job to gather together the elements of a codistributed array, or outside anspmdstatement to gather the elements of a distributed array. If you execute this inside anspmdstatement, pmode, or communicating job,Xis a replicated array with all the elements of the array on every worker. If you execute this outside anspmdstatement,Xis an array in the local workspace, with the elements transferred from the multiple workers.

X = gather(distributed(X))orX = gather(codistributed(X))returns the original arrayX.

X = gather(C,lab)converts a codistributed arrayCto a variant arrayX, such that all of the elements are contained on workerlab, andXis a 0-by-0 empty double on all other workers.

For a gpuArray input,X = gather(A)transfers the array elements from the GPU to the local workspace.

If the input argument togatheris not a distributed, a codistributed, or a gpuArray, the output is the same as the input.

Examples

Distribute a magic square across your workers, then gather the whole matrix onto every worker and then onto the client. This code results in the equivalent ofM = magic(n)on all workers and the client.

n = 10;spmdC = codistributed(magic(n)); M = gather(C)% Gather all elements to all workersendS = gather(C)% Gather elements to client

Gather all of the elements ofConto worker 1, for operations that cannot be performed across distributed arrays.

n = 10;spmdC = codistributed(magic(n)); out = gather(C,1);iflabindex == 1% Characteristic sum for this magic square:characteristicSum = sum(1:n^2)/n;% Ensure that the diagonal sums are equal to the% characteristic sum:areDiagonalsEqual = isequal...(trace(out),trace(flipud(out)),characteristicSum)endend
Lab 1: areDiagonalsEqual = 1

Gather all of the elements from a distributed arrayDonto the client.

n = 10; D = distributed(magic(n));% Distribute array to workersM = gather(D)% Return array to client

Gather the results of a GPU operation to the MATLAB workspace.

G = gpuArray(rand(1024,1)); F = sqrt(G);% Input and output are both gpuArrayW = gather(G);% Return array to workspacewhos
Name Size Bytes Class F 1024x1 108 gpuArray G 1024x1 108 gpuArray W 1024x1 8192 double

Tips

Note thatgatherassembles the codistributed or distributed array in the workspaces of all the workers on which it executes, or on the MATLAB®client, respectively, but not both. If you are usinggatherwithin anspmd声明中聚集数组的访问client via its correspondingCompositeobject; seeAccess Worker Variables with Composites. If you are runninggatherin a communicating job, you can return the gathered array to the client as an output argument from the task.

As thegatherfunction requires communication between all the workers, you cannot gather data from all the workers onto a single worker by placing the function inside a conditional statement such asif labindex == 1.

Introduced in R2006b

Was this topic helpful?