vecdot

vecdot(x1: array, x2: array, /, *, axis: int = -1) array

Computes the (vector) dot product of two arrays.

Parameters:
  • x1 (array) – first input array. Should have a numeric data type.

  • x2 (array) – second input array. Must be compatible with x1 (see Broadcasting). Should have a numeric data type.

  • axis (int) – axis over which to compute the dot product. Must be an integer on the interval [-N, N), where N is the rank (number of dimensions) of the shape determined according to Broadcasting. If specified as a negative integer, the function must determine the axis along which to compute the dot product by counting backward from the last dimension (where -1 refers to the last dimension). By default, the function must compute the dot product over the last axis. Default: -1.

Returns:

out (array) – if x1 and x2 are both one-dimensional arrays, a zero-dimensional containing the dot product; otherwise, a non-zero-dimensional array containing the dot products and having rank N-1, where N is the rank (number of dimensions) of the shape determined according to Broadcasting. The returned array must have a data type determined by Type Promotion Rules.

Raises

  • if provided an invalid axis.

  • if the size of the axis over which to compute the dot product is not the same for both x1 and x2.