nums.numpy.identity

nums.numpy.identity(n, dtype=<class 'float'>)

Return the identity array.

This docstring was copied from numpy.identity.

Some inconsistencies with the NumS version may exist.

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 – n x n array with its main diagonal set to one, and all other elements 0.

Return type

BlockArray

Examples

The doctests shown below are copied from NumPy. They won’t show the correct result until you operate get().

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