Skip to content

Rename (Minimum)EigensolverResult.aux_operator_eigenvalues from "eigenvalues" to just "values"#8053

Closed
Cryoris wants to merge 5 commits into
Qiskit:mainfrom
Cryoris:rename-auxops-values
Closed

Rename (Minimum)EigensolverResult.aux_operator_eigenvalues from "eigenvalues" to just "values"#8053
Cryoris wants to merge 5 commits into
Qiskit:mainfrom
Cryoris:rename-auxops-values

Conversation

@Cryoris
Copy link
Copy Markdown
Collaborator

@Cryoris Cryoris commented May 11, 2022

Summary

The eigensolver algorithms allow the evaluation of the expectation value of auxiliary operators at the final optimal point. These expectation values are generally not the eigenvalue of the auxiliary operators. However we currently store these expectations in an attribute called aux_operator_eigenvalues which is a bit misleading. This commit renames the attribute to just aux_operator_values to reflect that it's not an eigenvalue.

@Cryoris Cryoris requested review from a team, manoelmarques and woodsp-ibm as code owners May 11, 2022 16:46
@qiskit-bot
Copy link
Copy Markdown
Collaborator

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 the following people are requested to review this:

Comment thread qiskit/algorithms/eigen_solvers/eigen_solver.py
@coveralls
Copy link
Copy Markdown

Pull Request Test Coverage Report for Build 2308497351

  • 39 of 39 (100.0%) changed or added relevant lines in 6 files are covered.
  • 4 unchanged lines in 1 file lost coverage.
  • Overall coverage increased (+0.004%) to 84.381%

Files with Coverage Reduction New Missed Lines %
qiskit/utils/deprecation.py 4 85.19%
Totals Coverage Status
Change from base Build 2307415935: 0.004%
Covered Lines: 54515
Relevant Lines: 64606

💛 - Coveralls

Comment thread qiskit/algorithms/eigen_solvers/eigen_solver.py Outdated
Comment thread qiskit/algorithms/eigen_solvers/eigen_solver.py Outdated
Comment thread qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py Outdated
Comment thread qiskit/algorithms/minimum_eigen_solvers/minimum_eigen_solver.py Outdated
Co-authored-by: Steve Wood <40241007+woodsp-ibm@users.noreply.github.com>
@Cryoris
Copy link
Copy Markdown
Collaborator Author

Cryoris commented Oct 11, 2022

This has been addressed by #8702 where the result has been renamed to aux_operators_evaluated 🙂

@Cryoris Cryoris closed this Oct 11, 2022
@Cryoris Cryoris deleted the rename-auxops-values branch October 11, 2022 15:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants