Learn more about Parallel Computing Toolbox

Function Reference

Parallel Code Execution

Parallel Code on a MATLAB Pool	Parallel computations on a pool of MATLAB sessions
Configuration, Input, and Output	Data access and setup control
Interactive Functions	Parallel code development and debugging

Parallel Code on a MATLAB Pool

batch	Run MATLAB script as batch job
Composite	Create Composite object
distributed	Create distributed array from data in client workspace
matlabpool	Open or close pool of MATLAB sessions for parallel computation
parfor	Execute code loop in parallel
spmd	Execute code in parallel on MATLAB pool

Configuration, Input, and Output

defaultParallelConfig	Default parallel computing configuration
diary	Display or save Command Window text of batch job
exist	Check whether Composite is defined on labs
importParallelConfig	Import parallel configuration .mat file
load	Load workspace variables from batch job
pctRunOnAll	Run command on client and all workers in matlabpool
subsasgn	Subscripted assignment for Composite
subsref	Subscripted reference for Composite

Interactive Functions

mpiprofile	Profile parallel communication and execution times
pmode	Interactive Parallel Command Window

Distributed and Codistributed Arrays

Toolbox Functions	Array creation and manipulation
Overloaded MATLAB Functions	Predefined arrays with overloaded functions

Toolbox Functions

codistributed	Create codistributed array from replicated local data
codistributed.build	Create codistributed array from distributed data
codistributed.colon	Distributed colon operation
codistributor	Create codistributor object for codistributed arrays
codistributor1d	Create 1-D codistributor object for codistributed arrays
codistributor1d.defaultPartition	Default partition for codistributed array
codistributor2dbc	Create 2-D block-cyclic codistributor object for codistributed arrays
codistributor2dbc.defaultLabGrid	Default computational grid for 2-D block-cyclic distributed arrays
for	`for`-loop over distributed range
gather	Transfer distributed array data to local workspace
getCodistributor	Codistributor object for existing codistributed array
getLocalPart	Local portion of codistributed array
globalIndices	Global indices for local part of codistributed array
isaUnderlying	True if distributed array's underlying elements are of specified class
isComplete	True if codistributor object is complete
isreplicated	True for replicated array
redistribute	Redistribute codistributed array with another distribution scheme

Overloaded MATLAB Functions

codistributed.cell	Create codistributed cell array
codistributed.eye	Create codistributed identity matrix
codistributed.false	Create codistributed false array
codistributed.inf	Create codistributed array of `Inf` values
codistributed.nan	Create codistributed array of Not-a-Number values
codistributed.ones	Create codistributed array of ones
codistributed.rand	Create codistributed array of uniformly distributed pseudo-random numbers
codistributed.randn	Create codistributed array of normally distributed random values
codistributed.spalloc	Allocate space for sparse codistributed matrix
codistributed.speye	Create codistributed sparse identity matrix
codistributed.sprand	Create codistributed sparse array of uniformly distributed pseudo-random values
codistributed.sprandn	Create codistributed sparse array of uniformly distributed pseudo-random values
codistributed.true	Create codistributed true array
codistributed.zeros	Create codistributed array of zeros
distributed.cell	Create distributed cell array
distributed.eye	Create distributed identity matrix
distributed.false	Create distributed false array
distributed.inf	Create distributed array of `Inf` values
distributed.nan	Create distributed array of Not-a-Number values
distributed.ones	Create distributed array of ones
distributed.rand	Create distributed array of uniformly distributed pseudo-random numbers
distributed.randn	Create distributed array of normally distributed random values
distributed.spalloc	Allocate space for sparse distributed matrix
distributed.speye	Create distributed sparse identity matrix
distributed.sprand	Create distributed sparse array of uniformly distributed pseudo-random values
distributed.sprandn	Create distributed sparse array of normally distributed pseudo-random values
distributed.true	Create distributed true array
distributed.zeros	Create distributed array of zeros
sparse	Create sparse distributed or codistributed matrix

Job and Task Programming

Job Creation	Job and task definition
Job Management	Job and task execution
Task Execution Information	Information on the processes evaluating a task
Object Control	Parallel Computing Toolbox objects

Job Creation

createJob	Create job object in scheduler and client
createMatlabPoolJob	Create MATLAB pool job
createParallelJob	Create parallel job object
createTask	Create new task in job
dfeval	Evaluate function using cluster
dfevalasync	Evaluate function asynchronously using cluster
findResource	Find available parallel computing resources
jobStartup	File for user-defined options to run when job starts
mpiLibConf	Location of MPI implementation
mpiSettings	Configure options for MPI communication
pctconfig	Configure settings for Parallel Computing Toolbox client session
poolStartup	File for user-defined options to run on each worker when MATLAB pool starts
setupForParallelExecution	Set options for submitting parallel jobs to scheduler
taskFinish	File for user-defined options to run when task finishes
taskStartup	File for user-defined options to run when task starts

Job Management

cancel	Cancel job or task
demote	Demote job in job manager queue
destroy	Remove job or task object from parent and memory
findJob	Find job objects stored in scheduler
findTask	Task objects belonging to job object
getAllOutputArguments	Output arguments from evaluation of all tasks in job object
getDebugLog	Read output messages from job run by supported third-party or local scheduler
getJobSchedulerData	Get specific user data for job on generic scheduler
pause	Pause job manager queue
promote	Promote job in job manager queue
resume	Resume processing queue in job manager
setJobSchedulerData	Set specific user data for job on generic scheduler
submit	Queue job in scheduler
wait	Wait for job to finish or change state
waitForState	Wait for object to change state

Task Execution Information

getCurrentJob	Job object whose task is currently being evaluated
getCurrentJobmanager	Job manager object that scheduled current task
getCurrentTask	Task object currently being evaluated in this worker session
getCurrentWorker	Worker object currently running this session
getFileDependencyDir	Directory where `FileDependencies` are written on worker machine

Object Control

clear	Remove objects from MATLAB workspace
get	Object properties
inspect	Open Property Inspector
length	Length of object array
methods	List functions of object class
set	Configure or display object properties
size	Size of object array

Interlab Communication Within a Parallel Job

gcat	Global concatenation
gop	Global operation across all labs
gplus	Global addition
labBarrier	Block execution until all labs reach this call
labBroadcast	Send data to all labs or receive data sent to all labs
labindex	Index of this lab
labProbe	Test to see if messages are ready to be received from other lab
labReceive	Receive data from another lab
labSend	Send data to another lab
labSendReceive	Simultaneously send data to and receive data from another lab
numlabs	Total number of labs operating in parallel on current job
pload	Load file into parallel session
psave	Save data from parallel job session

Utilities

help	Help for toolbox functions in Command Window
pctRunDeployedCleanup	Clean up after deployed parallel applications

Objects — Alphabetical List

Functions — Alphabetical List