cupynumeric.eye#

cupynumeric.eye( N: int, M: int | None = None, k: int = 0, dtype: npt.DTypeLike | None = <class 'numpy.float64'>, ) → ndarray#

Return a 2-D array with ones on the diagonal and zeros elsewhere.

Parameters:

N (int) – Number of rows in the output.
M (int, optional) – Number of columns in the output. If None, defaults to N.
k (int, optional) – Index of the diagonal: 0 (the default) refers to the main diagonal, a positive value refers to an upper diagonal, and a negative value to a lower diagonal.
dtype (data-type, optional) – Data-type of the returned array.

Returns:

I – An array of shape (N, M) where all elements are equal to zero, except for the k-th diagonal, whose values are equal to one.

Return type:

ndarray