Document InteractionOperator Hermitian assumptions#1306
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
There was a problem hiding this comment.
Code Review
This pull request updates the docstring for the InteractionOperator class to clarify that it is intended for Hermitian interaction Hamiltonians, such as molecular electronic-structure Hamiltonians, and is not a general-purpose container for non-Hermitian fermionic operators. No review comments were provided, so I have no feedback to offer.
mhucka
left a comment
There was a problem hiding this comment.
This looks good. Thank you for the contribution!
Fixes #479.
This updates the
InteractionOperatordocstring to clarify that the representation is intended for Hermitian interaction Hamiltonians, such as molecular electronic-structure Hamiltonians.For arbitrary non-Hermitian fermionic operators, users should use
FermionOperator. This is important because transform routines specialized forInteractionOperatormay rely on Hermitian structure assumptions.