diff options
author | Stefan van der Walt <stefan@sun.ac.za> | 2008-08-21 16:41:34 +0000 |
---|---|---|
committer | Stefan van der Walt <stefan@sun.ac.za> | 2008-08-21 16:41:34 +0000 |
commit | 8e5324355bcdaddf18febe8bb8fc6085d7ea17e2 (patch) | |
tree | 047a46c4f6be41e22d8e58a9399105d87179f275 /numpy/random/info.py | |
parent | 06ea402528b0cdd228a16ce77d2aafff44ede61e (diff) | |
download | numpy-8e5324355bcdaddf18febe8bb8fc6085d7ea17e2.tar.gz |
Update `random` docstring.
Diffstat (limited to 'numpy/random/info.py')
-rw-r--r-- | numpy/random/info.py | 85 |
1 files changed, 82 insertions, 3 deletions
diff --git a/numpy/random/info.py b/numpy/random/info.py index 8c2cae44a..6139e5784 100644 --- a/numpy/random/info.py +++ b/numpy/random/info.py @@ -1,6 +1,85 @@ -"""\ -Core Random Tools -================= +""" +======================== +Random Number Generation +======================== + +==================== ========================================================= +Utility functions +============================================================================== +random Uniformly distributed values of a given shape. +bytes Uniformly distributed random bytes. +random_integers Uniformly distributed integers in a given range. +random_sample Uniformly distributed floats in a given range. +permutation Randomly permute a sequence / generate a random sequence. +shuffle Randomly permute a sequence in place. +seed Seed the random number generator. +==================== ========================================================= + +==================== ========================================================= +Compatibility functions +============================================================================== +rand Uniformly distributed values. +randn Normally distributed values. +ranf Uniformly distributed floating point numbers. +randint Uniformly distributed integers in a given range. +==================== ========================================================= + +==================== ========================================================= +Univariate distributions +============================================================================== +beta Beta distribution over ``[0, 1]``. +binomial Binomial distribution. +chisquare :math:`\\chi^2` distribution. +exponential Exponential distribution. +f F (Fisher-Snedecor) distribution. +gamma Gamma distribution. +geometric Geometric distribution. +gumbel Gumbel distribution. +hypergeometric Hypergeometric distribution. +laplace Laplace distribution. +logistic Logistic distribution. +lognormal Log-normal distribution. +logseries Logarithmic series distribution. +negative_binomial Negative binomial distribution. +noncentral_chisquare Non-central chi-square distribution. +noncentral_f Non-central F distribution. +normal Normal / Gaussian distribution. +pareto Pareto distribution. +poisson Poisson distribution. +power Power distribution. +rayleigh Rayleigh distribution. +triangular Triangular distribution. +uniform Uniform distribution. +vonmises Von Mises circular distribution. +wald Wald (inverse Gaussian) distribution. +weibull Weibull distribution. +zipf Zipf's distribution over ranked data. +==================== ========================================================= + +==================== ========================================================= +Multivariate distributions +============================================================================== +dirichlet Multivariate generalization of Beta distribution. +multinomial Multivariate generalization of the binomial distribution. +multivariate_normal Multivariate generalization of the normal distribution. +==================== ========================================================= + +==================== ========================================================= +Standard distributions +============================================================================== +standard_cauchy Standard Cauchy-Lorentz distribution. +standard_exponential Standard exponential distribution. +standard_gamma Standard Gamma distribution. +standard_normal Standard normal distribution. +standard_t Standard Student's t-distribution. +==================== ========================================================= + +==================== ========================================================= +Internal functions +============================================================================== +get_state Get tuple representing internal state of generator. +set_state Set state of generator. +==================== ========================================================= """ |