numpy.matmul#

numpy.matmul(x1, x2, /, out=None, *, casting='same_kind', order='K', dtype=None, subok=True[, signature, axes, axis]) = <ufunc 'matmul'>#

两个数组的矩阵乘积。

参数:
x1, x2array_like

输入数组,不允许标量。

outndarray, 可选

存储结果的位置。如果提供,其形状必须与签名 (n,k),(k,m)->(n,m) 匹配。如果不提供或为 None,则返回一个新分配的数组。

**kwargs

对于其他仅限关键字的参数,请参阅 ufunc 文档

版本 1.16 中的新内容: 现在处理 ufunc 关键字参数

返回值:
yndarray

输入的矩阵乘积。仅当 x1、x2 都是一维向量时,此结果才是标量。

引发:
ValueError

如果 x1 的最后维度与 x2 的倒数第二个维度大小不相同。

如果传入标量值。

参见

vdot

复共轭点积。

tensordot

任意轴上的求和积。

einsum

爱因斯坦求和约定。

dot

具有不同广播规则的替代矩阵乘积。

注释

行为取决于参数,方式如下。

  • 如果两个参数都是二维的,则像传统的矩阵一样相乘。

  • 如果任一参数是 N 维的,N > 2,则将其视为位于最后两个索引中的矩阵堆栈,并相应地进行广播。

  • 如果第一个参数是一维的,则通过在其维度前添加 1 来将其提升为矩阵。矩阵乘法后,移除前置的 1。

  • 如果第二个参数是一维的,则通过在其维度后附加 1 来将其提升为矩阵。矩阵乘法后,移除附加的 1。

matmul 在两个重要方面与 dot 不同

  • 不允许与标量相乘,请改用 *

  • 矩阵堆栈一起广播,就像矩阵是元素一样,尊重签名 (n,k),(k,m)->(n,m)

    >>> a = np.ones([9, 5, 7, 4])
    >>> c = np.ones([9, 5, 4, 3])
    >>> np.dot(a, c).shape
    (9, 5, 7, 9, 5, 3)
    >>> np.matmul(a, c).shape
    (9, 5, 7, 3)
    >>> # n is 7, k is 4, m is 3
    

matmul 函数实现了 Python 3.5 中引入的 @ 运算符的语义,遵循 PEP 465

它尽可能地使用优化的 BLAS 库(参见 numpy.linalg)。

示例

对于二维数组,它是矩阵乘积

>>> import numpy as np
>>> a = np.array([[1, 0],
...               [0, 1]])
>>> b = np.array([[4, 1],
...               [2, 2]])
>>> np.matmul(a, b)
array([[4, 1],
       [2, 2]])

对于二维与一维混合,结果是通常的结果。

>>> a = np.array([[1, 0],
...               [0, 1]])
>>> b = np.array([1, 2])
>>> np.matmul(a, b)
array([1, 2])
>>> np.matmul(b, a)
array([1, 2])

数组堆栈的广播是传统的

>>> a = np.arange(2 * 2 * 4).reshape((2, 2, 4))
>>> b = np.arange(2 * 2 * 4).reshape((2, 4, 2))
>>> np.matmul(a,b).shape
(2, 2, 2)
>>> np.matmul(a, b)[0, 1, 1]
98
>>> sum(a[0, 1, :] * b[0 , :, 1])
98

向量、向量返回标量内积,但任何一个参数都不进行复共轭

>>> np.matmul([2j, 3j], [2j, 3j])
(-13+0j)

标量乘法会引发错误。

>>> np.matmul([1,2], 3)
Traceback (most recent call last):
...
ValueError: matmul: Input operand 1 does not have enough dimensions ...

@ 运算符可以用作 ndarray 上 np.matmul 的简写。

>>> x1 = np.array([2j, 3j])
>>> x2 = np.array([2j, 3j])
>>> x1 @ x2
(-13+0j)

版本 1.10.0 中的新内容。