Qiskit / qiskit-fermions / 25155347065

98%

push

github

feat: add the `sandwich` argument to `FermionOperator.normal_ordered` (#81)

* feat: add the `sandwich` argument to `FermionOperator.normal_ordered`

The normal-ordering of the `FermionOperator` is always sorting the
creation and annihilation operators by descending indices. This commit
adds a new argument to the function which permits the order to become a
"sandwich" order, where one group has ascending and the other descending
indices (depending on the boolean value of the `sandwich` argument).
Although still corresponding to the same operator, this form can be more
natural to work with in certain scenarios so it makes sense to make it
easy to access for our users.

* docs: for the `sandwich` argument of `FermionOperator.normal_ordered`

* fix: grammar

89 of 89 new or added lines in 5 files covered. (100.0%)

4229 of 4310 relevant lines covered (98.12%)

221.77 hits per line