dot

UnitsAwareDataArray.dot(other: T_Xarray, dim: Dims = None) → T_Xarray

Perform dot product of two DataArrays along their shared dims.

Equivalent to taking taking tensordot over all shared dims.

Parameters:

  • other (DataArray) – The other array with which the dot product is performed.

  • dim (..., str, Iterable of Hashable or None, optional) – Which dimensions to sum over. Ellipsis (…) sums over all dimensions. If not specified, then all the common dimensions are summed over.

Returns:

result – Array resulting from the dot product over all shared dimensions.

Return type:

DataArray

See also

dot, numpy.tensordot

Examples

>>> da_vals = np.arange(6 * 5 * 4).reshape((6, 5, 4))
>>> da = xr.DataArray(da_vals, dims=["x", "y", "z"])
>>> dm_vals = np.arange(4)
>>> dm = xr.DataArray(dm_vals, dims=["z"])

>>> dm.dims
('z',)

>>> da.dims
('x', 'y', 'z')

>>> dot_result = da.dot(dm)
>>> dot_result.dims
('x', 'y')