ffsim.random.random_real_symmetric_matrix¶

ffsim.random.random_real_symmetric_matrix(dim, *, rank=None, seed=None, dtype=<class 'float'>)[source]¶

Return a random real symmetric matrix.

Parameters:

dim (int) – The width and height of the matrix.
rank (int | None) – The rank of the matrix. If None, the maximum rank is used.
seed – The pseudorandom number generator or seed. Should be an instance of np.random.Generator or else a valid input to np.random.default_rng.

Return type:

ndarray

Returns:

The sampled real symmetric matrix.