summaryrefslogtreecommitdiff
path: root/numpy/random
diff options
context:
space:
mode:
authorCharles Harris <charlesr.harris@gmail.com>2015-10-04 13:18:43 -0600
committerCharles Harris <charlesr.harris@gmail.com>2015-10-05 09:58:30 -0600
commitb6a8b35d13ce712272824af31d465ca437b9cd0e (patch)
tree19bc717471d15d35941af4960c3ccd2c5411ac8c /numpy/random
parent7c1f44fd07917b3a2fac483c2263edd67b490eda (diff)
downloadnumpy-b6a8b35d13ce712272824af31d465ca437b9cd0e.tar.gz
DOC: Update RandomState guarantee to be more explicit.
Diffstat (limited to 'numpy/random')
-rw-r--r--numpy/random/mtrand/mtrand.pyx13
1 files changed, 8 insertions, 5 deletions
diff --git a/numpy/random/mtrand/mtrand.pyx b/numpy/random/mtrand/mtrand.pyx
index fb325d9c1..cd50c4968 100644
--- a/numpy/random/mtrand/mtrand.pyx
+++ b/numpy/random/mtrand/mtrand.pyx
@@ -587,11 +587,14 @@ cdef class RandomState:
array filled with generated values is returned. If `size` is a tuple,
then an array with that shape is filled and returned.
- * Compatibility Guarantee*
- A fixed seed and a fixed series of calls to 'RandomState' methods will
- always produce the same results regardless of platform or numpy
- version. Small differences in floating point values may occur due to
- rounding differences between compilers.
+ *Compatibility Guarantee*
+ A fixed seed and a fixed series of calls to 'RandomState' methods using
+ the same parameters will always produce the same results up to roundoff
+ error except when the values were incorrect. Incorrect values will be
+ fixed and the NumPy version in which the fix was made will be noted in
+ the relevant docstring. Extension of existing parameter ranges and the
+ addition of new parameters is allowed as long the previous behavior
+ remains unchanged.
Parameters
----------