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

numpy.ma.identity

numpy.ma.identity(n, dtype=None) = <numpy.ma.core._convert2ma object>

Return the identity array.

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

Parameters:

n : int

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

dtype : data-type, optional

Data-type of the output. Defaults to float.

Returns:

out : ndarray

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.]])