diff options
author | pierregm <pierregm@localhost> | 2008-11-27 06:56:12 +0000 |
---|---|---|
committer | pierregm <pierregm@localhost> | 2008-11-27 06:56:12 +0000 |
commit | ce7cd10f480494656a704a7d0db5a8f6e3d8f6fb (patch) | |
tree | 07357a9bc73c7260f12f8536c0bd87809a2d21e8 /numpy | |
parent | 0629f41ff2501dc1e2235b40dd1da63162a1487b (diff) | |
download | numpy-ce7cd10f480494656a704a7d0db5a8f6e3d8f6fb.tar.gz |
Doc update
Diffstat (limited to 'numpy')
-rw-r--r-- | numpy/ma/core.py | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/numpy/ma/core.py b/numpy/ma/core.py index b8f810aa5..d5b80c46f 100644 --- a/numpy/ma/core.py +++ b/numpy/ma/core.py @@ -4219,6 +4219,17 @@ def round_(a, decimals=0, out=None): round = round_ def inner(a, b): + """ + Returns the inner product of a and b for arrays of floating point types. + + Like the generic NumPy equivalent the product sum is over the last dimension + of a and b. + + Notes + ----- + The first argument is not conjugated. + + """ fa = filled(a, 0) fb = filled(b, 0) if len(fa.shape) == 0: @@ -4269,7 +4280,7 @@ def allequal (a, b, fill_value=True): def allclose (a, b, masked_equal=True, rtol=1.e-5, atol=1.e-8, fill_value=None): """ - Returns True if two arrays are element-wise equal within a tolerance. + Returns True if two arrays are element-wise equal within a tolerance. The tolerance values are positive, typically very small numbers. The relative difference (`rtol` * `b`) and the absolute difference (`atol`) |