Function Reference


General Toolbox FunctionsToolbox functions not specific to particular object type
Job Manager FunctionsOperate on job manager object
Scheduler FunctionsOperate on various schedulers
Job FunctionsOperate on job object
Task FunctionsOperate on task object
Toolbox Functions Used in Parallel Jobs and pmodeExecute within parallel job code
Toolbox Functions Used in MATLAB® WorkersExecute within MATLAB® worker session

General Toolbox Functions

batchRun a batch MATLAB® pool job
clearRemove objects from MATLAB® workspace
createJobCreate job object in scheduler and client
createMatlabPoolJobCreate MATLAB® pool job
createParallelJobCreate parallel job object
defaultParallelConfigDefault parallel computing configuration
dfevalEvaluate function using cluster
dfevalasyncEvaluate function asynchronously using cluster
findResourceFind available distributed computing resources
getObject properties
helpHelp for toolbox functions in Command Window
inspectOpen Property Inspector
jobStartupM-file for user-defined options to run when job starts
lengthLength of object array
matlabpoolStart parallel language worker pool
methodsList functions of object class
parforExecute block of code in parallel
pctconfigConfigure settings for Parallel Computing Toolbox™ client session
pctRunOnAllRun command on client and all workers in matlabpool
pmodeInteractive parallel mode
setConfigure or display object properties
sizeSize of object array
taskFinishM-file for user-defined options to run when task finishes
taskStartupM-file for user-defined options to run when task starts

Job Manager Functions

createJobCreate job object in scheduler and client
createMatlabPoolJobCreate MATLAB® pool job
createParallelJobCreate parallel job object
demoteDemote job in job manager queue
findJobFind job objects stored in scheduler
pausePause job manager queue
promotePromote job in job manager queue
resumeResume processing queue in job manager

Scheduler Functions

createJobCreate job object in scheduler and client
createMatlabPoolJobCreate MATLAB® pool job
createParallelJobCreate parallel job object
findJobFind job objects stored in scheduler
getDebugLogRead output messages from job run by supported third-party or local scheduler
mpiLibConfLocation of MPI implementation
mpiSettingsConfigure options for MPI communication
setupForParallelExecutionSet options for submitting parallel jobs to scheduler

Job Functions

cancelCancel job or task
createTaskCreate new task in job
destroyRemove job or task object from parent and memory
diaryDisplay or save Command Window text of batch job
findTaskTask objects belonging to job object
getAllOutputArgumentsOutput arguments from evaluation of all tasks in job object
loadLoad workspace variables from batch job
submitQueue job in scheduler
waitWait for job to finish or change state
waitForStateWait for object to change state

Task Functions

cancelCancel job or task
destroyRemove job or task object from parent and memory
waitForStateWait for object to change state

Toolbox Functions Used in Parallel Jobs and pmode

cellCreate distributed cell array
dcolonDistributed colon operation
defaultPartitionDefault partition for distributed array
distributedCreate distributed array from local data
distributionDimensionDistributed dimension of distributed array
distributionPartitionPartition scheme of distributed array
distributorCreate distribution object for distributed arrays
eyeCreate distributed identity matrix
falseCreate distributed false array
forfor-loop over distributed range
gatherConvert distributed array into replicated array
gcatGlobal concatenation
globalIndicesGlobal indices for local part of replicated array
gopGlobal operation across all labs
gopGlobal operation across all labs
gplusGlobal addition
InfCreate distributed array of Inf values
isdistributedTrue for distributed array
isreplicatedTrue for replicated array
labBarrierBlock execution until all labs reach this call
labBroadcastSend data to all labs or receive data sent to all labs
labGridLab grid of '2d' distributed array
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
localPartLocal portion of distributed array
mpiprofileProfile parallel communication and execution times
NaNCreate distributed array of NaN values
numlabsTotal number of labs operating in parallel on current job
onesCreate distributed array of 1s
ploadLoad file into parallel session
psaveSave data from parallel job session
randCreate distributed array of uniformly distributed pseudo-random numbers
randnCreate distributed array of normally distributed random values
redistributeRedistribute a distributed array with another distribution scheme
sparseCreate distributed sparse matrix
speyeCreate distributed sparse identity matrix
sprandCreate distributed sparse array of uniformly distributed pseudo-random values
sprandnCreate distributed sparse array of normally distributed random values
trueCreate distributed true array
zerosCreate distributed array of 0s

Toolbox Functions Used in MATLAB® Workers

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
  


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