Pretty-printing for Statevec and DensityMatrix (closes #501)#524
Open
Vinny010 wants to merge 4 commits into
Open
Pretty-printing for Statevec and DensityMatrix (closes #501)#524Vinny010 wants to merge 4 commits into
Vinny010 wants to merge 4 commits into
Conversation
…x#501) Add human-friendly rendering of quantum amplitudes and states: - `complex_to_str` in `pretty_print.py` recognizes common values and renders them exactly instead of as floats: fractions (`1/4`), square roots (`√2/2`) and complex exponentials (`e^(iπ/3)`). Recognition uses a square-then-rationalize heuristic and reuses the existing `angle_to_str` for the exponential phase. Supports ASCII, Unicode and LaTeX output. - `statevec_to_str` + `Statevec.draw` render a statevector in ket notation (e.g. `√2/2|00⟩ + √2/2|01⟩`), honouring the existing `encoding` parameter from `Statevec.to_dict`. - `density_matrix_to_str` + `DensityMatrix.draw` render a density matrix as a column-aligned grid (ASCII/Unicode) or a LaTeX `pmatrix`. - Tests covering the issue examples plus edge cases (zero, negative, pure imaginary, LaTeX, decimal fallback, symbolic), with numpy-style docs. Co-Authored-By: Claude Opus 4.8 <[email protected]>
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #524 +/- ##
==========================================
+ Coverage 88.85% 89.00% +0.14%
==========================================
Files 49 49
Lines 7135 7311 +176
==========================================
+ Hits 6340 6507 +167
- Misses 795 804 +9 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Cover the exponential-with-radius, cartesian, complex-decimal-fallback and LaTeX/ASCII imaginary branches of complex_to_str, the integer-times-root render path, and the negative-term, parenthesized-coefficient and unit-negative branches of Statevec.draw, addressing the patch-coverage gap reported on the PR. Co-Authored-By: Claude Opus 4.8 <[email protected]>
Build the complex-amplitude statevec from a numpy array (numpy.complex128) rather than a Python complex literal: Python's complex only gained __complex__ in 3.11, so a bare complex is not a typing.SupportsComplex on 3.10 and is rejected by Statevec. Also use a real amplitude for the unit-negative case. Co-Authored-By: Claude Opus 4.8 <[email protected]>
This was referenced Jun 4, 2026
Collaborator
thierry-martinez
left a comment
thierry-martinez
left a comment
There was a problem hiding this comment.
Thank you very much for your contribution!
Codecov has detected that some parts of your code are not tested.
As you may have noticed, PR #503 and PR #523 address the same issue (#501). We invite you to cross‑review each other's work: PR reviews are an inherent part of software development, just as important as writing code. Moreover, this review process will help you position your PR relative to the others, allowing us to determine which contribution best addresses the issue.
| """Fallback formatting using rounded decimals.""" | ||
| unit = _imaginary_unit(output) | ||
| if abs(z.imag) <= _DEFAULT_ATOL: | ||
| return f"{z.real:.4g}" |
Collaborator
There was a problem hiding this comment.
We should be able to configure the precision of the printed value.
| return outer, inner | ||
|
|
||
|
|
||
| def _recognize_real(x: float, max_denominator: int, atol: float) -> tuple[int, int, int] | None: |
Collaborator
There was a problem hiding this comment.
The name _recognize_real feels overly generic; would _recognize_sqrt be a better fit?
- Add a ``precision`` keyword argument to :func:`complex_to_str`, :func:`statevec_to_str`, :func:`density_matrix_to_str` and the matching :meth:`Statevec.draw` / :meth:`DensityMatrix.draw` methods to control the number of significant digits of the decimal fallback. The default value (``4``) preserves the previous behaviour, and a regression test exercises multiple precisions. - Rename ``_recognize_real`` to ``_recognize_sqrt`` to better reflect the ``signed_num * sqrt(inner) / den`` form the helper returns (pure rationals are covered as ``inner == 1``); update the docstring accordingly. Co-Authored-By: Claude Opus 4.8 <[email protected]>
Author
|
Thanks for the review, @thierry-martinez! Pushed eebb104 addressing both inline points:
I'll have a look at #503 and #523 and follow up with comments there. |
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
2 participants
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.
Closes #501.
Adds human-friendly rendering of amplitudes and states:
complex_to_str— renders common values exactly (1/4,√2/2,e^(iπ/3)) via a square-then-rationalize heuristic, reusing the existingangle_to_strfor the exponential phase. Supports ASCII / Unicode / LaTeX.statevec_to_str+Statevec.draw— ket notation, honouring theto_dictencodingparameter (e.g.√2/2|00⟩ + √2/2|01⟩).density_matrix_to_str+DensityMatrix.draw— column-aligned grid (ASCII/Unicode) or LaTeXpmatrix.Passes
ruff check,ruff format,mypy --strict, andpytestlocally (167 tests in the affected suites).Design points I'd value feedback on:
draw()returns astr, consistent with the existingto_unicode/to_latexstyle.Happy to adjust either.
Developed with LLM assistance, reviewed and tested by me.