DOC: Add per RNG jump documentation

Add RNG-specific jump documentation to communicate jump size

[skip ci]

Author: Sheppard, Kevin

randomstate/defaults.pxi

@@ -5,3 +5,5 @@ DEF RS_RNG_JUMPABLE = 0
 DEF RS_RNG_STATE_LEN = 4
 DEF RS_SEED_NBYTES = 2
 DEF RS_SEED_ARRAY_BITS = 64
+DEF JUMP_DOCSTRING = """
+"""

randomstate/interface/dSFMT/dSFMT.pxi

@@ -161,3 +161,25 @@ state values.
        Jump Ahead Algorithm for Linear Recurrences in a Polynomial Space",
        Sequences and Their Applications - SETA, 290--298, 2008.
 """
+
+DEF JUMP_DOCSTRING = """
+jump(iter = 1)
+
+Jumps the state of the random number generator as-if 2**128 random numbers
+have been generated.
+
+Parameters
+----------
+iter : integer, positive
+    Number of times to jump the state of the rng.
+
+Returns
+-------
+out : None
+    Returns 'None' on success.
+
+Notes
+-----
+Jumping the rng state resets any pre-computed random numbers. This is required
+to ensure exact reproducibility.
+"""

randomstate/interface/mrg32k3a/mrg32k3a.pxi

@@ -191,3 +191,25 @@ References
        "An object-oriented random-number package with many long streams
        and substreams." Operations research 50, no. 6, pp. 1073-1075, 2002.
 """
+
+DEF JUMP_DOCSTRING = """
+jump(iter = 1)
+
+Jumps the state of the random number generator as-if 2**127 random numbers
+have been generated.
+
+Parameters
+----------
+iter : integer, positive
+    Number of times to jump the state of the rng.
+
+Returns
+-------
+out : None
+    Returns 'None' on success.
+
+Notes
+-----
+Jumping the rng state resets any pre-computed random numbers. This is required
+to ensure exact reproducibility.
+"""

randomstate/interface/xorshift1024/xorshift1024.pxi

@@ -129,3 +129,25 @@ References
 .. [4] Sebastiano Vigna. "Further scramblings of Marsaglia's xorshift
        generators." CoRR, abs/1403.0930, 2014.
 """
+
+DEF JUMP_DOCSTRING = """
+jump(iter = 1)
+
+Jumps the state of the random number generator as-if 2**512 random numbers
+have been generated.
+
+Parameters
+----------
+iter : integer, positive
+    Number of times to jump the state of the rng.
+
+Returns
+-------
+out : None
+    Returns 'None' on success.
+
+Notes
+-----
+Jumping the rng state resets any pre-computed random numbers. This is required
+to ensure exact reproducibility.
+"""

randomstate/interface/xorshift128/xorshift128.pxi

@@ -125,3 +125,25 @@ References
 .. [4] Sebastiano Vigna. "Further scramblings of Marsaglia's xorshift
        generators." CoRR, abs/1403.0930, 2014.
 """
+
+DEF JUMP_DOCSTRING = """
+jump(iter = 1)
+
+Jumps the state of the random number generator as-if 2**64 random numbers
+have been generated.
+
+Parameters
+----------
+iter : integer, positive
+    Number of times to jump the state of the rng.
+
+Returns
+-------
+out : None
+    Returns 'None' on success.
+
+Notes
+-----
+Jumping the rng state resets any pre-computed random numbers. This is required
+to ensure exact reproducibility.
+"""

randomstate/randomstate.pyx

@@ -381,27 +381,8 @@ cdef class RandomState:
 
     IF RS_RNG_JUMPABLE:
         def jump(self, uint32_t iter = 1):
-            """
-            jump(iter = 1)
-
-            Jumps the random number generator by a pre-specified skip.  The size of the jump is
-            rng-specific.
+            JUMP_DOCSTRING
 
-            Parameters
-            ----------
-            iter : integer, positive
-                Number of times to jump the state of the rng.
-
-            Returns
-            -------
-            out : None
-                Returns 'None' on success.
-
-            Notes
-            -----
-            Jumping the rng state resets any pre-computed random numbers. This is required to ensure
-            exact reproducibility.
-            """
             cdef Py_ssize_t i;
             for i in range(iter):
                 jump_state(&self.rng_state)