{ } Raw JSON

bundles / numpy 2.4.4 / numpy / matlib / eye

function

numpy.matlib:eye

source: /numpy/matlib.py :191

Signature

def   eye ( n M = None k = 0 dtype = <class 'float'> order = C )

Summary

Return a matrix with ones on the diagonal and zeros elsewhere.

Parameters

n : int

Number of rows in the output.

M : int, optional

Number of columns in the output, defaults to n.

k : int, optional

Index of the diagonal: 0 refers to the main diagonal, a positive value refers to an upper diagonal, and a negative value to a lower diagonal.

dtype : dtype, optional

Data-type of the returned matrix.

order : {'C', 'F'}, optional

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

Returns

I : matrix

A n x M matrix where all elements are equal to zero, except for the k-th diagonal, whose values are equal to one.

Examples

import numpy.matlib
np.matlib.eye(3, k=1, dtype=float)

See also

identity

Square identity matrix.

numpy.eye

Equivalent array function.

Aliases

  • numpy.matlib.eye