diff options
| author | Spencer Hill <shill@atmos.ucla.edu> | 2017-09-18 12:16:58 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-09-18 12:16:58 -0700 |
| commit | 4df78667e5b38560310f2e5e4e6b980821cce43d (patch) | |
| tree | 49e12647034c568b83365e7e319b72dce29f8d89 /numpy/core/numeric.py | |
| parent | 9474f036c4d25bc5f629229a4abd515d4bc90731 (diff) | |
| download | numpy-4df78667e5b38560310f2e5e4e6b980821cce43d.tar.gz | |
DOC allclose doesn't require matching shapes
Closes https://github.com/numpy/numpy/issues/5654
Diffstat (limited to 'numpy/core/numeric.py')
| -rw-r--r-- | numpy/core/numeric.py | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/numpy/core/numeric.py b/numpy/core/numeric.py index fde08490a..1f5d24936 100644 --- a/numpy/core/numeric.py +++ b/numpy/core/numeric.py @@ -2448,6 +2448,10 @@ def allclose(a, b, rtol=1.e-5, atol=1.e-8, equal_nan=False): The above equation is not symmetric in `a` and `b`, so that `allclose(a, b)` might be different from `allclose(b, a)` in some rare cases. + + The comparison of `a` and `b` includes standard broadcasting, + which means that `a` and `b` need not have the same shape in order for + allclose(a, b) to evaluate to True. (The same is true for `np.equals`.) Examples -------- |