function is_diagonal_matrix

deeptime.numeric.is_diagonal_matrix(matrix: ndarray) → bool

Checks whether a provided matrix is a diagonal matrix, i.e., $A = \mathrm{diag}(a_1,\ldots, a_n)$.

Parameters:

matrix (ndarray) – The matrix for which this check is performed.

Returns:

is_diagonal – True if the matrix is a diagonal matrix, otherwise False.

Return type:

bool