diff options
| author | Charles Harris <charlesr.harris@gmail.com> | 2019-08-03 09:27:33 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-08-03 09:27:33 -0500 |
| commit | 71c8a1030d5a32342edc2e2311cb71dc38a7374e (patch) | |
| tree | 07db57859b734fab6b49e034d2ec9501fa86111a /numpy | |
| parent | b4c1d4f93d2ed34bc27b59ece2f26a8b3b16e5e4 (diff) | |
| parent | d8672366f573cf27ff10d9f40cfc723bd9710f50 (diff) | |
| download | numpy-71c8a1030d5a32342edc2e2311cb71dc38a7374e.tar.gz | |
Merge pull request #14190 from hvy/docs-svd-hermitian
DOC: Fix hermitian argument docs in `svd`
Diffstat (limited to 'numpy')
| -rw-r--r-- | numpy/linalg/linalg.py | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/numpy/linalg/linalg.py b/numpy/linalg/linalg.py index 2a3ff0728..816a200eb 100644 --- a/numpy/linalg/linalg.py +++ b/numpy/linalg/linalg.py @@ -1481,6 +1481,12 @@ def svd(a, full_matrices=True, compute_uv=True, hermitian=False): compute_uv : bool, optional Whether or not to compute `u` and `vh` in addition to `s`. True by default. + hermitian : bool, optional + If True, `a` is assumed to be Hermitian (symmetric if real-valued), + enabling a more efficient method for finding singular values. + Defaults to False. + + .. versionadded:: 1.17.0 Returns ------- @@ -1498,12 +1504,6 @@ def svd(a, full_matrices=True, compute_uv=True, hermitian=False): size as those of the input `a`. The size of the last two dimensions depends on the value of `full_matrices`. Only returned when `compute_uv` is True. - hermitian : bool, optional - If True, `a` is assumed to be Hermitian (symmetric if real-valued), - enabling a more efficient method for finding singular values. - Defaults to False. - - .. versionadded:: 1.17.0 Raises ------ |