numpy.diagflat() in Python

numpy.diagflat() in Python

The diagflat() function of Python numpy class creates a two-dimensional array with the array_like input as a diagonal to the new output array.

Syntax

numpy.diagflat (a, k = 0)

Parameter

a : It represents the array_like input data with diagonal  elements

k: It represents the diagonal value that we require. It is an optional parameter, and its default value is 0. If k>0, the diagonal is above the main diagonal or vice versa.

Return

This function returns the 2-D output array as a diagonal to the new array(ndarray).

Example 1

# Python Programming explaining
# numpy.diagflat() function
import numpy as np
print("diagflat use on main diagonal : \n", np.diagflat([14, 71]))
print("diagflat use on main diagonal : \n", np.diagflat([15, 27, 46]))
# Diagnol above main diagnol
print("diagflat above main diagonal : \n", np.diagflat([51, 67, 69], 1))
print("diagflat above main diagonal : \n", np.diagflat([51, 67, 69], 2))

Output

diagflat use on main diagonal :
[[14  0]
[ 0 71]]
diagflat use on main diagonal :
[[15  0  0]
[ 0 27  0]
[ 0  0 46]]
diagflat above main diagonal :
[[ 0 51  0  0]
[ 0  0 67  0]
[ 0  0  0 69]
[ 0  0  0  0]]
diagflat above main diagonal :
[[ 0  0 51  0  0]
[ 0  0  0 67  0]
[ 0  0  0  0 69]
[ 0  0  0  0  0]
[ 0  0  0  0  0]]