rstream: rstream.RNG – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

rstream.RNG

Get and set "rstream" object from/to R global generator

Description

The function rstream.RNG(stream) is used to set a given "rstream" object stream as current global R uniform random number generators.

Without an argument (or NULL) it returns an "rstream" object that contains the current global generator. It is a copy (clone) of the global generator and thus it can be handled independently from the global generator.

Usage

rstream.RNG(stream = NULL)

Arguments

stream

NULL or an "rstream" object

Value

rstream.RNG returns an "rstream" object.

Author(s)

Josef Leydold josef.leydold@wu.ac.at

Examples

## create a new rstream.runif object
s <- new("rstream.mrg32k3a")

## use this stream as global R uniform RNG
rstream.RNG(s)

## get a (idenpendent) copy of the stream
## that contains the global R uniform RNG
gs <- rstream.RNG()

## change the state of the global generator
gs <- rstream.RNG()
rstream.nextsubstream(gs)
rstream.RNG(gs)

rstream

Streams of Random Numbers

v1.3.6

GPL-2

Authors

Josef Leydold <josef.leydold@wu.ac.at>

Initial release

2020-02-03