This is documentation for an old release of NumPy (version 1.18). Read this page Search for this page in the documentation of the latest stable release (version 2.2).

numpy.matlib.identity

numpy.matlib.identity(n, dtype=None)

Returns the square identity matrix of given size.

Parameters

nint

Size of the returned identity matrix.

dtypedata-type, optional

Data-type of the output. Defaults to float.

Returns

outmatrix

n x n matrix with its main diagonal set to one, and all other elements zero.

See also

numpy.identity

Equivalent array function.

matlib.eye

More general matrix identity function.

Examples

>>>

>>> import numpy.matlib
>>> np.matlib.identity(3, dtype=int)
matrix([[1, 0, 0],
        [0, 1, 0],
        [0, 0, 1]])