Function Reference


Parallel Code ExecutionConstructs for automatically running code in parallel
Codistributed ArraysData partitioned across multiple MATLAB sessions
Job and Task ProgrammingParallel computation through individual tasks
Interlab Communication Within a Parallel JobCommunications between labs during job execution

Parallel Code Execution

Parallel Code on a MATLAB PoolParallel computations on a pool of MATLAB sessions
Configuration, Input, and OutputData access and setup control
Interactive FunctionsParallel code development and debugging

Parallel Code on a MATLAB Pool

batchRun MATLAB script as batch job
CompositeCreate Composite object
matlabpoolOpen or close pool of MATLAB sessions for parallel computation
parforExecute code loop in parallel
spmdExecute code in parallel on MATLAB pool

Configuration, Input, and Output

defaultParallelConfigDefault parallel computing configuration
diaryDisplay or save Command Window text of batch job
existCheck whether Composite is defined on labs
loadLoad workspace variables from batch job
pctRunOnAllRun command on client and all workers in matlabpool
subsasgnSubscripted assignment for Composite
subsrefSubscripted reference for Composite

Interactive Functions

helpHelp for toolbox functions in Command Window
mpiprofileProfile parallel communication and execution times
pmodeInteractive Parallel Command Window

Codistributed Arrays

Toolbox Functions

codcolonDistributed colon operation
codistributedCreate codistributed array from local data
codistributorCreate codistributor object for codistributed arrays
defaultPartitionDefault partition for codistributed array
distributionDimensionDistributed dimension of codistributor object
distributionPartitionPartition scheme of codistributor object
forfor-loop over distributed range
gatherConvert codistributed array into replicated array
globalIndicesGlobal indices for local part of replicated array
isaTrue if object is of specified class
isreplicatedTrue for replicated array
labGridLab grid of '2d' codistributed array
localPartLocal portion of codistributed array
redistributeRedistribute a codistributed array with another distribution scheme

Overloaded MATLAB Functions

cellCreate codistributed cell array
eyeCreate codistributed identity matrix
falseCreate codistributed false array
InfCreate codistributed array of Inf values
NaNCreate codistributed array of NaN values
onesCreate codistributed array of 1s
randCreate codistributed array of uniformly distributed pseudo-random numbers
randnCreate codistributed array of normally distributed random values
sparseCreate codistributed sparse matrix
speyeCreate codistributed sparse identity matrix
sprandCreate codistributed sparse array of uniformly distributed pseudo-random values
sprandnCreate codistributed sparse array of normally distributed random values
trueCreate codistributed true array
zerosCreate codistributed array of 0s

Job and Task Programming

Job CreationJob and task definition
Job ManagementJob and task execution
Task Execution InformationInformation on the processes evaluating a task
Object ControlParallel Computing Toolbox objects

Job Creation

createJobCreate job object in scheduler and client
createMatlabPoolJobCreate MATLAB pool job
createParallelJobCreate parallel job object
createTaskCreate new task in job
dfevalEvaluate function using cluster
dfevalasyncEvaluate function asynchronously using cluster
findResourceFind available parallel computing resources
jobStartupM-file for user-defined options to run when job starts
mpiLibConfLocation of MPI implementation
mpiSettingsConfigure options for MPI communication
pctconfigConfigure settings for Parallel Computing Toolbox client session
setupForParallelExecutionSet options for submitting parallel jobs to scheduler
taskFinishM-file for user-defined options to run when task finishes
taskStartupM-file for user-defined options to run when task starts

Job Management

cancelCancel job or task
demoteDemote job in job manager queue
destroyRemove job or task object from parent and memory
findJobFind job objects stored in scheduler
findTaskTask objects belonging to job object
getAllOutputArgumentsOutput arguments from evaluation of all tasks in job object
getDebugLogRead output messages from job run by supported third-party or local scheduler
getJobSchedulerDataGet specific user data for job on generic scheduler
pausePause job manager queue
promotePromote job in job manager queue
resumeResume processing queue in job manager
setJobSchedulerDataSet specific user data for job on generic scheduler
submitQueue job in scheduler
waitWait for job to finish or change state
waitForStateWait for object to change state

Task Execution Information

getCurrentJobJob object whose task is currently being evaluated
getCurrentJobmanagerJob manager object that scheduled current task
getCurrentTaskTask object currently being evaluated in this worker session
getCurrentWorkerWorker object currently running this session
getFileDependencyDirDirectory where FileDependencies are written on worker machine

Object Control

clearRemove objects from MATLAB workspace
getObject properties
inspectOpen Property Inspector
lengthLength of object array
methodsList functions of object class
setConfigure or display object properties
sizeSize of object array

Interlab Communication Within a Parallel Job

gcatGlobal concatenation
gopGlobal operation across all labs
gplusGlobal addition
labBarrierBlock execution until all labs reach this call
labBroadcastSend data to all labs or receive data sent to all labs
labindexIndex of this lab
labProbeTest to see if messages are ready to be received from other lab
labReceiveReceive data from another lab
labSendSend data to another lab
labSendReceiveSimultaneously send data to and receive data from another lab
numlabsTotal number of labs operating in parallel on current job
ploadLoad file into parallel session
psaveSave data from parallel job session
  


 © 1984-2009- The MathWorks, Inc.    -   Site Help   -   Patents   -   Trademarks   -   Privacy Policy   -   Preventing Piracy   -   RSS