Skip to content

Commit

Permalink
Clarify broadcasting behavior in vecdot (#473)
Browse files Browse the repository at this point in the history
This resolves #471.

The existing spec provides conflicting guidance saying both that the
axes over which to compute the dot product must be equal, while also
saying that input arrays must be broadcast compatible without
qualification, thus implying that the contracted axis could also
broadcast.

This commit explicitly defines broadcast behavior for only the
contracted axes, thus bringing vecdot inline with broadcasting
behavior in tensordot.
  • Loading branch information
kgryte committed Sep 5, 2022
1 parent 733f27c commit 55b8fb0
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions spec/API_specification/array_api/linear_algebra_functions.py
Expand Up @@ -92,14 +92,18 @@ def vecdot(x1: array, x2: array, /, *, axis: int = -1) -> array:
x1: array
first input array. Should have a real-valued data type.
x2: array
second input array. Must be compatible with ``x1`` (see :ref:`broadcasting`). Should have a real-valued data type.
second input array. Should have a real-valued data type. Corresponding contracted axes of ``x1`` and ``x2`` must be equal.
.. note::
Contracted axes (dimensions) must not be broadcasted.
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 :ref:`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 :ref:`broadcasting`. The returned array must have a data type determined by :ref:`type-promotion`.
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 :ref:`broadcasting` along the non-contracted axes. The returned array must have a data type determined by :ref:`type-promotion`.
**Raises**
Expand Down

0 comments on commit 55b8fb0

Please sign in to comment.