numpy.identity

numpy.identity(n, dtype=None, *, like=None) [source]

Return the identity array.

The identity array is a square array with ones on the main diagonal.

Parameters

nint

Number of rows (and columns) in n x n output.

dtypedata-type, optional

Data-type of the output. Defaults to float.

likearray_like

Reference object to allow the creation of arrays which are not NumPy arrays. If an array-like passed in as like supports 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.

Note

The like keyword is an experimental feature pending on acceptance of NEP 35.

New in version 1.20.0.

Returns

outndarray

n x n array with its main diagonal set to one, and all other elements 0.

Examples

>>> np.identity(3)
array([[1.,  0.,  0.],
       [0.,  1.,  0.],
       [0.,  0.,  1.]])