The R Project SVN – R – Diff – /trunk/src/library/base/man/Random.Rd

 % File src/library/base/man/Random.Rd
 % Part of the R package, https://www.R-project.org
-% Copyright 1995-2025 R Core Team
+% Copyright 1995-2026 R Core Team
 % Distributed under GPL 2 or later
 \name{Random}
 \alias{Random}
 \alias{RNG}
   \code{set.seed} is the recommended way to specify seeds.
+}
 \usage{
 \special{.Random.seed <- c(rng.kind, n1, n2, \dots)}
-RNGkind(kind = NULL, normal.kind = NULL, sample.kind = NULL)
+RNGkind(kind = NULL, normal.kind = NULL, sample.kind = NULL, binom.kind = NULL)
 RNGversion(vstr)
-set.seed(seed, kind = NULL, normal.kind = NULL, sample.kind = NULL)
+set.seed(seed, kind = NULL, normal.kind = NULL, sample.kind = NULL, binom.kind = NULL)
+}
 \arguments{
   \item{kind}{character or \code{NULL}.  If \code{kind} is a character
     string, set \R's RNG to the kind desired.  Use \code{"default"} to
     return to the \R default.  See \sQuote{Details} for the
     to return to the \R default.  \code{NULL} makes no change.}
   \item{sample.kind}{character string or \code{NULL}.  If it is a character
     string, set the method of discrete uniform generation (used in
     \code{\link{sample}}, for instance).  Use \code{"default"} to return to
     the \R default.  \code{NULL} makes no change.}
+  \item{binom.kind}{character string or \code{NULL}.  If it is a character
+    string, set the method of \code{\link{rbinom}()}.  Use \code{"default"} to return to
+    the \R default.  \code{NULL} makes no change.}
   \item{seed}{a single value, interpreted as an integer, or \code{NULL}
     (see \sQuote{Details}).}
   \item{vstr}{a character string containing a version number,
     e.g., \code{"1.6.2"}.  The default RNG configuration of the current
     \R version is used if \code{vstr} is greater than the current version.}
     The two seeds are the \I{Tausworthe} and congruence long integers,
     respectively.
     It exhibits 25 clear failures in the \I{TestU01} Crush suite
     \bibcitep{R:L_Ecuyer+Simard:2007}.
+    }
     \item{\code{"Mersenne-Twister"}:}{
       From \bibcitet{R:Matsumoto+Nishimura:1998}; code updated in 2002.
       A twisted \abbr{GFSR} with period
   \code{sample.kind} can be \code{"Rounding"} or \code{"Rejection"},
   or partial matches to these.  The former was the default in versions
   prior to 3.6.0:  it made \code{\link{sample}} noticeably non-uniform
   on large populations, and should only be used for reproduction of old
   results.  See \PR{17494} for a discussion.
+  \code{binom.kind} can be \code{"Buggy BTPE"} or \code{"BTPE"},
+  or partial matches to these.  The former was the default in versions
+  prior to 4.7.0: for large but not very large mean,
+  \code{\link{rbinom}()}'s acceptance-rejection algorithm accepted
+  very few \dQuote{outer tail} values it should have rejected, leading to a
+  very slightly increased distribution tail weight.  See \PR{19049} for more.
-  \code{set.seed} uses a single integer argument to set as many seeds
+  \code{set.seed()} uses a single integer argument to set as many seeds
   as are required.  It is intended as a simple way to get quite different
   seeds by specifying small integer arguments, and also as a way to get
   valid seed sets for the more complicated methods (especially
   \code{"Mersenne-Twister"} and \code{"Knuth-TAOCP"}).  There is no
   guarantee that different values of \code{seed} will seed the RNG
   differently, although any exceptions would be extremely rare.  If
   called with \code{seed = NULL} it re-initializes (see \sQuote{Note})
   as if no seed had yet been set.
-  The use of \code{kind = NULL}, \code{normal.kind = NULL} or
+  The use of \code{kind = NULL}, \code{normal.kind = NULL},
-  \code{sample.kind = NULL} in
+  \code{sample.kind = NULL} or \code{binom.kind = NULL} in
   \code{RNGkind} or \code{set.seed} selects the currently-used
   generator (including that used in the previous session if the
   workspace has been restored): if no generator has been used it selects
   \code{"default"}.
+}
   In the underlying C, \code{.Random.seed[-1]} is \code{unsigned};
   therefore in \R \code{.Random.seed[-1]} can be negative or perhaps
   \code{\link{NA_integer_}}, due to
   the representation of an unsigned integer by a signed integer.
-  \code{RNGkind} returns a three-element character vector of the RNG,
+  \code{RNGkind} returns the character vector of the RNG and other kinds
-  normal and sample kinds selected \emph{before} the call, invisibly if
+  selected \emph{before} the call, invisibly if
   either argument is not \code{NULL}.  A type starts a session as the
   default, and is selected either by a call to \code{RNGkind} or by setting
   \code{.Random.seed} in the workspace. (NB: prior to \R 3.6.0 the first
   two kinds were returned in a two-element character vector.)

The R Project SVN R

(root)/trunk/src/library/base/man/Random.Rd @ 63243 – Rev 90027 → 90299