parallel.gpu.RandStream.setGlobalStream

R2026b

Set GPU global random number stream

Syntax

prevStream = parallel.gpu.RandStream.setGlobalStream(stream)

Description

prevStream = parallel.gpu.RandStream.setGlobalStream(stream) replaces the global random number stream with the stream specified by stream.

Examples

Change the Global Stream

You can change the global random number stream on the GPU and store the old settings for the global stream. First, define the random number stream that you want to set as the new global stream.

newStr = parallel.gpu.RandStream("Philox",Seed=1, ...
    NormalTransform="Inversion")

newStr =

Philox4x32_10 random stream on the GPU
             Seed: 1
  NormalTransform: Inversion

Next, set this new stream to be the global stream.

oldStr = parallel.gpu.RandStream.setGlobalStream(newStr)

oldStr =

Threefry4x64_20 random stream on the GPU
             Seed: 0
  NormalTransform: BoxMuller

oldStr holds the settings for the previous global random number stream on the GPU. The new global stream is newStr.

newStr

newStr =

Philox4x32_10 random stream on the GPU (current global stream)
             Seed: 1
  NormalTransform: Inversion

The functions rand, randi, and randn draw random numbers from the new global stream using the "Philox" generator algorithm. If you use a GPU random number stream, then the results are returned as a gpuArray.

Input Arguments

stream — New global random number stream

parallel.gpu.RandStream object

New global random number stream on the GPU, specified as a parallel.gpu.RandStream object. stream replaces the previous global stream.

Output Arguments

prevStream — Previous global random number stream

parallel.gpu.RandStream object

Previous global random number stream on the GPU, specified as a parallel.gpu.RandStream object.

Extended Capabilities

Thread-Based Environment

Run code in the background using MATLAB® backgroundPool or accelerate code with Parallel Computing Toolbox™ ThreadPool.

The parallel.gpu.RandStream.setGlobalStream function fully supports thread-based environments. For more information, see Run MATLAB Functions in Thread-Based Environment.

Version History

Introduced in R2011b