Diff of /man/parallel.Rd [000000] .. [858cf4] Maximize Restore

  Switch to side-by-side view

--- a
+++ b/man/parallel.Rd
@@ -0,0 +1,47 @@
+\name{parallel}
+\alias{parallel.seeds}
+\title{Get initial values for parallel RNGs}
+\description{
+  On a multi-processor system, you may wish to run parallel chains using
+  multiple \code{jags.model} objects, each running a single chain on a
+  separate processor.  This function returns a list of values that may
+  be used to initialize the random number generator of each chain.
+
+}
+\usage{
+parallel.seeds(factory, nchain)
+}
+\arguments{
+  \item{factory}{Name of the RNG factory to use.}
+  \item{nchain}{Number of chains for which to initialize RNGs.}
+}
+\value{
+  \code{parallel.seeds} returns a list of RNG states. Each element
+  is a list of length 2 with the following elements:
+  \item{.RNG.name}{The name of the RNG}
+  \item{.RNG.state}{An integer vector giving the state of the RNG.}
+}
+\note{
+  It is not yet possible to make the results of \code{parallel.seeds}
+  reproducible.  This will be fixed in a future version of JAGS.
+}
+\examples{
+##The BaseRNG factory generates up to four distinct types of RNG. If
+##more than 4 chains are requested, it will recycle the RNG types, but
+##use different initial values
+parallel.seeds("base::BaseRNG", 3)
+
+## The lecuyer module provides the RngStream factory, which allows large
+## numbers of independent parallel RNGs to be generated. 
+load.module("lecuyer")
+list.factories(type="rng")
+parallel.seeds("lecuyer::RngStream", 5);
+}
+\author{Martyn Plummer}
+\seealso{
+  \code{\link{jags.model}}, section \dQuote{Random number generators},
+  for further details on RNG initialization;
+  \code{\link{list.factories}} to find the names of available RNG
+  factories.
+}
+\keyword{models}