diff options
Diffstat (limited to 'numpy/core/numeric.py')
| -rw-r--r-- | numpy/core/numeric.py | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/numpy/core/numeric.py b/numpy/core/numeric.py index 4b78c16fd..e30df8b4e 100644 --- a/numpy/core/numeric.py +++ b/numpy/core/numeric.py @@ -2436,7 +2436,7 @@ def allclose(a, b, rtol=1.e-5, atol=1.e-8, equal_nan=False): See Also -------- - isclose, all, any, equals + isclose, all, any, equal Notes ----- @@ -2446,12 +2446,13 @@ def allclose(a, b, rtol=1.e-5, atol=1.e-8, equal_nan=False): absolute(`a` - `b`) <= (`atol` + `rtol` * absolute(`b`)) The above equation is not symmetric in `a` and `b`, so that - `allclose(a, b)` might be different from `allclose(b, a)` in + ``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 `equals`.) + + The comparison of `a` and `b` uses 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 + ``equal`` but not ``array_equal``. Examples -------- |