ffsim.testing.generate_norb_nocc

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

Generate (norb, nocc) tuples for testing.

nocc refers to the occupation of a single spin species, so it ranges from 0 to norb.

Parameters:
  • exhaustive (bool) – If True, generates all possible (norb, nocc) pairs 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, int]]