Main Content

distributed

Access elements of distributed arrays from client

Constructor

distributed

You can also create a distributed array explicitly from the client with any of several MATLAB functions, shown in the table.

eye(___,'distributed')true(___,'distributed')
false(___,'distributed')zeros(___,'distributed')
Inf(___,'distributed')distributed.cell
NaN(___,'distributed')distributed.spalloc
ones(___,'distributed')distributed.speye
rand(___,'distributed')distributed.sprand
randi(___,'distributed')distributed.sprandn
randn(___,'distributed') 

Description

Distributed arrays represent those arrays which are partitioned out among the workers in a parallel pool. A distributed array resembles a normal MATLAB array in the way you index and manipulate its elements, but none of its elements exists on the client.

Codistributed arrays that you create inside spmd statements are accessible as distributed arrays from the client.

Use the gather function to retrieve distributed arrays into the client work space.

Methods

InfArray of infinity
classUnderlying(Not recommended) Class of elements within gpuArray or distributed array
distributed.cellCreate distributed cell array
distributed.spallocAllocate space for sparse distributed matrix
distributed.speyeCreate distributed sparse identity matrix
distributed.sprandCreate distributed sparse array of uniformly distributed pseudo-random values
distributed.sprandnCreate distributed sparse array of normally distributed pseudo-random values
eyeIdentity matrix
falseArray of logical 0 (false)
gatherTransfer distributed array or gpuArray to local workspace
isaUnderlying(Not recommended) True if distributed array's underlying elements are of specified class
isdistributedTrue for distributed array
randArray of rand values
sparseCreate sparse distributed or codistributed matrix
trueArray of logical 1 (true)
writeWrite distributed data to an output location

The methods for distributed arrays are too numerous to list here. Most resemble and behave the same as built-in MATLAB functions. See Run MATLAB Functions with Distributed Arrays.

Also among the methods are several for examining the characteristics of the array itself. Most behave like the MATLAB functions of the same name:

FunctionDescription
isdistributedIndication if array is distributed
isrealIndication if array elements are real
isUnderlyingTypeDetermine if underlying data in the array is of specified type
lengthLength of vector or largest array dimension
ndimsNumber of dimensions in the array
sizeSize of array dimensions
underlyingTypeClass (data type) of the underlying data in the array
Introduced in R2008a