vector.matrixbuilder.diagonal.md

Home > @josh-brown/vector > MatrixBuilder > diagonal

MatrixBuilder.diagonal() method

Constructs a square diagonal matrix whose diagonal entries come from diagonalEntries

Signature:

diagonal(diagonalEntries: Vector<S>): M;

Parameters

Parameter	Type	Description
diagonalEntries	Vector<S>	A vector whose entries will be used as the diagonal entries of the new matrix

Returns:

M

The new matrix

Example

const diagonalEntries = NumberVector.fromValues(1, 2, 3);
matrixBuilder.diagonal(diagonalEntries);

// [ 1 0 0 ]
// [ 0 2 0 ]
// [ 0 0 3 ]