Skip to content

Commit

Permalink
Fix LaTeX equations for KaTeX (Qiskit#11435)
Browse files Browse the repository at this point in the history 
* fix tex by replacing \th with \rotationangle

* fix line too long
  • Loading branch information
@kevinsung
kevinsung authored Dec 20, 2023
1 parent 238f38a commit b145420
Show file tree
Hide file tree
Showing 15 changed files with 115 additions and 109 deletions.
2 changes: 1 addition & 1 deletion docs/conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,11 @@
"sphinx.ext.napoleon",
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"sphinx.ext.mathjax",
"sphinx.ext.intersphinx",
"sphinx.ext.doctest",
"matplotlib.sphinxext.plot_directive",
"reno.sphinxext",
"sphinxcontrib.katex",
]

templates_path = ["_templates"]
Expand Down
10 changes: 5 additions & 5 deletions qiskit/circuit/library/generalized_gates/rv.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,14 @@ class RVGate(Gate):
.. math::
\newcommand{\th}{|\vec{v}|}
\newcommand{\rotationangle}{|\vec{v}|}
\newcommand{\sinc}{\text{sinc}}
R(\vec{v}) = e^{-i \vec{v}\cdot\vec{\sigma}} =
\begin{pmatrix}
\cos\left(\th\right) -i v_z \sinc\left(\th\right)
& -(i v_x + v_y) \sinc\left(\th\right) \\
-(i v_x - v_y) \sinc\left(\th\right)
& \cos\left(\th\right) + i v_z \sinc\left(\th\right)
\cos\left(\rotationangle\right) -i v_z \sinc\left(\rotationangle\right)
& -(i v_x + v_y) \sinc\left(\rotationangle\right) \\
-(i v_x - v_y) \sinc\left(\rotationangle\right)
& \cos\left(\rotationangle\right) + i v_z \sinc\left(\rotationangle\right)
\end{pmatrix}
"""

Expand Down
6 changes: 3 additions & 3 deletions qiskit/circuit/library/n_local/excitation_preserving.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@ class ExcitationPreserving(TwoLocal):
.. math::
\newcommand{\th}{\theta/2}
\newcommand{\rotationangle}{\theta/2}
\begin{pmatrix}
1 & 0 & 0 & 0 \\
0 & \cos\left(\th\right) & -i\sin\left(\th\right) & 0 \\
0 & -i\sin\left(\th\right) & \cos\left(\th\right) & 0 \\
0 & \cos\left(\rotationangle\right) & -i\sin\left(\rotationangle\right) & 0 \\
0 & -i\sin\left(\rotationangle\right) & \cos\left(\rotationangle\right) & 0 \\
0 & 0 & 0 & e^{-i\phi}
\end{pmatrix}
Expand Down
8 changes: 4 additions & 4 deletions qiskit/circuit/library/standard_gates/r.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,12 @@ class RGate(Gate):
.. math::
\newcommand{\th}{\frac{\theta}{2}}
\newcommand{\rotationangle}{\frac{\theta}{2}}
R(\theta, \phi) = e^{-i \th \left(\cos{\phi} x + \sin{\phi} y\right)} =
R(\theta, \phi) = e^{-i \rotationangle \left(\cos{\phi} x + \sin{\phi} y\right)} =
\begin{pmatrix}
\cos\left(\th\right) & -i e^{-i \phi} \sin\left(\th\right) \\
-i e^{i \phi} \sin\left(\th\right) & \cos\left(\th\right)
\cos\left(\rotationangle\right) & -i e^{-i \phi} \sin\left(\rotationangle\right) \\
-i e^{i \phi} \sin\left(\rotationangle\right) & \cos\left(\rotationangle\right)
\end{pmatrix}
"""

Expand Down
20 changes: 10 additions & 10 deletions qiskit/circuit/library/standard_gates/rx.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,12 @@ class RXGate(Gate):
.. math::
\newcommand{\th}{\frac{\theta}{2}}
\newcommand{\rotationangle}{\frac{\theta}{2}}
RX(\theta) = \exp\left(-i \th X\right) =
RX(\theta) = \exp\left(-i \rotationangle X\right) =
\begin{pmatrix}
\cos\left(\th\right) & -i\sin\left(\th\right) \\
-i\sin\left(\th\right) & \cos\left(\th\right)
\cos\left(\rotationangle\right) & -i\sin\left(\rotationangle\right) \\
-i\sin\left(\rotationangle\right) & \cos\left(\rotationangle\right)
\end{pmatrix}
"""

Expand Down Expand Up @@ -133,15 +133,15 @@ class CRXGate(ControlledGate):
.. math::
\newcommand{\th}{\frac{\theta}{2}}
\newcommand{\rotationangle}{\frac{\theta}{2}}
CRX(\theta)\ q_0, q_1 =
I \otimes |0\rangle\langle 0| + RX(\theta) \otimes |1\rangle\langle 1| =
\begin{pmatrix}
1 & 0 & 0 & 0 \\
0 & \cos\left(\th\right) & 0 & -i\sin\left(\th\right) \\
0 & \cos\left(\rotationangle\right) & 0 & -i\sin\left(\rotationangle\right) \\
0 & 0 & 1 & 0 \\
0 & -i\sin\left(\th\right) & 0 & \cos\left(\th\right)
0 & -i\sin\left(\rotationangle\right) & 0 & \cos\left(\rotationangle\right)
\end{pmatrix}
.. note::
Expand All @@ -160,15 +160,15 @@ class CRXGate(ControlledGate):
.. math::
\newcommand{\th}{\frac{\theta}{2}}
\newcommand{\rotationangle}{\frac{\theta}{2}}
CRX(\theta)\ q_1, q_0 =
|0\rangle\langle0| \otimes I + |1\rangle\langle1| \otimes RX(\theta) =
\begin{pmatrix}
1 & 0 & 0 & 0 \\
0 & 1 & 0 & 0 \\
0 & 0 & \cos\left(\th\right) & -i\sin\left(\th\right) \\
0 & 0 & -i\sin\left(\th\right) & \cos\left(\th\right)
0 & 0 & \cos\left(\rotationangle\right) & -i\sin\left(\rotationangle\right) \\
0 & 0 & -i\sin\left(\rotationangle\right) & \cos\left(\rotationangle\right)
\end{pmatrix}
"""

Expand Down
12 changes: 6 additions & 6 deletions qiskit/circuit/library/standard_gates/rxx.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,14 @@ class RXXGate(Gate):
.. math::
\newcommand{\th}{\frac{\theta}{2}}
\newcommand{\rotationangle}{\frac{\theta}{2}}
R_{XX}(\theta) = \exp\left(-i \th X{\otimes}X\right) =
R_{XX}(\theta) = \exp\left(-i \rotationangle X{\otimes}X\right) =
\begin{pmatrix}
\cos\left(\th\right) & 0 & 0 & -i\sin\left(\th\right) \\
0 & \cos\left(\th\right) & -i\sin\left(\th\right) & 0 \\
0 & -i\sin\left(\th\right) & \cos\left(\th\right) & 0 \\
-i\sin\left(\th\right) & 0 & 0 & \cos\left(\th\right)
\cos\left(\rotationangle\right) & 0 & 0 & -i\sin\left(\rotationangle\right) \\
0 & \cos\left(\rotationangle\right) & -i\sin\left(\rotationangle\right) & 0 \\
0 & -i\sin\left(\rotationangle\right) & \cos\left(\rotationangle\right) & 0 \\
-i\sin\left(\rotationangle\right) & 0 & 0 & \cos\left(\rotationangle\right)
\end{pmatrix}
**Examples:**
Expand Down
20 changes: 10 additions & 10 deletions qiskit/circuit/library/standard_gates/ry.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,12 @@ class RYGate(Gate):
.. math::
\newcommand{\th}{\frac{\theta}{2}}
\newcommand{\rotationangle}{\frac{\theta}{2}}
RY(\theta) = \exp\left(-i \th Y\right) =
RY(\theta) = \exp\left(-i \rotationangle Y\right) =
\begin{pmatrix}
\cos\left(\th\right) & -\sin\left(\th\right) \\
\sin\left(\th\right) & \cos\left(\th\right)
\cos\left(\rotationangle\right) & -\sin\left(\rotationangle\right) \\
\sin\left(\rotationangle\right) & \cos\left(\rotationangle\right)
\end{pmatrix}
"""

Expand Down Expand Up @@ -132,15 +132,15 @@ class CRYGate(ControlledGate):
.. math::
\newcommand{\th}{\frac{\theta}{2}}
\newcommand{\rotationangle}{\frac{\theta}{2}}
CRY(\theta)\ q_0, q_1 =
I \otimes |0\rangle\langle 0| + RY(\theta) \otimes |1\rangle\langle 1| =
\begin{pmatrix}
1 & 0 & 0 & 0 \\
0 & \cos\left(\th\right) & 0 & -\sin\left(\th\right) \\
0 & \cos\left(\rotationangle\right) & 0 & -\sin\left(\rotationangle\right) \\
0 & 0 & 1 & 0 \\
0 & \sin\left(\th\right) & 0 & \cos\left(\th\right)
0 & \sin\left(\rotationangle\right) & 0 & \cos\left(\rotationangle\right)
\end{pmatrix}
.. note::
Expand All @@ -159,15 +159,15 @@ class CRYGate(ControlledGate):
.. math::
\newcommand{\th}{\frac{\theta}{2}}
\newcommand{\rotationangle}{\frac{\theta}{2}}
CRY(\theta)\ q_1, q_0 =
|0\rangle\langle 0| \otimes I + |1\rangle\langle 1| \otimes RY(\theta) =
\begin{pmatrix}
1 & 0 & 0 & 0 \\
0 & 1 & 0 & 0 \\
0 & 0 & \cos\left(\th\right) & -\sin\left(\th\right) \\
0 & 0 & \sin\left(\th\right) & \cos\left(\th\right)
0 & 0 & \cos\left(\rotationangle\right) & -\sin\left(\rotationangle\right) \\
0 & 0 & \sin\left(\rotationangle\right) & \cos\left(\rotationangle\right)
\end{pmatrix}
"""

Expand Down
12 changes: 6 additions & 6 deletions qiskit/circuit/library/standard_gates/ryy.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,14 @@ class RYYGate(Gate):
.. math::
\newcommand{\th}{\frac{\theta}{2}}
\newcommand{\rotationangle}{\frac{\theta}{2}}
R_{YY}(\theta) = \exp\left(-i \th Y{\otimes}Y\right) =
R_{YY}(\theta) = \exp\left(-i \rotationangle Y{\otimes}Y\right) =
\begin{pmatrix}
\cos\left(\th\right) & 0 & 0 & i\sin\left(\th\right) \\
0 & \cos\left(\th\right) & -i\sin\left(\th\right) & 0 \\
0 & -i\sin\left(\th\right) & \cos\left(\th\right) & 0 \\
i\sin\left(\th\right) & 0 & 0 & \cos\left(\th\right)
\cos\left(\rotationangle\right) & 0 & 0 & i\sin\left(\rotationangle\right) \\
0 & \cos\left(\rotationangle\right) & -i\sin\left(\rotationangle\right) & 0 \\
0 & -i\sin\left(\rotationangle\right) & \cos\left(\rotationangle\right) & 0 \\
i\sin\left(\rotationangle\right) & 0 & 0 & \cos\left(\rotationangle\right)
\end{pmatrix}
**Examples:**
Expand Down
20 changes: 10 additions & 10 deletions qiskit/circuit/library/standard_gates/rzx.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,14 +43,14 @@ class RZXGate(Gate):
.. math::
\newcommand{\th}{\frac{\theta}{2}}
\newcommand{\rotationangle}{\frac{\theta}{2}}
R_{ZX}(\theta)\ q_0, q_1 = \exp\left(-i \frac{\theta}{2} X{\otimes}Z\right) =
\begin{pmatrix}
\cos\left(\th\right) & 0 & -i\sin\left(\th\right) & 0 \\
0 & \cos\left(\th\right) & 0 & i\sin\left(\th\right) \\
-i\sin\left(\th\right) & 0 & \cos\left(\th\right) & 0 \\
0 & i\sin\left(\th\right) & 0 & \cos\left(\th\right)
\cos\left(\rotationangle\right) & 0 & -i\sin\left(\rotationangle\right) & 0 \\
0 & \cos\left(\rotationangle\right) & 0 & i\sin\left(\rotationangle\right) \\
-i\sin\left(\rotationangle\right) & 0 & \cos\left(\rotationangle\right) & 0 \\
0 & i\sin\left(\rotationangle\right) & 0 & \cos\left(\rotationangle\right)
\end{pmatrix}
.. note::
Expand All @@ -71,14 +71,14 @@ class RZXGate(Gate):
.. math::
\newcommand{\th}{\frac{\theta}{2}}
\newcommand{\rotationangle}{\frac{\theta}{2}}
R_{ZX}(\theta)\ q_1, q_0 = exp(-i \frac{\theta}{2} Z{\otimes}X) =
\begin{pmatrix}
\cos(\th) & -i\sin(\th) & 0 & 0 \\
-i\sin(\th) & \cos(\th) & 0 & 0 \\
0 & 0 & \cos(\th) & i\sin(\th) \\
0 & 0 & i\sin(\th) & \cos(\th)
\cos(\rotationangle) & -i\sin(\rotationangle) & 0 & 0 \\
-i\sin(\rotationangle) & \cos(\rotationangle) & 0 & 0 \\
0 & 0 & \cos(\rotationangle) & i\sin(\rotationangle) \\
0 & 0 & i\sin(\rotationangle) & \cos(\rotationangle)
\end{pmatrix}
This is a direct sum of RX rotations, so this gate is equivalent to a
Expand Down
12 changes: 6 additions & 6 deletions qiskit/circuit/library/standard_gates/rzz.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,14 @@ class RZZGate(Gate):
.. math::
\newcommand{\th}{\frac{\theta}{2}}
\newcommand{\rotationangle}{\frac{\theta}{2}}
R_{ZZ}(\theta) = \exp\left(-i \th Z{\otimes}Z\right) =
R_{ZZ}(\theta) = \exp\left(-i \rotationangle Z{\otimes}Z\right) =
\begin{pmatrix}
e^{-i \th} & 0 & 0 & 0 \\
0 & e^{i \th} & 0 & 0 \\
0 & 0 & e^{i \th} & 0 \\
0 & 0 & 0 & e^{-i \th}
e^{-i \rotationangle} & 0 & 0 & 0 \\
0 & e^{i \rotationangle} & 0 & 0 \\
0 & 0 & e^{i \rotationangle} & 0 \\
0 & 0 & 0 & e^{-i \rotationangle}
\end{pmatrix}
This is a direct sum of RZ rotations, so this gate is equivalent to a
Expand Down
40 changes: 22 additions & 18 deletions qiskit/circuit/library/standard_gates/u.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,13 @@ class UGate(Gate):
.. math::
\newcommand{\th}{\frac{\theta}{2}}
\newcommand{\rotationangle}{\frac{\theta}{2}}
U(\theta, \phi, \lambda) =
\begin{pmatrix}
\cos\left(\th\right) & -e^{i\lambda}\sin\left(\th\right) \\
e^{i\phi}\sin\left(\th\right) & e^{i(\phi+\lambda)}\cos\left(\th\right)
\end{pmatrix}
\begin{pmatrix}
\cos\left(\rotationangle\right) & -e^{i\lambda}\sin\left(\rotationangle\right) \\
e^{i\phi}\sin\left(\rotationangle\right) & e^{i(\phi+\lambda)}\cos\left(\rotationangle\right)
\end{pmatrix}
.. note::
Expand Down Expand Up @@ -190,16 +190,18 @@ class CUGate(ControlledGate):
.. math::
\newcommand{\th}{\frac{\theta}{2}}
\newcommand{\rotationangle}{\frac{\theta}{2}}
CU(\theta, \phi, \lambda, \gamma)\ q_0, q_1 =
I \otimes |0\rangle\langle 0| +
e^{i\gamma} U(\theta,\phi,\lambda) \otimes |1\rangle\langle 1| =
\begin{pmatrix}
1 & 0 & 0 & 0 \\
0 & e^{i\gamma}\cos(\th) & 0 & -e^{i(\gamma + \lambda)}\sin(\th) \\
0 & 0 & 1 & 0 \\
0 & e^{i(\gamma+\phi)}\sin(\th) & 0 & e^{i(\gamma+\phi+\lambda)}\cos(\th)
1 & 0 & 0 & 0 \\
0 & e^{i\gamma}\cos(\rotationangle) &
0 & -e^{i(\gamma + \lambda)}\sin(\rotationangle) \\
0 & 0 & 1 & 0 \\
0 & e^{i(\gamma+\phi)}\sin(\rotationangle) &
0 & e^{i(\gamma+\phi+\lambda)}\cos(\rotationangle)
\end{pmatrix}
.. note::
Expand All @@ -218,15 +220,17 @@ class CUGate(ControlledGate):
.. math::
\newcommand{\rotationangle}{\frac{\theta}{2}}
CU(\theta, \phi, \lambda, \gamma)\ q_1, q_0 =
|0\rangle\langle 0| \otimes I +
e^{i\gamma}|1\rangle\langle 1| \otimes U(\theta,\phi,\lambda) =
\begin{pmatrix}
1 & 0 & 0 & 0 \\
0 & 1 & 0 & 0 \\
0 & 0 & e^{i\gamma} \cos(\th) & -e^{i(\gamma + \lambda)}\sin(\th) \\
0 & 0 & e^{i(\gamma + \phi)}\sin(\th) & e^{i(\gamma + \phi+\lambda)}\cos(\th)
\end{pmatrix}
|0\rangle\langle 0| \otimes I +
e^{i\gamma}|1\rangle\langle 1| \otimes U(\theta,\phi,\lambda) =
\begin{pmatrix}
1 & 0 & 0 & 0 \\
0 & 1 & 0 & 0 \\
0 & 0 & e^{i\gamma} \cos(\rotationangle) & -e^{i(\gamma + \lambda)}\sin(\rotationangle) \\
0 & 0 &
e^{i(\gamma + \phi)}\sin(\rotationangle) & e^{i(\gamma + \phi+\lambda)}\cos(\rotationangle)
\end{pmatrix}
"""

def __init__(
Expand Down
17 changes: 9 additions & 8 deletions qiskit/circuit/library/standard_gates/u3.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,13 @@ class U3Gate(Gate):
.. math::
\newcommand{\th}{\frac{\theta}{2}}
\newcommand{\rotationangle}{\frac{\theta}{2}}
U3(\theta, \phi, \lambda) =
\begin{pmatrix}
\cos\left(\th\right) & -e^{i\lambda}\sin\left(\th\right) \\
e^{i\phi}\sin\left(\th\right) & e^{i(\phi+\lambda)}\cos\left(\th\right)
\cos\left(\rotationangle\right) & -e^{i\lambda}\sin\left(\rotationangle\right) \\
e^{i\phi}\sin\left(\rotationangle\right) &
e^{i(\phi+\lambda)}\cos\left(\rotationangle\right)
\end{pmatrix}
.. note::
Expand Down Expand Up @@ -165,16 +166,16 @@ class CU3Gate(ControlledGate):
.. math::
\newcommand{\th}{\frac{\theta}{2}}
\newcommand{\rotationangle}{\frac{\theta}{2}}
CU3(\theta, \phi, \lambda)\ q_0, q_1 =
I \otimes |0\rangle\langle 0| +
U3(\theta,\phi,\lambda) \otimes |1\rangle\langle 1| =
\begin{pmatrix}
1 & 0 & 0 & 0 \\
0 & \cos(\th) & 0 & -e^{i\lambda}\sin(\th) \\
0 & \cos(\rotationangle) & 0 & -e^{i\lambda}\sin(\rotationangle) \\
0 & 0 & 1 & 0 \\
0 & e^{i\phi}\sin(\th) & 0 & e^{i(\phi+\lambda)}\cos(\th)
0 & e^{i\phi}\sin(\rotationangle) & 0 & e^{i(\phi+\lambda)}\cos(\rotationangle)
\end{pmatrix}
.. note::
Expand All @@ -199,8 +200,8 @@ class CU3Gate(ControlledGate):
\begin{pmatrix}
1 & 0 & 0 & 0 \\
0 & 1 & 0 & 0 \\
0 & 0 & \cos(\th) & -e^{i\lambda}\sin(\th) \\
0 & 0 & e^{i\phi}\sin(\th) & e^{i(\phi+\lambda)}\cos(\th)
0 & 0 & \cos(\rotationangle) & -e^{i\lambda}\sin(\rotationangle) \\
0 & 0 & e^{i\phi}\sin(\rotationangle) & e^{i(\phi+\lambda)}\cos(\rotationangle)
\end{pmatrix}
"""

Expand Down
Loading

0 comments on commit b145420

Please sign in to comment.