RandStream.setGlobalStream

Set global random number stream

Syntax

prevstream = RandStream.setGlobalStream(stream)

Description

prevstream = RandStream.setGlobalStream(stream) designates the random number stream, specified as stream, to be the global stream that the rand, randi, and randn functions draw values from. It returns the previous global random number stream as prevstream.

rand, randi, and randn all rely on the same stream of uniform pseudorandom numbers, known as the global stream. rand draws one value from that stream to generate each uniform value it returns. randi draws one uniform value from that stream to generate each integer value it returns. And randn draws one or more uniform values to generate each normal value it returns. Note that you can also specify a specific random stream from which rand, randi, and randn draw values by creating a RandStream object and passing it as the first input argument.

Note

The rng function is a shorter alternative for many common uses of RandStream.setGlobalStream

Input Arguments

stream — Random number stream

RandStream object

Random number stream, specified as a RandStream object.

Extended Capabilities

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 R2011a