jax.numpy.tril_indices

jax.numpy.tril_indices#

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

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

JAX 实现 numpy.tril_indices().

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

  • k (int) – 可选,int,默认值=0. 指定返回下三角索引的次对角线及其以下的对角线。 k=0 指主对角线,k<0 指主对角线以下的次对角线,k>0 指主对角线以上的次对角线。

  • m (int | None | None) – 可选,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))