dust_rng_pointer: Create pointer to random number generator stream

In mrc-ide/dust: Iterate Multiple Realisations of Stochastic Models

Create pointer to random number generator stream

Description

This function exists to support use from other packages that wish to use dust's random number support, and creates an opaque pointer to a set of random number streams. It is described more fully in vignette("rng_package.Rmd")

Public fields

algorithm

The name of the generator algorithm used (read-only)

n_streams

The number of streams of random numbers provided (read-only)

Methods

Public methods

• dust_rng_pointer$new()

• dust_rng_pointer$sync()

• dust_rng_pointer$state()

• dust_rng_pointer$is_current()

---

Method new()

Create a new dust_rng_pointer object

Usage

dust_rng_pointer$new(
  seed = NULL,
  n_streams = 1L,
  long_jump = 0L,
  algorithm = "xoshiro256plus"
)

Arguments

seed

The random number seed to use (see dust_rng for details)

n_streams

The number of independent random number streams to create

long_jump

Optionally an integer indicating how many "long jumps" should be carried out immediately on creation. This can be used to create a distributed parallel random number generator (see dust_rng_distributed_state)

algorithm

The random number algorithm to use. The default is xoshiro256plus which is a good general choice

---

Method sync()

Synchronise the R copy of the random number state. Typically this is only needed before serialisation if you have ever used the object.

Usage

dust_rng_pointer$sync()

---

Method state()

Return a raw vector of state. This can be used to create other generators with the same state.

Usage

dust_rng_pointer$state()

---

Method is_current()

Return a logical, indicating if the random number state that would be returned by state() is "current" (i.e., the same as the copy held in the pointer) or not. This is TRUE on creation or immediately after calling ⁠$sync()⁠ or ⁠$state()⁠ and FALSE after any use of the pointer.

Usage

dust_rng_pointer$is_current()

Examples

dust::dust_rng_pointer$new()

mrc-ide/dust documentation built on Oct. 14, 2024, 12:57 a.m.