gcp

Get current parallel pool

Syntax

p = gcp

p = gcp("nocreate")

Description

p = gcp returns a parallel.Pool object representing the current parallel pool. The current pool is where parallel language features execute, such as parfor, spmd, distributed, Composite, parfeval and parfevalOnAll.

If no parallel pool exists, gcp starts a new parallel pool and returns a pool object for that, unless automatic pool starts are disabled in your parallel settings. If no parallel pool exists and automatic pool starts are disabled, gcp returns an empty pool object.

example

p = gcp("nocreate") returns the current pool if one exists. If no pool exists, the "nocreate" option causes gcp not to create a pool, regardless of your parallel settings.

example

Examples

collapse all

Find Size of Current Pool

Find the number of workers in the current parallel pool.

p = gcp("nocreate"); % If no pool, do not create new one.
if isempty(p)
    poolsize = 0;
else
    poolsize = p.NumWorkers
end

Delete Current Pool

Use the parallel pool object to delete the current pool.

delete(gcp("nocreate"))

Extended Capabilities

expand all

Thread-Based Environment
Run code in the background using MATLAB® `backgroundPool` or accelerate code with Parallel Computing Toolbox™ `ThreadPool`.

This function fully supports thread-based environments. For more information, see Run MATLAB Functions in Thread-Based Environment.

Version History

Introduced in R2013b

gcp