Merge pull request #217 from bashtage/sfc

ENH: Add SFC generator with Weyl sequence

Author: bashtage

doc/source/bit_generators/index.rst

@@ -29,6 +29,7 @@ These RNGs will be included in future releases.
    PCG64 <pcg64>
    Philox <philox>
    RDRAND <rdrand>
+   SFC64 <sfc>
    SFMT <sfmt>
    SPECK128 <speck128>
    ThreeFry <threefry>

doc/source/bit_generators/lxm.rst

@@ -16,6 +16,14 @@ Seeding and State
    ~LXM.seed
    ~LXM.state
 
+Parallel generation
+===================
+.. autosummary::
+   :toctree: generated/
+
+   ~LXM.jump
+   ~LXM.jumped
+
 Extending
 =========
 .. autosummary::

doc/source/bit_generators/sfc.rst

@@ -0,0 +1,32 @@
+SFC64 Generator
+---------------
+
+.. module:: randomgen.sfc
+
+.. currentmodule:: randomgen.sfc
+
+.. autoclass:: SFC64
+
+Seeding and State
+=================
+
+.. autosummary::
+   :toctree: generated/
+
+   ~SFC64.seed
+   ~SFC64.state
+
+Extending
+=========
+.. autosummary::
+   :toctree: generated/
+
+   ~SFC64.cffi
+   ~SFC64.ctypes
+
+Testing
+=======
+.. autosummary::
+   :toctree: generated/
+
+   ~SFC64.random_raw

doc/source/performance.rst

@@ -6,7 +6,7 @@ Performance
 Recommendation
 **************
 The recommended generator for single use is
-:class:`~randomgen.pcg64.PCG64` with the keyword argument ``variant="cm-dxsm"`.
+:class:`~randomgen.pcg64.PCG64` with the keyword argument ``variant="cm-dxsm"``.
 An excellent alternative is :class:`~randomgen.xoshiro256.Xoshiro256`
 where the `jump` method is used to advance the state. For very large scale
 applications -- requiring 1,000+ independent streams,

randomgen/__init__.py

@@ -14,6 +14,7 @@
 from randomgen.philox import Philox
 from randomgen.rdrand import RDRAND
 from randomgen.seed_sequence import SeedlessSeedSequence, SeedSequence
+from randomgen.sfc import SFC64
 from randomgen.sfmt import SFMT
 from randomgen.speck128 import SPECK128
 from randomgen.threefry import ThreeFry
@@ -39,6 +40,7 @@
     "Philox",
     "RDRAND",
     "RandomState",
+    "SFC64",
     "SFMT",
     "SPECK128",
     "ThreeFry",

randomgen/_pickle.py

@@ -14,6 +14,7 @@
 from randomgen.pcg64 import PCG64
 from randomgen.philox import Philox
 from randomgen.rdrand import RDRAND
+from randomgen.sfc import SFC64
 from randomgen.sfmt import SFMT
 from randomgen.speck128 import SPECK128
 from randomgen.threefry import ThreeFry
@@ -40,6 +41,7 @@
     "Xoshiro256": Xoshiro256,
     "Xoshiro512": Xoshiro512,
     "SPECK128": SPECK128,
+    "SFC64": SFC64,
     "SFMT": SFMT,
     "RDRAND": RDRAND,
 }

randomgen/aes.pyx

@@ -274,7 +274,7 @@ cdef class AESCounter(BitGenerator):
         for i in range(16 * 4):
             state[i] = self.rng_state.state[i]
         offset = self.rng_state.offset
-        return {"bit_generator": self.__class__.__name__,
+        return {"bit_generator": type(self).__name__,
                 "s": {"state": state, "seed": seed, "counter": counter,
                       "offset": offset},
                 "has_uint32": self.rng_state.has_uint32,
@@ -287,9 +287,9 @@ cdef class AESCounter(BitGenerator):
         if not isinstance(value, dict):
             raise TypeError("state must be a dict")
         bitgen = value.get("bit_generator", "")
-        if bitgen != self.__class__.__name__:
+        if bitgen != type(self).__name__:
             raise ValueError("state must be for a {0} "
-                             "PRNG".format(self.__class__.__name__))
+                             "PRNG".format(type(self).__name__))
         state =value["s"]["state"]
         for i in range(16 * 4):
             self.rng_state.state[i] = state[i]

randomgen/chacha.pyx

@@ -274,7 +274,7 @@ cdef class ChaCha(BitGenerator):
         for i in range(2):
             ctr[i] = self.rng_state.ctr[i]
 
-        return {"bit_generator": self.__class__.__name__,
+        return {"bit_generator": type(self).__name__,
                 "state": {"block": block, "keysetup": keysetup, "ctr": ctr,
                           "rounds": self.rng_state.rounds}}
 
@@ -283,9 +283,9 @@ cdef class ChaCha(BitGenerator):
         if not isinstance(value, dict):
             raise TypeError("state must be a dict")
         bitgen = value.get("bit_generator", "")
-        if bitgen != self.__class__.__name__:
+        if bitgen != type(self).__name__:
             raise ValueError("state must be for a {0} "
-                             "PRNG".format(self.__class__.__name__))
+                             "PRNG".format(type(self).__name__))
 
         state = value["state"]
         block = state["block"]

randomgen/common.pyx

@@ -96,7 +96,7 @@ cdef class BitGenerator:
             pass
         if isinstance(seed, ISEED_SEQUENCES):
             if self.mode == "legacy":
-                bg = self.__class__.__name__
+                bg = type(self).__name__
                 raise RuntimeError("{bg} was created using mode=\"legacy\". "
                                    "This is immutable and SeedSequences cannot"
                                    " be used".format(bg=bg))

randomgen/dsfmt.pyx

@@ -287,7 +287,7 @@ cdef class DSFMT(BitGenerator):
         buffered_uniforms = np.empty(DSFMT_N64, dtype=np.double)
         for i in range(DSFMT_N64):
             buffered_uniforms[i] = self.rng_state.buffered_uniforms[i]
-        return {"bit_generator": self.__class__.__name__,
+        return {"bit_generator": type(self).__name__,
                 "state": {"state": np.asarray(state),
                           "idx": self.rng_state.state.idx},
                 "buffer_loc": self.rng_state.buffer_loc,
@@ -299,9 +299,9 @@ cdef class DSFMT(BitGenerator):
         if not isinstance(value, dict):
             raise TypeError("state must be a dict")
         bitgen = value.get("bit_generator", "")
-        if bitgen != self.__class__.__name__:
+        if bitgen != type(self).__name__:
             raise ValueError("state must be for a {0} "
-                             "PRNG".format(self.__class__.__name__))
+                             "PRNG".format(type(self).__name__))
         state = check_state_array(value["state"]["state"], 2*DSFMT_N_PLUS_1,
                                   64, "state")
         for i in range(DSFMT_N_PLUS_1):