nums.numpy.eye

nums.numpy.eye(N, M=None, k=0, dtype=<class 'float'>)[source]

Return a 2-D array with ones on the diagonal and zeros elsewhere.

This docstring was copied from numpy.eye.

Some inconsistencies with the NumS version may exist.

Parameters

N (int) – Number of rows in the output.
M (int, optional) – Number of columns in the output. If None, defaults to N.
k (int, optional) – Index of the diagonal: 0 (the default) refers to the main diagonal, a positive value refers to an upper diagonal, and a negative value to a lower diagonal.
dtype (data-type, optional) – Data-type of the returned array.

Returns

I – An array where all elements are equal to zero, except for the k-th diagonal, whose values are equal to one.

Return type

BlockArray of shape (N,M)

See also

identity: (almost) equivalent function
diag: diagonal 2-D array from a 1-D array specified by the user.

Notes

Only k==0 is currently supported.

Examples

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

>>> nps.eye(2, dtype=int).get()  
array([[1, 0],
       [0, 1]])
>>> nps.eye(3, k=1).get()  
array([[0.,  1.,  0.],
       [0.,  0.,  1.],
       [0.,  0.,  0.]])

nums.numpy.identity

nums.numpy.diag