[work in progress] Clarify "conjugate" method purpose #13395
Conversation
qiskit-bot
added
the
Community PR
|
Thank you for opening a new pull request. Before your PR can be merged it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient. While you're waiting, please feel free to review other open PRs. While only a subset of people are authorized to approve pull requests for merging, everyone is encouraged to review open pull requests. Doing reviews helps reduce the burden on the core team and helps make the project's code better for everyone. One or more of the following people are relevant to this code:
|
Pull Request Test Coverage Report for Build 11684304427Warning: This coverage report may be inaccurate.This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.
Details
💛 - Coveralls |
| @@ -123,7 +123,7 @@ def inverse(self, annotated: bool = False): | |||
| return self.adjoint() | |||
|
|
|||
| def conjugate(self): | |||
| """Return the conjugate of the unitary.""" | |||
| """Return the complex conjugate of the unitary with respect to the representation returned by ``to_matrix``.""" | |||
There was a problem hiding this comment.
consider linking to the method:
| """Return the complex conjugate of the unitary with respect to the representation returned by ``to_matrix``.""" | |
| """Return the complex conjugate of the unitary with respect to the representation returned by :meht:`~UnitaryGate.to_matrix`.""" |
| @@ -291,6 +291,7 @@ def __setitem__(self, key, value): | |||
| # --------------------------------------------------------------------- | |||
|
|
|||
| def conjugate(self): | |||
| """Return the complex conjugate with respect to the representation returned by ``to_matrix``.""" | |||
There was a problem hiding this comment.
consider linking to the method:
| """Return the complex conjugate with respect to the representation returned by ``to_matrix``.""" | |
| """Return the complex conjugate with respect to the representation returned by :meth:`~SparsePauliOp.to_matrix`.""" |
Summary
Implements #13322
Details and comments
Below I have listed each
conjugatemethod as returned by this search query, together with the reason why or why not the doc string has been updated.to_matrixmethod, so reference to this basis is made.conjugatemethod returns the conjugate of theClifford(operator) used to create theStabilizerState. As such, I have referenced the basis returned by the operator'sto_matrixmethod.to_matrixmethod, so reference to this basis is made.