ffsim.testing.generate_norb_nelec_spin¶

ffsim.testing.generate_norb_nelec_spin(*, exhaustive=True, norb_range=None, include_norb_zero=True)[source]¶

Generate (norb, nelec, spin) tuples for testing.

Parameters:

exhaustive (bool) – If True, generates all possible (norb, nelec, spin) triplets for each norb in norb_range. If False, yields a small representative set covering edge cases, ignoring norb_range.
norb_range (Iterable[int] | None) – Range of choices for norb. Required when exhaustive=True.
include_norb_zero (bool) – Whether to include the case norb=0. Default: True.

Return type:

Iterator[tuple[int, tuple[int, int], Spin]]