summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRedRuM <44142765+zoj613@users.noreply.github.com>2019-08-21 18:33:35 +0200
committerRedRuM <44142765+zoj613@users.noreply.github.com>2019-08-21 18:33:35 +0200
commitc304397fd8a447a13741f4da2c6b37f5eee888f7 (patch)
tree0693b471145623537a1a52d156548c7d5843e6d3
parent8b76dbe47c718d732492ab8583377ed3b2f5dc3b (diff)
downloadnumpy-c304397fd8a447a13741f4da2c6b37f5eee888f7.tar.gz
DOC: Add version where new parameters are added
-rw-r--r--numpy/random/generator.pyx5
1 files changed, 5 insertions, 0 deletions
diff --git a/numpy/random/generator.pyx b/numpy/random/generator.pyx
index e7eb5133e..701240968 100644
--- a/numpy/random/generator.pyx
+++ b/numpy/random/generator.pyx
@@ -3368,12 +3368,17 @@ cdef class Generator:
the slowest, while 'cholesky' is the fastest but less robust than
the slowest method. The method `eigh` uses eigen decomposition to
compute A and is faster than svd but slower than cholesky.
+
+ .. versionadded:: 1.18.0
+
use_factor : bool, optional
If set to True then cov argument is treated as a precomputed factor
matrix A such that `A @ A.T = cov`` holds true. This provides
significant speedups because the factorization of cov is avoided.
Note that when this argument is set to True, ``method`` is ignored.
+ .. versionadded:: 1.18.0
+
Returns
-------
out : ndarray