diff options
| author | Kevin Sheppard <kevin.k.sheppard@gmail.com> | 2020-01-31 11:22:03 +0000 |
|---|---|---|
| committer | Kevin Sheppard <kevin.k.sheppard@gmail.com> | 2020-01-31 11:52:11 +0000 |
| commit | 6540338da0cd2bab5ec6a5ab1ec6024fcaf0f434 (patch) | |
| tree | 088328d1afd7d0d1d30ab53817e635ab98949157 | |
| parent | fa64d4bb9f0ec5dc6518ea0cf742ba78979f046d (diff) | |
| download | numpy-6540338da0cd2bab5ec6a5ab1ec6024fcaf0f434.tar.gz | |
DOC: Correct get_state doc
Move flag to parameters
| -rw-r--r-- | numpy/random/mtrand.pyx | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/numpy/random/mtrand.pyx b/numpy/random/mtrand.pyx index 95921a8ea..a04026c0d 100644 --- a/numpy/random/mtrand.pyx +++ b/numpy/random/mtrand.pyx @@ -252,6 +252,12 @@ cdef class RandomState: For more details, see `set_state`. + Parameters + ---------- + legacy : bool, optional + Flag indicating to return a legacy tuple state when the BitGenerator + is MT19937, instead of a dict. + Returns ------- out : {tuple(str, ndarray of 624 uints, int, int, float), dict} @@ -263,13 +269,9 @@ cdef class RandomState: 4. an integer ``has_gauss``. 5. a float ``cached_gaussian``. - If `legacy` is False, or the BitGenerator is not NT19937, then + If `legacy` is False, or the BitGenerator is not MT19937, then state is returned as a dictionary. - legacy : bool - Flag indicating the return a legacy tuple state when the BitGenerator - is MT19937. - See Also -------- set_state |