Skip to content

Fix API docstring math and ASCII rendering #8259

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
huangtina22 wants to merge 3 commits into
base: main
Choose a base branch
from
+20 −14
Open

Fix API docstring math and ASCII rendering #8259

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
13cf009
Fix API docstring math and ASCII rendering.
huangtina22 Aug 6, 2026
1e58ddf
Put display math on separate lines in docstring.
huangtina22 Aug 6, 2026
817f0d7
Merge branch 'main' into fix/docs-latex-uniform-superposition-8212
huangtina22 Aug 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions cirq-core/cirq/ops/uniform_superposition_gate.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,15 @@

@value.value_equality
class UniformSuperpositionGate(raw_types.Gate):
r"""Creates a uniform superposition state on the states $[0, M)$
The gate creates the state $\frac{1}{\sqrt{M}}\sum_{j=0}^{M-1}\ket{j}$
(where $1\leq M \leq 2^n$), using n qubits, according to the Shukla-Vedula algorithm [SV24].
r"""Creates a uniform superposition state on the states $[0, M)$.

The gate creates the state
$$
\frac{1}{\sqrt{M}}\sum_{j=0}^{M-1}|j\rangle
$$
(where $1 \leq M \leq 2^n$), using n qubits, according to the
Shukla-Vedula algorithm [SV24].

References:
[SV24]
[An efficient quantum algorithm for preparation of uniform quantum superposition
Expand Down
22 changes: 11 additions & 11 deletions cirq-core/cirq/vis/histogram.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,17 +41,17 @@ def integrated_histogram(
Suppose the input is a list of gate fidelities. The x-axis of the plot will
be gate fidelity, and the y-axis will be the probability that a random gate
fidelity from the list is less than the x-value. It will look something like
this

1.0
| |
| ___|
| |
| ____|
| |
| |
|_____|_______________
0.0
this:

1.0
| |
| ___|
| |
| ____|
| |
| |
|_____|_______________
0.0

Another way of saying this is that we assume the probability distribution
function (pdf) of gate fidelities is a set of equally weighted delta
Expand Down
Loading