bundles / numpy 2.4.3 / numpy / matlib / eye
function
numpy.matlib:eye
source: /numpy/matlib.py:191
Signature
def eye(n, M = None, k = 0, dtype = <class 'float'>, order = C)Summary
Return a matrix with ones on the diagonal and zeros elsewhere.
Parameters
n: intNumber of rows in the output.
M: int, optionalNumber of columns in the output, defaults to
n.k: int, optionalIndex of the diagonal: 0 refers to the main diagonal, a positive value refers to an upper diagonal, and a negative value to a lower diagonal.
dtype: dtype, optionalData-type of the returned matrix.
order: {'C', 'F'}, optionalWhether the output should be stored in row-major (C-style) or column-major (Fortran-style) order in memory.
Returns
I: matrixA
nxMmatrix where all elements are equal to zero, except for thek-th diagonal, whose values are equal to one.
Examples
import numpy.matlib
✓np.matlib.eye(3, k=1, dtype=float)
✗matrix([[0., 1., 0.],
[0., 0., 1.],
[0., 0., 0.]])
See also
Aliases
numpy.matlib.eye