Document InteractionOperator Hermitian assumptions#1306
Open
matti-sarjala wants to merge 1 commit into
Open
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. |
Contributor
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.