bundles / numpy 2.4.3 / numpy / eye
_ArrayFunctionDispatcher
numpy:eye
Signature
def eye ( N , M = None , k = 0 , dtype = <class 'float'> , order = C , * , device = None , like = None ) Summary
Return a 2-D array with ones on the diagonal and zeros elsewhere.
Parameters
N: intNumber of rows in the output.
M: int, optionalNumber of columns in the output. If None, defaults to
N.k: int, optionalIndex 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, optionalData-type of the returned array.
order: {'C', 'F'}, optionalWhether the output should be stored in row-major (C-style) or column-major (Fortran-style) order in memory.
device: str, optionalThe device on which to place the created array. Default: None. For Array-API interoperability only, so must be
"cpu"if passed.like: array_like, optionalReference object to allow the creation of arrays which are not NumPy arrays. If an array-like passed in as
likesupports the__array_function__protocol, the result will be defined by it. In this case, it ensures the creation of an array object compatible with that passed in via this argument.
Returns
I: ndarray of shape (N,M)An array where all elements are equal to zero, except for the
k-th diagonal, whose values are equal to one.
Examples
import numpy as np np.eye(2, dtype=int)✓
np.eye(3, k=1)
✗See also
- diag
diagonal 2-D array from a 1-D array specified by the user.
- identity
(almost) equivalent function
Aliases
-
numpy.eye -
numpy.lib._twodim_base_impl._eye_with_like