8000 DOC: reflect changes from #5822 (May 2015) in the docs · mattip/numpy@3aab0d5 · GitHub
[go: up one dir, main page]
Skip to content

Commit 3aab0d5

Browse files
mattipmattip
committed
DOC: reflect changes from numpy#5822 (May 2015) in the docs
1 parent 06da76c commit 3aab0d5

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

‎numpy/random/mtrand/mtrand.pyx

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1574,7 +1574,8 @@ cdef class RandomState:
15741574
loc : float or array_like of floats
15751575
Mean ("centre") of the distribution.
15761576
scale : float or array_like of floats
1577-
Standard deviation (spread or "width") of the distribution.
1577+
Standard deviation (spread or "width") of the distribution. Must be
1578+
non-negative.
15781579
size : int or tuple of ints, optional
15791580
Output shape. If the given shape is, e.g., ``(m, n, k)``, then
15801581
``m * n * k`` samples are drawn. If size is ``None`` (default),
@@ -1746,7 +1747,8 @@ cdef class RandomState:
17461747
Parameters
17471748
----------
17481749
scale : float or array_like of floats
1749-
The scale parameter, :math:`\\beta = 1/\\lambda`.
1750+
The scale parameter, :math:`\\beta = 1/\\lambda`. Must be
1751+
non-negative.
17501752
size : int or tuple of ints, optional
17511753
Output shape. If the given shape is, e.g., ``(m, n, k)``, then
17521754
``m * n * k`` samples are drawn. If size is ``None`` (default),
@@ -1828,7 +1830,7 @@ cdef class RandomState:
18281830
Parameters
18291831
----------
18301832
shape : float or array_like of floats
1831-
Parameter, should be > 0.
1833+
Parameter, must be non-negative.
18321834
size : int or tuple of ints, optional
18331835
Output shape. If the given shape is, e.g., ``(m, n, k)``, then
18341836
``m * n * k`` samples are drawn. If size is ``None`` (default),
@@ -1915,9 +1917,9 @@ cdef class RandomState:
19151917
Parameters
19161918
----------
19171919
shape : float or array_like of floats
1918-
The shape of the gamma distribution. Should be greater than zero.
1920+
The shape of the gamma distribution. Must be non-negative.
19191921
scale : float or array_like of floats, optional
1920-
The scale of the gamma distribution. Should be greater than zero.
1922+
The scale of the gamma distribution. Must be non-negative.
19211923
Default is equal to 1.
19221924
size : int or tuple of ints, optional
19231925
Output shape. If the given shape is, e.g., ``(m, n, k)``, then
@@ -2681,7 +2683,7 @@ cdef class RandomState:
26812683
Parameters
26822684
----------
26832685
a : float or array_like of floats
2684-
Shape of the distribution. Should be greater than zero.
2686+
Shape of the distribution. Must be non-negative.
26852687
size : int or tuple of ints, optional
26862688
Output shape. If the given shape is, e.g., ``(m, n, k)``, then
26872689
``m * n * k`` samples are drawn. If size is ``None`` (default),
@@ -3002,7 +3004,8 @@ cdef class RandomState:
30023004
loc : float or array_like of floats, optional
30033005
The position, :math:`\\mu`, of the distribution peak. Default is 0.
30043006
scale : float or array_like of floats, optional
3005-
:math:`\\lambda`, the exponential decay. Default is 1.
3007+
:math:`\\lambda`, the exponential decay. Default is 1. Must be non-
3008+
negative.
30063009
size : int or tuple of ints, optional
30073010
Output shape. If the given shape is, e.g., ``(m, n, k)``, then
30083011
``m * n * k`` samples are drawn. If size is ``None`` (default),
@@ -3098,7 +3101,8 @@ cdef class RandomState:
30983101
loc : float or array_like of floats, optional
30993102
The location of the mode of the distribution. Default is 0.
31003103
scale : float or array_like of floats, optional
3101-
The scale parameter of the distribution. Default is 1.
3104+
The scale parameter of the distribution. Default is 1. Must be non-
3105+
negative.
31023106
size : int or tuple of ints, optional
31033107
Output shape. If the given shape is, e.g., ``(m, n, k)``, then
31043108
``m * n * k`` samples are drawn. If size is ``None`` (default),
@@ -3228,7 +3232,7 @@ cdef class RandomState:
32283232
loc : float or array_like of floats, optional
32293233
Parameter of the distribution. Default is 0.
32303234
scale : float or array_like of floats, optional
3231-
Parameter of the distribution. Should be greater than zero.
3235+
Parameter of the distribution. Must be non-negative.
32323236
Default is 1.
32333237
size : int or tuple of ints, optional
32343238
Output shape. If the given shape is, e.g., ``(m, n, k)``, then
@@ -3444,7 +3448,7 @@ cdef class RandomState:
34443448
Parameters
34453449
----------
34463450
scale : float or array_like of floats, optional
3447-
Scale, also equals the mode. Should be >= 0. Default is 1.
3451+
Scale, also equals the mode. Must be non-negative. Default is 1.
34483452
size : int or tuple of ints, optional
34493453
Output shape. If the given shape is, e.g., ``(m, n, k)``, then
34503454
``m * n * k`` samples are drawn. If size is ``None`` (default),

0 commit comments

Comments
 (0)
0