numpy.matlib.eye
-
numpy.matlib.eye(n, M=None, k=0, dtype=<class 'float'>, order='C')
[source] -
Return a matrix 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, defaults to
n
.k : int, optional
Index 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, optional
Data-type of the returned matrix.
order : {‘C’, ‘F’}, optional
Whether the output should be stored in row-major (C-style) or column-major (Fortran-style) order in memory.
New in version 1.14.0.
Returns: I : matrix
A
n
xM
matrix 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.]])
© 2005–2019 NumPy Developers
Licensed under the 3-clause BSD License.
https://docs.scipy.org/doc/numpy-1.14.5/reference/generated/numpy.matlib.eye.html