jax.numpy.put

jax.numpy.put(a, ind, v, mode=None, *, inplace=True)

将元素放入给定索引的数组中。

numpy.put() 的 JAX 实现。

numpy.put() 的语义是就地修改数组，这对于 JAX 的不可变数组来说是不可能的。JAX 版本返回输入的修改副本，并添加了 inplace 参数，用户必须将其设置为“False`”，以提醒此 API 差异。

参数:

• a (Array | ndarray | bool | number | bool | int | float | complex) – 值将被放入的数组。

• ind (Array | ndarray | bool | number | bool | int | float | complex) – 数组索引，指示在扁平化数组中放入值的位置。

• v (Array | ndarray | bool | number | bool | int | float | complex) – 要放入数组中的值的数组。

• mode (str | None) –

  字符串，指定如何处理越界索引。支持的值

  • "clip" (默认)：将越界索引剪裁到最后一个索引。

  • "wrap"：将越界索引包裹到数组的开头。

• inplace (bool) – 必须设置为 False，以表明输入不是就地修改的，而是返回修改后的副本。

返回:

a 的副本，其中指定条目已更新。

返回类型:

数组

另请参阅

• jax.numpy.place()：通过布尔掩码将元素放入数组中。

• jax.numpy.ndarray.at()：使用 NumPy 样式索引进行数组更新。

• jax.numpy.take()：在给定索引处从数组中提取值。

示例

>>> x = jnp.zeros(5, dtype=int)
>>> indices = jnp.array([0, 2, 4])
>>> values = jnp.array([10, 20, 30])
>>> jnp.put(x, indices, values, inplace=False)
Array([10,  0, 20,  0, 30], dtype=int32)

这等效于以下 jax.numpy.ndarray.at 索引语法

>>> x.at[indices].set(values)
Array([10,  0, 20,  0, 30], dtype=int32)

有两种模式用于处理越界索引。默认情况下，它们会被剪裁

>>> indices = jnp.array([0, 2, 6])
>>> jnp.put(x, indices, values, inplace=False, mode='clip')
Array([10,  0, 20,  0, 30], dtype=int32)

或者，可以将它们包裹到数组的开头

>>> jnp.put(x, indices, values, inplace=False, mode='wrap')
Array([10,  30, 20,  0, 0], dtype=int32)

对于 N 维输入，索引指向扁平化数组

>>> x = jnp.zeros((3, 5), dtype=int)
>>> indices = jnp.array([0, 7, 14])
>>> jnp.put(x, indices, values, inplace=False)
Array([[10,  0,  0,  0,  0],
       [ 0,  0, 20,  0,  0],
       [ 0,  0,  0,  0, 30]], dtype=int32)