is_identity_matrix¶
-
forest.benchmarking.operator_tools.validate_operator.
is_identity_matrix
(matrix: numpy.ndarray, rtol: float = 1e-05, atol: float = 1e-08) → bool¶ Checks if a square matrix is the identity matrix.
Parameters: - matrix – a M by M matrix.
- rtol – The relative tolerance parameter in np.allclose
- atol – The absolute tolerance parameter in np.allclose
Returns: True if the matrix is the identity matrix; False otherwise.