numpy.eye() in Python

numpy.eye() in Python: The eye() method of Python numpy class returns a 2-D array with ones on the diagonal and zeros elsewhere.

Syntax

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

Parameters

The numpy.eye()  method consists of five parameters, which are as follows:

N : It represents the number of rows.

M : It represents the number of columns.  It an optional argument and by default M(number of columns) = N(Number of Rows)

k : [int, optional, 0 by default] This argument represents the  Diagonal. By default k=0.  A positive value (k>0) refers to an upper diagonal, and a negative value(k<0) to a lower diagonal.

dtype : It is an optional parameter. It depicts the data type of returned array, and by default, it is a float.

order : The order parameter can be either C_contiguous or F_contiguous

Return Value

The numpy.eye() method returns an array of shape, R x C, where all elements are equal to zero, except for the k^th diagonal, whose values are equal to one.

Example 1

# Python Programming giving an example for
# numpy.eye() method
import numpy as numpy
# 2x2 matrix with 1's on main diagonal
obj1 = numpy.eye(2, dtype = float)
print("Matrix : \n", obj1)
# matrix with Row=2 Column=3 and diagonal=1
obj2 = numpy.eye(2, 3, k = 1)
print("\nMatrix : \n", obj2)

Output

Matrix :
[[ 1.  0.]
[ 0.  1.]]
Matrix  :
[[ 0.  1.  0.]
[ 0.  0.  1.]]