summaryrefslogtreecommitdiff
path: root/numpy
diff options
context:
space:
mode:
authorCharles Harris <charlesr.harris@gmail.com>2017-08-27 09:32:09 -0600
committerCharles Harris <charlesr.harris@gmail.com>2017-08-27 09:33:42 -0600
commit15e585e8824123158c002bcfb850617fac492411 (patch)
tree46c4358ac786dea0b3bba457b77da877d0da554b /numpy
parent4e0d44c6e722b106df431b7d2e53cf4d82d32d6a (diff)
downloadnumpy-15e585e8824123158c002bcfb850617fac492411.tar.gz
DOC: Update release notes for noncentral_f changes.
The `dfnum` parameter is now required to be > 0 rather than the previous > 1. [ci skip]
Diffstat (limited to 'numpy')
-rw-r--r--numpy/random/mtrand/mtrand.pyx14
1 files changed, 9 insertions, 5 deletions
diff --git a/numpy/random/mtrand/mtrand.pyx b/numpy/random/mtrand/mtrand.pyx
index 5a4b59f82..aff0a687c 100644
--- a/numpy/random/mtrand/mtrand.pyx
+++ b/numpy/random/mtrand/mtrand.pyx
@@ -2109,12 +2109,16 @@ cdef class RandomState:
Parameters
----------
- dfnum : int or array_like of ints
- Parameter, should be > 0.
- dfden : int or array_like of ints
- Parameter, should be > 0.
+ dfnum : float or array_like of floats
+ Numerator degrees of freedom, should be > 0.
+
+ .. versionchanged:: 1.14.0
+ Earlier NumPy versions required dfnum > 1.
+ dfden : float or array_like of floats
+ Denominator degrees of freedom, should be > 0.
nonc : float or array_like of floats
- Parameter, should be >= 0.
+ Non-centrality parameter, the sum of the squares of the numerator
+ means, should be >= 0.
size : int or tuple of ints, optional
Output shape. If the given shape is, e.g., ``(m, n, k)``, then
``m * n * k`` samples are drawn. If size is ``None`` (default),