nlcpy.eye

nlcpy.eye(N, M=None, k=0, dtype=<class 'float'>, order='C')

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

Parameters

Nint

Number of rows in the output.

Mint, optional

Number of columns in the output. If None, defaults to N.

kint, 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.

dtypedtype, optional

Data-type of the returned array.

order{‘C’, ‘F’}, optional

Whether the output should be stored in row-major (C-style) or column-major (Fortran-style) order in memory.

Returns

Indarray

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

See also

identity

Returns the identity array.

diag

Extracts a diagonal or construct a diagonal array.

Examples

>>> import nlcpy as vp
>>> vp.eye(2, dtype=int)
array([[1, 0],
       [0, 1]])
>>> vp.eye(3, k=1)
array([[0., 1., 0.],
       [0., 0., 1.],
       [0., 0., 0.]])