nlcpy.diagflat

nlcpy.diagflat(v, k=0)

Creates a two-dimensional array with the flattened input as a diagonal.

Parameters

varray_like

Input data, which is flattened and set as the k-th diagonal of the output.

kint, optional

Diagonal to set; 0, the default, corresponds to the “main” diagonal, a positive (negative) k giving the number of the diagonal above (below) the main.

Returns

outndarray

The 2-D output array.

See also

diag

Extracts a diagonal or construct a diagonal array.

diagonal

Returns specified diagonals.

Examples

>>> import nlcpy as vp
>>> vp.diagflat([[1,2], [3,4]])
array([[1, 0, 0, 0],
       [0, 2, 0, 0],
       [0, 0, 3, 0],
       [0, 0, 0, 4]])

>>> vp.diagflat([1,2], 1)
array([[0, 1, 0],
       [0, 0, 2],
       [0, 0, 0]])