diff options
| author | Eric Wieser <wieser.eric@gmail.com> | 2017-10-16 11:29:11 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-10-16 11:29:11 -0700 |
| commit | 77f9540f277de3e727d696eb5987a0505ed8cdf9 (patch) | |
| tree | e2949d5303637599034f4b0d5150967f6bf9771b | |
| parent | 36e716adf3647d2c6ec7703a52a39f38718cee78 (diff) | |
| parent | 4c4f4d5a75829f985951ac201c69cc46dc26322f (diff) | |
| download | numpy-77f9540f277de3e727d696eb5987a0505ed8cdf9.tar.gz | |
Merge pull request #9869 from charris/qr-doc-fix
DOC: Make qr options render correctly as list.
| -rw-r--r-- | numpy/linalg/linalg.py | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/numpy/linalg/linalg.py b/numpy/linalg/linalg.py index d2ae7befc..060a3ecd4 100644 --- a/numpy/linalg/linalg.py +++ b/numpy/linalg/linalg.py @@ -630,15 +630,15 @@ def qr(a, mode='reduced'): mode : {'reduced', 'complete', 'r', 'raw', 'full', 'economic'}, optional If K = min(M, N), then - 'reduced' : returns q, r with dimensions (M, K), (K, N) (default) - 'complete' : returns q, r with dimensions (M, M), (M, N) - 'r' : returns r only with dimensions (K, N) - 'raw' : returns h, tau with dimensions (N, M), (K,) - 'full' : alias of 'reduced', deprecated - 'economic' : returns h from 'raw', deprecated. + * 'reduced' : returns q, r with dimensions (M, K), (K, N) (default) + * 'complete' : returns q, r with dimensions (M, M), (M, N) + * 'r' : returns r only with dimensions (K, N) + * 'raw' : returns h, tau with dimensions (N, M), (K,) + * 'full' : alias of 'reduced', deprecated + * 'economic' : returns h from 'raw', deprecated. The options 'reduced', 'complete, and 'raw' are new in numpy 1.8, - see the notes for more information. The default is 'reduced' and to + see the notes for more information. The default is 'reduced', and to maintain backward compatibility with earlier versions of numpy both it and the old default 'full' can be omitted. Note that array h returned in 'raw' mode is transposed for calling Fortran. The |