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 kwargs

返回:
yndarray

输入的矩阵乘积.当且仅当 x1, x2 都是 1-d 向量时,这是一个标量.

引发:
ValueError

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

如果传递的是一个标量值.

参见

vdot

复共轭点积.

tensordot

对任意轴上的乘积求和.

einsum

爱因斯坦求和约定.

dot

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

备注

行为取决于以下方式中的参数.

  • 如果两个参数都是二维的,它们会像传统矩阵一样相乘.

  • 如果任一参数是 N-D,N > 2,它被视为位于最后两个索引中的矩阵堆栈,并相应地进行广播.

  • 如果第一个参数是1-D,它会被提升为一个矩阵,通过在其维度前添加一个1.在矩阵乘法之后,添加的1会被移除.

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

matmuldot 在两个重要方面有所不同:

  • 不允许通过标量进行乘法,请使用 * 代替.

  • 矩阵堆栈一起广播,就像矩阵是元素一样,尊重签名 (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

Vector, vector 返回标量内积,但两个参数都不是复共轭的:

>>> 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 ...

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

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

在 1.10.0 版本加入.