jax.numpy.tril_indices#

jax.numpy.tril_indices(n, k=0, m=None)[源码]#

返回大小为 (n, m) 的数组的下三角索引。

JAX 对 numpy.tril_indices() 的实现。

参数:
  • n (DimSize) – int。返回索引的数组的行数。

  • k (DimSize) – optional, int, default=0。指定了在主对角线及其以下的子对角线,返回下三角的索引。k=0 指的是主对角线,k<0 指的是主对角线以下的子对角线,而 k>0 指的是主对角线以上的第一条子对角线。

  • m (DimSize | None) – optional, int。返回索引的数组的列数。如果未指定,则 m = n

返回:

包含下三角索引的两个数组组成的元组,每个轴一个。

返回类型:

tuple[Array, Array]

另请参阅

示例

如果输入中仅提供了 n,则返回大小为 (n, n) 的数组的下三角索引。

>>> jnp.tril_indices(3)
(Array([0, 1, 1, 2, 2, 2], dtype=int32), Array([0, 0, 1, 0, 1, 2], dtype=int32))

如果输入中同时提供了 nm,则返回大小为 (n, m) 的数组的下三角索引。

>>> jnp.tril_indices(3, m=2)
(Array([0, 1, 1, 2, 2], dtype=int32), Array([0, 0, 1, 0, 1], dtype=int32))

如果 k = 1,则返回主对角线上方第一条子对角线及其以下的索引。

>>> jnp.tril_indices(3, k=1)
(Array([0, 0, 1, 1, 1, 2, 2, 2], dtype=int32), Array([0, 1, 0, 1, 2, 0, 1, 2], dtype=int32))

如果 k = -1,则返回主对角线下方第一条子对角线及其以下的索引。

>>> jnp.tril_indices(3, k=-1)
(Array([1, 2, 2], dtype=int32), Array([0, 0, 1], dtype=int32))