Skip to content

Commit

Permalink
Fix IterativeAmplitudeEstimation pages crashing due to bad Latex (Q…
Browse files Browse the repository at this point in the history
…iskit#486)

The pages were crashing because we had a bad `|` character inside a
`$latex$` expression in a table. Normally the `|` would be okay to
represent the pipe character, but Markdown thought that it was saying
the table column was done.

Result:

<img width="723" alt="Screenshot 2023-12-06 at 3 06 56 PM"
src="https://github.com/Qiskit/documentation/assets/14852634/8e15b026-da67-4dcc-8528-e07a514e67ec">

Note that I had to use `\vert` for the pipe character. Using `\|`
resulted in the Latex interpreting as `||`, which results in the
`parallel` symbol being used:

<img width="249" alt="Screenshot 2023-12-06 at 3 08 45 PM"
src="https://github.com/Qiskit/documentation/assets/14852634/86e8c756-4639-404e-95fb-efb8c71e3532">

--

While this PR hotfixes the bad files, we should fix the underlying
generation script to handle this edge case. See
Qiskit#488

--

This change was generated with:

```bash
rg -F '\$\mathcal' -l | xargs sd -s '\$\mathcal{Q}^k \mathcal{A} | 0\rangle\$' '$\mathcal{Q}^k \mathcal{A} \vert0\rangle$'

rg -F '\$\mathcal' -l | xargs sd -s '\$\mathcal{Q}^k \mathcal{A}                                                                                 | 0\rangle\$' '$\mathcal{Q}^k \mathcal{A} \vert0\rangle$'
```
  • Loading branch information
Eric-Arellano authored Dec 7, 2023
1 parent 5dae5ec commit 06f6af9
Show file tree
Hide file tree
Showing 11 changed files with 11 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ The output of the algorithm is an estimate for the amplitude a, that with at lea
| | | |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| [`__init__`](#qiskit.algorithms.IterativeAmplitudeEstimation.__init__ "qiskit.algorithms.IterativeAmplitudeEstimation.__init__")(epsilon\_target, alpha\[, …]) | The output of the algorithm is an estimate for the amplitude a, that with at least probability 1 - alpha has an error of epsilon. | |
| [`construct_circuit`](#qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit "qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit")(estimation\_problem\[, k, …]) | Construct the circuit \$\mathcal{Q}^k \mathcal{A} | 0\rangle\$. |
| [`construct_circuit`](#qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit "qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit")(estimation\_problem\[, k, …]) | Construct the circuit $\mathcal{Q}^k \mathcal{A} \vert0\rangle$. |
| [`estimate`](#qiskit.algorithms.IterativeAmplitudeEstimation.estimate "qiskit.algorithms.IterativeAmplitudeEstimation.estimate")(estimation\_problem) | Run the amplitude estimation algorithm. | |

## Attributes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ The output of the algorithm is an estimate for the amplitude a, that with at lea
| | | |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| [`__init__`](#qiskit.algorithms.IterativeAmplitudeEstimation.__init__ "qiskit.algorithms.IterativeAmplitudeEstimation.__init__")(epsilon\_target, alpha\[, …]) | The output of the algorithm is an estimate for the amplitude a, that with at least probability 1 - alpha has an error of epsilon. | |
| [`construct_circuit`](#qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit "qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit")(estimation\_problem\[, k, …]) | Construct the circuit \$\mathcal{Q}^k \mathcal{A} | 0\rangle\$. |
| [`construct_circuit`](#qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit "qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit")(estimation\_problem\[, k, …]) | Construct the circuit $\mathcal{Q}^k \mathcal{A} \vert0\rangle$. |
| [`estimate`](#qiskit.algorithms.IterativeAmplitudeEstimation.estimate "qiskit.algorithms.IterativeAmplitudeEstimation.estimate")(estimation\_problem) | Run the amplitude estimation algorithm. | |

## Attributes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ The output of the algorithm is an estimate for the amplitude a, that with at lea
| | | |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| [`__init__`](#qiskit.algorithms.IterativeAmplitudeEstimation.__init__ "qiskit.algorithms.IterativeAmplitudeEstimation.__init__")(epsilon\_target, alpha\[, …]) | The output of the algorithm is an estimate for the amplitude a, that with at least probability 1 - alpha has an error of epsilon. | |
| [`construct_circuit`](#qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit "qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit")(estimation\_problem\[, k, …]) | Construct the circuit \$\mathcal{Q}^k \mathcal{A} | 0\rangle\$. |
| [`construct_circuit`](#qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit "qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit")(estimation\_problem\[, k, …]) | Construct the circuit $\mathcal{Q}^k \mathcal{A} \vert0\rangle$. |
| [`estimate`](#qiskit.algorithms.IterativeAmplitudeEstimation.estimate "qiskit.algorithms.IterativeAmplitudeEstimation.estimate")(estimation\_problem) | Run the amplitude estimation algorithm. | |

## Attributes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ The output of the algorithm is an estimate for the amplitude a, that with at lea
| | | |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| [`__init__`](#qiskit.algorithms.IterativeAmplitudeEstimation.__init__ "qiskit.algorithms.IterativeAmplitudeEstimation.__init__")(epsilon\_target, alpha\[, …]) | The output of the algorithm is an estimate for the amplitude a, that with at least probability 1 - alpha has an error of epsilon. | |
| [`construct_circuit`](#qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit "qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit")(estimation\_problem\[, k, …]) | Construct the circuit \$\mathcal{Q}^k \mathcal{A} | 0\rangle\$. |
| [`construct_circuit`](#qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit "qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit")(estimation\_problem\[, k, …]) | Construct the circuit $\mathcal{Q}^k \mathcal{A} \vert0\rangle$. |
| [`estimate`](#qiskit.algorithms.IterativeAmplitudeEstimation.estimate "qiskit.algorithms.IterativeAmplitudeEstimation.estimate")(estimation\_problem) | Run the amplitude estimation algorithm. | |

## Attributes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The output of the algorithm is an estimate for the amplitude a, that with at lea

| | | |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | ----------- |
| [`construct_circuit`](qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit#qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit "qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit") | Construct the circuit \$\mathcal{Q}^k \mathcal{A} | 0\rangle\$. |
| [`construct_circuit`](qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit#qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit "qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit") | Construct the circuit $\mathcal{Q}^k \mathcal{A} \vert0\rangle$. |
| [`estimate`](qiskit.algorithms.IterativeAmplitudeEstimation.estimate#qiskit.algorithms.IterativeAmplitudeEstimation.estimate "qiskit.algorithms.IterativeAmplitudeEstimation.estimate") | Run the amplitude estimation algorithm. | |

## Attributes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The output of the algorithm is an estimate for the amplitude a, that with at lea

| | | |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | ----------- |
| [`construct_circuit`](qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit#qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit "qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit") | Construct the circuit \$\mathcal{Q}^k \mathcal{A} | 0\rangle\$. |
| [`construct_circuit`](qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit#qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit "qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit") | Construct the circuit $\mathcal{Q}^k \mathcal{A} \vert0\rangle$. |
| [`estimate`](qiskit.algorithms.IterativeAmplitudeEstimation.estimate#qiskit.algorithms.IterativeAmplitudeEstimation.estimate "qiskit.algorithms.IterativeAmplitudeEstimation.estimate") | Run the amplitude estimation algorithm. | |

## Attributes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The output of the algorithm is an estimate for the amplitude a, that with at lea

| | | |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | ----------- |
| [`construct_circuit`](qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit#qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit "qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit") | Construct the circuit \$\mathcal{Q}^k \mathcal{A} | 0\rangle\$. |
| [`construct_circuit`](qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit#qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit "qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit") | Construct the circuit $\mathcal{Q}^k \mathcal{A} \vert0\rangle$. |
| [`estimate`](qiskit.algorithms.IterativeAmplitudeEstimation.estimate#qiskit.algorithms.IterativeAmplitudeEstimation.estimate "qiskit.algorithms.IterativeAmplitudeEstimation.estimate") | Run the amplitude estimation algorithm. | |

## Attributes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The output of the algorithm is an estimate for the amplitude a, that with at lea

| | | |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | ----------- |
| [`construct_circuit`](qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit#qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit "qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit") | Construct the circuit \$\mathcal{Q}^k \mathcal{A} | 0\rangle\$. |
| [`construct_circuit`](qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit#qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit "qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit") | Construct the circuit $\mathcal{Q}^k \mathcal{A} \vert0\rangle$. |
| [`estimate`](qiskit.algorithms.IterativeAmplitudeEstimation.estimate#qiskit.algorithms.IterativeAmplitudeEstimation.estimate "qiskit.algorithms.IterativeAmplitudeEstimation.estimate") | Run the amplitude estimation algorithm. | |

## Attributes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The output of the algorithm is an estimate for the amplitude a, that with at lea

| | | |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | ----------- |
| [`construct_circuit`](qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit#qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit "qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit") | Construct the circuit \$\mathcal{Q}^k \mathcal{A} | 0\rangle\$. |
| [`construct_circuit`](qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit#qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit "qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit") | Construct the circuit $\mathcal{Q}^k \mathcal{A} \vert0\rangle$. |
| [`estimate`](qiskit.algorithms.IterativeAmplitudeEstimation.estimate#qiskit.algorithms.IterativeAmplitudeEstimation.estimate "qiskit.algorithms.IterativeAmplitudeEstimation.estimate") | Run the amplitude estimation algorithm. | |

## Attributes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The output of the algorithm is an estimate for the amplitude a, that with at lea

| | | |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | ----------- |
| [`construct_circuit`](qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit#qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit "qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit") | Construct the circuit \$\mathcal{Q}^k \mathcal{A} | 0\rangle\$. |
| [`construct_circuit`](qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit#qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit "qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit") | Construct the circuit $\mathcal{Q}^k \mathcal{A} \vert0\rangle$. |
| [`estimate`](qiskit.algorithms.IterativeAmplitudeEstimation.estimate#qiskit.algorithms.IterativeAmplitudeEstimation.estimate "qiskit.algorithms.IterativeAmplitudeEstimation.estimate") | Run the amplitude estimation algorithm. | |

## Attributes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The output of the algorithm is an estimate for the amplitude a, that with at lea

| | | |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------- | ----------- |
| [`construct_circuit`](qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit#qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit "qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit") | Construct the circuit \$\mathcal{Q}^k \mathcal{A} | 0\rangle\$. |
| [`construct_circuit`](qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit#qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit "qiskit.algorithms.IterativeAmplitudeEstimation.construct_circuit") | Construct the circuit $\mathcal{Q}^k \mathcal{A} \vert0\rangle$. |
| [`estimate`](qiskit.algorithms.IterativeAmplitudeEstimation.estimate#qiskit.algorithms.IterativeAmplitudeEstimation.estimate "qiskit.algorithms.IterativeAmplitudeEstimation.estimate") | Run the amplitude estimation algorithm. | |

## Attributes
Expand Down

0 comments on commit 06f6af9

Please sign in to comment.