cupy.fill_diagonal#

cupy.fill_diagonal(a, val, wrap=False)[source]#

Fills the main diagonal of the given array of any dimensionality.

For an array a with a.ndim > 2, the diagonal is the list of locations with indices a[i, i, ..., i] all identical. This function modifies the input array in-place, it does not return a value.

Parameters:

a (cupy.ndarray) – The array, at least 2-D.
val (scalar) – The value to be written on the diagonal. Its type must be compatible with that of the array a.
wrap (bool) – If specified, the diagonal is “wrapped” after N columns. This affects only tall matrices.

Examples

>>> a = cupy.zeros((3, 3), int)
>>> cupy.fill_diagonal(a, 5)
>>> a
array([[5, 0, 0],
       [0, 5, 0],
       [0, 0, 5]])