# Multiply-with-carry pseudorandom number generator

In computer science, multiply-with-carry (MWC) is a method invented by George Marsaglia for generating sequences of random integers based on an initial set from two to many thousands of randomly chosen seed values. The main advantages of the MWC method are that it invokes simple computer integer arithmetic and leads to very fast generation of sequences of random numbers with immense periods, ranging from around $2^{60}$ to $2^{2000000}$.
As with all pseudorandom number generators, the resulting sequences are functions of the supplied seed values.

## General theory

An MWC generator is a special form of Lehmer random number generator $x_{n}=bx_{n-1}{\bmod {p}}$ which allows efficient implementation of a prime modulus $p$ much larger than the machine word size.
Normal Lehmer generator implementations choose a modulus close to the machine word size. An MWC generator instead maintains its state in base $b$, so multiplying by $b$ is done implicitly by shifting one word. The base $b$ is typically chosen to equal the computer's word size, as this makes arithmetic modulo $b$ trivial. This may vary from $b=2^{8}$ for a microcontroller to $b=2^{64}$. (This article uses $b=2^{32}$ for examples.)
The initial state ("seed") values are arbitrary, except that they must not be all zero, nor all at the maximum permitted values ($x_{0}=b-1$ and $c_{0}=a-1$ ). (This is commonly done by choosing $c_{0}$ between 1 and $a-2$.). The MWC sequence is then a sequence of pairs $x_{n},c_{n}$ determined by
    $x_{n}=(ax_{n-1}+c_{n-1})\,{\bmod {\,}}b,\ c_{n}=\left\lfloor {\frac {ax_{n-1}+c_{n-1}}{b}}\right\rfloor$
This is called a lag-1 MWC sequence. Sometimes an odd base is preferred, in which case $b=2^{k}-1$ can be used, which is almost as simple to implement. A lag-$r$ sequence is a generalization of the lag-1 sequence allowing longer periods. The lag-$r$ MWC sequence is then a sequence of pairs $x_{n},c_{n}$ (for $n>r$) determined by
    $x_{n}=(ax_{n-r}+c_{n-1})\,{\bmod {\,}}b,\ c_{n}=\left\lfloor {\frac {ax_{n-r}+c_{n-1}}{b}}\right\rfloor$
and the MWC generator output is the sequence of $x$'s,
    $x_{r},x_{r+1},x_{r+2},...$
In this case, the initial state ("seed") values must not be all zero nor $x_{0}=b-1$ and $c_{r-1}=a-1$.
The MWC multiplier $a$ and lag $r$ determine the modulus $p=ab^{r}-1$. In practice, $a$ is chosen so the modulus is prime and the sequence has long period. If the modulus is prime, the period of a lag-$r$ MWC generator is the order of $b$ in the multiplicative group of numbers modulo $p$. While it is theoretically possible to choose a non-prime modulus, a prime modulus eliminates the possibility of the initial seed sharing a common divisor with the modulus, which would reduce the generator's period.
Because 2 is a quadratic residue of numbers of the form $8k\pm 1$, $b=2^{k}$ cannot be a primitive root of $p=ab^{r}-1$. Therefore, MWC generators with base $2^{k}$ have their parameters chosen so their period is (ab$^r$−1)/2. This is one of the difficulties that use of b = 2$^k$ − 1 overcomes.
The basic form of an MWC generator has parameters a, b and r, and r+1 words of state. The state consists of r residues modulo b
    0 ≤ x$_0$, x$_1$, x$_2$,..., x$_{r−1}$ < b,
and a carry c$_{r−1}$ < a.
Although the theory of MWC generators permits a > b, a is almost always chosen smaller for convenience of implementation.
The state transformation function of an MWC generator is one step of Montgomery reduction modulo p. The state is a large integer with most significant word c$_{n−1}$ and least significant word x$_{n−r}$. Each step, x$_{n−r}$·(ab$^r$−1) is added to this integer. This is done in two parts: −1·x$_{n−r}$ is added to x$_{n−r}$, resulting in a least significant word of zero. And second, a·x$_{n−r}$ is added to the carry. This makes the integer one word longer, producing two new most significant words x$_n$ and c$_n$.
So far, this has simply added a multiple of p to the state, resulting in a different representative of the same residue class modulo p. But finally, the state is shifted down one word, dividing by b. This discards the least significant word of zero (which, in practice, is never computed at all) and effectively multiplies the state by b$^{−1}$ (mod p).
Thus, a multiply-with-carry generator is a Lehmer generator with modulus p and multiplier b$^{−1}$ (mod p). This is the same as a generator with multiplier b, but producing output in reverse order, which does not affect the quality of the resultant pseudorandom numbers.
Couture and L'Ecuyer have proved the surprising result that the lattice associated with a multiply-with-carry generator is very close to the lattice associated with the Lehmer generator it simulates. Thus, the mathematical techniques developed for Lehmer generators (such as the spectral test) can be applied to multiply-with-carry generators.

## Efficiency

A linear congruential generator with base b = 2$^{32}$ is implemented as
    $x_{n+1}=(ax_{n}+c)\ {\bmod {\,}}2^{32},$
where c is a constant. If a ≡ 1 (mod 4) and c is odd, the resulting base-2$^{32}$ congruential sequence will have period 2$^{32}$.
This can be computed using only the low 32 bits of the product of a and the current x. However, many microprocessors can compute a full 64-bit product in almost the same time as the low 32 bits. Indeed, many compute the 64-bit product and then ignore the high half.
A lag-1 multiply-with-carry generator allows us to make the period nearly 2$^{63}$ by using almost the same computer operations, except that the top half of the 64-bit product is not ignored after the product is computed. Instead, a 64-bit sum is computed, and the top half is used as a new carry value c rather than the fixed additive constant of the standard congruential sequence: Compute ax+c in 64 bits, then use the top half as the new c, and bottom half as the new x.

## Choice of multiplier

With multiplier a specified, each pair of input values x, c is converted to a new pair,
    $x\leftarrow (ax+c)\,{\bmod {\,}}2^{32},\ \ c\leftarrow \left\lfloor {\frac {ax+c}{2^{32}}}\right\rfloor .$
If x and c are not both zero, then the period of the resulting multiply-with-carry sequence will be the order of b = 2$^{32}$ in the multiplicative group of residues modulo ab$^r$ − 1, that is, the smallest n such that b$^n$ ≡ 1 (mod ab$^r$ − 1).
If p = ab$^r$ − 1 is prime, then Fermat's little theorem guarantees that the order of any element must divide p − 1 = ab$^r$ − 2, so one way to ensure a large order is to choose a such that p is a "safe prime", that is both p and (p − 1)/2 = ab$^r$/2 − 1 are prime. In such a case, for b= 2$^{32}$ and r = 1, the period will be ab$^r$/2 − 1, approaching 2$^{63}$, which in practice may be an acceptably large subset of the number of possible 32-bit pairs (x, c).
More specifically, in such a case, the order of any element divides p − 1, and there are only four possible divisors: 1, 2, ab$^r$/2 − 1, or ab$^r$ − 2. The first two apply only to the elements 1 and −1, and quadratic reciprocity arguments show that the fourth option cannot apply to b, so only the third option remains.
Following are some maximal values of a for computer applications which satisfy the above safe prime condition, for lag-1 generators:
| Bits in a | b | Maximum a such that ab−1 is a safe prime | Period |
| 15 | 2$^{16}$ | 2$^{15}$−50 = 32,718 | 1,072,103,423 |
| 16 | 2$^{16}$ | 2$^{16}$−352 = 65,184 | 2,135,949,311 |
| 31 | 2$^{32}$ | 2$^{31}$−563 = 2,147,483,085 | 4,611,684,809,394,094,079 |
| 32 | 2$^{32}$ | 2$^{32}$−178 = 4,294,967,118 | 9,223,371,654,602,686,463 |
| 64 | 2$^{64}$ | 2$^{64}$−742 = 18,446,744,073,709,550,874 | 2$^{63}$(2$^{64}$−742)−1 ≈ 1.701×10^$^{38}$ |
| 128 | 2$^{128}$ | 2$^{128}$−10,408 | 2$^{127}$(2$^{128}$−10,408)−1 ≈ 5.790×10^$^{76}$ |
| 256 | 2$^{256}$ | 2$^{256}$−9166 | 2$^{255}$(2$^{256}$−9166)−1 ≈ 6.704×10^$^{153}$ |
| 512 | 2$^{512}$ | 2$^{512}$−150,736 | 2$^{511}$(2$^{512}$−150,736)−1 ≈ 8.988×10^$^{307}$ |
While a safe prime ensures that almost any element of the group has a large order, the period of the generator is specifically the order of b. For small moduli, more computationally expensive methods can be used to find multipliers a where the period is ab/2 − 1. The following are again maximum values of a of various sizes.
| Bits in a | b$^r$ | Maximum a such that b has order ab$^r$/2−1 | Period |
| 8 | 2$^8$ | 2$^8$−7 = 249 | 31,871 |
| 8 | (2$^8$)$^2$ = 2$^{16}$ | 2$^8$−32 = 224 | 7,340,031 |
| 15 | 2$^{16}$ | 2$^{15}$−29 = 32,739 | 1,072,791,551 |
| 16 | 2$^{16}$ | 2$^{16}$−22 = 65,514 | 2,146,762,751 |
| 8 | (2$^8$)$^4$ = 2$^{32}$ | 2$^8$−64 = 192 | 412,316,860,415 |
| 15 | (2$^{16}$)$^2$ = 2$^{32}$ | 2$^{15}$−26 = 32,742 | 70,312,909,602,815 |
| 16 | (2$^{16}$)$^2$ = 2$^{32}$ | 2$^{16}$−2 = 65,534 | 140,733,193,388,031 |
| 31 | 2$^{32}$ | 2$^{31}$−68 = 2,147,483,580 | 4,611,685,872,398,499,839 |
| 32 | 2$^{32}$ | 2$^{32}$−76 = 4,294,967,220 | 9,223,371,873,646,018,559 |
| 8 | (2$^8$)$^8$ = 2$^{64}$ | 2$^8$−41 = 215 | 2$^{63}$(2$^8$−41)−1 ≈ 1.983×10^$^{21}$ |
| 15 | (2$^{16}$)$^4$ = 2$^{64}$ | 2$^{15}$−50 = 32,718 | 2$^{63}$(2$^{15}$−50)−1 ≈ 3.018×10^$^{23}$ |
| 16 | (2$^{16}$)$^4$ = 2$^{64}$ | 2$^{16}$−56 = 65,480 | 2$^{63}$(2$^{16}$−56)−1 ≈ 6.039×10^$^{23}$ |
| 31 | (2$^{32}$)$^2$ = 2$^{64}$ | 2$^{31}$−38 = 2,147,483,610 | 2$^{63}$(2$^{31}$−38)−1 ≈ 1.981×10^$^{28}$ |
| 32 | (2$^{32}$)$^2$ = 2$^{64}$ | 2$^{32}$−43 = 4,294,967,253 | 2$^{63}$(2$^{32}$−43)−1 ≈ 3.961×10^$^{28}$ |
| 63 | 2$^{64}$ | 2$^{63}$−140 = 9,223,372,036,854,775,668 | 2$^{63}$(2$^{63}$−140)−1 ≈ 8.507×10^$^{37}$ |
| 64 | 2$^{64}$ | 2$^{64}$−116 = 18,446,744,073,709,551,500 | 2$^{63}$(2$^{64}$−116)−1 ≈ 1.701×10^$^{38}$ |

## MWC generators as repeating decimals

The output of a multiply-with-carry generator is equivalent to the radix-b expansion of a fraction with denominator p = ab$^r$ − 1. Here is an example for the simple case of b = 10 and r = 1, so the result is a repeating decimal.
Starting with c$_0$=1, x$_0$=0{\textstyle c_{0}=1, x_{0}=0}, the MWC sequence
    $x_{n}=(7x_{n-1}+c_{n-1})\,{\bmod {\,}}10,\ c_{n}=\left\lfloor {\frac {7x_{n-1}+c_{n-1}}{10}}\right\rfloor ,$
produces this sequence of states:
    10,01,07,49,67,55,40,04,28,58,61,13,22,16,43,25,37,52,19,64,34,31, 10,01,07,...
with period 22. Consider just the sequence of x$_i$:
    0,1,7,9,7,5,0,4,8,8,1,3,2,6,3,5,7,2,9,4,4,1, 0,1,7,9,7,5,0,...
Notice that if those repeated segments of x values are put in reverse order:
    $1449275\cdots 9710\,1449275\cdots 9710\,144\cdots$
we get the expansion j/(ab−1) with a=7, b=10, j=10:
    ${\frac {10}{69}}=0.1449275362318840579710\,14492753623\ldots$
This is true in general: The sequence of xs produced by a lag-r MWC generator:
    $x_{n}=(ax_{n-r}+c_{n-1}){\bmod {\,}}b\,,\ \ c_{n}=\left\lfloor {\frac {ax_{n-r}+c_{n-1}}{b}}\right\rfloor ,$
when put in reverse order, will be the radix-b expansion of a fraction j/(ab$^r$ − 1) for some 0 < j < ab$^r$.

## Equivalence to linear congruential generator

Continuing the above example, if we start with x$_0$=34{\textstyle x_{0}=34}, and generate the ordinary congruential sequence
    $x_{n}=7x_{n-1}\,{\bmod {\,}}69$,
we get the period 22 sequence
    31,10,1,7,49,67,55,40,4,28,58,61,13,22,16,43,25,37,52,19,64,34, 31,10,1,7,...
and that sequence, reduced mod 10, is
    1,0,1,7,9,7,5,0,4,8,8,1,3,2,6,3,5,7,2,9,4,4, 1,0,1,7,9,7,5,0,...
the same sequence of x's resulting from the MWC sequence.
This is true in general, (but apparently only for lag-1 MWC sequences):
Given initial values $x_{0},c_{0}$, the sequence $x_{1},x_{2},\ldots$ resulting from the lag-1 MWC sequence
    $x_{n}=(ax_{n-1}+c_{n-1})\,{\bmod {b}}\,,\ \ c_{n}=\left\lfloor {\frac {ax_{n-1}+c_{n-1}}{b}}\right\rfloor$
is exactly the Lehmer random number generator output sequence y$_n$ = ay$_{n−1}$ mod (ab − 1), reduced modulo b.
Choosing a different initial value y$_0$ merely rotates the cycle of x's.

## Complementary-multiply-with-carry generators

Establishing the period of a lag-r MWC generator usually entails choosing multiplier a so that p = ab$^r$ − 1 is prime. Then p − 1 will have to be factored in order to find the order of b mod p. If p is a safe prime, then this is simple, and the order of b will be either p − 1 or (p − 1)/2. In other cases, p − 1 may be difficult to factor.
However, the algorithm also permits a negative multiplier. This leads to a slight modification of the MWC procedure, and produces a modulus p = |−ab$^r$ − 1| = ab$^r$ + 1. This makes p − 1 = ab$^r$ easy to factor, making it practical to establish the period of very large generators.
The modified procedure is called complementary-multiply-with-carry (CMWC), and the setup is the same as that for lag-r MWC: multiplier a, base b, and r + 1 seeds,
    x$_0$, x$_1$, x$_2$, ..., x$_{r−1}$, and c$_{r−1}$.
The modification is to the generation of a new pair (x, c). Rearranging the computation to avoid negative numbers, the new x value is complemented by subtracting it from b − 1:
    $x_{n}=(b-1)-(ax_{n-r}+c_{n-1})\,{\bmod {\,}}b,\ c_{n}=\left\lfloor {\frac {ax_{n-r}+c_{n-1}}{b}}\right\rfloor .$
The resulting sequence of x's produced by the CMWC RNG will have period the order of b in the multiplicative group of residues modulo ab$^r$+1, and the output x's, in reverse order, will form the base b expansion of j/(ab$^r$+1) for some 0 < j < ab$^r$.
Use of lag-r CMWC makes it much easier to find periods for r's as large as 512, 1024, 2048, etc. (Making r a power of 2 makes it slightly simpler to access elements in the array containing the r most recent x's.)
Another advantage of this modified procedure is that the period is a multiple of b, so the output is exactly equidistributed mod b. (The ordinary MWC, over its full period, produces each possible output an equal number of times except that zero is produced one time less, a bias which is negligible if the period is long enough.)
One disadvantage of the CMWC construction is that, with a power-of-two base, the maximum achievable period is less than for a similar-sized MWC generator; you lose several bits. Thus, an MWC generator is usually preferable for small lags. This can remedied by using b = 2$^k$−1, or choosing a lag one word longer to compensate.
Some examples: With b = 2$^{32}$, and a = 109111 or 108798 or 108517, the period of the lag-1024 CMWC
    $x_{n}=(b-1)-(ax_{n-1024}+c_{n-1})\,{\bmod {\,}}b,\ c_{n}=\left\lfloor {\frac {ax_{n-1024}+c_{n-1}}{b}}\right\rfloor .$
will be a·2$^{32762}$ = ab$^{1024}$/64, about 10$^{9867}$.
With b = 2$^{32}$ and a = 3636507990, p = ab$^{1359}$ − 1 is a safe prime, so the MWC sequence based on that a has period 3636507990·2$^{43487}$ ≈ 10$^{13101}$.
With b = 2$^{32}$, a CMWC RNG with near record period may be based on the prime p = 15455296b$^{42658}$ + 1. The order of b for that prime is 241489·2$^{1365056}$ ≈ 10$^{410928}$.

## More general moduli

The MWC modulus of ab$^r$−1 is chosen to make computation particularly simple, but brings with it some disadvantages, notably that the period is at most half the modulus. There are several ways to generalize this, at the cost of more multiplications per iteration.
First, it is possible to add additional terms to the product, producing a modulus of the form a$_r$b$^r$+a$_s$b$^s$−1. This requires computing c$_n$b + x$_n$ = a$_r$x$_{n−r}$ + a$_s$x$_{n−s}$. (The carry is limited to one word if a$_r$ + a$_s$ ≤ b.)
However, this does not fix the period issue, which depends on the low bits of the modulus. Fortunately, the Montgomery reduction algorithm permits other moduli, as long as they are relatively prime to the base b, and this can be applied to permit a modulus of the form a$_r$b$^r$−a$_0$, for a wide range of values a$_0$. Goresky and Klapper developed the theory of these generalized multiply-with-carry generators, proving, in particular, that choosing a negative a$_0$ and a$_r$–a$_0$ < b the carry value is always smaller than b, making the implementation efficient. The more general form of the modulus improves also the quality of the generator, albeit one cannot always get full period.
To implement a Goresky-Klapper generator one precomputes a$^{−1}$ $_0$ (mod b), and changes the iteration as follows:
    $t=c_{n-1}+\sum _{1}^{r}a_{i}x_{n-i},\ x_{n}=a_{0}^{-1}t{\bmod {b}},\ c_{n}=\left\lfloor {\frac {t-a_{0}x_{n}}{b}}\right\rfloor .$
In the common case that b = 2$^k$, a$_0$ must be odd for the inverse to exist.

## Implementation

The following is an implementation of the CMWC algorithm in the C programming language. Also, included in the program is a sample initialization function. In this implementation the base is 2$^{32}$−1 and lag r=4096. The period of the resulting generator is about $2^{131104}$.
The following are implementations of small-state MWC generators with 64-bit output using 128-bit multiplications.
The following are implementations of small-state Goresky-Klapper's generalized MWC generators with 64-bit output using 128-bit multiplications.

## Usage

Because of simplicity and speed, CMWC is known to be used in game development, particularly in modern roguelike games. It is informally known as the Mother of All PRNGs, a name originally coined by Marsaglia himself. In libtcod, CMWC4096 replaced MT19937 as the default PRNG.