Skip to content

Commit 4dfc890

Browse files
committed
changed vdot docs as suggested
1 parent 970d7e3 commit 4dfc890

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

numpy/_core/multiarray.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -851,9 +851,11 @@ def vdot(a, b):
851851
dot(`a`, `b`). If the first argument is complex the complex conjugate
852852
of the first argument is used for the calculation of the dot product.
853853
854-
Note that `vdot` handles multidimensional arrays differently than `dot`:
855-
it does *not* perform a matrix product, but flattens input arguments
856-
to 1-D vectors first. Consequently, it should only be used for vectors.
854+
Note that `vdot` handles multidimensional arrays differently than `dot`:
855+
it does not perform a matrix product, but flattens input arguments to 1-D vectors first.
856+
The runtime of this function is linear in `a.size` and `b.size`. When `(a, b)` are 2-D arrays
857+
of the same shape, this function returns their `Frobenius inner-product` (also known as the
858+
*trace inner product* or the *standard inner product* on a vector space of matrices).
857859
858860
Parameters
859861
----------

0 commit comments

Comments
 (0)