ffsim.linalg.is_real_symmetric

ffsim.linalg.is_real_symmetric(mat, *, rtol=1e-05, atol=1e-08)[source]

Determine if a matrix is real and approximately symmetric.

Parameters:
  • mat (ndarray) – The matrix.

  • rtol (float) – Relative numerical tolerance.

  • atol (float) – Absolute numerical tolerance.

Return type:

bool | bool

Returns:

Whether the matrix is real and symmetric within the given tolerance.