From 929125231d5b4798e7bb97cf2019b18fd343e697 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Wed, 4 Sep 2024 15:45:17 -0400 Subject: [PATCH 01/28] Handle Sphinx data type --- scripts/js/lib/api/Metadata.ts | 3 +- scripts/js/lib/api/generateApiComponents.ts | 4 ++- scripts/js/lib/api/generateToc.ts | 1 + scripts/js/lib/api/processHtml.test.ts | 32 +++++++++++++++++++++ scripts/js/lib/api/processHtml.ts | 5 +++- 5 files changed, 42 insertions(+), 3 deletions(-) diff --git a/scripts/js/lib/api/Metadata.ts b/scripts/js/lib/api/Metadata.ts index 8c7beb31ae7..85da7ea5ee4 100644 --- a/scripts/js/lib/api/Metadata.ts +++ b/scripts/js/lib/api/Metadata.ts @@ -17,7 +17,8 @@ export type ApiType = | "attribute" | "module" | "function" - | "exception"; + | "exception" + | "data"; export type Metadata = { apiName?: string; diff --git a/scripts/js/lib/api/generateApiComponents.ts b/scripts/js/lib/api/generateApiComponents.ts index 5ee4f558712..c9e4119c0d0 100644 --- a/scripts/js/lib/api/generateApiComponents.ts +++ b/scripts/js/lib/api/generateApiComponents.ts @@ -34,13 +34,14 @@ export type ComponentProps = { isDedicatedPage?: boolean; }; -const APITYPE_TO_TAG: Record = { +const APITYPE_TO_TAG: Record, string> = { class: "class", exception: "class", attribute: "attribute", property: "attribute", function: "function", method: "function", + data: "attribute", }; export async function processMdxComponent( @@ -110,6 +111,7 @@ function prepareProps( attribute: prepAttributeOrProperty, method: prepMethod, function: prepFunction, + data: prepAttributeOrProperty, }; const githubSourceLink = prepareGitHubLink($child, apiType === "method"); diff --git a/scripts/js/lib/api/generateToc.ts b/scripts/js/lib/api/generateToc.ts index b4db6f10ce1..aa64b61c34f 100644 --- a/scripts/js/lib/api/generateToc.ts +++ b/scripts/js/lib/api/generateToc.ts @@ -82,6 +82,7 @@ function getModulesAndItems( "method", "property", "attribute", + "data", ].includes(result.meta.apiType), ); diff --git a/scripts/js/lib/api/processHtml.test.ts b/scripts/js/lib/api/processHtml.test.ts index 19fc5c2dc91..e7debd42c5b 100644 --- a/scripts/js/lib/api/processHtml.test.ts +++ b/scripts/js/lib/api/processHtml.test.ts @@ -551,4 +551,36 @@ particular error, which subclasses both { + const html = ` +
+
+qiskit.qasm2.LEGACY_CUSTOM_INSTRUCTIONS
+

A tuple containing the extra custom_instructions that Qiskit’s legacy built-in converters used +if qelib1.inc is included, and there is any definition of a delay instruction. The gates +in the paper version of qelib1.inc and delay all require a compatible declaration +statement to be present within the OpenQASM 2 program, but Qiskit’s legacy additions are all +marked as builtins since they are not actually present in any include file this parser sees.

+
+`; + const doc = CheerioDoc.load(html); + const meta: Metadata = { apiType: "module", apiName: "my_module" }; + await processMembersAndSetMeta(doc.$, doc.$main, meta); + doc.expectHtml(` +

qiskit.qasm2.LEGACY_CUSTOM_INSTRUCTIONS¶

+ +

A tuple containing the extra custom_instructions that Qiskit’s legacy built-in converters used +if qelib1.inc is included, and there is any definition of a delay instruction. The gates +in the paper version of qelib1.inc and delay all require a compatible declaration +statement to be present within the OpenQASM 2 program, but Qiskit’s legacy additions are all +marked as builtins since they are not actually present in any include file this parser sees.

+
+
+`); + expect(meta).toEqual({ + apiName: "my_module", + apiType: "module", + }); + }); }); diff --git a/scripts/js/lib/api/processHtml.ts b/scripts/js/lib/api/processHtml.ts index eb44bd57e96..e2f05a29d1e 100644 --- a/scripts/js/lib/api/processHtml.ts +++ b/scripts/js/lib/api/processHtml.ts @@ -279,8 +279,10 @@ export async function processMembersAndSetMeta( // members can be recursive, so we need to pick elements one by one const dl = $main .find( - "dl.py.class, dl.py.property, dl.py.method, dl.py.attribute, dl.py.function, dl.py.exception", + "dl.py.class, dl.py.property, dl.py.method, dl.py.attribute, dl.py.function, dl.py.exception, dl.py.data", ) + // Components inside tables will not work properly. This happened with `dl.py.data` in /api/qiskit/utils. + .not("td > dl") .get(0); if (!dl) { @@ -402,6 +404,7 @@ function getApiType($dl: Cheerio): ApiType | undefined { "property", "attribute", "module", + "data", ]) { if ($dl.hasClass(className)) { return className as ApiType; From 448695f96de4004f3efa6186f37bf1b6f4b2f210 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Fri, 6 Sep 2024 09:26:21 -0400 Subject: [PATCH 02/28] Regenerate qiskit 0.19.6 --- docs/api/qiskit/0.19/_toc.json | 12 ++++++++++++ docs/api/qiskit/0.19/qiskit.aqua.aqua_globals.mdx | 13 +++++++++++-- .../qiskit/0.19/qiskit.optimization.INFINITY.mdx | 13 +++++++++++-- .../qiskit.optimization.applications.ising.tsp.mdx | 6 ++++-- ...qiskit.quantum_info.two_qubit_cnot_decompose.mdx | 13 +++++++++++-- docs/api/qiskit/0.19/qiskit_aqua.mdx | 6 +++--- docs/api/qiskit/0.19/qiskit_optimization.mdx | 6 +++--- docs/api/qiskit/0.19/quantum_info.mdx | 12 ++++++------ 8 files changed, 61 insertions(+), 20 deletions(-) diff --git a/docs/api/qiskit/0.19/_toc.json b/docs/api/qiskit/0.19/_toc.json index aa27fa15862..137a7e4610a 100644 --- a/docs/api/qiskit/0.19/_toc.json +++ b/docs/api/qiskit/0.19/_toc.json @@ -572,6 +572,10 @@ "title": "SuperOp", "url": "/api/qiskit/0.19/qiskit.quantum_info.SuperOp" }, + { + "title": "two_qubit_cnot_decompose", + "url": "/api/qiskit/0.19/qiskit.quantum_info.two_qubit_cnot_decompose" + }, { "title": "TwoQubitBasisDecomposer", "url": "/api/qiskit/0.19/qiskit.quantum_info.TwoQubitBasisDecomposer" @@ -2058,6 +2062,10 @@ "title": "Module overview", "url": "/api/qiskit/0.19/qiskit_aqua" }, + { + "title": "aqua_globals", + "url": "/api/qiskit/0.19/qiskit.aqua.aqua_globals" + }, { "title": "AquaError", "url": "/api/qiskit/0.19/qiskit.aqua.AquaError" @@ -3654,6 +3662,10 @@ "title": "Module overview", "url": "/api/qiskit/0.19/qiskit_optimization" }, + { + "title": "INFINITY", + "url": "/api/qiskit/0.19/qiskit.optimization.INFINITY" + }, { "title": "QiskitOptimizationError", "url": "/api/qiskit/0.19/qiskit.optimization.QiskitOptimizationError" diff --git a/docs/api/qiskit/0.19/qiskit.aqua.aqua_globals.mdx b/docs/api/qiskit/0.19/qiskit.aqua.aqua_globals.mdx index f862e27351d..24d03f24649 100644 --- a/docs/api/qiskit/0.19/qiskit.aqua.aqua_globals.mdx +++ b/docs/api/qiskit/0.19/qiskit.aqua.aqua_globals.mdx @@ -1,5 +1,14 @@ +--- +title: aqua_globals +description: API reference for qiskit.aqua.aqua_globals +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.aqua.aqua_globals +--- + # aqua\_globals -## aqua\_globals *= \* + + Aqua class for global properties. + -Aqua class for global properties. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.INFINITY.mdx b/docs/api/qiskit/0.19/qiskit.optimization.INFINITY.mdx index 9c6ff183428..8628287a8e0 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.INFINITY.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.INFINITY.mdx @@ -1,5 +1,14 @@ +--- +title: INFINITY +description: API reference for qiskit.optimization.INFINITY +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.optimization.INFINITY +--- + # INFINITY -## INFINITY *= 1e+20* + + Convert a string or number to a floating point number, if possible. + -Convert a string or number to a floating point number, if possible. diff --git a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.tsp.mdx b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.tsp.mdx index f9b7ef90ace..514e0526b86 100644 --- a/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.tsp.mdx +++ b/docs/api/qiskit/0.19/qiskit.optimization.applications.ising.tsp.mdx @@ -117,9 +117,11 @@ Convert symmetric TSP instances into Pauli list Deal with TSPLIB format. It supp list\[int] -**logger *= \*** +### logger -Instance data of TSP + + Instance data of TSP + ### parse\_tsplib\_format diff --git a/docs/api/qiskit/0.19/qiskit.quantum_info.two_qubit_cnot_decompose.mdx b/docs/api/qiskit/0.19/qiskit.quantum_info.two_qubit_cnot_decompose.mdx index bc2cfaa46d5..79e09cdb2b9 100644 --- a/docs/api/qiskit/0.19/qiskit.quantum_info.two_qubit_cnot_decompose.mdx +++ b/docs/api/qiskit/0.19/qiskit.quantum_info.two_qubit_cnot_decompose.mdx @@ -1,5 +1,14 @@ +--- +title: two_qubit_cnot_decompose +description: API reference for qiskit.quantum_info.two_qubit_cnot_decompose +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.quantum_info.two_qubit_cnot_decompose +--- + # two\_qubit\_cnot\_decompose -## two\_qubit\_cnot\_decompose *= \* + + A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. + -A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. diff --git a/docs/api/qiskit/0.19/qiskit_aqua.mdx b/docs/api/qiskit/0.19/qiskit_aqua.mdx index 1e9a7ec4d15..c29680128e5 100644 --- a/docs/api/qiskit/0.19/qiskit_aqua.mdx +++ b/docs/api/qiskit/0.19/qiskit_aqua.mdx @@ -18,9 +18,9 @@ python_api_name: qiskit.aqua Qiskit Aqua provides a library of quantum algorithms and components to build quantum applications and leverage near-term devices. -| | | -| ---------------------------------------------------------------------------------------------- | --------------------------------- | -| [`aqua_globals`](qiskit.aqua.aqua_globals#qiskit.aqua.aqua_globals "qiskit.aqua.aqua_globals") | Aqua class for global properties. | +| | | +| --------------------------------------------------------------------- | --------------------------------- | +| [`aqua_globals`](qiskit.aqua.aqua_globals "qiskit.aqua.aqua_globals") | Aqua class for global properties. | Aqua globals class provides random number and max parallel process configuration. Aqua uses the random function and max parallel processes when running any function requiring randomization and/or that can be be done in parallel. Setting the random seed to a given value will ensure predictability in outcome when using a simulator (seeds should also be set in [`QuantumInstance`](qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance") for transpiler and simulator too). diff --git a/docs/api/qiskit/0.19/qiskit_optimization.mdx b/docs/api/qiskit/0.19/qiskit_optimization.mdx index 16f2daf5b36..c050718fb62 100644 --- a/docs/api/qiskit/0.19/qiskit_optimization.mdx +++ b/docs/api/qiskit/0.19/qiskit_optimization.mdx @@ -34,9 +34,9 @@ Representation of a Quadratically Constrained Quadratic Program supporting inequ In addition to standard Python errors the optimization module will raise this error if circumstances are that it cannot proceed to completion. -| | | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------- | -| [`INFINITY`](qiskit.optimization.INFINITY#qiskit.optimization.INFINITY "qiskit.optimization.INFINITY") | Convert a string or number to a floating point number, if possible. | +| | | +| ------------------------------------------------------------------------- | ------------------------------------------------------------------- | +| [`INFINITY`](qiskit.optimization.INFINITY "qiskit.optimization.INFINITY") | Convert a string or number to a floating point number, if possible. | A constant for infinity. diff --git a/docs/api/qiskit/0.19/quantum_info.mdx b/docs/api/qiskit/0.19/quantum_info.mdx index 6df039c064c..dda3e2719e1 100644 --- a/docs/api/qiskit/0.19/quantum_info.mdx +++ b/docs/api/qiskit/0.19/quantum_info.mdx @@ -93,10 +93,10 @@ python_api_name: qiskit.quantum_info ## Synthesis -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | -| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, basis\_fidelity]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | -| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose#qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | -| [`euler_angles_1q`](qiskit.quantum_info.euler_angles_1q "qiskit.quantum_info.euler_angles_1q")(unitary\_matrix) | DEPRECATED: Compute Euler angles for a single-qubit gate. | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------- | +| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | +| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, basis\_fidelity]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | +| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | +| [`euler_angles_1q`](qiskit.quantum_info.euler_angles_1q "qiskit.quantum_info.euler_angles_1q")(unitary\_matrix) | DEPRECATED: Compute Euler angles for a single-qubit gate. | From 519e2db2ea973f195a209c2ee10532345279507e Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Fri, 6 Sep 2024 09:27:30 -0400 Subject: [PATCH 03/28] Regenerate qiskit 0.24.1 --- docs/api/qiskit/0.24/_toc.json | 12 ++++++++++ .../qiskit/0.24/qiskit.aqua.aqua_globals.mdx | 15 +++++++++--- .../0.24/qiskit.optimization.INFINITY.mdx | 15 +++++++++--- ...it.optimization.applications.ising.tsp.mdx | 6 +++-- ....quantum_info.two_qubit_cnot_decompose.mdx | 23 +++++++++++++------ docs/api/qiskit/0.24/qiskit_aqua.mdx | 6 ++--- docs/api/qiskit/0.24/qiskit_optimization.mdx | 6 ++--- docs/api/qiskit/0.24/quantum_info.mdx | 12 +++++----- 8 files changed, 68 insertions(+), 27 deletions(-) diff --git a/docs/api/qiskit/0.24/_toc.json b/docs/api/qiskit/0.24/_toc.json index 2e476f46cfb..f18c78e1051 100644 --- a/docs/api/qiskit/0.24/_toc.json +++ b/docs/api/qiskit/0.24/_toc.json @@ -889,6 +889,10 @@ "title": "SuperOp", "url": "/api/qiskit/0.24/qiskit.quantum_info.SuperOp" }, + { + "title": "two_qubit_cnot_decompose", + "url": "/api/qiskit/0.24/qiskit.quantum_info.two_qubit_cnot_decompose" + }, { "title": "TwoQubitBasisDecomposer", "url": "/api/qiskit/0.24/qiskit.quantum_info.TwoQubitBasisDecomposer" @@ -2625,6 +2629,10 @@ "title": "Module overview", "url": "/api/qiskit/0.24/qiskit_aqua" }, + { + "title": "aqua_globals", + "url": "/api/qiskit/0.24/qiskit.aqua.aqua_globals" + }, { "title": "AquaError", "url": "/api/qiskit/0.24/qiskit.aqua.AquaError" @@ -4630,6 +4638,10 @@ "title": "Module overview", "url": "/api/qiskit/0.24/qiskit_optimization" }, + { + "title": "INFINITY", + "url": "/api/qiskit/0.24/qiskit.optimization.INFINITY" + }, { "title": "QiskitOptimizationError", "url": "/api/qiskit/0.24/qiskit.optimization.QiskitOptimizationError" diff --git a/docs/api/qiskit/0.24/qiskit.aqua.aqua_globals.mdx b/docs/api/qiskit/0.24/qiskit.aqua.aqua_globals.mdx index 6a7ae6ad817..3445181a093 100644 --- a/docs/api/qiskit/0.24/qiskit.aqua.aqua_globals.mdx +++ b/docs/api/qiskit/0.24/qiskit.aqua.aqua_globals.mdx @@ -1,7 +1,16 @@ +--- +title: aqua_globals +description: API reference for qiskit.aqua.aqua_globals +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.aqua.aqua_globals +--- + -# qiskit.aqua.aqua\_globals +# aqua\_globals -## `aqua_globals` *= \* + + Aqua class for global properties. + -Aqua class for global properties. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.INFINITY.mdx b/docs/api/qiskit/0.24/qiskit.optimization.INFINITY.mdx index 354694c9c5f..f3d34ecdcd7 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.INFINITY.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.INFINITY.mdx @@ -1,7 +1,16 @@ +--- +title: INFINITY +description: API reference for qiskit.optimization.INFINITY +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.optimization.INFINITY +--- + -# qiskit.optimization.INFINITY +# INFINITY -## `INFINITY` *= 1e+20* + + Convert a string or number to a floating point number, if possible. + -Convert a string or number to a floating point number, if possible. diff --git a/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.tsp.mdx b/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.tsp.mdx index efb8bd15217..0ca8b3b1b0c 100644 --- a/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.tsp.mdx +++ b/docs/api/qiskit/0.24/qiskit.optimization.applications.ising.tsp.mdx @@ -121,9 +121,11 @@ Convert symmetric TSP instances into Pauli list Deal with TSPLIB format. It supp list\[int] -**`logger` *= \*** +### logger -Instance data of TSP + + Instance data of TSP + ### parse\_tsplib\_format diff --git a/docs/api/qiskit/0.24/qiskit.quantum_info.two_qubit_cnot_decompose.mdx b/docs/api/qiskit/0.24/qiskit.quantum_info.two_qubit_cnot_decompose.mdx index ef3dc8c0fca..c20c6c2db48 100644 --- a/docs/api/qiskit/0.24/qiskit.quantum_info.two_qubit_cnot_decompose.mdx +++ b/docs/api/qiskit/0.24/qiskit.quantum_info.two_qubit_cnot_decompose.mdx @@ -1,13 +1,22 @@ +--- +title: two_qubit_cnot_decompose +description: API reference for qiskit.quantum_info.two_qubit_cnot_decompose +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.quantum_info.two_qubit_cnot_decompose +--- + -# qiskit.quantum\_info.two\_qubit\_cnot\_decompose +# two\_qubit\_cnot\_decompose -## `two_qubit_cnot_decompose` *= \* + + A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. -A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. + **Parameters** -**Parameters** + * **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – Two-qubit gate to be used in the KAK decomposition. + * **basis\_fidelity** (*float*) – Fidelity to be assumed for applications of KAK Gate. Default 1.0. + * **euler\_basis** (*str*) – Basis string to be provided to OneQubitEulerDecomposer for 1Q synthesis. Valid options are \[‘ZYZ’, ‘ZXZ’, ‘XYX’, ‘U’, ‘U3’, ‘U1X’, ‘PSX’, ‘ZSX’, ‘RR’]. Default ‘U3’. + -* **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – Two-qubit gate to be used in the KAK decomposition. -* **basis\_fidelity** (*float*) – Fidelity to be assumed for applications of KAK Gate. Default 1.0. -* **euler\_basis** (*str*) – Basis string to be provided to OneQubitEulerDecomposer for 1Q synthesis. Valid options are \[‘ZYZ’, ‘ZXZ’, ‘XYX’, ‘U’, ‘U3’, ‘U1X’, ‘PSX’, ‘ZSX’, ‘RR’]. Default ‘U3’. diff --git a/docs/api/qiskit/0.24/qiskit_aqua.mdx b/docs/api/qiskit/0.24/qiskit_aqua.mdx index 2531e5aa311..3c239dc9261 100644 --- a/docs/api/qiskit/0.24/qiskit_aqua.mdx +++ b/docs/api/qiskit/0.24/qiskit_aqua.mdx @@ -20,9 +20,9 @@ python_api_name: qiskit.aqua Qiskit Aqua provides a library of quantum algorithms and components to build quantum applications and leverage near-term devices. -| | | -| ---------------------------------------------------------------------------------------------- | --------------------------------- | -| [`aqua_globals`](qiskit.aqua.aqua_globals#qiskit.aqua.aqua_globals "qiskit.aqua.aqua_globals") | Aqua class for global properties. | +| | | +| --------------------------------------------------------------------- | --------------------------------- | +| [`aqua_globals`](qiskit.aqua.aqua_globals "qiskit.aqua.aqua_globals") | Aqua class for global properties. | Aqua globals class provides random number and max parallel process configuration. Aqua uses the random function and max parallel processes when running any function requiring randomization and/or that can be be done in parallel. Setting the random seed to a given value will ensure predictability in outcome when using a simulator (seeds should also be set in [`QuantumInstance`](qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance") for transpiler and simulator too). diff --git a/docs/api/qiskit/0.24/qiskit_optimization.mdx b/docs/api/qiskit/0.24/qiskit_optimization.mdx index 6b9dba79112..c6d881e1669 100644 --- a/docs/api/qiskit/0.24/qiskit_optimization.mdx +++ b/docs/api/qiskit/0.24/qiskit_optimization.mdx @@ -36,9 +36,9 @@ Representation of a Quadratically Constrained Quadratic Program supporting inequ In addition to standard Python errors the optimization module will raise this error if circumstances are that it cannot proceed to completion. -| | | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------- | -| [`INFINITY`](qiskit.optimization.INFINITY#qiskit.optimization.INFINITY "qiskit.optimization.INFINITY") | Convert a string or number to a floating point number, if possible. | +| | | +| ------------------------------------------------------------------------- | ------------------------------------------------------------------- | +| [`INFINITY`](qiskit.optimization.INFINITY "qiskit.optimization.INFINITY") | Convert a string or number to a floating point number, if possible. | A constant for infinity. diff --git a/docs/api/qiskit/0.24/quantum_info.mdx b/docs/api/qiskit/0.24/quantum_info.mdx index c1c289367f0..bdbea3aff34 100644 --- a/docs/api/qiskit/0.24/quantum_info.mdx +++ b/docs/api/qiskit/0.24/quantum_info.mdx @@ -95,10 +95,10 @@ python_api_name: qiskit.quantum_info ## Synthesis -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | -| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, …]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | -| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose#qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | -| [`euler_angles_1q`](qiskit.quantum_info.euler_angles_1q "qiskit.quantum_info.euler_angles_1q")(unitary\_matrix) | DEPRECATED: Compute Euler angles for a single-qubit gate. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | +| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, …]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | +| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | +| [`euler_angles_1q`](qiskit.quantum_info.euler_angles_1q "qiskit.quantum_info.euler_angles_1q")(unitary\_matrix) | DEPRECATED: Compute Euler angles for a single-qubit gate. | From 6a1a3ea5556e8e78ec1d2d775fe6ea47a407097f Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Fri, 6 Sep 2024 09:29:05 -0400 Subject: [PATCH 04/28] Regenerate qiskit 0.25.4 --- docs/api/qiskit/0.25/_toc.json | 16 +++++++++++++ .../qiskit/0.25/qiskit.aqua.aqua_globals.mdx | 15 +++++++++--- .../0.25/qiskit.optimization.INFINITY.mdx | 15 +++++++++--- ...it.optimization.applications.ising.tsp.mdx | 6 +++-- ....quantum_info.two_qubit_cnot_decompose.mdx | 23 +++++++++++++------ .../0.25/qiskit.utils.algorithm_globals.mdx | 15 +++++++++--- docs/api/qiskit/0.25/qiskit_aqua.mdx | 6 ++--- docs/api/qiskit/0.25/qiskit_optimization.mdx | 6 ++--- docs/api/qiskit/0.25/quantum_info.mdx | 14 +++++------ docs/api/qiskit/0.25/utils.mdx | 18 +++++++-------- 10 files changed, 94 insertions(+), 40 deletions(-) diff --git a/docs/api/qiskit/0.25/_toc.json b/docs/api/qiskit/0.25/_toc.json index 9e82d919d77..2c24450e86e 100644 --- a/docs/api/qiskit/0.25/_toc.json +++ b/docs/api/qiskit/0.25/_toc.json @@ -1033,6 +1033,10 @@ "title": "SuperOp", "url": "/api/qiskit/0.25/qiskit.quantum_info.SuperOp" }, + { + "title": "two_qubit_cnot_decompose", + "url": "/api/qiskit/0.25/qiskit.quantum_info.two_qubit_cnot_decompose" + }, { "title": "TwoQubitBasisDecomposer", "url": "/api/qiskit/0.25/qiskit.quantum_info.TwoQubitBasisDecomposer" @@ -2619,6 +2623,10 @@ "title": "Module overview", "url": "/api/qiskit/0.25/utils" }, + { + "title": "algorithm_globals", + "url": "/api/qiskit/0.25/qiskit.utils.algorithm_globals" + }, { "title": "apply_prefix", "url": "/api/qiskit/0.25/qiskit.utils.apply_prefix" @@ -3587,6 +3595,10 @@ "title": "Module overview", "url": "/api/qiskit/0.25/qiskit_aqua" }, + { + "title": "aqua_globals", + "url": "/api/qiskit/0.25/qiskit.aqua.aqua_globals" + }, { "title": "AquaError", "url": "/api/qiskit/0.25/qiskit.aqua.AquaError" @@ -5605,6 +5617,10 @@ "title": "Module overview", "url": "/api/qiskit/0.25/qiskit_optimization" }, + { + "title": "INFINITY", + "url": "/api/qiskit/0.25/qiskit.optimization.INFINITY" + }, { "title": "QiskitOptimizationError", "url": "/api/qiskit/0.25/qiskit.optimization.QiskitOptimizationError" diff --git a/docs/api/qiskit/0.25/qiskit.aqua.aqua_globals.mdx b/docs/api/qiskit/0.25/qiskit.aqua.aqua_globals.mdx index fc13ae4d02f..24d03f24649 100644 --- a/docs/api/qiskit/0.25/qiskit.aqua.aqua_globals.mdx +++ b/docs/api/qiskit/0.25/qiskit.aqua.aqua_globals.mdx @@ -1,5 +1,14 @@ -# qiskit.aqua.aqua\_globals +--- +title: aqua_globals +description: API reference for qiskit.aqua.aqua_globals +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.aqua.aqua_globals +--- -## `aqua_globals` *= \* +# aqua\_globals + + + Aqua class for global properties. + -Aqua class for global properties. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.INFINITY.mdx b/docs/api/qiskit/0.25/qiskit.optimization.INFINITY.mdx index 21a0e027748..8628287a8e0 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.INFINITY.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.INFINITY.mdx @@ -1,5 +1,14 @@ -# qiskit.optimization.INFINITY +--- +title: INFINITY +description: API reference for qiskit.optimization.INFINITY +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.optimization.INFINITY +--- -## `INFINITY` *= 1e+20* +# INFINITY + + + Convert a string or number to a floating point number, if possible. + -Convert a string or number to a floating point number, if possible. diff --git a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.tsp.mdx b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.tsp.mdx index b970674ed02..61e14b4576c 100644 --- a/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.tsp.mdx +++ b/docs/api/qiskit/0.25/qiskit.optimization.applications.ising.tsp.mdx @@ -119,9 +119,11 @@ Convert symmetric TSP instances into Pauli list Deal with TSPLIB format. It supp list\[int] -**`logger` *= \*** +### logger -Instance data of TSP + + Instance data of TSP + ### parse\_tsplib\_format diff --git a/docs/api/qiskit/0.25/qiskit.quantum_info.two_qubit_cnot_decompose.mdx b/docs/api/qiskit/0.25/qiskit.quantum_info.two_qubit_cnot_decompose.mdx index b5e09776520..e231eea7c15 100644 --- a/docs/api/qiskit/0.25/qiskit.quantum_info.two_qubit_cnot_decompose.mdx +++ b/docs/api/qiskit/0.25/qiskit.quantum_info.two_qubit_cnot_decompose.mdx @@ -1,11 +1,20 @@ -# qiskit.quantum\_info.two\_qubit\_cnot\_decompose +--- +title: two_qubit_cnot_decompose +description: API reference for qiskit.quantum_info.two_qubit_cnot_decompose +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.quantum_info.two_qubit_cnot_decompose +--- -## `two_qubit_cnot_decompose` *= \* +# two\_qubit\_cnot\_decompose -A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. + + A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. -**Parameters** + **Parameters** + + * **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – Two-qubit gate to be used in the KAK decomposition. + * **basis\_fidelity** (*float*) – Fidelity to be assumed for applications of KAK Gate. Default 1.0. + * **euler\_basis** (*str*) – Basis string to be provided to OneQubitEulerDecomposer for 1Q synthesis. Valid options are \[‘ZYZ’, ‘ZXZ’, ‘XYX’, ‘U’, ‘U3’, ‘U1X’, ‘PSX’, ‘ZSX’, ‘RR’]. Default ‘U3’. + -* **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – Two-qubit gate to be used in the KAK decomposition. -* **basis\_fidelity** (*float*) – Fidelity to be assumed for applications of KAK Gate. Default 1.0. -* **euler\_basis** (*str*) – Basis string to be provided to OneQubitEulerDecomposer for 1Q synthesis. Valid options are \[‘ZYZ’, ‘ZXZ’, ‘XYX’, ‘U’, ‘U3’, ‘U1X’, ‘PSX’, ‘ZSX’, ‘RR’]. Default ‘U3’. diff --git a/docs/api/qiskit/0.25/qiskit.utils.algorithm_globals.mdx b/docs/api/qiskit/0.25/qiskit.utils.algorithm_globals.mdx index e7838b75c01..e4e70fe8472 100644 --- a/docs/api/qiskit/0.25/qiskit.utils.algorithm_globals.mdx +++ b/docs/api/qiskit/0.25/qiskit.utils.algorithm_globals.mdx @@ -1,5 +1,14 @@ -# qiskit.utils.algorithm\_globals +--- +title: algorithm_globals +description: API reference for qiskit.utils.algorithm_globals +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.utils.algorithm_globals +--- -## `algorithm_globals` *= \* +# algorithm\_globals + + + Class for global properties. + -Class for global properties. diff --git a/docs/api/qiskit/0.25/qiskit_aqua.mdx b/docs/api/qiskit/0.25/qiskit_aqua.mdx index 662688a9f25..c0c447c7f57 100644 --- a/docs/api/qiskit/0.25/qiskit_aqua.mdx +++ b/docs/api/qiskit/0.25/qiskit_aqua.mdx @@ -18,9 +18,9 @@ python_api_name: qiskit.aqua Qiskit Aqua provides a library of quantum algorithms and components to build quantum applications and leverage near-term devices. -| | | -| ---------------------------------------------------------------------------------------------- | --------------------------------- | -| [`aqua_globals`](qiskit.aqua.aqua_globals#qiskit.aqua.aqua_globals "qiskit.aqua.aqua_globals") | Aqua class for global properties. | +| | | +| --------------------------------------------------------------------- | --------------------------------- | +| [`aqua_globals`](qiskit.aqua.aqua_globals "qiskit.aqua.aqua_globals") | Aqua class for global properties. | Aqua globals class provides random number and max parallel process configuration. Aqua uses the random function and max parallel processes when running any function requiring randomization and/or that can be be done in parallel. Setting the random seed to a given value will ensure predictability in outcome when using a simulator (seeds should also be set in [`QuantumInstance`](qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance") for transpiler and simulator too). diff --git a/docs/api/qiskit/0.25/qiskit_optimization.mdx b/docs/api/qiskit/0.25/qiskit_optimization.mdx index 16f2daf5b36..c050718fb62 100644 --- a/docs/api/qiskit/0.25/qiskit_optimization.mdx +++ b/docs/api/qiskit/0.25/qiskit_optimization.mdx @@ -34,9 +34,9 @@ Representation of a Quadratically Constrained Quadratic Program supporting inequ In addition to standard Python errors the optimization module will raise this error if circumstances are that it cannot proceed to completion. -| | | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------- | -| [`INFINITY`](qiskit.optimization.INFINITY#qiskit.optimization.INFINITY "qiskit.optimization.INFINITY") | Convert a string or number to a floating point number, if possible. | +| | | +| ------------------------------------------------------------------------- | ------------------------------------------------------------------- | +| [`INFINITY`](qiskit.optimization.INFINITY "qiskit.optimization.INFINITY") | Convert a string or number to a floating point number, if possible. | A constant for infinity. diff --git a/docs/api/qiskit/0.25/quantum_info.mdx b/docs/api/qiskit/0.25/quantum_info.mdx index 34cdf797e27..1e54aa647b2 100644 --- a/docs/api/qiskit/0.25/quantum_info.mdx +++ b/docs/api/qiskit/0.25/quantum_info.mdx @@ -95,11 +95,11 @@ python_api_name: qiskit.quantum_info ## Synthesis -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | -| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, …]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | -| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose#qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | -| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | -| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | Decompose a Clifford operator into a QuantumCircuit. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | +| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, …]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | +| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | +| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | +| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | Decompose a Clifford operator into a QuantumCircuit. | diff --git a/docs/api/qiskit/0.25/utils.mdx b/docs/api/qiskit/0.25/utils.mdx index 21d78218140..a13db21a37d 100644 --- a/docs/api/qiskit/0.25/utils.mdx +++ b/docs/api/qiskit/0.25/utils.mdx @@ -26,15 +26,15 @@ python_api_name: qiskit.utils ## Algorithm Utilities -| | | -| --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | -| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | -| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | -| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | -| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | -| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | -| [`algorithm_globals`](qiskit.utils.algorithm_globals#qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | +| | | +| ----------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | +| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | +| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | +| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | +| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | +| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | +| [`algorithm_globals`](qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | | | | | -------------------------------------------------------------------------------- | -------------------------------------------- | From 4796075aa52d8d3cad2a30494b4ac1f75ab85312 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Fri, 6 Sep 2024 09:30:41 -0400 Subject: [PATCH 05/28] Regenerate qiskit 0.26.2 --- docs/api/qiskit/0.26/_toc.json | 16 +++++++++++++ .../qiskit/0.26/qiskit.aqua.aqua_globals.mdx | 15 +++++++++--- .../0.26/qiskit.optimization.INFINITY.mdx | 15 +++++++++--- ...it.optimization.applications.ising.tsp.mdx | 6 +++-- ....quantum_info.two_qubit_cnot_decompose.mdx | 23 +++++++++++++------ .../0.26/qiskit.utils.algorithm_globals.mdx | 15 +++++++++--- docs/api/qiskit/0.26/qiskit_aqua.mdx | 6 ++--- docs/api/qiskit/0.26/qiskit_optimization.mdx | 6 ++--- docs/api/qiskit/0.26/quantum_info.mdx | 14 +++++------ docs/api/qiskit/0.26/utils.mdx | 18 +++++++-------- 10 files changed, 94 insertions(+), 40 deletions(-) diff --git a/docs/api/qiskit/0.26/_toc.json b/docs/api/qiskit/0.26/_toc.json index 6b091a09c9c..5312fa3cc94 100644 --- a/docs/api/qiskit/0.26/_toc.json +++ b/docs/api/qiskit/0.26/_toc.json @@ -1033,6 +1033,10 @@ "title": "SuperOp", "url": "/api/qiskit/0.26/qiskit.quantum_info.SuperOp" }, + { + "title": "two_qubit_cnot_decompose", + "url": "/api/qiskit/0.26/qiskit.quantum_info.two_qubit_cnot_decompose" + }, { "title": "TwoQubitBasisDecomposer", "url": "/api/qiskit/0.26/qiskit.quantum_info.TwoQubitBasisDecomposer" @@ -2627,6 +2631,10 @@ "title": "Module overview", "url": "/api/qiskit/0.26/utils" }, + { + "title": "algorithm_globals", + "url": "/api/qiskit/0.26/qiskit.utils.algorithm_globals" + }, { "title": "apply_prefix", "url": "/api/qiskit/0.26/qiskit.utils.apply_prefix" @@ -3632,6 +3640,10 @@ "title": "Module overview", "url": "/api/qiskit/0.26/qiskit_aqua" }, + { + "title": "aqua_globals", + "url": "/api/qiskit/0.26/qiskit.aqua.aqua_globals" + }, { "title": "AquaError", "url": "/api/qiskit/0.26/qiskit.aqua.AquaError" @@ -5650,6 +5662,10 @@ "title": "Module overview", "url": "/api/qiskit/0.26/qiskit_optimization" }, + { + "title": "INFINITY", + "url": "/api/qiskit/0.26/qiskit.optimization.INFINITY" + }, { "title": "QiskitOptimizationError", "url": "/api/qiskit/0.26/qiskit.optimization.QiskitOptimizationError" diff --git a/docs/api/qiskit/0.26/qiskit.aqua.aqua_globals.mdx b/docs/api/qiskit/0.26/qiskit.aqua.aqua_globals.mdx index fc13ae4d02f..24d03f24649 100644 --- a/docs/api/qiskit/0.26/qiskit.aqua.aqua_globals.mdx +++ b/docs/api/qiskit/0.26/qiskit.aqua.aqua_globals.mdx @@ -1,5 +1,14 @@ -# qiskit.aqua.aqua\_globals +--- +title: aqua_globals +description: API reference for qiskit.aqua.aqua_globals +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.aqua.aqua_globals +--- -## `aqua_globals` *= \* +# aqua\_globals + + + Aqua class for global properties. + -Aqua class for global properties. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.INFINITY.mdx b/docs/api/qiskit/0.26/qiskit.optimization.INFINITY.mdx index 21a0e027748..8628287a8e0 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.INFINITY.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.INFINITY.mdx @@ -1,5 +1,14 @@ -# qiskit.optimization.INFINITY +--- +title: INFINITY +description: API reference for qiskit.optimization.INFINITY +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.optimization.INFINITY +--- -## `INFINITY` *= 1e+20* +# INFINITY + + + Convert a string or number to a floating point number, if possible. + -Convert a string or number to a floating point number, if possible. diff --git a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.tsp.mdx b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.tsp.mdx index b970674ed02..61e14b4576c 100644 --- a/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.tsp.mdx +++ b/docs/api/qiskit/0.26/qiskit.optimization.applications.ising.tsp.mdx @@ -119,9 +119,11 @@ Convert symmetric TSP instances into Pauli list Deal with TSPLIB format. It supp list\[int] -**`logger` *= \*** +### logger -Instance data of TSP + + Instance data of TSP + ### parse\_tsplib\_format diff --git a/docs/api/qiskit/0.26/qiskit.quantum_info.two_qubit_cnot_decompose.mdx b/docs/api/qiskit/0.26/qiskit.quantum_info.two_qubit_cnot_decompose.mdx index b5e09776520..e231eea7c15 100644 --- a/docs/api/qiskit/0.26/qiskit.quantum_info.two_qubit_cnot_decompose.mdx +++ b/docs/api/qiskit/0.26/qiskit.quantum_info.two_qubit_cnot_decompose.mdx @@ -1,11 +1,20 @@ -# qiskit.quantum\_info.two\_qubit\_cnot\_decompose +--- +title: two_qubit_cnot_decompose +description: API reference for qiskit.quantum_info.two_qubit_cnot_decompose +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.quantum_info.two_qubit_cnot_decompose +--- -## `two_qubit_cnot_decompose` *= \* +# two\_qubit\_cnot\_decompose -A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. + + A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. -**Parameters** + **Parameters** + + * **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – Two-qubit gate to be used in the KAK decomposition. + * **basis\_fidelity** (*float*) – Fidelity to be assumed for applications of KAK Gate. Default 1.0. + * **euler\_basis** (*str*) – Basis string to be provided to OneQubitEulerDecomposer for 1Q synthesis. Valid options are \[‘ZYZ’, ‘ZXZ’, ‘XYX’, ‘U’, ‘U3’, ‘U1X’, ‘PSX’, ‘ZSX’, ‘RR’]. Default ‘U3’. + -* **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – Two-qubit gate to be used in the KAK decomposition. -* **basis\_fidelity** (*float*) – Fidelity to be assumed for applications of KAK Gate. Default 1.0. -* **euler\_basis** (*str*) – Basis string to be provided to OneQubitEulerDecomposer for 1Q synthesis. Valid options are \[‘ZYZ’, ‘ZXZ’, ‘XYX’, ‘U’, ‘U3’, ‘U1X’, ‘PSX’, ‘ZSX’, ‘RR’]. Default ‘U3’. diff --git a/docs/api/qiskit/0.26/qiskit.utils.algorithm_globals.mdx b/docs/api/qiskit/0.26/qiskit.utils.algorithm_globals.mdx index e7838b75c01..e4e70fe8472 100644 --- a/docs/api/qiskit/0.26/qiskit.utils.algorithm_globals.mdx +++ b/docs/api/qiskit/0.26/qiskit.utils.algorithm_globals.mdx @@ -1,5 +1,14 @@ -# qiskit.utils.algorithm\_globals +--- +title: algorithm_globals +description: API reference for qiskit.utils.algorithm_globals +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.utils.algorithm_globals +--- -## `algorithm_globals` *= \* +# algorithm\_globals + + + Class for global properties. + -Class for global properties. diff --git a/docs/api/qiskit/0.26/qiskit_aqua.mdx b/docs/api/qiskit/0.26/qiskit_aqua.mdx index 662688a9f25..c0c447c7f57 100644 --- a/docs/api/qiskit/0.26/qiskit_aqua.mdx +++ b/docs/api/qiskit/0.26/qiskit_aqua.mdx @@ -18,9 +18,9 @@ python_api_name: qiskit.aqua Qiskit Aqua provides a library of quantum algorithms and components to build quantum applications and leverage near-term devices. -| | | -| ---------------------------------------------------------------------------------------------- | --------------------------------- | -| [`aqua_globals`](qiskit.aqua.aqua_globals#qiskit.aqua.aqua_globals "qiskit.aqua.aqua_globals") | Aqua class for global properties. | +| | | +| --------------------------------------------------------------------- | --------------------------------- | +| [`aqua_globals`](qiskit.aqua.aqua_globals "qiskit.aqua.aqua_globals") | Aqua class for global properties. | Aqua globals class provides random number and max parallel process configuration. Aqua uses the random function and max parallel processes when running any function requiring randomization and/or that can be be done in parallel. Setting the random seed to a given value will ensure predictability in outcome when using a simulator (seeds should also be set in [`QuantumInstance`](qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance") for transpiler and simulator too). diff --git a/docs/api/qiskit/0.26/qiskit_optimization.mdx b/docs/api/qiskit/0.26/qiskit_optimization.mdx index 16f2daf5b36..c050718fb62 100644 --- a/docs/api/qiskit/0.26/qiskit_optimization.mdx +++ b/docs/api/qiskit/0.26/qiskit_optimization.mdx @@ -34,9 +34,9 @@ Representation of a Quadratically Constrained Quadratic Program supporting inequ In addition to standard Python errors the optimization module will raise this error if circumstances are that it cannot proceed to completion. -| | | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------- | -| [`INFINITY`](qiskit.optimization.INFINITY#qiskit.optimization.INFINITY "qiskit.optimization.INFINITY") | Convert a string or number to a floating point number, if possible. | +| | | +| ------------------------------------------------------------------------- | ------------------------------------------------------------------- | +| [`INFINITY`](qiskit.optimization.INFINITY "qiskit.optimization.INFINITY") | Convert a string or number to a floating point number, if possible. | A constant for infinity. diff --git a/docs/api/qiskit/0.26/quantum_info.mdx b/docs/api/qiskit/0.26/quantum_info.mdx index 34cdf797e27..1e54aa647b2 100644 --- a/docs/api/qiskit/0.26/quantum_info.mdx +++ b/docs/api/qiskit/0.26/quantum_info.mdx @@ -95,11 +95,11 @@ python_api_name: qiskit.quantum_info ## Synthesis -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | -| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, …]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | -| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose#qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | -| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | -| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | Decompose a Clifford operator into a QuantumCircuit. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | +| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, …]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | +| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | +| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | +| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | Decompose a Clifford operator into a QuantumCircuit. | diff --git a/docs/api/qiskit/0.26/utils.mdx b/docs/api/qiskit/0.26/utils.mdx index 21d78218140..a13db21a37d 100644 --- a/docs/api/qiskit/0.26/utils.mdx +++ b/docs/api/qiskit/0.26/utils.mdx @@ -26,15 +26,15 @@ python_api_name: qiskit.utils ## Algorithm Utilities -| | | -| --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | -| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | -| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | -| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | -| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | -| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | -| [`algorithm_globals`](qiskit.utils.algorithm_globals#qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | +| | | +| ----------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | +| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | +| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | +| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | +| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | +| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | +| [`algorithm_globals`](qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | | | | | -------------------------------------------------------------------------------- | -------------------------------------------- | From 03dd0983de4c49c6bd5aa6c817e9f747cb389248 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Fri, 6 Sep 2024 09:32:18 -0400 Subject: [PATCH 06/28] Regenerate qiskit 0.27.0 --- docs/api/qiskit/0.27/_toc.json | 16 +++++++++++++ .../qiskit/0.27/qiskit.aqua.aqua_globals.mdx | 15 +++++++++--- .../0.27/qiskit.optimization.INFINITY.mdx | 15 +++++++++--- ...it.optimization.applications.ising.tsp.mdx | 6 +++-- ....quantum_info.two_qubit_cnot_decompose.mdx | 23 +++++++++++++------ .../0.27/qiskit.utils.algorithm_globals.mdx | 15 +++++++++--- docs/api/qiskit/0.27/qiskit_aqua.mdx | 6 ++--- docs/api/qiskit/0.27/qiskit_optimization.mdx | 6 ++--- docs/api/qiskit/0.27/quantum_info.mdx | 14 +++++------ docs/api/qiskit/0.27/utils.mdx | 18 +++++++-------- 10 files changed, 94 insertions(+), 40 deletions(-) diff --git a/docs/api/qiskit/0.27/_toc.json b/docs/api/qiskit/0.27/_toc.json index 2b4baab6036..e3568a69811 100644 --- a/docs/api/qiskit/0.27/_toc.json +++ b/docs/api/qiskit/0.27/_toc.json @@ -1033,6 +1033,10 @@ "title": "SuperOp", "url": "/api/qiskit/0.27/qiskit.quantum_info.SuperOp" }, + { + "title": "two_qubit_cnot_decompose", + "url": "/api/qiskit/0.27/qiskit.quantum_info.two_qubit_cnot_decompose" + }, { "title": "TwoQubitBasisDecomposer", "url": "/api/qiskit/0.27/qiskit.quantum_info.TwoQubitBasisDecomposer" @@ -2627,6 +2631,10 @@ "title": "Module overview", "url": "/api/qiskit/0.27/utils" }, + { + "title": "algorithm_globals", + "url": "/api/qiskit/0.27/qiskit.utils.algorithm_globals" + }, { "title": "apply_prefix", "url": "/api/qiskit/0.27/qiskit.utils.apply_prefix" @@ -3632,6 +3640,10 @@ "title": "Module overview", "url": "/api/qiskit/0.27/qiskit_aqua" }, + { + "title": "aqua_globals", + "url": "/api/qiskit/0.27/qiskit.aqua.aqua_globals" + }, { "title": "AquaError", "url": "/api/qiskit/0.27/qiskit.aqua.AquaError" @@ -5650,6 +5662,10 @@ "title": "Module overview", "url": "/api/qiskit/0.27/qiskit_optimization" }, + { + "title": "INFINITY", + "url": "/api/qiskit/0.27/qiskit.optimization.INFINITY" + }, { "title": "QiskitOptimizationError", "url": "/api/qiskit/0.27/qiskit.optimization.QiskitOptimizationError" diff --git a/docs/api/qiskit/0.27/qiskit.aqua.aqua_globals.mdx b/docs/api/qiskit/0.27/qiskit.aqua.aqua_globals.mdx index fc13ae4d02f..24d03f24649 100644 --- a/docs/api/qiskit/0.27/qiskit.aqua.aqua_globals.mdx +++ b/docs/api/qiskit/0.27/qiskit.aqua.aqua_globals.mdx @@ -1,5 +1,14 @@ -# qiskit.aqua.aqua\_globals +--- +title: aqua_globals +description: API reference for qiskit.aqua.aqua_globals +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.aqua.aqua_globals +--- -## `aqua_globals` *= \* +# aqua\_globals + + + Aqua class for global properties. + -Aqua class for global properties. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.INFINITY.mdx b/docs/api/qiskit/0.27/qiskit.optimization.INFINITY.mdx index 21a0e027748..8628287a8e0 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.INFINITY.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.INFINITY.mdx @@ -1,5 +1,14 @@ -# qiskit.optimization.INFINITY +--- +title: INFINITY +description: API reference for qiskit.optimization.INFINITY +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.optimization.INFINITY +--- -## `INFINITY` *= 1e+20* +# INFINITY + + + Convert a string or number to a floating point number, if possible. + -Convert a string or number to a floating point number, if possible. diff --git a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.tsp.mdx b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.tsp.mdx index b970674ed02..61e14b4576c 100644 --- a/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.tsp.mdx +++ b/docs/api/qiskit/0.27/qiskit.optimization.applications.ising.tsp.mdx @@ -119,9 +119,11 @@ Convert symmetric TSP instances into Pauli list Deal with TSPLIB format. It supp list\[int] -**`logger` *= \*** +### logger -Instance data of TSP + + Instance data of TSP + ### parse\_tsplib\_format diff --git a/docs/api/qiskit/0.27/qiskit.quantum_info.two_qubit_cnot_decompose.mdx b/docs/api/qiskit/0.27/qiskit.quantum_info.two_qubit_cnot_decompose.mdx index b5e09776520..e231eea7c15 100644 --- a/docs/api/qiskit/0.27/qiskit.quantum_info.two_qubit_cnot_decompose.mdx +++ b/docs/api/qiskit/0.27/qiskit.quantum_info.two_qubit_cnot_decompose.mdx @@ -1,11 +1,20 @@ -# qiskit.quantum\_info.two\_qubit\_cnot\_decompose +--- +title: two_qubit_cnot_decompose +description: API reference for qiskit.quantum_info.two_qubit_cnot_decompose +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.quantum_info.two_qubit_cnot_decompose +--- -## `two_qubit_cnot_decompose` *= \* +# two\_qubit\_cnot\_decompose -A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. + + A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. -**Parameters** + **Parameters** + + * **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – Two-qubit gate to be used in the KAK decomposition. + * **basis\_fidelity** (*float*) – Fidelity to be assumed for applications of KAK Gate. Default 1.0. + * **euler\_basis** (*str*) – Basis string to be provided to OneQubitEulerDecomposer for 1Q synthesis. Valid options are \[‘ZYZ’, ‘ZXZ’, ‘XYX’, ‘U’, ‘U3’, ‘U1X’, ‘PSX’, ‘ZSX’, ‘RR’]. Default ‘U3’. + -* **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – Two-qubit gate to be used in the KAK decomposition. -* **basis\_fidelity** (*float*) – Fidelity to be assumed for applications of KAK Gate. Default 1.0. -* **euler\_basis** (*str*) – Basis string to be provided to OneQubitEulerDecomposer for 1Q synthesis. Valid options are \[‘ZYZ’, ‘ZXZ’, ‘XYX’, ‘U’, ‘U3’, ‘U1X’, ‘PSX’, ‘ZSX’, ‘RR’]. Default ‘U3’. diff --git a/docs/api/qiskit/0.27/qiskit.utils.algorithm_globals.mdx b/docs/api/qiskit/0.27/qiskit.utils.algorithm_globals.mdx index e7838b75c01..e4e70fe8472 100644 --- a/docs/api/qiskit/0.27/qiskit.utils.algorithm_globals.mdx +++ b/docs/api/qiskit/0.27/qiskit.utils.algorithm_globals.mdx @@ -1,5 +1,14 @@ -# qiskit.utils.algorithm\_globals +--- +title: algorithm_globals +description: API reference for qiskit.utils.algorithm_globals +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.utils.algorithm_globals +--- -## `algorithm_globals` *= \* +# algorithm\_globals + + + Class for global properties. + -Class for global properties. diff --git a/docs/api/qiskit/0.27/qiskit_aqua.mdx b/docs/api/qiskit/0.27/qiskit_aqua.mdx index 662688a9f25..c0c447c7f57 100644 --- a/docs/api/qiskit/0.27/qiskit_aqua.mdx +++ b/docs/api/qiskit/0.27/qiskit_aqua.mdx @@ -18,9 +18,9 @@ python_api_name: qiskit.aqua Qiskit Aqua provides a library of quantum algorithms and components to build quantum applications and leverage near-term devices. -| | | -| ---------------------------------------------------------------------------------------------- | --------------------------------- | -| [`aqua_globals`](qiskit.aqua.aqua_globals#qiskit.aqua.aqua_globals "qiskit.aqua.aqua_globals") | Aqua class for global properties. | +| | | +| --------------------------------------------------------------------- | --------------------------------- | +| [`aqua_globals`](qiskit.aqua.aqua_globals "qiskit.aqua.aqua_globals") | Aqua class for global properties. | Aqua globals class provides random number and max parallel process configuration. Aqua uses the random function and max parallel processes when running any function requiring randomization and/or that can be be done in parallel. Setting the random seed to a given value will ensure predictability in outcome when using a simulator (seeds should also be set in [`QuantumInstance`](qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance") for transpiler and simulator too). diff --git a/docs/api/qiskit/0.27/qiskit_optimization.mdx b/docs/api/qiskit/0.27/qiskit_optimization.mdx index 16f2daf5b36..c050718fb62 100644 --- a/docs/api/qiskit/0.27/qiskit_optimization.mdx +++ b/docs/api/qiskit/0.27/qiskit_optimization.mdx @@ -34,9 +34,9 @@ Representation of a Quadratically Constrained Quadratic Program supporting inequ In addition to standard Python errors the optimization module will raise this error if circumstances are that it cannot proceed to completion. -| | | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------- | -| [`INFINITY`](qiskit.optimization.INFINITY#qiskit.optimization.INFINITY "qiskit.optimization.INFINITY") | Convert a string or number to a floating point number, if possible. | +| | | +| ------------------------------------------------------------------------- | ------------------------------------------------------------------- | +| [`INFINITY`](qiskit.optimization.INFINITY "qiskit.optimization.INFINITY") | Convert a string or number to a floating point number, if possible. | A constant for infinity. diff --git a/docs/api/qiskit/0.27/quantum_info.mdx b/docs/api/qiskit/0.27/quantum_info.mdx index 34cdf797e27..1e54aa647b2 100644 --- a/docs/api/qiskit/0.27/quantum_info.mdx +++ b/docs/api/qiskit/0.27/quantum_info.mdx @@ -95,11 +95,11 @@ python_api_name: qiskit.quantum_info ## Synthesis -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | -| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, …]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | -| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose#qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | -| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | -| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | Decompose a Clifford operator into a QuantumCircuit. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | +| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, …]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | +| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | +| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | +| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | Decompose a Clifford operator into a QuantumCircuit. | diff --git a/docs/api/qiskit/0.27/utils.mdx b/docs/api/qiskit/0.27/utils.mdx index 21d78218140..a13db21a37d 100644 --- a/docs/api/qiskit/0.27/utils.mdx +++ b/docs/api/qiskit/0.27/utils.mdx @@ -26,15 +26,15 @@ python_api_name: qiskit.utils ## Algorithm Utilities -| | | -| --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | -| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | -| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | -| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | -| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | -| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | -| [`algorithm_globals`](qiskit.utils.algorithm_globals#qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | +| | | +| ----------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | +| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | +| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | +| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | +| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | +| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | +| [`algorithm_globals`](qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | | | | | -------------------------------------------------------------------------------- | -------------------------------------------- | From 2483b537f47704433949425dc468bd006309b711 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Fri, 6 Sep 2024 09:34:06 -0400 Subject: [PATCH 07/28] Regenerate qiskit 0.28.0 --- docs/api/qiskit/0.28/_toc.json | 16 ++++++++++++ .../qiskit/0.28/qiskit.aqua.aqua_globals.mdx | 15 ++++++++--- .../0.28/qiskit.optimization.INFINITY.mdx | 15 ++++++++--- ...it.optimization.applications.ising.tsp.mdx | 6 +++-- ....quantum_info.two_qubit_cnot_decompose.mdx | 25 +++++++++++++------ .../0.28/qiskit.utils.algorithm_globals.mdx | 15 ++++++++--- docs/api/qiskit/0.28/qiskit_aqua.mdx | 6 ++--- docs/api/qiskit/0.28/qiskit_optimization.mdx | 6 ++--- docs/api/qiskit/0.28/quantum_info.mdx | 14 +++++------ docs/api/qiskit/0.28/utils.mdx | 18 ++++++------- 10 files changed, 95 insertions(+), 41 deletions(-) diff --git a/docs/api/qiskit/0.28/_toc.json b/docs/api/qiskit/0.28/_toc.json index 9b071a3f927..6138e3f29a9 100644 --- a/docs/api/qiskit/0.28/_toc.json +++ b/docs/api/qiskit/0.28/_toc.json @@ -1069,6 +1069,10 @@ "title": "SuperOp", "url": "/api/qiskit/0.28/qiskit.quantum_info.SuperOp" }, + { + "title": "two_qubit_cnot_decompose", + "url": "/api/qiskit/0.28/qiskit.quantum_info.two_qubit_cnot_decompose" + }, { "title": "TwoQubitBasisDecomposer", "url": "/api/qiskit/0.28/qiskit.quantum_info.TwoQubitBasisDecomposer" @@ -2695,6 +2699,10 @@ "title": "Module overview", "url": "/api/qiskit/0.28/utils" }, + { + "title": "algorithm_globals", + "url": "/api/qiskit/0.28/qiskit.utils.algorithm_globals" + }, { "title": "apply_prefix", "url": "/api/qiskit/0.28/qiskit.utils.apply_prefix" @@ -3728,6 +3736,10 @@ "title": "Module overview", "url": "/api/qiskit/0.28/qiskit_aqua" }, + { + "title": "aqua_globals", + "url": "/api/qiskit/0.28/qiskit.aqua.aqua_globals" + }, { "title": "AquaError", "url": "/api/qiskit/0.28/qiskit.aqua.AquaError" @@ -5746,6 +5758,10 @@ "title": "Module overview", "url": "/api/qiskit/0.28/qiskit_optimization" }, + { + "title": "INFINITY", + "url": "/api/qiskit/0.28/qiskit.optimization.INFINITY" + }, { "title": "QiskitOptimizationError", "url": "/api/qiskit/0.28/qiskit.optimization.QiskitOptimizationError" diff --git a/docs/api/qiskit/0.28/qiskit.aqua.aqua_globals.mdx b/docs/api/qiskit/0.28/qiskit.aqua.aqua_globals.mdx index fc13ae4d02f..24d03f24649 100644 --- a/docs/api/qiskit/0.28/qiskit.aqua.aqua_globals.mdx +++ b/docs/api/qiskit/0.28/qiskit.aqua.aqua_globals.mdx @@ -1,5 +1,14 @@ -# qiskit.aqua.aqua\_globals +--- +title: aqua_globals +description: API reference for qiskit.aqua.aqua_globals +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.aqua.aqua_globals +--- -## `aqua_globals` *= \* +# aqua\_globals + + + Aqua class for global properties. + -Aqua class for global properties. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.INFINITY.mdx b/docs/api/qiskit/0.28/qiskit.optimization.INFINITY.mdx index 21a0e027748..8628287a8e0 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.INFINITY.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.INFINITY.mdx @@ -1,5 +1,14 @@ -# qiskit.optimization.INFINITY +--- +title: INFINITY +description: API reference for qiskit.optimization.INFINITY +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.optimization.INFINITY +--- -## `INFINITY` *= 1e+20* +# INFINITY + + + Convert a string or number to a floating point number, if possible. + -Convert a string or number to a floating point number, if possible. diff --git a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.tsp.mdx b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.tsp.mdx index b970674ed02..61e14b4576c 100644 --- a/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.tsp.mdx +++ b/docs/api/qiskit/0.28/qiskit.optimization.applications.ising.tsp.mdx @@ -119,9 +119,11 @@ Convert symmetric TSP instances into Pauli list Deal with TSPLIB format. It supp list\[int] -**`logger` *= \*** +### logger -Instance data of TSP + + Instance data of TSP + ### parse\_tsplib\_format diff --git a/docs/api/qiskit/0.28/qiskit.quantum_info.two_qubit_cnot_decompose.mdx b/docs/api/qiskit/0.28/qiskit.quantum_info.two_qubit_cnot_decompose.mdx index 505da64312b..6f32b7048fc 100644 --- a/docs/api/qiskit/0.28/qiskit.quantum_info.two_qubit_cnot_decompose.mdx +++ b/docs/api/qiskit/0.28/qiskit.quantum_info.two_qubit_cnot_decompose.mdx @@ -1,12 +1,21 @@ -# qiskit.quantum\_info.two\_qubit\_cnot\_decompose +--- +title: two_qubit_cnot_decompose +description: API reference for qiskit.quantum_info.two_qubit_cnot_decompose +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.quantum_info.two_qubit_cnot_decompose +--- -## `two_qubit_cnot_decompose` *= \* +# two\_qubit\_cnot\_decompose -A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. + + A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. -**Parameters** + **Parameters** + + * **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – Two-qubit gate to be used in the KAK decomposition. + * **basis\_fidelity** (*float*) – Fidelity to be assumed for applications of KAK Gate. Default 1.0. + * **euler\_basis** (*str*) – Basis string to be provided to OneQubitEulerDecomposer for 1Q synthesis. Valid options are \[‘ZYZ’, ‘ZXZ’, ‘XYX’, ‘U’, ‘U3’, ‘U1X’, ‘PSX’, ‘ZSX’, ‘RR’]. Default ‘U3’. + * **pulse\_optimize** (*None or bool*) – If True, try to do decomposition which minimizes local unitaries in between entangling gates. This will raise an exception if an optimal decomposition is not implemented. Currently, only \[\{CX, SX, RZ}] is known. If False, don’t attempt optimization. If None, attempt optimization but don’t raise if unknown. + -* **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – Two-qubit gate to be used in the KAK decomposition. -* **basis\_fidelity** (*float*) – Fidelity to be assumed for applications of KAK Gate. Default 1.0. -* **euler\_basis** (*str*) – Basis string to be provided to OneQubitEulerDecomposer for 1Q synthesis. Valid options are \[‘ZYZ’, ‘ZXZ’, ‘XYX’, ‘U’, ‘U3’, ‘U1X’, ‘PSX’, ‘ZSX’, ‘RR’]. Default ‘U3’. -* **pulse\_optimize** (*None or bool*) – If True, try to do decomposition which minimizes local unitaries in between entangling gates. This will raise an exception if an optimal decomposition is not implemented. Currently, only \[\{CX, SX, RZ}] is known. If False, don’t attempt optimization. If None, attempt optimization but don’t raise if unknown. diff --git a/docs/api/qiskit/0.28/qiskit.utils.algorithm_globals.mdx b/docs/api/qiskit/0.28/qiskit.utils.algorithm_globals.mdx index e7838b75c01..e4e70fe8472 100644 --- a/docs/api/qiskit/0.28/qiskit.utils.algorithm_globals.mdx +++ b/docs/api/qiskit/0.28/qiskit.utils.algorithm_globals.mdx @@ -1,5 +1,14 @@ -# qiskit.utils.algorithm\_globals +--- +title: algorithm_globals +description: API reference for qiskit.utils.algorithm_globals +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.utils.algorithm_globals +--- -## `algorithm_globals` *= \* +# algorithm\_globals + + + Class for global properties. + -Class for global properties. diff --git a/docs/api/qiskit/0.28/qiskit_aqua.mdx b/docs/api/qiskit/0.28/qiskit_aqua.mdx index 662688a9f25..c0c447c7f57 100644 --- a/docs/api/qiskit/0.28/qiskit_aqua.mdx +++ b/docs/api/qiskit/0.28/qiskit_aqua.mdx @@ -18,9 +18,9 @@ python_api_name: qiskit.aqua Qiskit Aqua provides a library of quantum algorithms and components to build quantum applications and leverage near-term devices. -| | | -| ---------------------------------------------------------------------------------------------- | --------------------------------- | -| [`aqua_globals`](qiskit.aqua.aqua_globals#qiskit.aqua.aqua_globals "qiskit.aqua.aqua_globals") | Aqua class for global properties. | +| | | +| --------------------------------------------------------------------- | --------------------------------- | +| [`aqua_globals`](qiskit.aqua.aqua_globals "qiskit.aqua.aqua_globals") | Aqua class for global properties. | Aqua globals class provides random number and max parallel process configuration. Aqua uses the random function and max parallel processes when running any function requiring randomization and/or that can be be done in parallel. Setting the random seed to a given value will ensure predictability in outcome when using a simulator (seeds should also be set in [`QuantumInstance`](qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance") for transpiler and simulator too). diff --git a/docs/api/qiskit/0.28/qiskit_optimization.mdx b/docs/api/qiskit/0.28/qiskit_optimization.mdx index 16f2daf5b36..c050718fb62 100644 --- a/docs/api/qiskit/0.28/qiskit_optimization.mdx +++ b/docs/api/qiskit/0.28/qiskit_optimization.mdx @@ -34,9 +34,9 @@ Representation of a Quadratically Constrained Quadratic Program supporting inequ In addition to standard Python errors the optimization module will raise this error if circumstances are that it cannot proceed to completion. -| | | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------- | -| [`INFINITY`](qiskit.optimization.INFINITY#qiskit.optimization.INFINITY "qiskit.optimization.INFINITY") | Convert a string or number to a floating point number, if possible. | +| | | +| ------------------------------------------------------------------------- | ------------------------------------------------------------------- | +| [`INFINITY`](qiskit.optimization.INFINITY "qiskit.optimization.INFINITY") | Convert a string or number to a floating point number, if possible. | A constant for infinity. diff --git a/docs/api/qiskit/0.28/quantum_info.mdx b/docs/api/qiskit/0.28/quantum_info.mdx index 215c9455f27..3949df71ea7 100644 --- a/docs/api/qiskit/0.28/quantum_info.mdx +++ b/docs/api/qiskit/0.28/quantum_info.mdx @@ -97,11 +97,11 @@ python_api_name: qiskit.quantum_info ## Synthesis -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | -| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, …]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | -| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose#qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | -| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | -| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | Decompose a Clifford operator into a QuantumCircuit. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | +| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, …]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | +| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | +| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | +| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | Decompose a Clifford operator into a QuantumCircuit. | diff --git a/docs/api/qiskit/0.28/utils.mdx b/docs/api/qiskit/0.28/utils.mdx index 21d78218140..a13db21a37d 100644 --- a/docs/api/qiskit/0.28/utils.mdx +++ b/docs/api/qiskit/0.28/utils.mdx @@ -26,15 +26,15 @@ python_api_name: qiskit.utils ## Algorithm Utilities -| | | -| --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | -| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | -| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | -| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | -| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | -| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | -| [`algorithm_globals`](qiskit.utils.algorithm_globals#qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | +| | | +| ----------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | +| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | +| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | +| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | +| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | +| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | +| [`algorithm_globals`](qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | | | | | -------------------------------------------------------------------------------- | -------------------------------------------- | From acc612536c9a25445a03665e5ce4178e6bea96ed Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Fri, 6 Sep 2024 09:35:02 -0400 Subject: [PATCH 08/28] Regenerate qiskit 0.29.1 --- docs/api/qiskit/0.29/_toc.json | 16 ++++++++++++ .../qiskit/0.29/qiskit.aqua.aqua_globals.mdx | 15 ++++++++--- .../0.29/qiskit.optimization.INFINITY.mdx | 15 ++++++++--- ....quantum_info.two_qubit_cnot_decompose.mdx | 25 +++++++++++++------ .../0.29/qiskit.utils.algorithm_globals.mdx | 15 ++++++++--- docs/api/qiskit/0.29/qiskit_aqua.mdx | 6 ++--- docs/api/qiskit/0.29/qiskit_optimization.mdx | 6 ++--- docs/api/qiskit/0.29/quantum_info.mdx | 14 +++++------ docs/api/qiskit/0.29/utils.mdx | 18 ++++++------- 9 files changed, 91 insertions(+), 39 deletions(-) diff --git a/docs/api/qiskit/0.29/_toc.json b/docs/api/qiskit/0.29/_toc.json index deddb94b61f..8dec3c04f89 100644 --- a/docs/api/qiskit/0.29/_toc.json +++ b/docs/api/qiskit/0.29/_toc.json @@ -1069,6 +1069,10 @@ "title": "SuperOp", "url": "/api/qiskit/0.29/qiskit.quantum_info.SuperOp" }, + { + "title": "two_qubit_cnot_decompose", + "url": "/api/qiskit/0.29/qiskit.quantum_info.two_qubit_cnot_decompose" + }, { "title": "TwoQubitBasisDecomposer", "url": "/api/qiskit/0.29/qiskit.quantum_info.TwoQubitBasisDecomposer" @@ -2708,6 +2712,10 @@ "title": "Module overview", "url": "/api/qiskit/0.29/utils" }, + { + "title": "algorithm_globals", + "url": "/api/qiskit/0.29/qiskit.utils.algorithm_globals" + }, { "title": "apply_prefix", "url": "/api/qiskit/0.29/qiskit.utils.apply_prefix" @@ -3753,6 +3761,10 @@ "title": "Module overview", "url": "/api/qiskit/0.29/qiskit_aqua" }, + { + "title": "aqua_globals", + "url": "/api/qiskit/0.29/qiskit.aqua.aqua_globals" + }, { "title": "AquaError", "url": "/api/qiskit/0.29/qiskit.aqua.AquaError" @@ -5771,6 +5783,10 @@ "title": "Module overview", "url": "/api/qiskit/0.29/qiskit_optimization" }, + { + "title": "INFINITY", + "url": "/api/qiskit/0.29/qiskit.optimization.INFINITY" + }, { "title": "QiskitOptimizationError", "url": "/api/qiskit/0.29/qiskit.optimization.QiskitOptimizationError" diff --git a/docs/api/qiskit/0.29/qiskit.aqua.aqua_globals.mdx b/docs/api/qiskit/0.29/qiskit.aqua.aqua_globals.mdx index fc13ae4d02f..24d03f24649 100644 --- a/docs/api/qiskit/0.29/qiskit.aqua.aqua_globals.mdx +++ b/docs/api/qiskit/0.29/qiskit.aqua.aqua_globals.mdx @@ -1,5 +1,14 @@ -# qiskit.aqua.aqua\_globals +--- +title: aqua_globals +description: API reference for qiskit.aqua.aqua_globals +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.aqua.aqua_globals +--- -## `aqua_globals` *= \* +# aqua\_globals + + + Aqua class for global properties. + -Aqua class for global properties. diff --git a/docs/api/qiskit/0.29/qiskit.optimization.INFINITY.mdx b/docs/api/qiskit/0.29/qiskit.optimization.INFINITY.mdx index 21a0e027748..8628287a8e0 100644 --- a/docs/api/qiskit/0.29/qiskit.optimization.INFINITY.mdx +++ b/docs/api/qiskit/0.29/qiskit.optimization.INFINITY.mdx @@ -1,5 +1,14 @@ -# qiskit.optimization.INFINITY +--- +title: INFINITY +description: API reference for qiskit.optimization.INFINITY +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.optimization.INFINITY +--- -## `INFINITY` *= 1e+20* +# INFINITY + + + Convert a string or number to a floating point number, if possible. + -Convert a string or number to a floating point number, if possible. diff --git a/docs/api/qiskit/0.29/qiskit.quantum_info.two_qubit_cnot_decompose.mdx b/docs/api/qiskit/0.29/qiskit.quantum_info.two_qubit_cnot_decompose.mdx index 505da64312b..6f32b7048fc 100644 --- a/docs/api/qiskit/0.29/qiskit.quantum_info.two_qubit_cnot_decompose.mdx +++ b/docs/api/qiskit/0.29/qiskit.quantum_info.two_qubit_cnot_decompose.mdx @@ -1,12 +1,21 @@ -# qiskit.quantum\_info.two\_qubit\_cnot\_decompose +--- +title: two_qubit_cnot_decompose +description: API reference for qiskit.quantum_info.two_qubit_cnot_decompose +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.quantum_info.two_qubit_cnot_decompose +--- -## `two_qubit_cnot_decompose` *= \* +# two\_qubit\_cnot\_decompose -A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. + + A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. -**Parameters** + **Parameters** + + * **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – Two-qubit gate to be used in the KAK decomposition. + * **basis\_fidelity** (*float*) – Fidelity to be assumed for applications of KAK Gate. Default 1.0. + * **euler\_basis** (*str*) – Basis string to be provided to OneQubitEulerDecomposer for 1Q synthesis. Valid options are \[‘ZYZ’, ‘ZXZ’, ‘XYX’, ‘U’, ‘U3’, ‘U1X’, ‘PSX’, ‘ZSX’, ‘RR’]. Default ‘U3’. + * **pulse\_optimize** (*None or bool*) – If True, try to do decomposition which minimizes local unitaries in between entangling gates. This will raise an exception if an optimal decomposition is not implemented. Currently, only \[\{CX, SX, RZ}] is known. If False, don’t attempt optimization. If None, attempt optimization but don’t raise if unknown. + -* **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – Two-qubit gate to be used in the KAK decomposition. -* **basis\_fidelity** (*float*) – Fidelity to be assumed for applications of KAK Gate. Default 1.0. -* **euler\_basis** (*str*) – Basis string to be provided to OneQubitEulerDecomposer for 1Q synthesis. Valid options are \[‘ZYZ’, ‘ZXZ’, ‘XYX’, ‘U’, ‘U3’, ‘U1X’, ‘PSX’, ‘ZSX’, ‘RR’]. Default ‘U3’. -* **pulse\_optimize** (*None or bool*) – If True, try to do decomposition which minimizes local unitaries in between entangling gates. This will raise an exception if an optimal decomposition is not implemented. Currently, only \[\{CX, SX, RZ}] is known. If False, don’t attempt optimization. If None, attempt optimization but don’t raise if unknown. diff --git a/docs/api/qiskit/0.29/qiskit.utils.algorithm_globals.mdx b/docs/api/qiskit/0.29/qiskit.utils.algorithm_globals.mdx index e7838b75c01..e4e70fe8472 100644 --- a/docs/api/qiskit/0.29/qiskit.utils.algorithm_globals.mdx +++ b/docs/api/qiskit/0.29/qiskit.utils.algorithm_globals.mdx @@ -1,5 +1,14 @@ -# qiskit.utils.algorithm\_globals +--- +title: algorithm_globals +description: API reference for qiskit.utils.algorithm_globals +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.utils.algorithm_globals +--- -## `algorithm_globals` *= \* +# algorithm\_globals + + + Class for global properties. + -Class for global properties. diff --git a/docs/api/qiskit/0.29/qiskit_aqua.mdx b/docs/api/qiskit/0.29/qiskit_aqua.mdx index 662688a9f25..c0c447c7f57 100644 --- a/docs/api/qiskit/0.29/qiskit_aqua.mdx +++ b/docs/api/qiskit/0.29/qiskit_aqua.mdx @@ -18,9 +18,9 @@ python_api_name: qiskit.aqua Qiskit Aqua provides a library of quantum algorithms and components to build quantum applications and leverage near-term devices. -| | | -| ---------------------------------------------------------------------------------------------- | --------------------------------- | -| [`aqua_globals`](qiskit.aqua.aqua_globals#qiskit.aqua.aqua_globals "qiskit.aqua.aqua_globals") | Aqua class for global properties. | +| | | +| --------------------------------------------------------------------- | --------------------------------- | +| [`aqua_globals`](qiskit.aqua.aqua_globals "qiskit.aqua.aqua_globals") | Aqua class for global properties. | Aqua globals class provides random number and max parallel process configuration. Aqua uses the random function and max parallel processes when running any function requiring randomization and/or that can be be done in parallel. Setting the random seed to a given value will ensure predictability in outcome when using a simulator (seeds should also be set in [`QuantumInstance`](qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance") for transpiler and simulator too). diff --git a/docs/api/qiskit/0.29/qiskit_optimization.mdx b/docs/api/qiskit/0.29/qiskit_optimization.mdx index 16f2daf5b36..c050718fb62 100644 --- a/docs/api/qiskit/0.29/qiskit_optimization.mdx +++ b/docs/api/qiskit/0.29/qiskit_optimization.mdx @@ -34,9 +34,9 @@ Representation of a Quadratically Constrained Quadratic Program supporting inequ In addition to standard Python errors the optimization module will raise this error if circumstances are that it cannot proceed to completion. -| | | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------- | -| [`INFINITY`](qiskit.optimization.INFINITY#qiskit.optimization.INFINITY "qiskit.optimization.INFINITY") | Convert a string or number to a floating point number, if possible. | +| | | +| ------------------------------------------------------------------------- | ------------------------------------------------------------------- | +| [`INFINITY`](qiskit.optimization.INFINITY "qiskit.optimization.INFINITY") | Convert a string or number to a floating point number, if possible. | A constant for infinity. diff --git a/docs/api/qiskit/0.29/quantum_info.mdx b/docs/api/qiskit/0.29/quantum_info.mdx index 215c9455f27..3949df71ea7 100644 --- a/docs/api/qiskit/0.29/quantum_info.mdx +++ b/docs/api/qiskit/0.29/quantum_info.mdx @@ -97,11 +97,11 @@ python_api_name: qiskit.quantum_info ## Synthesis -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | -| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, …]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | -| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose#qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | -| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | -| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | Decompose a Clifford operator into a QuantumCircuit. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | +| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, …]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | +| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | +| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | +| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | Decompose a Clifford operator into a QuantumCircuit. | diff --git a/docs/api/qiskit/0.29/utils.mdx b/docs/api/qiskit/0.29/utils.mdx index 21d78218140..a13db21a37d 100644 --- a/docs/api/qiskit/0.29/utils.mdx +++ b/docs/api/qiskit/0.29/utils.mdx @@ -26,15 +26,15 @@ python_api_name: qiskit.utils ## Algorithm Utilities -| | | -| --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | -| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | -| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | -| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | -| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | -| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | -| [`algorithm_globals`](qiskit.utils.algorithm_globals#qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | +| | | +| ----------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | +| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | +| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | +| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | +| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | +| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | +| [`algorithm_globals`](qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | | | | | -------------------------------------------------------------------------------- | -------------------------------------------- | From 8c88b5a03cacc5d054b340a4735729e8f03be954 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Fri, 6 Sep 2024 09:35:54 -0400 Subject: [PATCH 09/28] Regenerate qiskit 0.30.1 --- docs/api/qiskit/0.30/_toc.json | 16 ++++++++++++ .../qiskit/0.30/qiskit.aqua.aqua_globals.mdx | 15 ++++++++--- .../0.30/qiskit.optimization.INFINITY.mdx | 15 ++++++++--- ....quantum_info.two_qubit_cnot_decompose.mdx | 25 +++++++++++++------ .../0.30/qiskit.utils.algorithm_globals.mdx | 15 ++++++++--- docs/api/qiskit/0.30/qiskit_aqua.mdx | 6 ++--- docs/api/qiskit/0.30/qiskit_optimization.mdx | 6 ++--- docs/api/qiskit/0.30/quantum_info.mdx | 14 +++++------ docs/api/qiskit/0.30/utils.mdx | 18 ++++++------- 9 files changed, 91 insertions(+), 39 deletions(-) diff --git a/docs/api/qiskit/0.30/_toc.json b/docs/api/qiskit/0.30/_toc.json index 166bd07f469..f26fe94ff56 100644 --- a/docs/api/qiskit/0.30/_toc.json +++ b/docs/api/qiskit/0.30/_toc.json @@ -1069,6 +1069,10 @@ "title": "SuperOp", "url": "/api/qiskit/0.30/qiskit.quantum_info.SuperOp" }, + { + "title": "two_qubit_cnot_decompose", + "url": "/api/qiskit/0.30/qiskit.quantum_info.two_qubit_cnot_decompose" + }, { "title": "TwoQubitBasisDecomposer", "url": "/api/qiskit/0.30/qiskit.quantum_info.TwoQubitBasisDecomposer" @@ -2708,6 +2712,10 @@ "title": "Module overview", "url": "/api/qiskit/0.30/utils" }, + { + "title": "algorithm_globals", + "url": "/api/qiskit/0.30/qiskit.utils.algorithm_globals" + }, { "title": "apply_prefix", "url": "/api/qiskit/0.30/qiskit.utils.apply_prefix" @@ -3766,6 +3774,10 @@ "title": "Module overview", "url": "/api/qiskit/0.30/qiskit_aqua" }, + { + "title": "aqua_globals", + "url": "/api/qiskit/0.30/qiskit.aqua.aqua_globals" + }, { "title": "AquaError", "url": "/api/qiskit/0.30/qiskit.aqua.AquaError" @@ -5784,6 +5796,10 @@ "title": "Module overview", "url": "/api/qiskit/0.30/qiskit_optimization" }, + { + "title": "INFINITY", + "url": "/api/qiskit/0.30/qiskit.optimization.INFINITY" + }, { "title": "QiskitOptimizationError", "url": "/api/qiskit/0.30/qiskit.optimization.QiskitOptimizationError" diff --git a/docs/api/qiskit/0.30/qiskit.aqua.aqua_globals.mdx b/docs/api/qiskit/0.30/qiskit.aqua.aqua_globals.mdx index fc13ae4d02f..24d03f24649 100644 --- a/docs/api/qiskit/0.30/qiskit.aqua.aqua_globals.mdx +++ b/docs/api/qiskit/0.30/qiskit.aqua.aqua_globals.mdx @@ -1,5 +1,14 @@ -# qiskit.aqua.aqua\_globals +--- +title: aqua_globals +description: API reference for qiskit.aqua.aqua_globals +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.aqua.aqua_globals +--- -## `aqua_globals` *= \* +# aqua\_globals + + + Aqua class for global properties. + -Aqua class for global properties. diff --git a/docs/api/qiskit/0.30/qiskit.optimization.INFINITY.mdx b/docs/api/qiskit/0.30/qiskit.optimization.INFINITY.mdx index 21a0e027748..8628287a8e0 100644 --- a/docs/api/qiskit/0.30/qiskit.optimization.INFINITY.mdx +++ b/docs/api/qiskit/0.30/qiskit.optimization.INFINITY.mdx @@ -1,5 +1,14 @@ -# qiskit.optimization.INFINITY +--- +title: INFINITY +description: API reference for qiskit.optimization.INFINITY +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.optimization.INFINITY +--- -## `INFINITY` *= 1e+20* +# INFINITY + + + Convert a string or number to a floating point number, if possible. + -Convert a string or number to a floating point number, if possible. diff --git a/docs/api/qiskit/0.30/qiskit.quantum_info.two_qubit_cnot_decompose.mdx b/docs/api/qiskit/0.30/qiskit.quantum_info.two_qubit_cnot_decompose.mdx index 505da64312b..6f32b7048fc 100644 --- a/docs/api/qiskit/0.30/qiskit.quantum_info.two_qubit_cnot_decompose.mdx +++ b/docs/api/qiskit/0.30/qiskit.quantum_info.two_qubit_cnot_decompose.mdx @@ -1,12 +1,21 @@ -# qiskit.quantum\_info.two\_qubit\_cnot\_decompose +--- +title: two_qubit_cnot_decompose +description: API reference for qiskit.quantum_info.two_qubit_cnot_decompose +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.quantum_info.two_qubit_cnot_decompose +--- -## `two_qubit_cnot_decompose` *= \* +# two\_qubit\_cnot\_decompose -A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. + + A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. -**Parameters** + **Parameters** + + * **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – Two-qubit gate to be used in the KAK decomposition. + * **basis\_fidelity** (*float*) – Fidelity to be assumed for applications of KAK Gate. Default 1.0. + * **euler\_basis** (*str*) – Basis string to be provided to OneQubitEulerDecomposer for 1Q synthesis. Valid options are \[‘ZYZ’, ‘ZXZ’, ‘XYX’, ‘U’, ‘U3’, ‘U1X’, ‘PSX’, ‘ZSX’, ‘RR’]. Default ‘U3’. + * **pulse\_optimize** (*None or bool*) – If True, try to do decomposition which minimizes local unitaries in between entangling gates. This will raise an exception if an optimal decomposition is not implemented. Currently, only \[\{CX, SX, RZ}] is known. If False, don’t attempt optimization. If None, attempt optimization but don’t raise if unknown. + -* **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – Two-qubit gate to be used in the KAK decomposition. -* **basis\_fidelity** (*float*) – Fidelity to be assumed for applications of KAK Gate. Default 1.0. -* **euler\_basis** (*str*) – Basis string to be provided to OneQubitEulerDecomposer for 1Q synthesis. Valid options are \[‘ZYZ’, ‘ZXZ’, ‘XYX’, ‘U’, ‘U3’, ‘U1X’, ‘PSX’, ‘ZSX’, ‘RR’]. Default ‘U3’. -* **pulse\_optimize** (*None or bool*) – If True, try to do decomposition which minimizes local unitaries in between entangling gates. This will raise an exception if an optimal decomposition is not implemented. Currently, only \[\{CX, SX, RZ}] is known. If False, don’t attempt optimization. If None, attempt optimization but don’t raise if unknown. diff --git a/docs/api/qiskit/0.30/qiskit.utils.algorithm_globals.mdx b/docs/api/qiskit/0.30/qiskit.utils.algorithm_globals.mdx index e7838b75c01..e4e70fe8472 100644 --- a/docs/api/qiskit/0.30/qiskit.utils.algorithm_globals.mdx +++ b/docs/api/qiskit/0.30/qiskit.utils.algorithm_globals.mdx @@ -1,5 +1,14 @@ -# qiskit.utils.algorithm\_globals +--- +title: algorithm_globals +description: API reference for qiskit.utils.algorithm_globals +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.utils.algorithm_globals +--- -## `algorithm_globals` *= \* +# algorithm\_globals + + + Class for global properties. + -Class for global properties. diff --git a/docs/api/qiskit/0.30/qiskit_aqua.mdx b/docs/api/qiskit/0.30/qiskit_aqua.mdx index 662688a9f25..c0c447c7f57 100644 --- a/docs/api/qiskit/0.30/qiskit_aqua.mdx +++ b/docs/api/qiskit/0.30/qiskit_aqua.mdx @@ -18,9 +18,9 @@ python_api_name: qiskit.aqua Qiskit Aqua provides a library of quantum algorithms and components to build quantum applications and leverage near-term devices. -| | | -| ---------------------------------------------------------------------------------------------- | --------------------------------- | -| [`aqua_globals`](qiskit.aqua.aqua_globals#qiskit.aqua.aqua_globals "qiskit.aqua.aqua_globals") | Aqua class for global properties. | +| | | +| --------------------------------------------------------------------- | --------------------------------- | +| [`aqua_globals`](qiskit.aqua.aqua_globals "qiskit.aqua.aqua_globals") | Aqua class for global properties. | Aqua globals class provides random number and max parallel process configuration. Aqua uses the random function and max parallel processes when running any function requiring randomization and/or that can be be done in parallel. Setting the random seed to a given value will ensure predictability in outcome when using a simulator (seeds should also be set in [`QuantumInstance`](qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance") for transpiler and simulator too). diff --git a/docs/api/qiskit/0.30/qiskit_optimization.mdx b/docs/api/qiskit/0.30/qiskit_optimization.mdx index 16f2daf5b36..c050718fb62 100644 --- a/docs/api/qiskit/0.30/qiskit_optimization.mdx +++ b/docs/api/qiskit/0.30/qiskit_optimization.mdx @@ -34,9 +34,9 @@ Representation of a Quadratically Constrained Quadratic Program supporting inequ In addition to standard Python errors the optimization module will raise this error if circumstances are that it cannot proceed to completion. -| | | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------- | -| [`INFINITY`](qiskit.optimization.INFINITY#qiskit.optimization.INFINITY "qiskit.optimization.INFINITY") | Convert a string or number to a floating point number, if possible. | +| | | +| ------------------------------------------------------------------------- | ------------------------------------------------------------------- | +| [`INFINITY`](qiskit.optimization.INFINITY "qiskit.optimization.INFINITY") | Convert a string or number to a floating point number, if possible. | A constant for infinity. diff --git a/docs/api/qiskit/0.30/quantum_info.mdx b/docs/api/qiskit/0.30/quantum_info.mdx index 215c9455f27..3949df71ea7 100644 --- a/docs/api/qiskit/0.30/quantum_info.mdx +++ b/docs/api/qiskit/0.30/quantum_info.mdx @@ -97,11 +97,11 @@ python_api_name: qiskit.quantum_info ## Synthesis -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | -| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, …]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | -| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose#qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | -| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | -| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | Decompose a Clifford operator into a QuantumCircuit. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | +| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, …]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | +| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | +| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | +| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | Decompose a Clifford operator into a QuantumCircuit. | diff --git a/docs/api/qiskit/0.30/utils.mdx b/docs/api/qiskit/0.30/utils.mdx index 21d78218140..a13db21a37d 100644 --- a/docs/api/qiskit/0.30/utils.mdx +++ b/docs/api/qiskit/0.30/utils.mdx @@ -26,15 +26,15 @@ python_api_name: qiskit.utils ## Algorithm Utilities -| | | -| --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | -| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | -| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | -| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | -| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | -| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | -| [`algorithm_globals`](qiskit.utils.algorithm_globals#qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | +| | | +| ----------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | +| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | +| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | +| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | +| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | +| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | +| [`algorithm_globals`](qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | | | | | -------------------------------------------------------------------------------- | -------------------------------------------- | From 87fabf9bff91b9435efbe17b690016d8ee137766 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Fri, 6 Sep 2024 09:36:51 -0400 Subject: [PATCH 10/28] Regenerate qiskit 0.31.0 --- docs/api/qiskit/0.31/_toc.json | 16 ++++++++++++ .../qiskit/0.31/qiskit.aqua.aqua_globals.mdx | 15 ++++++++--- .../0.31/qiskit.optimization.INFINITY.mdx | 15 ++++++++--- ....quantum_info.two_qubit_cnot_decompose.mdx | 25 +++++++++++++------ .../0.31/qiskit.utils.algorithm_globals.mdx | 15 ++++++++--- docs/api/qiskit/0.31/qiskit_aqua.mdx | 6 ++--- docs/api/qiskit/0.31/qiskit_optimization.mdx | 6 ++--- docs/api/qiskit/0.31/quantum_info.mdx | 14 +++++------ docs/api/qiskit/0.31/utils.mdx | 18 ++++++------- 9 files changed, 91 insertions(+), 39 deletions(-) diff --git a/docs/api/qiskit/0.31/_toc.json b/docs/api/qiskit/0.31/_toc.json index 3cbe82effd7..90a695c2845 100644 --- a/docs/api/qiskit/0.31/_toc.json +++ b/docs/api/qiskit/0.31/_toc.json @@ -1069,6 +1069,10 @@ "title": "SuperOp", "url": "/api/qiskit/0.31/qiskit.quantum_info.SuperOp" }, + { + "title": "two_qubit_cnot_decompose", + "url": "/api/qiskit/0.31/qiskit.quantum_info.two_qubit_cnot_decompose" + }, { "title": "TwoQubitBasisDecomposer", "url": "/api/qiskit/0.31/qiskit.quantum_info.TwoQubitBasisDecomposer" @@ -2708,6 +2712,10 @@ "title": "Module overview", "url": "/api/qiskit/0.31/utils" }, + { + "title": "algorithm_globals", + "url": "/api/qiskit/0.31/qiskit.utils.algorithm_globals" + }, { "title": "apply_prefix", "url": "/api/qiskit/0.31/qiskit.utils.apply_prefix" @@ -3766,6 +3774,10 @@ "title": "Module overview", "url": "/api/qiskit/0.31/qiskit_aqua" }, + { + "title": "aqua_globals", + "url": "/api/qiskit/0.31/qiskit.aqua.aqua_globals" + }, { "title": "AquaError", "url": "/api/qiskit/0.31/qiskit.aqua.AquaError" @@ -5784,6 +5796,10 @@ "title": "Module overview", "url": "/api/qiskit/0.31/qiskit_optimization" }, + { + "title": "INFINITY", + "url": "/api/qiskit/0.31/qiskit.optimization.INFINITY" + }, { "title": "QiskitOptimizationError", "url": "/api/qiskit/0.31/qiskit.optimization.QiskitOptimizationError" diff --git a/docs/api/qiskit/0.31/qiskit.aqua.aqua_globals.mdx b/docs/api/qiskit/0.31/qiskit.aqua.aqua_globals.mdx index fc13ae4d02f..24d03f24649 100644 --- a/docs/api/qiskit/0.31/qiskit.aqua.aqua_globals.mdx +++ b/docs/api/qiskit/0.31/qiskit.aqua.aqua_globals.mdx @@ -1,5 +1,14 @@ -# qiskit.aqua.aqua\_globals +--- +title: aqua_globals +description: API reference for qiskit.aqua.aqua_globals +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.aqua.aqua_globals +--- -## `aqua_globals` *= \* +# aqua\_globals + + + Aqua class for global properties. + -Aqua class for global properties. diff --git a/docs/api/qiskit/0.31/qiskit.optimization.INFINITY.mdx b/docs/api/qiskit/0.31/qiskit.optimization.INFINITY.mdx index 21a0e027748..8628287a8e0 100644 --- a/docs/api/qiskit/0.31/qiskit.optimization.INFINITY.mdx +++ b/docs/api/qiskit/0.31/qiskit.optimization.INFINITY.mdx @@ -1,5 +1,14 @@ -# qiskit.optimization.INFINITY +--- +title: INFINITY +description: API reference for qiskit.optimization.INFINITY +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.optimization.INFINITY +--- -## `INFINITY` *= 1e+20* +# INFINITY + + + Convert a string or number to a floating point number, if possible. + -Convert a string or number to a floating point number, if possible. diff --git a/docs/api/qiskit/0.31/qiskit.quantum_info.two_qubit_cnot_decompose.mdx b/docs/api/qiskit/0.31/qiskit.quantum_info.two_qubit_cnot_decompose.mdx index 505da64312b..6f32b7048fc 100644 --- a/docs/api/qiskit/0.31/qiskit.quantum_info.two_qubit_cnot_decompose.mdx +++ b/docs/api/qiskit/0.31/qiskit.quantum_info.two_qubit_cnot_decompose.mdx @@ -1,12 +1,21 @@ -# qiskit.quantum\_info.two\_qubit\_cnot\_decompose +--- +title: two_qubit_cnot_decompose +description: API reference for qiskit.quantum_info.two_qubit_cnot_decompose +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.quantum_info.two_qubit_cnot_decompose +--- -## `two_qubit_cnot_decompose` *= \* +# two\_qubit\_cnot\_decompose -A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. + + A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. -**Parameters** + **Parameters** + + * **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – Two-qubit gate to be used in the KAK decomposition. + * **basis\_fidelity** (*float*) – Fidelity to be assumed for applications of KAK Gate. Default 1.0. + * **euler\_basis** (*str*) – Basis string to be provided to OneQubitEulerDecomposer for 1Q synthesis. Valid options are \[‘ZYZ’, ‘ZXZ’, ‘XYX’, ‘U’, ‘U3’, ‘U1X’, ‘PSX’, ‘ZSX’, ‘RR’]. Default ‘U3’. + * **pulse\_optimize** (*None or bool*) – If True, try to do decomposition which minimizes local unitaries in between entangling gates. This will raise an exception if an optimal decomposition is not implemented. Currently, only \[\{CX, SX, RZ}] is known. If False, don’t attempt optimization. If None, attempt optimization but don’t raise if unknown. + -* **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – Two-qubit gate to be used in the KAK decomposition. -* **basis\_fidelity** (*float*) – Fidelity to be assumed for applications of KAK Gate. Default 1.0. -* **euler\_basis** (*str*) – Basis string to be provided to OneQubitEulerDecomposer for 1Q synthesis. Valid options are \[‘ZYZ’, ‘ZXZ’, ‘XYX’, ‘U’, ‘U3’, ‘U1X’, ‘PSX’, ‘ZSX’, ‘RR’]. Default ‘U3’. -* **pulse\_optimize** (*None or bool*) – If True, try to do decomposition which minimizes local unitaries in between entangling gates. This will raise an exception if an optimal decomposition is not implemented. Currently, only \[\{CX, SX, RZ}] is known. If False, don’t attempt optimization. If None, attempt optimization but don’t raise if unknown. diff --git a/docs/api/qiskit/0.31/qiskit.utils.algorithm_globals.mdx b/docs/api/qiskit/0.31/qiskit.utils.algorithm_globals.mdx index e7838b75c01..e4e70fe8472 100644 --- a/docs/api/qiskit/0.31/qiskit.utils.algorithm_globals.mdx +++ b/docs/api/qiskit/0.31/qiskit.utils.algorithm_globals.mdx @@ -1,5 +1,14 @@ -# qiskit.utils.algorithm\_globals +--- +title: algorithm_globals +description: API reference for qiskit.utils.algorithm_globals +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.utils.algorithm_globals +--- -## `algorithm_globals` *= \* +# algorithm\_globals + + + Class for global properties. + -Class for global properties. diff --git a/docs/api/qiskit/0.31/qiskit_aqua.mdx b/docs/api/qiskit/0.31/qiskit_aqua.mdx index 662688a9f25..c0c447c7f57 100644 --- a/docs/api/qiskit/0.31/qiskit_aqua.mdx +++ b/docs/api/qiskit/0.31/qiskit_aqua.mdx @@ -18,9 +18,9 @@ python_api_name: qiskit.aqua Qiskit Aqua provides a library of quantum algorithms and components to build quantum applications and leverage near-term devices. -| | | -| ---------------------------------------------------------------------------------------------- | --------------------------------- | -| [`aqua_globals`](qiskit.aqua.aqua_globals#qiskit.aqua.aqua_globals "qiskit.aqua.aqua_globals") | Aqua class for global properties. | +| | | +| --------------------------------------------------------------------- | --------------------------------- | +| [`aqua_globals`](qiskit.aqua.aqua_globals "qiskit.aqua.aqua_globals") | Aqua class for global properties. | Aqua globals class provides random number and max parallel process configuration. Aqua uses the random function and max parallel processes when running any function requiring randomization and/or that can be be done in parallel. Setting the random seed to a given value will ensure predictability in outcome when using a simulator (seeds should also be set in [`QuantumInstance`](qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance") for transpiler and simulator too). diff --git a/docs/api/qiskit/0.31/qiskit_optimization.mdx b/docs/api/qiskit/0.31/qiskit_optimization.mdx index 16f2daf5b36..c050718fb62 100644 --- a/docs/api/qiskit/0.31/qiskit_optimization.mdx +++ b/docs/api/qiskit/0.31/qiskit_optimization.mdx @@ -34,9 +34,9 @@ Representation of a Quadratically Constrained Quadratic Program supporting inequ In addition to standard Python errors the optimization module will raise this error if circumstances are that it cannot proceed to completion. -| | | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------- | -| [`INFINITY`](qiskit.optimization.INFINITY#qiskit.optimization.INFINITY "qiskit.optimization.INFINITY") | Convert a string or number to a floating point number, if possible. | +| | | +| ------------------------------------------------------------------------- | ------------------------------------------------------------------- | +| [`INFINITY`](qiskit.optimization.INFINITY "qiskit.optimization.INFINITY") | Convert a string or number to a floating point number, if possible. | A constant for infinity. diff --git a/docs/api/qiskit/0.31/quantum_info.mdx b/docs/api/qiskit/0.31/quantum_info.mdx index 215c9455f27..3949df71ea7 100644 --- a/docs/api/qiskit/0.31/quantum_info.mdx +++ b/docs/api/qiskit/0.31/quantum_info.mdx @@ -97,11 +97,11 @@ python_api_name: qiskit.quantum_info ## Synthesis -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | -| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, …]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | -| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose#qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | -| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | -| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | Decompose a Clifford operator into a QuantumCircuit. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | +| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, …]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | +| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | +| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | +| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | Decompose a Clifford operator into a QuantumCircuit. | diff --git a/docs/api/qiskit/0.31/utils.mdx b/docs/api/qiskit/0.31/utils.mdx index 21d78218140..a13db21a37d 100644 --- a/docs/api/qiskit/0.31/utils.mdx +++ b/docs/api/qiskit/0.31/utils.mdx @@ -26,15 +26,15 @@ python_api_name: qiskit.utils ## Algorithm Utilities -| | | -| --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | -| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | -| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | -| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | -| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | -| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | -| [`algorithm_globals`](qiskit.utils.algorithm_globals#qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | +| | | +| ----------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | +| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | +| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | +| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | +| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | +| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | +| [`algorithm_globals`](qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | | | | | -------------------------------------------------------------------------------- | -------------------------------------------- | From 92784165b3eff56fc93a17f47638db1b8b74d687 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Fri, 6 Sep 2024 09:37:45 -0400 Subject: [PATCH 11/28] Regenerate qiskit 0.32.1 --- docs/api/qiskit/0.32/_toc.json | 16 ++++++++++++ .../qiskit/0.32/qiskit.aqua.aqua_globals.mdx | 15 ++++++++--- .../0.32/qiskit.optimization.INFINITY.mdx | 15 ++++++++--- ....quantum_info.two_qubit_cnot_decompose.mdx | 25 +++++++++++++------ .../0.32/qiskit.utils.algorithm_globals.mdx | 15 ++++++++--- docs/api/qiskit/0.32/qiskit_aqua.mdx | 6 ++--- docs/api/qiskit/0.32/qiskit_optimization.mdx | 6 ++--- docs/api/qiskit/0.32/quantum_info.mdx | 14 +++++------ docs/api/qiskit/0.32/utils.mdx | 18 ++++++------- 9 files changed, 91 insertions(+), 39 deletions(-) diff --git a/docs/api/qiskit/0.32/_toc.json b/docs/api/qiskit/0.32/_toc.json index b06bc018fa8..e637867d7f9 100644 --- a/docs/api/qiskit/0.32/_toc.json +++ b/docs/api/qiskit/0.32/_toc.json @@ -1069,6 +1069,10 @@ "title": "SuperOp", "url": "/api/qiskit/0.32/qiskit.quantum_info.SuperOp" }, + { + "title": "two_qubit_cnot_decompose", + "url": "/api/qiskit/0.32/qiskit.quantum_info.two_qubit_cnot_decompose" + }, { "title": "TwoQubitBasisDecomposer", "url": "/api/qiskit/0.32/qiskit.quantum_info.TwoQubitBasisDecomposer" @@ -2708,6 +2712,10 @@ "title": "Module overview", "url": "/api/qiskit/0.32/utils" }, + { + "title": "algorithm_globals", + "url": "/api/qiskit/0.32/qiskit.utils.algorithm_globals" + }, { "title": "apply_prefix", "url": "/api/qiskit/0.32/qiskit.utils.apply_prefix" @@ -3766,6 +3774,10 @@ "title": "Module overview", "url": "/api/qiskit/0.32/qiskit_aqua" }, + { + "title": "aqua_globals", + "url": "/api/qiskit/0.32/qiskit.aqua.aqua_globals" + }, { "title": "AquaError", "url": "/api/qiskit/0.32/qiskit.aqua.AquaError" @@ -5784,6 +5796,10 @@ "title": "Module overview", "url": "/api/qiskit/0.32/qiskit_optimization" }, + { + "title": "INFINITY", + "url": "/api/qiskit/0.32/qiskit.optimization.INFINITY" + }, { "title": "QiskitOptimizationError", "url": "/api/qiskit/0.32/qiskit.optimization.QiskitOptimizationError" diff --git a/docs/api/qiskit/0.32/qiskit.aqua.aqua_globals.mdx b/docs/api/qiskit/0.32/qiskit.aqua.aqua_globals.mdx index fc13ae4d02f..24d03f24649 100644 --- a/docs/api/qiskit/0.32/qiskit.aqua.aqua_globals.mdx +++ b/docs/api/qiskit/0.32/qiskit.aqua.aqua_globals.mdx @@ -1,5 +1,14 @@ -# qiskit.aqua.aqua\_globals +--- +title: aqua_globals +description: API reference for qiskit.aqua.aqua_globals +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.aqua.aqua_globals +--- -## `aqua_globals` *= \* +# aqua\_globals + + + Aqua class for global properties. + -Aqua class for global properties. diff --git a/docs/api/qiskit/0.32/qiskit.optimization.INFINITY.mdx b/docs/api/qiskit/0.32/qiskit.optimization.INFINITY.mdx index 21a0e027748..8628287a8e0 100644 --- a/docs/api/qiskit/0.32/qiskit.optimization.INFINITY.mdx +++ b/docs/api/qiskit/0.32/qiskit.optimization.INFINITY.mdx @@ -1,5 +1,14 @@ -# qiskit.optimization.INFINITY +--- +title: INFINITY +description: API reference for qiskit.optimization.INFINITY +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.optimization.INFINITY +--- -## `INFINITY` *= 1e+20* +# INFINITY + + + Convert a string or number to a floating point number, if possible. + -Convert a string or number to a floating point number, if possible. diff --git a/docs/api/qiskit/0.32/qiskit.quantum_info.two_qubit_cnot_decompose.mdx b/docs/api/qiskit/0.32/qiskit.quantum_info.two_qubit_cnot_decompose.mdx index 505da64312b..6f32b7048fc 100644 --- a/docs/api/qiskit/0.32/qiskit.quantum_info.two_qubit_cnot_decompose.mdx +++ b/docs/api/qiskit/0.32/qiskit.quantum_info.two_qubit_cnot_decompose.mdx @@ -1,12 +1,21 @@ -# qiskit.quantum\_info.two\_qubit\_cnot\_decompose +--- +title: two_qubit_cnot_decompose +description: API reference for qiskit.quantum_info.two_qubit_cnot_decompose +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.quantum_info.two_qubit_cnot_decompose +--- -## `two_qubit_cnot_decompose` *= \* +# two\_qubit\_cnot\_decompose -A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. + + A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. -**Parameters** + **Parameters** + + * **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – Two-qubit gate to be used in the KAK decomposition. + * **basis\_fidelity** (*float*) – Fidelity to be assumed for applications of KAK Gate. Default 1.0. + * **euler\_basis** (*str*) – Basis string to be provided to OneQubitEulerDecomposer for 1Q synthesis. Valid options are \[‘ZYZ’, ‘ZXZ’, ‘XYX’, ‘U’, ‘U3’, ‘U1X’, ‘PSX’, ‘ZSX’, ‘RR’]. Default ‘U3’. + * **pulse\_optimize** (*None or bool*) – If True, try to do decomposition which minimizes local unitaries in between entangling gates. This will raise an exception if an optimal decomposition is not implemented. Currently, only \[\{CX, SX, RZ}] is known. If False, don’t attempt optimization. If None, attempt optimization but don’t raise if unknown. + -* **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – Two-qubit gate to be used in the KAK decomposition. -* **basis\_fidelity** (*float*) – Fidelity to be assumed for applications of KAK Gate. Default 1.0. -* **euler\_basis** (*str*) – Basis string to be provided to OneQubitEulerDecomposer for 1Q synthesis. Valid options are \[‘ZYZ’, ‘ZXZ’, ‘XYX’, ‘U’, ‘U3’, ‘U1X’, ‘PSX’, ‘ZSX’, ‘RR’]. Default ‘U3’. -* **pulse\_optimize** (*None or bool*) – If True, try to do decomposition which minimizes local unitaries in between entangling gates. This will raise an exception if an optimal decomposition is not implemented. Currently, only \[\{CX, SX, RZ}] is known. If False, don’t attempt optimization. If None, attempt optimization but don’t raise if unknown. diff --git a/docs/api/qiskit/0.32/qiskit.utils.algorithm_globals.mdx b/docs/api/qiskit/0.32/qiskit.utils.algorithm_globals.mdx index e7838b75c01..e4e70fe8472 100644 --- a/docs/api/qiskit/0.32/qiskit.utils.algorithm_globals.mdx +++ b/docs/api/qiskit/0.32/qiskit.utils.algorithm_globals.mdx @@ -1,5 +1,14 @@ -# qiskit.utils.algorithm\_globals +--- +title: algorithm_globals +description: API reference for qiskit.utils.algorithm_globals +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.utils.algorithm_globals +--- -## `algorithm_globals` *= \* +# algorithm\_globals + + + Class for global properties. + -Class for global properties. diff --git a/docs/api/qiskit/0.32/qiskit_aqua.mdx b/docs/api/qiskit/0.32/qiskit_aqua.mdx index 662688a9f25..c0c447c7f57 100644 --- a/docs/api/qiskit/0.32/qiskit_aqua.mdx +++ b/docs/api/qiskit/0.32/qiskit_aqua.mdx @@ -18,9 +18,9 @@ python_api_name: qiskit.aqua Qiskit Aqua provides a library of quantum algorithms and components to build quantum applications and leverage near-term devices. -| | | -| ---------------------------------------------------------------------------------------------- | --------------------------------- | -| [`aqua_globals`](qiskit.aqua.aqua_globals#qiskit.aqua.aqua_globals "qiskit.aqua.aqua_globals") | Aqua class for global properties. | +| | | +| --------------------------------------------------------------------- | --------------------------------- | +| [`aqua_globals`](qiskit.aqua.aqua_globals "qiskit.aqua.aqua_globals") | Aqua class for global properties. | Aqua globals class provides random number and max parallel process configuration. Aqua uses the random function and max parallel processes when running any function requiring randomization and/or that can be be done in parallel. Setting the random seed to a given value will ensure predictability in outcome when using a simulator (seeds should also be set in [`QuantumInstance`](qiskit.aqua.QuantumInstance "qiskit.aqua.QuantumInstance") for transpiler and simulator too). diff --git a/docs/api/qiskit/0.32/qiskit_optimization.mdx b/docs/api/qiskit/0.32/qiskit_optimization.mdx index 16f2daf5b36..c050718fb62 100644 --- a/docs/api/qiskit/0.32/qiskit_optimization.mdx +++ b/docs/api/qiskit/0.32/qiskit_optimization.mdx @@ -34,9 +34,9 @@ Representation of a Quadratically Constrained Quadratic Program supporting inequ In addition to standard Python errors the optimization module will raise this error if circumstances are that it cannot proceed to completion. -| | | -| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------- | -| [`INFINITY`](qiskit.optimization.INFINITY#qiskit.optimization.INFINITY "qiskit.optimization.INFINITY") | Convert a string or number to a floating point number, if possible. | +| | | +| ------------------------------------------------------------------------- | ------------------------------------------------------------------- | +| [`INFINITY`](qiskit.optimization.INFINITY "qiskit.optimization.INFINITY") | Convert a string or number to a floating point number, if possible. | A constant for infinity. diff --git a/docs/api/qiskit/0.32/quantum_info.mdx b/docs/api/qiskit/0.32/quantum_info.mdx index 215c9455f27..3949df71ea7 100644 --- a/docs/api/qiskit/0.32/quantum_info.mdx +++ b/docs/api/qiskit/0.32/quantum_info.mdx @@ -97,11 +97,11 @@ python_api_name: qiskit.quantum_info ## Synthesis -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | -| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, …]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | -| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose#qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | -| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | -| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | Decompose a Clifford operator into a QuantumCircuit. | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | +| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | +| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, …]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | +| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | +| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | +| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | Decompose a Clifford operator into a QuantumCircuit. | diff --git a/docs/api/qiskit/0.32/utils.mdx b/docs/api/qiskit/0.32/utils.mdx index 21d78218140..a13db21a37d 100644 --- a/docs/api/qiskit/0.32/utils.mdx +++ b/docs/api/qiskit/0.32/utils.mdx @@ -26,15 +26,15 @@ python_api_name: qiskit.utils ## Algorithm Utilities -| | | -| --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | -| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | -| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | -| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | -| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | -| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | -| [`algorithm_globals`](qiskit.utils.algorithm_globals#qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | +| | | +| ----------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | +| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | +| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | +| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | +| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | +| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | +| [`algorithm_globals`](qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | | | | | -------------------------------------------------------------------------------- | -------------------------------------------- | From 0442f1823119d37b00be169d803abce10466f1a4 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Fri, 6 Sep 2024 09:38:26 -0400 Subject: [PATCH 12/28] Regenerate qiskit 0.33.1 --- docs/api/qiskit/0.33/_toc.json | 8 ++++++ ....quantum_info.two_qubit_cnot_decompose.mdx | 25 +++++++++++++------ .../0.33/qiskit.utils.algorithm_globals.mdx | 15 ++++++++--- docs/api/qiskit/0.33/quantum_info.mdx | 16 ++++++------ docs/api/qiskit/0.33/utils.mdx | 18 ++++++------- 5 files changed, 54 insertions(+), 28 deletions(-) diff --git a/docs/api/qiskit/0.33/_toc.json b/docs/api/qiskit/0.33/_toc.json index 56cc86acbc5..3811adedcf4 100644 --- a/docs/api/qiskit/0.33/_toc.json +++ b/docs/api/qiskit/0.33/_toc.json @@ -1109,6 +1109,10 @@ "title": "SuperOp", "url": "/api/qiskit/0.33/qiskit.quantum_info.SuperOp" }, + { + "title": "two_qubit_cnot_decompose", + "url": "/api/qiskit/0.33/qiskit.quantum_info.two_qubit_cnot_decompose" + }, { "title": "TwoQubitBasisDecomposer", "url": "/api/qiskit/0.33/qiskit.quantum_info.TwoQubitBasisDecomposer" @@ -2868,6 +2872,10 @@ "title": "Module overview", "url": "/api/qiskit/0.33/utils" }, + { + "title": "algorithm_globals", + "url": "/api/qiskit/0.33/qiskit.utils.algorithm_globals" + }, { "title": "apply_prefix", "url": "/api/qiskit/0.33/qiskit.utils.apply_prefix" diff --git a/docs/api/qiskit/0.33/qiskit.quantum_info.two_qubit_cnot_decompose.mdx b/docs/api/qiskit/0.33/qiskit.quantum_info.two_qubit_cnot_decompose.mdx index 505da64312b..6f32b7048fc 100644 --- a/docs/api/qiskit/0.33/qiskit.quantum_info.two_qubit_cnot_decompose.mdx +++ b/docs/api/qiskit/0.33/qiskit.quantum_info.two_qubit_cnot_decompose.mdx @@ -1,12 +1,21 @@ -# qiskit.quantum\_info.two\_qubit\_cnot\_decompose +--- +title: two_qubit_cnot_decompose +description: API reference for qiskit.quantum_info.two_qubit_cnot_decompose +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.quantum_info.two_qubit_cnot_decompose +--- -## `two_qubit_cnot_decompose` *= \* +# two\_qubit\_cnot\_decompose -A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. + + A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. -**Parameters** + **Parameters** + + * **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – Two-qubit gate to be used in the KAK decomposition. + * **basis\_fidelity** (*float*) – Fidelity to be assumed for applications of KAK Gate. Default 1.0. + * **euler\_basis** (*str*) – Basis string to be provided to OneQubitEulerDecomposer for 1Q synthesis. Valid options are \[‘ZYZ’, ‘ZXZ’, ‘XYX’, ‘U’, ‘U3’, ‘U1X’, ‘PSX’, ‘ZSX’, ‘RR’]. Default ‘U3’. + * **pulse\_optimize** (*None or bool*) – If True, try to do decomposition which minimizes local unitaries in between entangling gates. This will raise an exception if an optimal decomposition is not implemented. Currently, only \[\{CX, SX, RZ}] is known. If False, don’t attempt optimization. If None, attempt optimization but don’t raise if unknown. + -* **gate** ([*Gate*](qiskit.circuit.Gate "qiskit.circuit.Gate")) – Two-qubit gate to be used in the KAK decomposition. -* **basis\_fidelity** (*float*) – Fidelity to be assumed for applications of KAK Gate. Default 1.0. -* **euler\_basis** (*str*) – Basis string to be provided to OneQubitEulerDecomposer for 1Q synthesis. Valid options are \[‘ZYZ’, ‘ZXZ’, ‘XYX’, ‘U’, ‘U3’, ‘U1X’, ‘PSX’, ‘ZSX’, ‘RR’]. Default ‘U3’. -* **pulse\_optimize** (*None or bool*) – If True, try to do decomposition which minimizes local unitaries in between entangling gates. This will raise an exception if an optimal decomposition is not implemented. Currently, only \[\{CX, SX, RZ}] is known. If False, don’t attempt optimization. If None, attempt optimization but don’t raise if unknown. diff --git a/docs/api/qiskit/0.33/qiskit.utils.algorithm_globals.mdx b/docs/api/qiskit/0.33/qiskit.utils.algorithm_globals.mdx index e7838b75c01..e4e70fe8472 100644 --- a/docs/api/qiskit/0.33/qiskit.utils.algorithm_globals.mdx +++ b/docs/api/qiskit/0.33/qiskit.utils.algorithm_globals.mdx @@ -1,5 +1,14 @@ -# qiskit.utils.algorithm\_globals +--- +title: algorithm_globals +description: API reference for qiskit.utils.algorithm_globals +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.utils.algorithm_globals +--- -## `algorithm_globals` *= \* +# algorithm\_globals + + + Class for global properties. + -Class for global properties. diff --git a/docs/api/qiskit/0.33/quantum_info.mdx b/docs/api/qiskit/0.33/quantum_info.mdx index f4e7edc4643..30113a985d0 100644 --- a/docs/api/qiskit/0.33/quantum_info.mdx +++ b/docs/api/qiskit/0.33/quantum_info.mdx @@ -98,12 +98,12 @@ python_api_name: qiskit.quantum_info ## Synthesis -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | -| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, …]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | -| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose#qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | -| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | -| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | Decompose a Clifford operator into a QuantumCircuit. | -| [`XXDecomposer`](qiskit.quantum_info.XXDecomposer "qiskit.quantum_info.XXDecomposer")(\[euler\_basis, embodiments, …]) | A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | +| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, …]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | +| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | +| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | +| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | Decompose a Clifford operator into a QuantumCircuit. | +| [`XXDecomposer`](qiskit.quantum_info.XXDecomposer "qiskit.quantum_info.XXDecomposer")(\[euler\_basis, embodiments, …]) | A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). | diff --git a/docs/api/qiskit/0.33/utils.mdx b/docs/api/qiskit/0.33/utils.mdx index 4b6a39c0c93..b0f4e1b0967 100644 --- a/docs/api/qiskit/0.33/utils.mdx +++ b/docs/api/qiskit/0.33/utils.mdx @@ -27,15 +27,15 @@ python_api_name: qiskit.utils ## Algorithm Utilities -| | | -| --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | -| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | -| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | -| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | -| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | -| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | -| [`algorithm_globals`](qiskit.utils.algorithm_globals#qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | +| | | +| ----------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | +| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | +| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | +| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | +| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | +| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | +| [`algorithm_globals`](qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | | | | | -------------------------------------------------------------------------------- | -------------------------------------------- | From f66ad39e0d7aa014ca04c69a5b625d31a8ea24e0 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Fri, 6 Sep 2024 09:39:13 -0400 Subject: [PATCH 13/28] Regenerate qiskit 0.35.0 --- docs/api/qiskit/0.35/_toc.json | 8 ++++++++ ...t.quantum_info.two_qubit_cnot_decompose.mdx | 13 +++++++++++-- .../0.35/qiskit.utils.algorithm_globals.mdx | 15 ++++++++++++--- docs/api/qiskit/0.35/quantum_info.mdx | 16 ++++++++-------- docs/api/qiskit/0.35/utils.mdx | 18 +++++++++--------- 5 files changed, 48 insertions(+), 22 deletions(-) diff --git a/docs/api/qiskit/0.35/_toc.json b/docs/api/qiskit/0.35/_toc.json index 756312a03ea..1457311e237 100644 --- a/docs/api/qiskit/0.35/_toc.json +++ b/docs/api/qiskit/0.35/_toc.json @@ -1105,6 +1105,10 @@ "title": "SuperOp", "url": "/api/qiskit/0.35/qiskit.quantum_info.SuperOp" }, + { + "title": "two_qubit_cnot_decompose", + "url": "/api/qiskit/0.35/qiskit.quantum_info.two_qubit_cnot_decompose" + }, { "title": "TwoQubitBasisDecomposer", "url": "/api/qiskit/0.35/qiskit.quantum_info.TwoQubitBasisDecomposer" @@ -2970,6 +2974,10 @@ "title": "Module overview", "url": "/api/qiskit/0.35/utils" }, + { + "title": "algorithm_globals", + "url": "/api/qiskit/0.35/qiskit.utils.algorithm_globals" + }, { "title": "apply_prefix", "url": "/api/qiskit/0.35/qiskit.utils.apply_prefix" diff --git a/docs/api/qiskit/0.35/qiskit.quantum_info.two_qubit_cnot_decompose.mdx b/docs/api/qiskit/0.35/qiskit.quantum_info.two_qubit_cnot_decompose.mdx index fd967a3492e..6df60293c98 100644 --- a/docs/api/qiskit/0.35/qiskit.quantum_info.two_qubit_cnot_decompose.mdx +++ b/docs/api/qiskit/0.35/qiskit.quantum_info.two_qubit_cnot_decompose.mdx @@ -1,3 +1,12 @@ -# qiskit.quantum\_info.two\_qubit\_cnot\_decompose +--- +title: two_qubit_cnot_decompose +description: API reference for qiskit.quantum_info.two_qubit_cnot_decompose +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.quantum_info.two_qubit_cnot_decompose +--- + +# two\_qubit\_cnot\_decompose + + -## `two_qubit_cnot_decompose` *= \* diff --git a/docs/api/qiskit/0.35/qiskit.utils.algorithm_globals.mdx b/docs/api/qiskit/0.35/qiskit.utils.algorithm_globals.mdx index e7838b75c01..e4e70fe8472 100644 --- a/docs/api/qiskit/0.35/qiskit.utils.algorithm_globals.mdx +++ b/docs/api/qiskit/0.35/qiskit.utils.algorithm_globals.mdx @@ -1,5 +1,14 @@ -# qiskit.utils.algorithm\_globals +--- +title: algorithm_globals +description: API reference for qiskit.utils.algorithm_globals +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.utils.algorithm_globals +--- -## `algorithm_globals` *= \* +# algorithm\_globals + + + Class for global properties. + -Class for global properties. diff --git a/docs/api/qiskit/0.35/quantum_info.mdx b/docs/api/qiskit/0.35/quantum_info.mdx index a93efb8005a..52a75fe4b44 100644 --- a/docs/api/qiskit/0.35/quantum_info.mdx +++ b/docs/api/qiskit/0.35/quantum_info.mdx @@ -98,12 +98,12 @@ python_api_name: qiskit.quantum_info ## Synthesis -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | -| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, …]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | -| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose#qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | | -| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | -| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | Decompose a Clifford operator into a QuantumCircuit. | -| [`XXDecomposer`](qiskit.quantum_info.XXDecomposer "qiskit.quantum_info.XXDecomposer")(\[euler\_basis, embodiments, …]) | A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | +| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, …]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | +| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | | +| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | +| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | Decompose a Clifford operator into a QuantumCircuit. | +| [`XXDecomposer`](qiskit.quantum_info.XXDecomposer "qiskit.quantum_info.XXDecomposer")(\[euler\_basis, embodiments, …]) | A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). | diff --git a/docs/api/qiskit/0.35/utils.mdx b/docs/api/qiskit/0.35/utils.mdx index e8e401f9938..f1c66225fbe 100644 --- a/docs/api/qiskit/0.35/utils.mdx +++ b/docs/api/qiskit/0.35/utils.mdx @@ -28,15 +28,15 @@ python_api_name: qiskit.utils ## Algorithm Utilities -| | | -| --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | -| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | -| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | -| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | -| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | -| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | -| [`algorithm_globals`](qiskit.utils.algorithm_globals#qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | +| | | +| ----------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | +| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | +| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | +| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | +| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | +| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | +| [`algorithm_globals`](qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | | | | | -------------------------------------------------------------------------------- | -------------------------------------------- | From 70dc94a56f8bce988c1431fe842aa1ddda19ce02 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Fri, 6 Sep 2024 09:40:00 -0400 Subject: [PATCH 14/28] Regenerate qiskit 0.36.0 --- docs/api/qiskit/0.36/_toc.json | 8 ++++++++ ...t.quantum_info.two_qubit_cnot_decompose.mdx | 13 +++++++++++-- .../0.36/qiskit.utils.algorithm_globals.mdx | 15 ++++++++++++--- docs/api/qiskit/0.36/quantum_info.mdx | 16 ++++++++-------- docs/api/qiskit/0.36/utils.mdx | 18 +++++++++--------- 5 files changed, 48 insertions(+), 22 deletions(-) diff --git a/docs/api/qiskit/0.36/_toc.json b/docs/api/qiskit/0.36/_toc.json index 3ee93f5a8b2..369f03b21e5 100644 --- a/docs/api/qiskit/0.36/_toc.json +++ b/docs/api/qiskit/0.36/_toc.json @@ -1105,6 +1105,10 @@ "title": "SuperOp", "url": "/api/qiskit/0.36/qiskit.quantum_info.SuperOp" }, + { + "title": "two_qubit_cnot_decompose", + "url": "/api/qiskit/0.36/qiskit.quantum_info.two_qubit_cnot_decompose" + }, { "title": "TwoQubitBasisDecomposer", "url": "/api/qiskit/0.36/qiskit.quantum_info.TwoQubitBasisDecomposer" @@ -2970,6 +2974,10 @@ "title": "Module overview", "url": "/api/qiskit/0.36/utils" }, + { + "title": "algorithm_globals", + "url": "/api/qiskit/0.36/qiskit.utils.algorithm_globals" + }, { "title": "apply_prefix", "url": "/api/qiskit/0.36/qiskit.utils.apply_prefix" diff --git a/docs/api/qiskit/0.36/qiskit.quantum_info.two_qubit_cnot_decompose.mdx b/docs/api/qiskit/0.36/qiskit.quantum_info.two_qubit_cnot_decompose.mdx index fd967a3492e..6df60293c98 100644 --- a/docs/api/qiskit/0.36/qiskit.quantum_info.two_qubit_cnot_decompose.mdx +++ b/docs/api/qiskit/0.36/qiskit.quantum_info.two_qubit_cnot_decompose.mdx @@ -1,3 +1,12 @@ -# qiskit.quantum\_info.two\_qubit\_cnot\_decompose +--- +title: two_qubit_cnot_decompose +description: API reference for qiskit.quantum_info.two_qubit_cnot_decompose +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.quantum_info.two_qubit_cnot_decompose +--- + +# two\_qubit\_cnot\_decompose + + -## `two_qubit_cnot_decompose` *= \* diff --git a/docs/api/qiskit/0.36/qiskit.utils.algorithm_globals.mdx b/docs/api/qiskit/0.36/qiskit.utils.algorithm_globals.mdx index e7838b75c01..e4e70fe8472 100644 --- a/docs/api/qiskit/0.36/qiskit.utils.algorithm_globals.mdx +++ b/docs/api/qiskit/0.36/qiskit.utils.algorithm_globals.mdx @@ -1,5 +1,14 @@ -# qiskit.utils.algorithm\_globals +--- +title: algorithm_globals +description: API reference for qiskit.utils.algorithm_globals +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.utils.algorithm_globals +--- -## `algorithm_globals` *= \* +# algorithm\_globals + + + Class for global properties. + -Class for global properties. diff --git a/docs/api/qiskit/0.36/quantum_info.mdx b/docs/api/qiskit/0.36/quantum_info.mdx index a93efb8005a..52a75fe4b44 100644 --- a/docs/api/qiskit/0.36/quantum_info.mdx +++ b/docs/api/qiskit/0.36/quantum_info.mdx @@ -98,12 +98,12 @@ python_api_name: qiskit.quantum_info ## Synthesis -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | -| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, …]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | -| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose#qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | | -| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | -| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | Decompose a Clifford operator into a QuantumCircuit. | -| [`XXDecomposer`](qiskit.quantum_info.XXDecomposer "qiskit.quantum_info.XXDecomposer")(\[euler\_basis, embodiments, …]) | A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). | +| | | +| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | +| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, …]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | +| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | | +| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | +| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | Decompose a Clifford operator into a QuantumCircuit. | +| [`XXDecomposer`](qiskit.quantum_info.XXDecomposer "qiskit.quantum_info.XXDecomposer")(\[euler\_basis, embodiments, …]) | A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). | diff --git a/docs/api/qiskit/0.36/utils.mdx b/docs/api/qiskit/0.36/utils.mdx index e8e401f9938..f1c66225fbe 100644 --- a/docs/api/qiskit/0.36/utils.mdx +++ b/docs/api/qiskit/0.36/utils.mdx @@ -28,15 +28,15 @@ python_api_name: qiskit.utils ## Algorithm Utilities -| | | -| --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | -| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | -| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | -| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | -| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | -| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | -| [`algorithm_globals`](qiskit.utils.algorithm_globals#qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | +| | | +| ----------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | +| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | +| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | +| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | +| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | +| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | +| [`algorithm_globals`](qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | | | | | -------------------------------------------------------------------------------- | -------------------------------------------- | From 5751cdd023ea0b29a4d78dbe3a0d571d98997587 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Fri, 6 Sep 2024 09:40:58 -0400 Subject: [PATCH 15/28] Regenerate qiskit 0.37.2 --- docs/api/qiskit/0.37/_toc.json | 8 ++++++++ ...t.quantum_info.two_qubit_cnot_decompose.mdx | 13 +++++++++++-- .../0.37/qiskit.utils.algorithm_globals.mdx | 15 ++++++++++++--- docs/api/qiskit/0.37/quantum_info.mdx | 16 ++++++++-------- docs/api/qiskit/0.37/utils.mdx | 18 +++++++++--------- 5 files changed, 48 insertions(+), 22 deletions(-) diff --git a/docs/api/qiskit/0.37/_toc.json b/docs/api/qiskit/0.37/_toc.json index a30105bd611..5bb7940dbd4 100644 --- a/docs/api/qiskit/0.37/_toc.json +++ b/docs/api/qiskit/0.37/_toc.json @@ -1121,6 +1121,10 @@ "title": "SuperOp", "url": "/api/qiskit/0.37/qiskit.quantum_info.SuperOp" }, + { + "title": "two_qubit_cnot_decompose", + "url": "/api/qiskit/0.37/qiskit.quantum_info.two_qubit_cnot_decompose" + }, { "title": "TwoQubitBasisDecomposer", "url": "/api/qiskit/0.37/qiskit.quantum_info.TwoQubitBasisDecomposer" @@ -3423,6 +3427,10 @@ "title": "Module overview", "url": "/api/qiskit/0.37/utils" }, + { + "title": "algorithm_globals", + "url": "/api/qiskit/0.37/qiskit.utils.algorithm_globals" + }, { "title": "apply_prefix", "url": "/api/qiskit/0.37/qiskit.utils.apply_prefix" diff --git a/docs/api/qiskit/0.37/qiskit.quantum_info.two_qubit_cnot_decompose.mdx b/docs/api/qiskit/0.37/qiskit.quantum_info.two_qubit_cnot_decompose.mdx index 6436f0b57fe..6df60293c98 100644 --- a/docs/api/qiskit/0.37/qiskit.quantum_info.two_qubit_cnot_decompose.mdx +++ b/docs/api/qiskit/0.37/qiskit.quantum_info.two_qubit_cnot_decompose.mdx @@ -1,3 +1,12 @@ -# qiskit.quantum\_info.two\_qubit\_cnot\_decompose +--- +title: two_qubit_cnot_decompose +description: API reference for qiskit.quantum_info.two_qubit_cnot_decompose +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.quantum_info.two_qubit_cnot_decompose +--- + +# two\_qubit\_cnot\_decompose + + -## two\_qubit\_cnot\_decompose *= \* diff --git a/docs/api/qiskit/0.37/qiskit.utils.algorithm_globals.mdx b/docs/api/qiskit/0.37/qiskit.utils.algorithm_globals.mdx index 5c290b1f4dc..e4e70fe8472 100644 --- a/docs/api/qiskit/0.37/qiskit.utils.algorithm_globals.mdx +++ b/docs/api/qiskit/0.37/qiskit.utils.algorithm_globals.mdx @@ -1,5 +1,14 @@ -# qiskit.utils.algorithm\_globals +--- +title: algorithm_globals +description: API reference for qiskit.utils.algorithm_globals +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.utils.algorithm_globals +--- -## algorithm\_globals *= \* +# algorithm\_globals + + + Class for global properties. + -Class for global properties. diff --git a/docs/api/qiskit/0.37/quantum_info.mdx b/docs/api/qiskit/0.37/quantum_info.mdx index 0ed5f69c34f..3ec6b0b4701 100644 --- a/docs/api/qiskit/0.37/quantum_info.mdx +++ b/docs/api/qiskit/0.37/quantum_info.mdx @@ -97,12 +97,12 @@ python_api_name: qiskit.quantum_info ## Synthesis -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | -| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, ...]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | -| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose#qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | | -| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | -| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | Decompose a Clifford operator into a QuantumCircuit. | -| [`XXDecomposer`](qiskit.quantum_info.XXDecomposer "qiskit.quantum_info.XXDecomposer")(\[euler\_basis, embodiments, ...]) | A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | +| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, ...]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | +| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | | +| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | +| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | Decompose a Clifford operator into a QuantumCircuit. | +| [`XXDecomposer`](qiskit.quantum_info.XXDecomposer "qiskit.quantum_info.XXDecomposer")(\[euler\_basis, embodiments, ...]) | A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). | diff --git a/docs/api/qiskit/0.37/utils.mdx b/docs/api/qiskit/0.37/utils.mdx index 8c47e7f72d9..569b51f8370 100644 --- a/docs/api/qiskit/0.37/utils.mdx +++ b/docs/api/qiskit/0.37/utils.mdx @@ -28,15 +28,15 @@ python_api_name: qiskit.utils ## Algorithm Utilities -| | | -| --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | -| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | -| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | -| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | -| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | -| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | -| [`algorithm_globals`](qiskit.utils.algorithm_globals#qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | +| | | +| ----------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | +| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | +| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | +| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | +| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | +| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | +| [`algorithm_globals`](qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | | | | | -------------------------------------------------------------------------------- | -------------------------------------------- | From c79cad426cd2e8a2cb27a2093cbefa33f55a3870 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Fri, 6 Sep 2024 09:41:59 -0400 Subject: [PATCH 16/28] Regenerate qiskit 0.38.0 --- docs/api/qiskit/0.38/_toc.json | 8 ++++++++ ...t.quantum_info.two_qubit_cnot_decompose.mdx | 13 +++++++++++-- .../0.38/qiskit.utils.algorithm_globals.mdx | 15 ++++++++++++--- docs/api/qiskit/0.38/quantum_info.mdx | 16 ++++++++-------- docs/api/qiskit/0.38/utils.mdx | 18 +++++++++--------- 5 files changed, 48 insertions(+), 22 deletions(-) diff --git a/docs/api/qiskit/0.38/_toc.json b/docs/api/qiskit/0.38/_toc.json index 21477f3af43..c882f564d80 100644 --- a/docs/api/qiskit/0.38/_toc.json +++ b/docs/api/qiskit/0.38/_toc.json @@ -1121,6 +1121,10 @@ "title": "SuperOp", "url": "/api/qiskit/0.38/qiskit.quantum_info.SuperOp" }, + { + "title": "two_qubit_cnot_decompose", + "url": "/api/qiskit/0.38/qiskit.quantum_info.two_qubit_cnot_decompose" + }, { "title": "TwoQubitBasisDecomposer", "url": "/api/qiskit/0.38/qiskit.quantum_info.TwoQubitBasisDecomposer" @@ -3423,6 +3427,10 @@ "title": "Module overview", "url": "/api/qiskit/0.38/utils" }, + { + "title": "algorithm_globals", + "url": "/api/qiskit/0.38/qiskit.utils.algorithm_globals" + }, { "title": "apply_prefix", "url": "/api/qiskit/0.38/qiskit.utils.apply_prefix" diff --git a/docs/api/qiskit/0.38/qiskit.quantum_info.two_qubit_cnot_decompose.mdx b/docs/api/qiskit/0.38/qiskit.quantum_info.two_qubit_cnot_decompose.mdx index 6436f0b57fe..6df60293c98 100644 --- a/docs/api/qiskit/0.38/qiskit.quantum_info.two_qubit_cnot_decompose.mdx +++ b/docs/api/qiskit/0.38/qiskit.quantum_info.two_qubit_cnot_decompose.mdx @@ -1,3 +1,12 @@ -# qiskit.quantum\_info.two\_qubit\_cnot\_decompose +--- +title: two_qubit_cnot_decompose +description: API reference for qiskit.quantum_info.two_qubit_cnot_decompose +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.quantum_info.two_qubit_cnot_decompose +--- + +# two\_qubit\_cnot\_decompose + + -## two\_qubit\_cnot\_decompose *= \* diff --git a/docs/api/qiskit/0.38/qiskit.utils.algorithm_globals.mdx b/docs/api/qiskit/0.38/qiskit.utils.algorithm_globals.mdx index 5c290b1f4dc..e4e70fe8472 100644 --- a/docs/api/qiskit/0.38/qiskit.utils.algorithm_globals.mdx +++ b/docs/api/qiskit/0.38/qiskit.utils.algorithm_globals.mdx @@ -1,5 +1,14 @@ -# qiskit.utils.algorithm\_globals +--- +title: algorithm_globals +description: API reference for qiskit.utils.algorithm_globals +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.utils.algorithm_globals +--- -## algorithm\_globals *= \* +# algorithm\_globals + + + Class for global properties. + -Class for global properties. diff --git a/docs/api/qiskit/0.38/quantum_info.mdx b/docs/api/qiskit/0.38/quantum_info.mdx index 0ed5f69c34f..3ec6b0b4701 100644 --- a/docs/api/qiskit/0.38/quantum_info.mdx +++ b/docs/api/qiskit/0.38/quantum_info.mdx @@ -97,12 +97,12 @@ python_api_name: qiskit.quantum_info ## Synthesis -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | -| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, ...]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | -| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose#qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | | -| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | -| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | Decompose a Clifford operator into a QuantumCircuit. | -| [`XXDecomposer`](qiskit.quantum_info.XXDecomposer "qiskit.quantum_info.XXDecomposer")(\[euler\_basis, embodiments, ...]) | A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | +| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, ...]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | +| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | | +| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | +| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | Decompose a Clifford operator into a QuantumCircuit. | +| [`XXDecomposer`](qiskit.quantum_info.XXDecomposer "qiskit.quantum_info.XXDecomposer")(\[euler\_basis, embodiments, ...]) | A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). | diff --git a/docs/api/qiskit/0.38/utils.mdx b/docs/api/qiskit/0.38/utils.mdx index a6ebbb9464f..33dd018d269 100644 --- a/docs/api/qiskit/0.38/utils.mdx +++ b/docs/api/qiskit/0.38/utils.mdx @@ -28,15 +28,15 @@ python_api_name: qiskit.utils ## Algorithm Utilities -| | | -| --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | -| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | -| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | -| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | -| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | -| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | -| [`algorithm_globals`](qiskit.utils.algorithm_globals#qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | +| | | +| ----------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | +| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | +| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | +| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | +| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | +| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | +| [`algorithm_globals`](qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | | | | | -------------------------------------------------------------------------------- | -------------------------------------------- | From 358d3962b8ebddbc43bf5a65ecd32768a5aaa980 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Fri, 6 Sep 2024 09:43:01 -0400 Subject: [PATCH 17/28] Regenerate qiskit 0.39.5 --- docs/api/qiskit/0.39/_toc.json | 8 ++++++++ ...t.quantum_info.two_qubit_cnot_decompose.mdx | 13 +++++++++++-- .../0.39/qiskit.utils.algorithm_globals.mdx | 15 ++++++++++++--- docs/api/qiskit/0.39/quantum_info.mdx | 16 ++++++++-------- docs/api/qiskit/0.39/utils.mdx | 18 +++++++++--------- 5 files changed, 48 insertions(+), 22 deletions(-) diff --git a/docs/api/qiskit/0.39/_toc.json b/docs/api/qiskit/0.39/_toc.json index 2256f62a016..586ce09dd9c 100644 --- a/docs/api/qiskit/0.39/_toc.json +++ b/docs/api/qiskit/0.39/_toc.json @@ -1141,6 +1141,10 @@ "title": "SuperOp", "url": "/api/qiskit/0.39/qiskit.quantum_info.SuperOp" }, + { + "title": "two_qubit_cnot_decompose", + "url": "/api/qiskit/0.39/qiskit.quantum_info.two_qubit_cnot_decompose" + }, { "title": "TwoQubitBasisDecomposer", "url": "/api/qiskit/0.39/qiskit.quantum_info.TwoQubitBasisDecomposer" @@ -3536,6 +3540,10 @@ "title": "Module overview", "url": "/api/qiskit/0.39/utils" }, + { + "title": "algorithm_globals", + "url": "/api/qiskit/0.39/qiskit.utils.algorithm_globals" + }, { "title": "apply_prefix", "url": "/api/qiskit/0.39/qiskit.utils.apply_prefix" diff --git a/docs/api/qiskit/0.39/qiskit.quantum_info.two_qubit_cnot_decompose.mdx b/docs/api/qiskit/0.39/qiskit.quantum_info.two_qubit_cnot_decompose.mdx index 6436f0b57fe..6df60293c98 100644 --- a/docs/api/qiskit/0.39/qiskit.quantum_info.two_qubit_cnot_decompose.mdx +++ b/docs/api/qiskit/0.39/qiskit.quantum_info.two_qubit_cnot_decompose.mdx @@ -1,3 +1,12 @@ -# qiskit.quantum\_info.two\_qubit\_cnot\_decompose +--- +title: two_qubit_cnot_decompose +description: API reference for qiskit.quantum_info.two_qubit_cnot_decompose +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.quantum_info.two_qubit_cnot_decompose +--- + +# two\_qubit\_cnot\_decompose + + -## two\_qubit\_cnot\_decompose *= \* diff --git a/docs/api/qiskit/0.39/qiskit.utils.algorithm_globals.mdx b/docs/api/qiskit/0.39/qiskit.utils.algorithm_globals.mdx index 5c290b1f4dc..e4e70fe8472 100644 --- a/docs/api/qiskit/0.39/qiskit.utils.algorithm_globals.mdx +++ b/docs/api/qiskit/0.39/qiskit.utils.algorithm_globals.mdx @@ -1,5 +1,14 @@ -# qiskit.utils.algorithm\_globals +--- +title: algorithm_globals +description: API reference for qiskit.utils.algorithm_globals +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.utils.algorithm_globals +--- -## algorithm\_globals *= \* +# algorithm\_globals + + + Class for global properties. + -Class for global properties. diff --git a/docs/api/qiskit/0.39/quantum_info.mdx b/docs/api/qiskit/0.39/quantum_info.mdx index 57f11a19722..fd6ea5e3de0 100644 --- a/docs/api/qiskit/0.39/quantum_info.mdx +++ b/docs/api/qiskit/0.39/quantum_info.mdx @@ -97,12 +97,12 @@ python_api_name: qiskit.quantum_info ## Synthesis -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | -| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, ...]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | -| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose#qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | | -| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | -| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | Decompose a Clifford operator into a QuantumCircuit. | -| [`XXDecomposer`](qiskit.quantum_info.XXDecomposer "qiskit.quantum_info.XXDecomposer")(\[euler\_basis, embodiments, ...]) | A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | +| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, ...]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | +| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | | +| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | +| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | Decompose a Clifford operator into a QuantumCircuit. | +| [`XXDecomposer`](qiskit.quantum_info.XXDecomposer "qiskit.quantum_info.XXDecomposer")(\[euler\_basis, embodiments, ...]) | A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). | diff --git a/docs/api/qiskit/0.39/utils.mdx b/docs/api/qiskit/0.39/utils.mdx index 3e76d45e1b6..f5ffe4b445a 100644 --- a/docs/api/qiskit/0.39/utils.mdx +++ b/docs/api/qiskit/0.39/utils.mdx @@ -28,15 +28,15 @@ python_api_name: qiskit.utils ## Algorithm Utilities -| | | -| --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | -| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | -| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | -| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | -| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | -| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | -| [`algorithm_globals`](qiskit.utils.algorithm_globals#qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | +| | | +| ----------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | +| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | +| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | +| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | +| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | +| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | +| [`algorithm_globals`](qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | | | | | -------------------------------------------------------------------------------- | -------------------------------------------- | From 0017582a6a77211d098a567e1962c5b25cf42889 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Fri, 6 Sep 2024 09:44:02 -0400 Subject: [PATCH 18/28] Regenerate qiskit 0.40.0 --- docs/api/qiskit/0.40/_toc.json | 8 ++++++++ ...t.quantum_info.two_qubit_cnot_decompose.mdx | 13 +++++++++++-- .../0.40/qiskit.utils.algorithm_globals.mdx | 15 ++++++++++++--- docs/api/qiskit/0.40/quantum_info.mdx | 16 ++++++++-------- docs/api/qiskit/0.40/utils.mdx | 18 +++++++++--------- 5 files changed, 48 insertions(+), 22 deletions(-) diff --git a/docs/api/qiskit/0.40/_toc.json b/docs/api/qiskit/0.40/_toc.json index 5d36d3c7b26..25e09570554 100644 --- a/docs/api/qiskit/0.40/_toc.json +++ b/docs/api/qiskit/0.40/_toc.json @@ -1129,6 +1129,10 @@ "title": "SuperOp", "url": "/api/qiskit/0.40/qiskit.quantum_info.SuperOp" }, + { + "title": "two_qubit_cnot_decompose", + "url": "/api/qiskit/0.40/qiskit.quantum_info.two_qubit_cnot_decompose" + }, { "title": "TwoQubitBasisDecomposer", "url": "/api/qiskit/0.40/qiskit.quantum_info.TwoQubitBasisDecomposer" @@ -3659,6 +3663,10 @@ "title": "Module overview", "url": "/api/qiskit/0.40/utils" }, + { + "title": "algorithm_globals", + "url": "/api/qiskit/0.40/qiskit.utils.algorithm_globals" + }, { "title": "apply_prefix", "url": "/api/qiskit/0.40/qiskit.utils.apply_prefix" diff --git a/docs/api/qiskit/0.40/qiskit.quantum_info.two_qubit_cnot_decompose.mdx b/docs/api/qiskit/0.40/qiskit.quantum_info.two_qubit_cnot_decompose.mdx index 6436f0b57fe..6df60293c98 100644 --- a/docs/api/qiskit/0.40/qiskit.quantum_info.two_qubit_cnot_decompose.mdx +++ b/docs/api/qiskit/0.40/qiskit.quantum_info.two_qubit_cnot_decompose.mdx @@ -1,3 +1,12 @@ -# qiskit.quantum\_info.two\_qubit\_cnot\_decompose +--- +title: two_qubit_cnot_decompose +description: API reference for qiskit.quantum_info.two_qubit_cnot_decompose +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.quantum_info.two_qubit_cnot_decompose +--- + +# two\_qubit\_cnot\_decompose + + -## two\_qubit\_cnot\_decompose *= \* diff --git a/docs/api/qiskit/0.40/qiskit.utils.algorithm_globals.mdx b/docs/api/qiskit/0.40/qiskit.utils.algorithm_globals.mdx index 5c290b1f4dc..e4e70fe8472 100644 --- a/docs/api/qiskit/0.40/qiskit.utils.algorithm_globals.mdx +++ b/docs/api/qiskit/0.40/qiskit.utils.algorithm_globals.mdx @@ -1,5 +1,14 @@ -# qiskit.utils.algorithm\_globals +--- +title: algorithm_globals +description: API reference for qiskit.utils.algorithm_globals +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.utils.algorithm_globals +--- -## algorithm\_globals *= \* +# algorithm\_globals + + + Class for global properties. + -Class for global properties. diff --git a/docs/api/qiskit/0.40/quantum_info.mdx b/docs/api/qiskit/0.40/quantum_info.mdx index 67a523604d2..4ea15f1e40c 100644 --- a/docs/api/qiskit/0.40/quantum_info.mdx +++ b/docs/api/qiskit/0.40/quantum_info.mdx @@ -97,12 +97,12 @@ python_api_name: qiskit.quantum_info ## Synthesis -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis, use\_dag]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | -| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, ...]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | -| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose#qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | | -| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | -| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | DEPRECATED: Decompose a Clifford operator into a QuantumCircuit. | -| [`XXDecomposer`](qiskit.quantum_info.XXDecomposer "qiskit.quantum_info.XXDecomposer")(\[euler\_basis, embodiments, ...]) | A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis, use\_dag]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | +| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, ...]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | +| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | | +| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | +| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | DEPRECATED: Decompose a Clifford operator into a QuantumCircuit. | +| [`XXDecomposer`](qiskit.quantum_info.XXDecomposer "qiskit.quantum_info.XXDecomposer")(\[euler\_basis, embodiments, ...]) | A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). | diff --git a/docs/api/qiskit/0.40/utils.mdx b/docs/api/qiskit/0.40/utils.mdx index ac6439fa39b..6b7610e10a9 100644 --- a/docs/api/qiskit/0.40/utils.mdx +++ b/docs/api/qiskit/0.40/utils.mdx @@ -28,15 +28,15 @@ python_api_name: qiskit.utils ## Algorithm Utilities -| | | -| --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | -| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | -| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | -| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | -| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | -| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | -| [`algorithm_globals`](qiskit.utils.algorithm_globals#qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | +| | | +| ----------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | +| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | +| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | +| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | +| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | +| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | +| [`algorithm_globals`](qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | | | | | -------------------------------------------------------------------------------- | -------------------------------------------- | From 680ed5cc35bcf65d0187b676f8464be3e024e5d7 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Fri, 6 Sep 2024 09:45:03 -0400 Subject: [PATCH 19/28] Regenerate qiskit 0.41.0 --- docs/api/qiskit/0.41/_toc.json | 8 ++++++++ ...t.quantum_info.two_qubit_cnot_decompose.mdx | 13 +++++++++++-- .../0.41/qiskit.utils.algorithm_globals.mdx | 15 ++++++++++++--- docs/api/qiskit/0.41/quantum_info.mdx | 16 ++++++++-------- docs/api/qiskit/0.41/utils.mdx | 18 +++++++++--------- 5 files changed, 48 insertions(+), 22 deletions(-) diff --git a/docs/api/qiskit/0.41/_toc.json b/docs/api/qiskit/0.41/_toc.json index f33819e9bd3..9bfaa17c9ba 100644 --- a/docs/api/qiskit/0.41/_toc.json +++ b/docs/api/qiskit/0.41/_toc.json @@ -1129,6 +1129,10 @@ "title": "SuperOp", "url": "/api/qiskit/0.41/qiskit.quantum_info.SuperOp" }, + { + "title": "two_qubit_cnot_decompose", + "url": "/api/qiskit/0.41/qiskit.quantum_info.two_qubit_cnot_decompose" + }, { "title": "TwoQubitBasisDecomposer", "url": "/api/qiskit/0.41/qiskit.quantum_info.TwoQubitBasisDecomposer" @@ -3667,6 +3671,10 @@ "title": "Module overview", "url": "/api/qiskit/0.41/utils" }, + { + "title": "algorithm_globals", + "url": "/api/qiskit/0.41/qiskit.utils.algorithm_globals" + }, { "title": "apply_prefix", "url": "/api/qiskit/0.41/qiskit.utils.apply_prefix" diff --git a/docs/api/qiskit/0.41/qiskit.quantum_info.two_qubit_cnot_decompose.mdx b/docs/api/qiskit/0.41/qiskit.quantum_info.two_qubit_cnot_decompose.mdx index 6436f0b57fe..6df60293c98 100644 --- a/docs/api/qiskit/0.41/qiskit.quantum_info.two_qubit_cnot_decompose.mdx +++ b/docs/api/qiskit/0.41/qiskit.quantum_info.two_qubit_cnot_decompose.mdx @@ -1,3 +1,12 @@ -# qiskit.quantum\_info.two\_qubit\_cnot\_decompose +--- +title: two_qubit_cnot_decompose +description: API reference for qiskit.quantum_info.two_qubit_cnot_decompose +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.quantum_info.two_qubit_cnot_decompose +--- + +# two\_qubit\_cnot\_decompose + + -## two\_qubit\_cnot\_decompose *= \* diff --git a/docs/api/qiskit/0.41/qiskit.utils.algorithm_globals.mdx b/docs/api/qiskit/0.41/qiskit.utils.algorithm_globals.mdx index 5c290b1f4dc..e4e70fe8472 100644 --- a/docs/api/qiskit/0.41/qiskit.utils.algorithm_globals.mdx +++ b/docs/api/qiskit/0.41/qiskit.utils.algorithm_globals.mdx @@ -1,5 +1,14 @@ -# qiskit.utils.algorithm\_globals +--- +title: algorithm_globals +description: API reference for qiskit.utils.algorithm_globals +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.utils.algorithm_globals +--- -## algorithm\_globals *= \* +# algorithm\_globals + + + Class for global properties. + -Class for global properties. diff --git a/docs/api/qiskit/0.41/quantum_info.mdx b/docs/api/qiskit/0.41/quantum_info.mdx index 67a523604d2..4ea15f1e40c 100644 --- a/docs/api/qiskit/0.41/quantum_info.mdx +++ b/docs/api/qiskit/0.41/quantum_info.mdx @@ -97,12 +97,12 @@ python_api_name: qiskit.quantum_info ## Synthesis -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis, use\_dag]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | -| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, ...]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | -| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose#qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | | -| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | -| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | DEPRECATED: Decompose a Clifford operator into a QuantumCircuit. | -| [`XXDecomposer`](qiskit.quantum_info.XXDecomposer "qiskit.quantum_info.XXDecomposer")(\[euler\_basis, embodiments, ...]) | A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis, use\_dag]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | +| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, ...]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | +| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | | +| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | +| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | DEPRECATED: Decompose a Clifford operator into a QuantumCircuit. | +| [`XXDecomposer`](qiskit.quantum_info.XXDecomposer "qiskit.quantum_info.XXDecomposer")(\[euler\_basis, embodiments, ...]) | A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). | diff --git a/docs/api/qiskit/0.41/utils.mdx b/docs/api/qiskit/0.41/utils.mdx index ac6439fa39b..6b7610e10a9 100644 --- a/docs/api/qiskit/0.41/utils.mdx +++ b/docs/api/qiskit/0.41/utils.mdx @@ -28,15 +28,15 @@ python_api_name: qiskit.utils ## Algorithm Utilities -| | | -| --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | -| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | -| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | -| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | -| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | -| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | -| [`algorithm_globals`](qiskit.utils.algorithm_globals#qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | +| | | +| ----------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | +| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | +| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | +| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | +| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | +| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | +| [`algorithm_globals`](qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | | | | | -------------------------------------------------------------------------------- | -------------------------------------------- | From 60fb0ba47c5fa5733fb76ac49875bd31da43fb1e Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Fri, 6 Sep 2024 09:45:57 -0400 Subject: [PATCH 20/28] Regenerate qiskit 0.42.0 --- docs/api/qiskit/0.42/_toc.json | 8 ++++++++ ...t.quantum_info.two_qubit_cnot_decompose.mdx | 13 +++++++++++-- .../0.42/qiskit.utils.algorithm_globals.mdx | 15 ++++++++++++--- docs/api/qiskit/0.42/quantum_info.mdx | 16 ++++++++-------- docs/api/qiskit/0.42/utils.mdx | 18 +++++++++--------- 5 files changed, 48 insertions(+), 22 deletions(-) diff --git a/docs/api/qiskit/0.42/_toc.json b/docs/api/qiskit/0.42/_toc.json index 7389ee67d7e..1ae7df850d9 100644 --- a/docs/api/qiskit/0.42/_toc.json +++ b/docs/api/qiskit/0.42/_toc.json @@ -1129,6 +1129,10 @@ "title": "SuperOp", "url": "/api/qiskit/0.42/qiskit.quantum_info.SuperOp" }, + { + "title": "two_qubit_cnot_decompose", + "url": "/api/qiskit/0.42/qiskit.quantum_info.two_qubit_cnot_decompose" + }, { "title": "TwoQubitBasisDecomposer", "url": "/api/qiskit/0.42/qiskit.quantum_info.TwoQubitBasisDecomposer" @@ -3667,6 +3671,10 @@ "title": "Module overview", "url": "/api/qiskit/0.42/utils" }, + { + "title": "algorithm_globals", + "url": "/api/qiskit/0.42/qiskit.utils.algorithm_globals" + }, { "title": "apply_prefix", "url": "/api/qiskit/0.42/qiskit.utils.apply_prefix" diff --git a/docs/api/qiskit/0.42/qiskit.quantum_info.two_qubit_cnot_decompose.mdx b/docs/api/qiskit/0.42/qiskit.quantum_info.two_qubit_cnot_decompose.mdx index 6436f0b57fe..6df60293c98 100644 --- a/docs/api/qiskit/0.42/qiskit.quantum_info.two_qubit_cnot_decompose.mdx +++ b/docs/api/qiskit/0.42/qiskit.quantum_info.two_qubit_cnot_decompose.mdx @@ -1,3 +1,12 @@ -# qiskit.quantum\_info.two\_qubit\_cnot\_decompose +--- +title: two_qubit_cnot_decompose +description: API reference for qiskit.quantum_info.two_qubit_cnot_decompose +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.quantum_info.two_qubit_cnot_decompose +--- + +# two\_qubit\_cnot\_decompose + + -## two\_qubit\_cnot\_decompose *= \* diff --git a/docs/api/qiskit/0.42/qiskit.utils.algorithm_globals.mdx b/docs/api/qiskit/0.42/qiskit.utils.algorithm_globals.mdx index 5c290b1f4dc..e4e70fe8472 100644 --- a/docs/api/qiskit/0.42/qiskit.utils.algorithm_globals.mdx +++ b/docs/api/qiskit/0.42/qiskit.utils.algorithm_globals.mdx @@ -1,5 +1,14 @@ -# qiskit.utils.algorithm\_globals +--- +title: algorithm_globals +description: API reference for qiskit.utils.algorithm_globals +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.utils.algorithm_globals +--- -## algorithm\_globals *= \* +# algorithm\_globals + + + Class for global properties. + -Class for global properties. diff --git a/docs/api/qiskit/0.42/quantum_info.mdx b/docs/api/qiskit/0.42/quantum_info.mdx index 67a523604d2..4ea15f1e40c 100644 --- a/docs/api/qiskit/0.42/quantum_info.mdx +++ b/docs/api/qiskit/0.42/quantum_info.mdx @@ -97,12 +97,12 @@ python_api_name: qiskit.quantum_info ## Synthesis -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis, use\_dag]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | -| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, ...]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | -| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose#qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | | -| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | -| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | DEPRECATED: Decompose a Clifford operator into a QuantumCircuit. | -| [`XXDecomposer`](qiskit.quantum_info.XXDecomposer "qiskit.quantum_info.XXDecomposer")(\[euler\_basis, embodiments, ...]) | A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis, use\_dag]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | +| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, ...]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | +| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | | +| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | +| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | DEPRECATED: Decompose a Clifford operator into a QuantumCircuit. | +| [`XXDecomposer`](qiskit.quantum_info.XXDecomposer "qiskit.quantum_info.XXDecomposer")(\[euler\_basis, embodiments, ...]) | A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). | diff --git a/docs/api/qiskit/0.42/utils.mdx b/docs/api/qiskit/0.42/utils.mdx index ac6439fa39b..6b7610e10a9 100644 --- a/docs/api/qiskit/0.42/utils.mdx +++ b/docs/api/qiskit/0.42/utils.mdx @@ -28,15 +28,15 @@ python_api_name: qiskit.utils ## Algorithm Utilities -| | | -| --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | -| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | -| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | -| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | -| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | -| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | -| [`algorithm_globals`](qiskit.utils.algorithm_globals#qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | +| | | +| ----------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | +| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | +| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | +| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed | +| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | check if Aer is installed | +| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | +| [`algorithm_globals`](qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | | | | | -------------------------------------------------------------------------------- | -------------------------------------------- | From 50467957185788cfaa4e4851ada4eeecf6d32226 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Fri, 6 Sep 2024 09:46:46 -0400 Subject: [PATCH 21/28] Regenerate qiskit 0.43.0 --- docs/api/qiskit/0.43/_toc.json | 8 ++++++++ docs/api/qiskit/0.43/qasm2.mdx | 18 ++++++++++++------ ...t.quantum_info.two_qubit_cnot_decompose.mdx | 13 +++++++++++-- .../0.43/qiskit.utils.algorithm_globals.mdx | 15 ++++++++++++--- docs/api/qiskit/0.43/quantum_info.mdx | 16 ++++++++-------- docs/api/qiskit/0.43/utils.mdx | 18 +++++++++--------- 6 files changed, 60 insertions(+), 28 deletions(-) diff --git a/docs/api/qiskit/0.43/_toc.json b/docs/api/qiskit/0.43/_toc.json index 24d2a65cecd..a356816b7d8 100644 --- a/docs/api/qiskit/0.43/_toc.json +++ b/docs/api/qiskit/0.43/_toc.json @@ -1169,6 +1169,10 @@ "title": "SuperOp", "url": "/api/qiskit/0.43/qiskit.quantum_info.SuperOp" }, + { + "title": "two_qubit_cnot_decompose", + "url": "/api/qiskit/0.43/qiskit.quantum_info.two_qubit_cnot_decompose" + }, { "title": "TwoQubitBasisDecomposer", "url": "/api/qiskit/0.43/qiskit.quantum_info.TwoQubitBasisDecomposer" @@ -3739,6 +3743,10 @@ "title": "add_deprecation_to_docstring", "url": "/api/qiskit/0.43/qiskit.utils.add_deprecation_to_docstring" }, + { + "title": "algorithm_globals", + "url": "/api/qiskit/0.43/qiskit.utils.algorithm_globals" + }, { "title": "apply_prefix", "url": "/api/qiskit/0.43/qiskit.utils.apply_prefix" diff --git a/docs/api/qiskit/0.43/qasm2.mdx b/docs/api/qiskit/0.43/qasm2.mdx index f37ae49a6b1..70580b92b22 100644 --- a/docs/api/qiskit/0.43/qasm2.mdx +++ b/docs/api/qiskit/0.43/qasm2.mdx @@ -328,17 +328,23 @@ In particular, in the legacy importers: You can emulate this behaviour in [`load()`](#qiskit.qasm2.load "qiskit.qasm2.load") and [`loads()`](#qiskit.qasm2.loads "qiskit.qasm2.loads") by setting include\_path appropriately (try inspecting the variable `qiskit.__file__` to find the installed location), and by passing a list of [`CustomInstruction`](#qiskit.qasm2.CustomInstruction "qiskit.qasm2.CustomInstruction") instances for each of the custom gates you care about. To make things easier we make three tuples available, which each contain one component of a configuration that is equivalent to Qiskit’s legacy converter behaviour. -**LEGACY\_CUSTOM\_INSTRUCTIONS** +### LEGACY\_CUSTOM\_INSTRUCTIONS -A tuple containing the extra custom\_instructions that Qiskit’s legacy built-in converters used if `qelib1.inc` is included, and there is any definition of a `delay` instruction. The gates in the paper version of `qelib1.inc` and `delay` all require a compatible declaration statement to be present within the OpenQASM 2 program, but Qiskit’s legacy additions are all marked as builtins since they are not actually present in any include file this parser sees. + + A tuple containing the extra custom\_instructions that Qiskit’s legacy built-in converters used if `qelib1.inc` is included, and there is any definition of a `delay` instruction. The gates in the paper version of `qelib1.inc` and `delay` all require a compatible declaration statement to be present within the OpenQASM 2 program, but Qiskit’s legacy additions are all marked as builtins since they are not actually present in any include file this parser sees. + -**LEGACY\_CUSTOM\_CLASSICAL** +### LEGACY\_CUSTOM\_CLASSICAL -A tuple containing the extra custom\_classical functions that Qiskit’s legacy built-in converters use beyond those specified by the paper. This is the three basic inverse trigonometric functions: $\asin$, $\acos$ and $\atan$. + + A tuple containing the extra custom\_classical functions that Qiskit’s legacy built-in converters use beyond those specified by the paper. This is the three basic inverse trigonometric functions: $\asin$, $\acos$ and $\atan$. + -**LEGACY\_INCLUDE\_PATH** +### LEGACY\_INCLUDE\_PATH -A tuple containing the exact include\_path used by the legacy Qiskit converter. + + A tuple containing the exact include\_path used by the legacy Qiskit converter. + On *all* the gates defined in Qiskit’s legacy version of `qelib1.inc` and the `delay` instruction, it does not matter how the gates are actually defined and used, the legacy importer will always attempt to output its custom objects for them. This can result in errors during the circuit construction, even after a successful parse. There is no way to emulate this buggy behaviour with [`qiskit.qasm2`](#module-qiskit.qasm2 "qiskit.qasm2"); only an `include "qelib1.inc";` statement or the custom\_instructions argument can cause built-in Qiskit instructions to be used, and the signatures of these match each other. diff --git a/docs/api/qiskit/0.43/qiskit.quantum_info.two_qubit_cnot_decompose.mdx b/docs/api/qiskit/0.43/qiskit.quantum_info.two_qubit_cnot_decompose.mdx index 009e3502b7f..35d5afb7091 100644 --- a/docs/api/qiskit/0.43/qiskit.quantum_info.two_qubit_cnot_decompose.mdx +++ b/docs/api/qiskit/0.43/qiskit.quantum_info.two_qubit_cnot_decompose.mdx @@ -1,5 +1,14 @@ +--- +title: two_qubit_cnot_decompose +description: API reference for qiskit.quantum_info.two_qubit_cnot_decompose +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.quantum_info.two_qubit_cnot_decompose +--- + -# qiskit.quantum\_info.two\_qubit\_cnot\_decompose +# two\_qubit\_cnot\_decompose + + -## two\_qubit\_cnot\_decompose *= \* diff --git a/docs/api/qiskit/0.43/qiskit.utils.algorithm_globals.mdx b/docs/api/qiskit/0.43/qiskit.utils.algorithm_globals.mdx index 939a4cfc9c6..5ced7e9ddc1 100644 --- a/docs/api/qiskit/0.43/qiskit.utils.algorithm_globals.mdx +++ b/docs/api/qiskit/0.43/qiskit.utils.algorithm_globals.mdx @@ -1,7 +1,16 @@ +--- +title: algorithm_globals +description: API reference for qiskit.utils.algorithm_globals +in_page_toc_min_heading_level: 1 +python_api_type: data +python_api_name: qiskit.utils.algorithm_globals +--- + -# qiskit.utils.algorithm\_globals +# algorithm\_globals -## algorithm\_globals *= \* + + Class for global properties. + -Class for global properties. diff --git a/docs/api/qiskit/0.43/quantum_info.mdx b/docs/api/qiskit/0.43/quantum_info.mdx index f83b25820ab..ebcf90e1c5b 100644 --- a/docs/api/qiskit/0.43/quantum_info.mdx +++ b/docs/api/qiskit/0.43/quantum_info.mdx @@ -107,12 +107,12 @@ python_api_name: qiskit.quantum_info ## Synthesis -| | | -| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis, use\_dag]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | -| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, ...]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | -| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose#qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | | -| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | -| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | DEPRECATED: Decompose a Clifford operator into a QuantumCircuit. | -| [`XXDecomposer`](qiskit.quantum_info.XXDecomposer "qiskit.quantum_info.XXDecomposer")(\[basis\_fidelity, euler\_basis, ...]) | A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). | +| | | +| ------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [`OneQubitEulerDecomposer`](qiskit.quantum_info.OneQubitEulerDecomposer "qiskit.quantum_info.OneQubitEulerDecomposer")(\[basis, use\_dag]) | A class for decomposing 1-qubit unitaries into Euler angle rotations. | +| [`TwoQubitBasisDecomposer`](qiskit.quantum_info.TwoQubitBasisDecomposer "qiskit.quantum_info.TwoQubitBasisDecomposer")(gate\[, ...]) | A class for decomposing 2-qubit unitaries into minimal number of uses of a 2-qubit basis gate. | +| [`two_qubit_cnot_decompose`](qiskit.quantum_info.two_qubit_cnot_decompose "qiskit.quantum_info.two_qubit_cnot_decompose") | | +| [`Quaternion`](qiskit.quantum_info.Quaternion "qiskit.quantum_info.Quaternion")(data) | A class representing a Quaternion. | +| [`decompose_clifford`](qiskit.quantum_info.decompose_clifford "qiskit.quantum_info.decompose_clifford")(clifford\[, method]) | DEPRECATED: Decompose a Clifford operator into a QuantumCircuit. | +| [`XXDecomposer`](qiskit.quantum_info.XXDecomposer "qiskit.quantum_info.XXDecomposer")(\[basis\_fidelity, euler\_basis, ...]) | A class for optimal decomposition of 2-qubit unitaries into 2-qubit basis gates of XX type (i.e., each locally equivalent to CAN(alpha, 0, 0) for a possibly varying alpha). | diff --git a/docs/api/qiskit/0.43/utils.mdx b/docs/api/qiskit/0.43/utils.mdx index 4e37b8f8079..7e566ddc77c 100644 --- a/docs/api/qiskit/0.43/utils.mdx +++ b/docs/api/qiskit/0.43/utils.mdx @@ -33,15 +33,15 @@ python_api_name: qiskit.utils ## Algorithm Utilities -| | | -| --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | -| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | -| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | -| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | -| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed. | -| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | Check if Aer is installed. | -| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | -| [`algorithm_globals`](qiskit.utils.algorithm_globals#qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | +| | | +| ----------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | +| [`summarize_circuits`](qiskit.utils.summarize_circuits "qiskit.utils.summarize_circuits") | Summarize circuits based on QuantumCircuit, and five metrics are summarized. | +| [`get_entangler_map`](qiskit.utils.get_entangler_map "qiskit.utils.get_entangler_map") | Utility method to get an entangler map among qubits. | +| [`validate_entangler_map`](qiskit.utils.validate_entangler_map "qiskit.utils.validate_entangler_map") | Validate a user supplied entangler map and converts entries to ints. | +| [`has_ibmq`](qiskit.utils.has_ibmq "qiskit.utils.has_ibmq") | Check if IBMQ is installed. | +| [`has_aer`](qiskit.utils.has_aer "qiskit.utils.has_aer") | Check if Aer is installed. | +| [`name_args`](qiskit.utils.name_args "qiskit.utils.name_args") | Decorator to convert unnamed arguments to named ones. | +| [`algorithm_globals`](qiskit.utils.algorithm_globals "qiskit.utils.algorithm_globals") | Class for global properties. | | | | | -------------------------------------------------------------------------------- | -------------------------------------------------------- | From 46f949bdac1d0ba7f733c3c13d12e5ef2ee3c87f Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Fri, 6 Sep 2024 09:47:36 -0400 Subject: [PATCH 22/28] Regenerate qiskit 0.44.0 --- docs/api/qiskit/0.44/circuit.mdx | 64 ++++++++++++++++---------------- docs/api/qiskit/0.44/qasm2.mdx | 18 ++++++--- docs/api/qiskit/0.44/utils.mdx | 6 ++- 3 files changed, 48 insertions(+), 40 deletions(-) diff --git a/docs/api/qiskit/0.44/circuit.mdx b/docs/api/qiskit/0.44/circuit.mdx index a5c54e5b598..562a99a3859 100644 --- a/docs/api/qiskit/0.44/circuit.mdx +++ b/docs/api/qiskit/0.44/circuit.mdx @@ -238,41 +238,41 @@ qc.depth() The [`SwitchCaseOp`](qiskit.circuit.SwitchCaseOp "qiskit.circuit.SwitchCaseOp") also understands a special value: -**qiskit.circuit.CASE\_DEFAULT** + + A special object that represents the “default” case of a switch statement. If you use this as a case target, it must be the last case, and will match anything that wasn’t already matched. For example: -A special object that represents the “default” case of a switch statement. If you use this as a case target, it must be the last case, and will match anything that wasn’t already matched. For example: - -```python -from qiskit import QuantumCircuit, QuantumRegister, ClassicalRegister -from qiskit.circuit import SwitchCaseOp, CASE_DEFAULT - -body0 = QuantumCircuit(2, 2) -body0.x(0) -body1 = QuantumCircuit(2, 2) -body1.z(0) -body2 = QuantumCircuit(2, 2) -body2.cx(0, 1) - -qr, cr = QuantumRegister(2), ClassicalRegister(2) -qc = QuantumCircuit(qr, cr) -qc.switch(cr, [(0, body0), (1, body1), (CASE_DEFAULT, body2)], qr, cr) -``` - -When using the builder interface of [`QuantumCircuit.switch()`](qiskit.circuit.QuantumCircuit#switch "qiskit.circuit.QuantumCircuit.switch"), this can also be accessed as the `DEFAULT` attribute of the bound case-builder object, such as: + ```python + from qiskit import QuantumCircuit, QuantumRegister, ClassicalRegister + from qiskit.circuit import SwitchCaseOp, CASE_DEFAULT + + body0 = QuantumCircuit(2, 2) + body0.x(0) + body1 = QuantumCircuit(2, 2) + body1.z(0) + body2 = QuantumCircuit(2, 2) + body2.cx(0, 1) + + qr, cr = QuantumRegister(2), ClassicalRegister(2) + qc = QuantumCircuit(qr, cr) + qc.switch(cr, [(0, body0), (1, body1), (CASE_DEFAULT, body2)], qr, cr) + ``` -```python -from qiskit import QuantumCircuit, QuantumRegister, ClassicalRegister + When using the builder interface of [`QuantumCircuit.switch()`](qiskit.circuit.QuantumCircuit#switch "qiskit.circuit.QuantumCircuit.switch"), this can also be accessed as the `DEFAULT` attribute of the bound case-builder object, such as: -qr, cr = QuantumRegister(2), ClassicalRegister(2) -qc = QuantumCircuit(qr, cr) -with qc.switch(cr) as case: - with case(0): - qc.x(0) - with case(1): - qc.z(0) - with case(case.DEFAULT): - qc.cx(0, 1) -``` + ```python + from qiskit import QuantumCircuit, QuantumRegister, ClassicalRegister + + qr, cr = QuantumRegister(2), ClassicalRegister(2) + qc = QuantumCircuit(qr, cr) + with qc.switch(cr) as case: + with case(0): + qc.x(0) + with case(1): + qc.z(0) + with case(case.DEFAULT): + qc.cx(0, 1) + ``` + ### Parametric Quantum Circuits diff --git a/docs/api/qiskit/0.44/qasm2.mdx b/docs/api/qiskit/0.44/qasm2.mdx index 2ce7e81227c..57e70396143 100644 --- a/docs/api/qiskit/0.44/qasm2.mdx +++ b/docs/api/qiskit/0.44/qasm2.mdx @@ -399,17 +399,23 @@ In particular, in the legacy importers: You can emulate this behaviour in [`load()`](#qiskit.qasm2.load "qiskit.qasm2.load") and [`loads()`](#qiskit.qasm2.loads "qiskit.qasm2.loads") by setting include\_path appropriately (try inspecting the variable `qiskit.__file__` to find the installed location), and by passing a list of [`CustomInstruction`](#qiskit.qasm2.CustomInstruction "qiskit.qasm2.CustomInstruction") instances for each of the custom gates you care about. To make things easier we make three tuples available, which each contain one component of a configuration that is equivalent to Qiskit’s legacy converter behaviour. -**qiskit.qasm2.LEGACY\_CUSTOM\_INSTRUCTIONS** +### qiskit.qasm2.LEGACY\_CUSTOM\_INSTRUCTIONS -A tuple containing the extra custom\_instructions that Qiskit’s legacy built-in converters used if `qelib1.inc` is included, and there is any definition of a `delay` instruction. The gates in the paper version of `qelib1.inc` and `delay` all require a compatible declaration statement to be present within the OpenQASM 2 program, but Qiskit’s legacy additions are all marked as builtins since they are not actually present in any include file this parser sees. + + A tuple containing the extra custom\_instructions that Qiskit’s legacy built-in converters used if `qelib1.inc` is included, and there is any definition of a `delay` instruction. The gates in the paper version of `qelib1.inc` and `delay` all require a compatible declaration statement to be present within the OpenQASM 2 program, but Qiskit’s legacy additions are all marked as builtins since they are not actually present in any include file this parser sees. + -**qiskit.qasm2.LEGACY\_CUSTOM\_CLASSICAL** +### qiskit.qasm2.LEGACY\_CUSTOM\_CLASSICAL -A tuple containing the extra custom\_classical functions that Qiskit’s legacy built-in converters use beyond those specified by the paper. This is the three basic inverse trigonometric functions: $\asin$, $\acos$ and $\atan$. + + A tuple containing the extra custom\_classical functions that Qiskit’s legacy built-in converters use beyond those specified by the paper. This is the three basic inverse trigonometric functions: $\asin$, $\acos$ and $\atan$. + -**qiskit.qasm2.LEGACY\_INCLUDE\_PATH** +### qiskit.qasm2.LEGACY\_INCLUDE\_PATH -A tuple containing the exact include\_path used by the legacy Qiskit converter. + + A tuple containing the exact include\_path used by the legacy Qiskit converter. + On *all* the gates defined in Qiskit’s legacy version of `qelib1.inc` and the `delay` instruction, it does not matter how the gates are actually defined and used, the legacy importer will always attempt to output its custom objects for them. This can result in errors during the circuit construction, even after a successful parse. There is no way to emulate this buggy behaviour with [`qiskit.qasm2`](#module-qiskit.qasm2 "qiskit.qasm2"); only an `include "qelib1.inc";` statement or the custom\_instructions argument can cause built-in Qiskit instructions to be used, and the signatures of these match each other. diff --git a/docs/api/qiskit/0.44/utils.mdx b/docs/api/qiskit/0.44/utils.mdx index e9ae8ff6b1e..610d3f5326f 100644 --- a/docs/api/qiskit/0.44/utils.mdx +++ b/docs/api/qiskit/0.44/utils.mdx @@ -369,9 +369,11 @@ python_api_name: qiskit.utils ``` -**qiskit.utils.algorithm\_globals *= \*** +### qiskit.utils.algorithm\_globals -Class for global properties. + + Class for global properties. + | | | | -------------------------------------------------------------------------------- | -------------------------------------------------------- | From 6e5ffa61de25b3cd4704db7e755b9fe76e58b5bf Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Fri, 6 Sep 2024 09:48:10 -0400 Subject: [PATCH 23/28] Regenerate qiskit 0.45.3 --- docs/api/qiskit/0.45/circuit.mdx | 64 ++++++++++++++++---------------- docs/api/qiskit/0.45/qasm2.mdx | 18 ++++++--- docs/api/qiskit/0.45/utils.mdx | 6 ++- 3 files changed, 48 insertions(+), 40 deletions(-) diff --git a/docs/api/qiskit/0.45/circuit.mdx b/docs/api/qiskit/0.45/circuit.mdx index 06dbb8b332c..1116b452432 100644 --- a/docs/api/qiskit/0.45/circuit.mdx +++ b/docs/api/qiskit/0.45/circuit.mdx @@ -238,41 +238,41 @@ qc.depth() The [`SwitchCaseOp`](qiskit.circuit.SwitchCaseOp "qiskit.circuit.SwitchCaseOp") also understands a special value: -**qiskit.circuit.CASE\_DEFAULT** + + A special object that represents the “default” case of a switch statement. If you use this as a case target, it must be the last case, and will match anything that wasn’t already matched. For example: -A special object that represents the “default” case of a switch statement. If you use this as a case target, it must be the last case, and will match anything that wasn’t already matched. For example: - -```python -from qiskit import QuantumCircuit, QuantumRegister, ClassicalRegister -from qiskit.circuit import SwitchCaseOp, CASE_DEFAULT - -body0 = QuantumCircuit(2, 2) -body0.x(0) -body1 = QuantumCircuit(2, 2) -body1.z(0) -body2 = QuantumCircuit(2, 2) -body2.cx(0, 1) - -qr, cr = QuantumRegister(2), ClassicalRegister(2) -qc = QuantumCircuit(qr, cr) -qc.switch(cr, [(0, body0), (1, body1), (CASE_DEFAULT, body2)], qr, cr) -``` - -When using the builder interface of [`QuantumCircuit.switch()`](qiskit.circuit.QuantumCircuit#switch "qiskit.circuit.QuantumCircuit.switch"), this can also be accessed as the `DEFAULT` attribute of the bound case-builder object, such as: + ```python + from qiskit import QuantumCircuit, QuantumRegister, ClassicalRegister + from qiskit.circuit import SwitchCaseOp, CASE_DEFAULT + + body0 = QuantumCircuit(2, 2) + body0.x(0) + body1 = QuantumCircuit(2, 2) + body1.z(0) + body2 = QuantumCircuit(2, 2) + body2.cx(0, 1) + + qr, cr = QuantumRegister(2), ClassicalRegister(2) + qc = QuantumCircuit(qr, cr) + qc.switch(cr, [(0, body0), (1, body1), (CASE_DEFAULT, body2)], qr, cr) + ``` -```python -from qiskit import QuantumCircuit, QuantumRegister, ClassicalRegister + When using the builder interface of [`QuantumCircuit.switch()`](qiskit.circuit.QuantumCircuit#switch "qiskit.circuit.QuantumCircuit.switch"), this can also be accessed as the `DEFAULT` attribute of the bound case-builder object, such as: -qr, cr = QuantumRegister(2), ClassicalRegister(2) -qc = QuantumCircuit(qr, cr) -with qc.switch(cr) as case: - with case(0): - qc.x(0) - with case(1): - qc.z(0) - with case(case.DEFAULT): - qc.cx(0, 1) -``` + ```python + from qiskit import QuantumCircuit, QuantumRegister, ClassicalRegister + + qr, cr = QuantumRegister(2), ClassicalRegister(2) + qc = QuantumCircuit(qr, cr) + with qc.switch(cr) as case: + with case(0): + qc.x(0) + with case(1): + qc.z(0) + with case(case.DEFAULT): + qc.cx(0, 1) + ``` + ### Parametric Quantum Circuits diff --git a/docs/api/qiskit/0.45/qasm2.mdx b/docs/api/qiskit/0.45/qasm2.mdx index fe665f7c33a..228a9bc9ee8 100644 --- a/docs/api/qiskit/0.45/qasm2.mdx +++ b/docs/api/qiskit/0.45/qasm2.mdx @@ -495,17 +495,23 @@ In particular, in the legacy importers: You can emulate this behaviour in [`load()`](#qiskit.qasm2.load "qiskit.qasm2.load") and [`loads()`](#qiskit.qasm2.loads "qiskit.qasm2.loads") by setting include\_path appropriately (try inspecting the variable `qiskit.__file__` to find the installed location), and by passing a list of [`CustomInstruction`](#qiskit.qasm2.CustomInstruction "qiskit.qasm2.CustomInstruction") instances for each of the custom gates you care about. To make things easier we make three tuples available, which each contain one component of a configuration that is equivalent to Qiskit’s legacy converter behaviour. -**qiskit.qasm2.LEGACY\_CUSTOM\_INSTRUCTIONS** +### qiskit.qasm2.LEGACY\_CUSTOM\_INSTRUCTIONS -A tuple containing the extra custom\_instructions that Qiskit’s legacy built-in converters used if `qelib1.inc` is included, and there is any definition of a `delay` instruction. The gates in the paper version of `qelib1.inc` and `delay` all require a compatible declaration statement to be present within the OpenQASM 2 program, but Qiskit’s legacy additions are all marked as builtins since they are not actually present in any include file this parser sees. + + A tuple containing the extra custom\_instructions that Qiskit’s legacy built-in converters used if `qelib1.inc` is included, and there is any definition of a `delay` instruction. The gates in the paper version of `qelib1.inc` and `delay` all require a compatible declaration statement to be present within the OpenQASM 2 program, but Qiskit’s legacy additions are all marked as builtins since they are not actually present in any include file this parser sees. + -**qiskit.qasm2.LEGACY\_CUSTOM\_CLASSICAL** +### qiskit.qasm2.LEGACY\_CUSTOM\_CLASSICAL -A tuple containing the extra custom\_classical functions that Qiskit’s legacy built-in converters use beyond those specified by the paper. This is the three basic inverse trigonometric functions: $\asin$, $\acos$ and $\atan$. + + A tuple containing the extra custom\_classical functions that Qiskit’s legacy built-in converters use beyond those specified by the paper. This is the three basic inverse trigonometric functions: $\asin$, $\acos$ and $\atan$. + -**qiskit.qasm2.LEGACY\_INCLUDE\_PATH** +### qiskit.qasm2.LEGACY\_INCLUDE\_PATH -A tuple containing the exact include\_path used by the legacy Qiskit converter. + + A tuple containing the exact include\_path used by the legacy Qiskit converter. + On *all* the gates defined in Qiskit’s legacy version of `qelib1.inc` and the `delay` instruction, it does not matter how the gates are actually defined and used, the legacy importer will always attempt to output its custom objects for them. This can result in errors during the circuit construction, even after a successful parse. There is no way to emulate this buggy behaviour with [`qiskit.qasm2`](#module-qiskit.qasm2 "qiskit.qasm2"); only an `include "qelib1.inc";` statement or the custom\_instructions argument can cause built-in Qiskit instructions to be used, and the signatures of these match each other. diff --git a/docs/api/qiskit/0.45/utils.mdx b/docs/api/qiskit/0.45/utils.mdx index 404b5f3a7e1..488cd2ed878 100644 --- a/docs/api/qiskit/0.45/utils.mdx +++ b/docs/api/qiskit/0.45/utils.mdx @@ -369,9 +369,11 @@ python_api_name: qiskit.utils ``` -**qiskit.utils.algorithm\_globals *= \*** +### qiskit.utils.algorithm\_globals -Class for global properties. + + Class for global properties. + | | | | -------------------------------------------------------------------------------- | -------------------------------------------------------- | From 0c0c2a4f410c5365d1753547ffb840e67f5ce4d5 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Fri, 6 Sep 2024 09:48:47 -0400 Subject: [PATCH 24/28] Regenerate qiskit 0.46.2 --- docs/api/qiskit/0.46/circuit.mdx | 64 ++++++++++++++++---------------- docs/api/qiskit/0.46/qasm2.mdx | 18 ++++++--- docs/api/qiskit/0.46/utils.mdx | 6 ++- 3 files changed, 48 insertions(+), 40 deletions(-) diff --git a/docs/api/qiskit/0.46/circuit.mdx b/docs/api/qiskit/0.46/circuit.mdx index 227b694cb8b..ea1b857da7e 100644 --- a/docs/api/qiskit/0.46/circuit.mdx +++ b/docs/api/qiskit/0.46/circuit.mdx @@ -239,41 +239,41 @@ qc.depth() The [`SwitchCaseOp`](qiskit.circuit.SwitchCaseOp "qiskit.circuit.SwitchCaseOp") also understands a special value: -**qiskit.circuit.CASE\_DEFAULT** + + A special object that represents the “default” case of a switch statement. If you use this as a case target, it must be the last case, and will match anything that wasn’t already matched. For example: -A special object that represents the “default” case of a switch statement. If you use this as a case target, it must be the last case, and will match anything that wasn’t already matched. For example: - -```python -from qiskit import QuantumCircuit, QuantumRegister, ClassicalRegister -from qiskit.circuit import SwitchCaseOp, CASE_DEFAULT - -body0 = QuantumCircuit(2, 2) -body0.x(0) -body1 = QuantumCircuit(2, 2) -body1.z(0) -body2 = QuantumCircuit(2, 2) -body2.cx(0, 1) - -qr, cr = QuantumRegister(2), ClassicalRegister(2) -qc = QuantumCircuit(qr, cr) -qc.switch(cr, [(0, body0), (1, body1), (CASE_DEFAULT, body2)], qr, cr) -``` - -When using the builder interface of [`QuantumCircuit.switch()`](qiskit.circuit.QuantumCircuit#switch "qiskit.circuit.QuantumCircuit.switch"), this can also be accessed as the `DEFAULT` attribute of the bound case-builder object, such as: + ```python + from qiskit import QuantumCircuit, QuantumRegister, ClassicalRegister + from qiskit.circuit import SwitchCaseOp, CASE_DEFAULT + + body0 = QuantumCircuit(2, 2) + body0.x(0) + body1 = QuantumCircuit(2, 2) + body1.z(0) + body2 = QuantumCircuit(2, 2) + body2.cx(0, 1) + + qr, cr = QuantumRegister(2), ClassicalRegister(2) + qc = QuantumCircuit(qr, cr) + qc.switch(cr, [(0, body0), (1, body1), (CASE_DEFAULT, body2)], qr, cr) + ``` -```python -from qiskit import QuantumCircuit, QuantumRegister, ClassicalRegister + When using the builder interface of [`QuantumCircuit.switch()`](qiskit.circuit.QuantumCircuit#switch "qiskit.circuit.QuantumCircuit.switch"), this can also be accessed as the `DEFAULT` attribute of the bound case-builder object, such as: -qr, cr = QuantumRegister(2), ClassicalRegister(2) -qc = QuantumCircuit(qr, cr) -with qc.switch(cr) as case: - with case(0): - qc.x(0) - with case(1): - qc.z(0) - with case(case.DEFAULT): - qc.cx(0, 1) -``` + ```python + from qiskit import QuantumCircuit, QuantumRegister, ClassicalRegister + + qr, cr = QuantumRegister(2), ClassicalRegister(2) + qc = QuantumCircuit(qr, cr) + with qc.switch(cr) as case: + with case(0): + qc.x(0) + with case(1): + qc.z(0) + with case(case.DEFAULT): + qc.cx(0, 1) + ``` + ### Parametric Quantum Circuits diff --git a/docs/api/qiskit/0.46/qasm2.mdx b/docs/api/qiskit/0.46/qasm2.mdx index 82305d7b560..75f11451295 100644 --- a/docs/api/qiskit/0.46/qasm2.mdx +++ b/docs/api/qiskit/0.46/qasm2.mdx @@ -495,17 +495,23 @@ In particular, in the legacy importers: You can emulate this behaviour in [`load()`](#qiskit.qasm2.load "qiskit.qasm2.load") and [`loads()`](#qiskit.qasm2.loads "qiskit.qasm2.loads") by setting include\_path appropriately (try inspecting the variable `qiskit.__file__` to find the installed location), and by passing a list of [`CustomInstruction`](#qiskit.qasm2.CustomInstruction "qiskit.qasm2.CustomInstruction") instances for each of the custom gates you care about. To make things easier we make three tuples available, which each contain one component of a configuration that is equivalent to Qiskit’s legacy converter behaviour. -**qiskit.qasm2.LEGACY\_CUSTOM\_INSTRUCTIONS** +### qiskit.qasm2.LEGACY\_CUSTOM\_INSTRUCTIONS -A tuple containing the extra custom\_instructions that Qiskit’s legacy built-in converters used if `qelib1.inc` is included, and there is any definition of a `delay` instruction. The gates in the paper version of `qelib1.inc` and `delay` all require a compatible declaration statement to be present within the OpenQASM 2 program, but Qiskit’s legacy additions are all marked as builtins since they are not actually present in any include file this parser sees. + + A tuple containing the extra custom\_instructions that Qiskit’s legacy built-in converters used if `qelib1.inc` is included, and there is any definition of a `delay` instruction. The gates in the paper version of `qelib1.inc` and `delay` all require a compatible declaration statement to be present within the OpenQASM 2 program, but Qiskit’s legacy additions are all marked as builtins since they are not actually present in any include file this parser sees. + -**qiskit.qasm2.LEGACY\_CUSTOM\_CLASSICAL** +### qiskit.qasm2.LEGACY\_CUSTOM\_CLASSICAL -A tuple containing the extra custom\_classical functions that Qiskit’s legacy built-in converters use beyond those specified by the paper. This is the three basic inverse trigonometric functions: $\asin$, $\acos$ and $\atan$. + + A tuple containing the extra custom\_classical functions that Qiskit’s legacy built-in converters use beyond those specified by the paper. This is the three basic inverse trigonometric functions: $\asin$, $\acos$ and $\atan$. + -**qiskit.qasm2.LEGACY\_INCLUDE\_PATH** +### qiskit.qasm2.LEGACY\_INCLUDE\_PATH -A tuple containing the exact include\_path used by the legacy Qiskit converter. + + A tuple containing the exact include\_path used by the legacy Qiskit converter. + On *all* the gates defined in Qiskit’s legacy version of `qelib1.inc` and the `delay` instruction, it does not matter how the gates are actually defined and used, the legacy importer will always attempt to output its custom objects for them. This can result in errors during the circuit construction, even after a successful parse. There is no way to emulate this buggy behaviour with [`qiskit.qasm2`](#module-qiskit.qasm2 "qiskit.qasm2"); only an `include "qelib1.inc";` statement or the custom\_instructions argument can cause built-in Qiskit instructions to be used, and the signatures of these match each other. diff --git a/docs/api/qiskit/0.46/utils.mdx b/docs/api/qiskit/0.46/utils.mdx index 9d0d9101c06..722bb57630f 100644 --- a/docs/api/qiskit/0.46/utils.mdx +++ b/docs/api/qiskit/0.46/utils.mdx @@ -385,9 +385,11 @@ python_api_name: qiskit.utils -**qiskit.utils.algorithm\_globals *= \*** +### qiskit.utils.algorithm\_globals -Class for global properties. + + Class for global properties. + | | | | -------------------------------------------------------------------------------- | -------------------------------------------------------- | From 4cb315fd805543b2268310377e2782e88158d761 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Fri, 6 Sep 2024 09:49:11 -0400 Subject: [PATCH 25/28] Regenerate qiskit 1.0.2 --- docs/api/qiskit/1.0/circuit.mdx | 64 ++++++++++++++++----------------- docs/api/qiskit/1.0/qasm2.mdx | 18 ++++++---- docs/api/qiskit/1.0/qasm3.mdx | 6 ++-- 3 files changed, 48 insertions(+), 40 deletions(-) diff --git a/docs/api/qiskit/1.0/circuit.mdx b/docs/api/qiskit/1.0/circuit.mdx index a4973d37325..2fbdd132d36 100644 --- a/docs/api/qiskit/1.0/circuit.mdx +++ b/docs/api/qiskit/1.0/circuit.mdx @@ -248,41 +248,41 @@ qc.depth() The [`SwitchCaseOp`](qiskit.circuit.SwitchCaseOp "qiskit.circuit.SwitchCaseOp") also understands a special value: -**qiskit.circuit.CASE\_DEFAULT** + + A special object that represents the “default” case of a switch statement. If you use this as a case target, it must be the last case, and will match anything that wasn’t already matched. For example: -A special object that represents the “default” case of a switch statement. If you use this as a case target, it must be the last case, and will match anything that wasn’t already matched. For example: - -```python -from qiskit import QuantumCircuit, QuantumRegister, ClassicalRegister -from qiskit.circuit import SwitchCaseOp, CASE_DEFAULT - -body0 = QuantumCircuit(2, 2) -body0.x(0) -body1 = QuantumCircuit(2, 2) -body1.z(0) -body2 = QuantumCircuit(2, 2) -body2.cx(0, 1) - -qr, cr = QuantumRegister(2), ClassicalRegister(2) -qc = QuantumCircuit(qr, cr) -qc.switch(cr, [(0, body0), (1, body1), (CASE_DEFAULT, body2)], qr, cr) -``` - -When using the builder interface of [`QuantumCircuit.switch()`](qiskit.circuit.QuantumCircuit#switch "qiskit.circuit.QuantumCircuit.switch"), this can also be accessed as the `DEFAULT` attribute of the bound case-builder object, such as: + ```python + from qiskit import QuantumCircuit, QuantumRegister, ClassicalRegister + from qiskit.circuit import SwitchCaseOp, CASE_DEFAULT + + body0 = QuantumCircuit(2, 2) + body0.x(0) + body1 = QuantumCircuit(2, 2) + body1.z(0) + body2 = QuantumCircuit(2, 2) + body2.cx(0, 1) + + qr, cr = QuantumRegister(2), ClassicalRegister(2) + qc = QuantumCircuit(qr, cr) + qc.switch(cr, [(0, body0), (1, body1), (CASE_DEFAULT, body2)], qr, cr) + ``` -```python -from qiskit import QuantumCircuit, QuantumRegister, ClassicalRegister + When using the builder interface of [`QuantumCircuit.switch()`](qiskit.circuit.QuantumCircuit#switch "qiskit.circuit.QuantumCircuit.switch"), this can also be accessed as the `DEFAULT` attribute of the bound case-builder object, such as: -qr, cr = QuantumRegister(2), ClassicalRegister(2) -qc = QuantumCircuit(qr, cr) -with qc.switch(cr) as case: - with case(0): - qc.x(0) - with case(1): - qc.z(0) - with case(case.DEFAULT): - qc.cx(0, 1) -``` + ```python + from qiskit import QuantumCircuit, QuantumRegister, ClassicalRegister + + qr, cr = QuantumRegister(2), ClassicalRegister(2) + qc = QuantumCircuit(qr, cr) + with qc.switch(cr) as case: + with case(0): + qc.x(0) + with case(1): + qc.z(0) + with case(case.DEFAULT): + qc.cx(0, 1) + ``` + ### Parametric Quantum Circuits diff --git a/docs/api/qiskit/1.0/qasm2.mdx b/docs/api/qiskit/1.0/qasm2.mdx index dea008cc504..724632e646c 100644 --- a/docs/api/qiskit/1.0/qasm2.mdx +++ b/docs/api/qiskit/1.0/qasm2.mdx @@ -482,17 +482,23 @@ In particular, in the legacy importers: You can emulate this behaviour in [`load()`](#qiskit.qasm2.load "qiskit.qasm2.load") and [`loads()`](#qiskit.qasm2.loads "qiskit.qasm2.loads") by setting include\_path appropriately (try inspecting the variable `qiskit.__file__` to find the installed location), and by passing a list of [`CustomInstruction`](#qiskit.qasm2.CustomInstruction "qiskit.qasm2.CustomInstruction") instances for each of the custom gates you care about. To make things easier we make three tuples available, which each contain one component of a configuration that is equivalent to Qiskit’s legacy converter behaviour. -**qiskit.qasm2.LEGACY\_CUSTOM\_INSTRUCTIONS** +### qiskit.qasm2.LEGACY\_CUSTOM\_INSTRUCTIONS -A tuple containing the extra custom\_instructions that Qiskit’s legacy built-in converters used if `qelib1.inc` is included, and there is any definition of a `delay` instruction. The gates in the paper version of `qelib1.inc` and `delay` all require a compatible declaration statement to be present within the OpenQASM 2 program, but Qiskit’s legacy additions are all marked as builtins since they are not actually present in any include file this parser sees. + + A tuple containing the extra custom\_instructions that Qiskit’s legacy built-in converters used if `qelib1.inc` is included, and there is any definition of a `delay` instruction. The gates in the paper version of `qelib1.inc` and `delay` all require a compatible declaration statement to be present within the OpenQASM 2 program, but Qiskit’s legacy additions are all marked as builtins since they are not actually present in any include file this parser sees. + -**qiskit.qasm2.LEGACY\_CUSTOM\_CLASSICAL** +### qiskit.qasm2.LEGACY\_CUSTOM\_CLASSICAL -A tuple containing the extra custom\_classical functions that Qiskit’s legacy built-in converters use beyond those specified by the paper. This is the three basic inverse trigonometric functions: $\asin$, $\acos$ and $\atan$. + + A tuple containing the extra custom\_classical functions that Qiskit’s legacy built-in converters use beyond those specified by the paper. This is the three basic inverse trigonometric functions: $\asin$, $\acos$ and $\atan$. + -**qiskit.qasm2.LEGACY\_INCLUDE\_PATH** +### qiskit.qasm2.LEGACY\_INCLUDE\_PATH -A tuple containing the exact include\_path used by the legacy Qiskit converter. + + A tuple containing the exact include\_path used by the legacy Qiskit converter. + On *all* the gates defined in Qiskit’s legacy version of `qelib1.inc` and the `delay` instruction, it does not matter how the gates are actually defined and used, the legacy importer will always attempt to output its custom objects for them. This can result in errors during the circuit construction, even after a successful parse. There is no way to emulate this buggy behaviour with [`qiskit.qasm2`](#module-qiskit.qasm2 "qiskit.qasm2"); only an `include "qelib1.inc";` statement or the custom\_instructions argument can cause built-in Qiskit instructions to be used, and the signatures of these match each other. diff --git a/docs/api/qiskit/1.0/qasm3.mdx b/docs/api/qiskit/1.0/qasm3.mdx index 337a021d279..c621a91a1d8 100644 --- a/docs/api/qiskit/1.0/qasm3.mdx +++ b/docs/api/qiskit/1.0/qasm3.mdx @@ -399,7 +399,9 @@ These two functions allow for specifying include paths as an iterable of paths, In `custom_gates` is not given, Qiskit will attempt to use its standard-library gate objects for the gates defined in OpenQASM 3 standard library file `stdgates.inc`. This sequence of gates is available on this module, if you wish to build on top of it: -**qiskit.qasm3.STDGATES\_INC\_GATES** +#### qiskit.qasm3.STDGATES\_INC\_GATES -A tuple of [`CustomGate`](#qiskit.qasm3.CustomGate "qiskit.qasm3.CustomGate") objects specifying the Qiskit constructors to use for the `stdgates.inc` include file. + + A tuple of [`CustomGate`](#qiskit.qasm3.CustomGate "qiskit.qasm3.CustomGate") objects specifying the Qiskit constructors to use for the `stdgates.inc` include file. + From 594c35b9659ed196caee8c00f264dd3bae83b783 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Fri, 6 Sep 2024 09:49:37 -0400 Subject: [PATCH 26/28] Regenerate qiskit 1.1.2 --- docs/api/qiskit/1.1/circuit.mdx | 18 ++++++++++++------ docs/api/qiskit/1.1/qasm2.mdx | 18 ++++++++++++------ docs/api/qiskit/1.1/qasm3.mdx | 6 ++++-- 3 files changed, 28 insertions(+), 14 deletions(-) diff --git a/docs/api/qiskit/1.1/circuit.mdx b/docs/api/qiskit/1.1/circuit.mdx index 9c88da73abb..a41250d09b6 100644 --- a/docs/api/qiskit/1.1/circuit.mdx +++ b/docs/api/qiskit/1.1/circuit.mdx @@ -621,9 +621,11 @@ These control-flow operations ([`IfElseOp`](qiskit.circuit.IfElseOp "qiskit.circ The [`SwitchCaseOp`](qiskit.circuit.SwitchCaseOp "qiskit.circuit.SwitchCaseOp") also understands a special value: -**qiskit.circuit.CASE\_DEFAULT *= \*** +#### qiskit.circuit.CASE\_DEFAULT -A special object that represents the “default” case of a switch statement. If you use this as a case target, it must be the last case, and will match anything that wasn’t already matched. When using the builder interface of [`QuantumCircuit.switch()`](qiskit.circuit.QuantumCircuit#switch "qiskit.circuit.QuantumCircuit.switch"), this can also be accessed as the `DEFAULT` attribute of the bound case-builder object. + + A special object that represents the “default” case of a switch statement. If you use this as a case target, it must be the last case, and will match anything that wasn’t already matched. When using the builder interface of [`QuantumCircuit.switch()`](qiskit.circuit.QuantumCircuit#switch "qiskit.circuit.QuantumCircuit.switch"), this can also be accessed as the `DEFAULT` attribute of the bound case-builder object. + In addition to the block-structure control-flow operations, there are also two special instructions that affect the flow of control when within loops. These correspond to typical uses of the `break` and `continue` statements in classical programming languages. @@ -801,15 +803,19 @@ A common task in mapping abstract circuits to physical hardware and optimizing t Qiskit ships with a large set of predefined equivalence relationships for all of its standard gates. This base library is called [`StandardEquivalenceLibrary`](#qiskit.circuit.StandardEquivalenceLibrary "qiskit.circuit.StandardEquivalenceLibrary"), and should be treated as immutable. -**qiskit.circuit.StandardEquivalenceLibrary** +#### qiskit.circuit.StandardEquivalenceLibrary -A [`EquivalenceLibrary`](qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary") that stores of all Qiskit’s built-in standard gate relationships. You should not mutate this, but instead either create your own [`EquivalenceLibrary`](qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary") using this one as its `base`, or modify the global-state [`SessionEquivalenceLibrary`](#qiskit.circuit.SessionEquivalenceLibrary "qiskit.circuit.SessionEquivalenceLibrary"). + + A [`EquivalenceLibrary`](qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary") that stores of all Qiskit’s built-in standard gate relationships. You should not mutate this, but instead either create your own [`EquivalenceLibrary`](qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary") using this one as its `base`, or modify the global-state [`SessionEquivalenceLibrary`](#qiskit.circuit.SessionEquivalenceLibrary "qiskit.circuit.SessionEquivalenceLibrary"). + Qiskit also defines a shared global-state object, [`SessionEquivalenceLibrary`](#qiskit.circuit.SessionEquivalenceLibrary "qiskit.circuit.SessionEquivalenceLibrary"), which is the default equivalences used by various places in Qiskit, most notably the [`BasisTranslator`](qiskit.transpiler.passes.BasisTranslator "qiskit.transpiler.passes.BasisTranslator") transpiler pass. You should feel free to add your own equivalences to this using its [`add_equivalence()`](qiskit.circuit.EquivalenceLibrary#add_equivalence "qiskit.circuit.EquivalenceLibrary.add_equivalence") method, and they will be automatically picked up by default instances of the [`BasisTranslator`](qiskit.transpiler.passes.BasisTranslator "qiskit.transpiler.passes.BasisTranslator"). -**qiskit.circuit.SessionEquivalenceLibrary** +#### qiskit.circuit.SessionEquivalenceLibrary -The default instance of [`EquivalenceLibrary`](qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary"), which will be used by most Qiskit objects if no library is manually specified. You can feel free to add equivalences to this using [`add_equivalence()`](qiskit.circuit.EquivalenceLibrary#add_equivalence "qiskit.circuit.EquivalenceLibrary.add_equivalence"). It inherits all the built-in rules of [`StandardEquivalenceLibrary`](#qiskit.circuit.StandardEquivalenceLibrary "qiskit.circuit.StandardEquivalenceLibrary"). + + The default instance of [`EquivalenceLibrary`](qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary"), which will be used by most Qiskit objects if no library is manually specified. You can feel free to add equivalences to this using [`add_equivalence()`](qiskit.circuit.EquivalenceLibrary#add_equivalence "qiskit.circuit.EquivalenceLibrary.add_equivalence"). It inherits all the built-in rules of [`StandardEquivalenceLibrary`](#qiskit.circuit.StandardEquivalenceLibrary "qiskit.circuit.StandardEquivalenceLibrary"). + ### Generating random circuits diff --git a/docs/api/qiskit/1.1/qasm2.mdx b/docs/api/qiskit/1.1/qasm2.mdx index 821bd180e9e..bbbbf66bc12 100644 --- a/docs/api/qiskit/1.1/qasm2.mdx +++ b/docs/api/qiskit/1.1/qasm2.mdx @@ -482,17 +482,23 @@ In particular, in the legacy importers: You can emulate this behaviour in [`load()`](#qiskit.qasm2.load "qiskit.qasm2.load") and [`loads()`](#qiskit.qasm2.loads "qiskit.qasm2.loads") by setting include\_path appropriately (try inspecting the variable `qiskit.__file__` to find the installed location), and by passing a list of [`CustomInstruction`](#qiskit.qasm2.CustomInstruction "qiskit.qasm2.CustomInstruction") instances for each of the custom gates you care about. To make things easier we make three tuples available, which each contain one component of a configuration that is equivalent to Qiskit’s legacy converter behaviour. -**qiskit.qasm2.LEGACY\_CUSTOM\_INSTRUCTIONS** +### qiskit.qasm2.LEGACY\_CUSTOM\_INSTRUCTIONS -A tuple containing the extra custom\_instructions that Qiskit’s legacy built-in converters used if `qelib1.inc` is included, and there is any definition of a `delay` instruction. The gates in the paper version of `qelib1.inc` and `delay` all require a compatible declaration statement to be present within the OpenQASM 2 program, but Qiskit’s legacy additions are all marked as builtins since they are not actually present in any include file this parser sees. + + A tuple containing the extra custom\_instructions that Qiskit’s legacy built-in converters used if `qelib1.inc` is included, and there is any definition of a `delay` instruction. The gates in the paper version of `qelib1.inc` and `delay` all require a compatible declaration statement to be present within the OpenQASM 2 program, but Qiskit’s legacy additions are all marked as builtins since they are not actually present in any include file this parser sees. + -**qiskit.qasm2.LEGACY\_CUSTOM\_CLASSICAL** +### qiskit.qasm2.LEGACY\_CUSTOM\_CLASSICAL -A tuple containing the extra custom\_classical functions that Qiskit’s legacy built-in converters use beyond those specified by the paper. This is the three basic inverse trigonometric functions: $\asin$, $\acos$ and $\atan$. + + A tuple containing the extra custom\_classical functions that Qiskit’s legacy built-in converters use beyond those specified by the paper. This is the three basic inverse trigonometric functions: $\asin$, $\acos$ and $\atan$. + -**qiskit.qasm2.LEGACY\_INCLUDE\_PATH** +### qiskit.qasm2.LEGACY\_INCLUDE\_PATH -A tuple containing the exact include\_path used by the legacy Qiskit converter. + + A tuple containing the exact include\_path used by the legacy Qiskit converter. + On *all* the gates defined in Qiskit’s legacy version of `qelib1.inc` and the `delay` instruction, it does not matter how the gates are actually defined and used, the legacy importer will always attempt to output its custom objects for them. This can result in errors during the circuit construction, even after a successful parse. There is no way to emulate this buggy behaviour with [`qiskit.qasm2`](#module-qiskit.qasm2 "qiskit.qasm2"); only an `include "qelib1.inc";` statement or the custom\_instructions argument can cause built-in Qiskit instructions to be used, and the signatures of these match each other. diff --git a/docs/api/qiskit/1.1/qasm3.mdx b/docs/api/qiskit/1.1/qasm3.mdx index 251dbcbd0d9..d371ecc970f 100644 --- a/docs/api/qiskit/1.1/qasm3.mdx +++ b/docs/api/qiskit/1.1/qasm3.mdx @@ -399,7 +399,9 @@ These two functions allow for specifying include paths as an iterable of paths, In `custom_gates` is not given, Qiskit will attempt to use its standard-library gate objects for the gates defined in OpenQASM 3 standard library file `stdgates.inc`. This sequence of gates is available on this module, if you wish to build on top of it: -**qiskit.qasm3.STDGATES\_INC\_GATES** +#### qiskit.qasm3.STDGATES\_INC\_GATES -A tuple of [`CustomGate`](#qiskit.qasm3.CustomGate "qiskit.qasm3.CustomGate") objects specifying the Qiskit constructors to use for the `stdgates.inc` include file. + + A tuple of [`CustomGate`](#qiskit.qasm3.CustomGate "qiskit.qasm3.CustomGate") objects specifying the Qiskit constructors to use for the `stdgates.inc` include file. + From 836d133934a20c69ccf7e60e38fb55adc0258d5d Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Fri, 6 Sep 2024 09:50:05 -0400 Subject: [PATCH 27/28] Regenerate qiskit 1.2.0 --- docs/api/qiskit/circuit.mdx | 18 ++++++++++++------ docs/api/qiskit/qasm2.mdx | 18 ++++++++++++------ docs/api/qiskit/qasm3.mdx | 6 ++++-- 3 files changed, 28 insertions(+), 14 deletions(-) diff --git a/docs/api/qiskit/circuit.mdx b/docs/api/qiskit/circuit.mdx index cb9569a08f8..0234e9b9f75 100644 --- a/docs/api/qiskit/circuit.mdx +++ b/docs/api/qiskit/circuit.mdx @@ -622,9 +622,11 @@ These control-flow operations ([`IfElseOp`](qiskit.circuit.IfElseOp "qiskit.circ The [`SwitchCaseOp`](qiskit.circuit.SwitchCaseOp "qiskit.circuit.SwitchCaseOp") also understands a special value: -**qiskit.circuit.CASE\_DEFAULT *= \*** +#### qiskit.circuit.CASE\_DEFAULT -A special object that represents the “default” case of a switch statement. If you use this as a case target, it must be the last case, and will match anything that wasn’t already matched. When using the builder interface of [`QuantumCircuit.switch()`](qiskit.circuit.QuantumCircuit#switch "qiskit.circuit.QuantumCircuit.switch"), this can also be accessed as the `DEFAULT` attribute of the bound case-builder object. + + A special object that represents the “default” case of a switch statement. If you use this as a case target, it must be the last case, and will match anything that wasn’t already matched. When using the builder interface of [`QuantumCircuit.switch()`](qiskit.circuit.QuantumCircuit#switch "qiskit.circuit.QuantumCircuit.switch"), this can also be accessed as the `DEFAULT` attribute of the bound case-builder object. + In addition to the block-structure control-flow operations, there are also two special instructions that affect the flow of control when within loops. These correspond to typical uses of the `break` and `continue` statements in classical programming languages. @@ -802,15 +804,19 @@ A common task in mapping abstract circuits to physical hardware and optimizing t Qiskit ships with a large set of predefined equivalence relationships for all of its standard gates. This base library is called [`StandardEquivalenceLibrary`](#qiskit.circuit.StandardEquivalenceLibrary "qiskit.circuit.StandardEquivalenceLibrary"), and should be treated as immutable. -**qiskit.circuit.StandardEquivalenceLibrary** +#### qiskit.circuit.StandardEquivalenceLibrary -A [`EquivalenceLibrary`](qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary") that stores of all Qiskit’s built-in standard gate relationships. You should not mutate this, but instead either create your own [`EquivalenceLibrary`](qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary") using this one as its `base`, or modify the global-state [`SessionEquivalenceLibrary`](#qiskit.circuit.SessionEquivalenceLibrary "qiskit.circuit.SessionEquivalenceLibrary"). + + A [`EquivalenceLibrary`](qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary") that stores of all Qiskit’s built-in standard gate relationships. You should not mutate this, but instead either create your own [`EquivalenceLibrary`](qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary") using this one as its `base`, or modify the global-state [`SessionEquivalenceLibrary`](#qiskit.circuit.SessionEquivalenceLibrary "qiskit.circuit.SessionEquivalenceLibrary"). + Qiskit also defines a shared global-state object, [`SessionEquivalenceLibrary`](#qiskit.circuit.SessionEquivalenceLibrary "qiskit.circuit.SessionEquivalenceLibrary"), which is the default equivalences used by various places in Qiskit, most notably the [`BasisTranslator`](qiskit.transpiler.passes.BasisTranslator "qiskit.transpiler.passes.BasisTranslator") transpiler pass. You should feel free to add your own equivalences to this using its [`add_equivalence()`](qiskit.circuit.EquivalenceLibrary#add_equivalence "qiskit.circuit.EquivalenceLibrary.add_equivalence") method, and they will be automatically picked up by default instances of the [`BasisTranslator`](qiskit.transpiler.passes.BasisTranslator "qiskit.transpiler.passes.BasisTranslator"). -**qiskit.circuit.SessionEquivalenceLibrary** +#### qiskit.circuit.SessionEquivalenceLibrary -The default instance of [`EquivalenceLibrary`](qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary"), which will be used by most Qiskit objects if no library is manually specified. You can feel free to add equivalences to this using [`add_equivalence()`](qiskit.circuit.EquivalenceLibrary#add_equivalence "qiskit.circuit.EquivalenceLibrary.add_equivalence"). It inherits all the built-in rules of [`StandardEquivalenceLibrary`](#qiskit.circuit.StandardEquivalenceLibrary "qiskit.circuit.StandardEquivalenceLibrary"). + + The default instance of [`EquivalenceLibrary`](qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary"), which will be used by most Qiskit objects if no library is manually specified. You can feel free to add equivalences to this using [`add_equivalence()`](qiskit.circuit.EquivalenceLibrary#add_equivalence "qiskit.circuit.EquivalenceLibrary.add_equivalence"). It inherits all the built-in rules of [`StandardEquivalenceLibrary`](#qiskit.circuit.StandardEquivalenceLibrary "qiskit.circuit.StandardEquivalenceLibrary"). + ### Generating random circuits diff --git a/docs/api/qiskit/qasm2.mdx b/docs/api/qiskit/qasm2.mdx index 4f139c9c145..1a348aa926a 100644 --- a/docs/api/qiskit/qasm2.mdx +++ b/docs/api/qiskit/qasm2.mdx @@ -482,17 +482,23 @@ In particular, in the legacy importers: You can emulate this behavior in [`load()`](#qiskit.qasm2.load "qiskit.qasm2.load") and [`loads()`](#qiskit.qasm2.loads "qiskit.qasm2.loads") by setting include\_path appropriately (try inspecting the variable `qiskit.__file__` to find the installed location), and by passing a list of [`CustomInstruction`](#qiskit.qasm2.CustomInstruction "qiskit.qasm2.CustomInstruction") instances for each of the custom gates you care about. To make things easier we make three tuples available, which each contain one component of a configuration that is equivalent to Qiskit’s legacy converter behavior. -**qiskit.qasm2.LEGACY\_CUSTOM\_INSTRUCTIONS** +### qiskit.qasm2.LEGACY\_CUSTOM\_INSTRUCTIONS -A tuple containing the extra custom\_instructions that Qiskit’s legacy built-in converters used if `qelib1.inc` is included, and there is any definition of a `delay` instruction. The gates in the paper version of `qelib1.inc` and `delay` all require a compatible declaration statement to be present within the OpenQASM 2 program, but Qiskit’s legacy additions are all marked as builtins since they are not actually present in any include file this parser sees. + + A tuple containing the extra custom\_instructions that Qiskit’s legacy built-in converters used if `qelib1.inc` is included, and there is any definition of a `delay` instruction. The gates in the paper version of `qelib1.inc` and `delay` all require a compatible declaration statement to be present within the OpenQASM 2 program, but Qiskit’s legacy additions are all marked as builtins since they are not actually present in any include file this parser sees. + -**qiskit.qasm2.LEGACY\_CUSTOM\_CLASSICAL** +### qiskit.qasm2.LEGACY\_CUSTOM\_CLASSICAL -A tuple containing the extra custom\_classical functions that Qiskit’s legacy built-in converters use beyond those specified by the paper. This is the three basic inverse trigonometric functions: $\asin$, $\acos$ and $\atan$. + + A tuple containing the extra custom\_classical functions that Qiskit’s legacy built-in converters use beyond those specified by the paper. This is the three basic inverse trigonometric functions: $\asin$, $\acos$ and $\atan$. + -**qiskit.qasm2.LEGACY\_INCLUDE\_PATH** +### qiskit.qasm2.LEGACY\_INCLUDE\_PATH -A tuple containing the exact include\_path used by the legacy Qiskit converter. + + A tuple containing the exact include\_path used by the legacy Qiskit converter. + On *all* the gates defined in Qiskit’s legacy version of `qelib1.inc` and the `delay` instruction, it does not matter how the gates are actually defined and used, the legacy importer will always attempt to output its custom objects for them. This can result in errors during the circuit construction, even after a successful parse. There is no way to emulate this buggy behavior with [`qiskit.qasm2`](#module-qiskit.qasm2 "qiskit.qasm2"); only an `include "qelib1.inc";` statement or the custom\_instructions argument can cause built-in Qiskit instructions to be used, and the signatures of these match each other. diff --git a/docs/api/qiskit/qasm3.mdx b/docs/api/qiskit/qasm3.mdx index 081f57f05a0..be5300cc1d0 100644 --- a/docs/api/qiskit/qasm3.mdx +++ b/docs/api/qiskit/qasm3.mdx @@ -399,7 +399,9 @@ These two functions allow for specifying include paths as an iterable of paths, In `custom_gates` is not given, Qiskit will attempt to use its standard-library gate objects for the gates defined in OpenQASM 3 standard library file `stdgates.inc`. This sequence of gates is available on this module, if you wish to build on top of it: -**qiskit.qasm3.STDGATES\_INC\_GATES** +#### qiskit.qasm3.STDGATES\_INC\_GATES -A tuple of [`CustomGate`](#qiskit.qasm3.CustomGate "qiskit.qasm3.CustomGate") objects specifying the Qiskit constructors to use for the `stdgates.inc` include file. + + A tuple of [`CustomGate`](#qiskit.qasm3.CustomGate "qiskit.qasm3.CustomGate") objects specifying the Qiskit constructors to use for the `stdgates.inc` include file. + From 06dafd0a36f86eb70079cafedddcd84081012ff2 Mon Sep 17 00:00:00 2001 From: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com> Date: Fri, 6 Sep 2024 09:50:33 -0400 Subject: [PATCH 28/28] Regenerate qiskit 1.3.0-dev --- docs/api/qiskit/dev/circuit.mdx | 18 ++++++++++++------ docs/api/qiskit/dev/qasm2.mdx | 18 ++++++++++++------ docs/api/qiskit/dev/qasm3.mdx | 6 ++++-- 3 files changed, 28 insertions(+), 14 deletions(-) diff --git a/docs/api/qiskit/dev/circuit.mdx b/docs/api/qiskit/dev/circuit.mdx index eaae87e5a08..d55e0bc836b 100644 --- a/docs/api/qiskit/dev/circuit.mdx +++ b/docs/api/qiskit/dev/circuit.mdx @@ -621,9 +621,11 @@ These control-flow operations ([`IfElseOp`](qiskit.circuit.IfElseOp "qiskit.circ The [`SwitchCaseOp`](qiskit.circuit.SwitchCaseOp "qiskit.circuit.SwitchCaseOp") also understands a special value: -**qiskit.circuit.CASE\_DEFAULT *= \*** +#### qiskit.circuit.CASE\_DEFAULT -A special object that represents the “default” case of a switch statement. If you use this as a case target, it must be the last case, and will match anything that wasn’t already matched. When using the builder interface of [`QuantumCircuit.switch()`](qiskit.circuit.QuantumCircuit#switch "qiskit.circuit.QuantumCircuit.switch"), this can also be accessed as the `DEFAULT` attribute of the bound case-builder object. + + A special object that represents the “default” case of a switch statement. If you use this as a case target, it must be the last case, and will match anything that wasn’t already matched. When using the builder interface of [`QuantumCircuit.switch()`](qiskit.circuit.QuantumCircuit#switch "qiskit.circuit.QuantumCircuit.switch"), this can also be accessed as the `DEFAULT` attribute of the bound case-builder object. + In addition to the block-structure control-flow operations, there are also two special instructions that affect the flow of control when within loops. These correspond to typical uses of the `break` and `continue` statements in classical programming languages. @@ -801,15 +803,19 @@ A common task in mapping abstract circuits to physical hardware and optimizing t Qiskit ships with a large set of predefined equivalence relationships for all of its standard gates. This base library is called [`StandardEquivalenceLibrary`](#qiskit.circuit.StandardEquivalenceLibrary "qiskit.circuit.StandardEquivalenceLibrary"), and should be treated as immutable. -**qiskit.circuit.StandardEquivalenceLibrary** +#### qiskit.circuit.StandardEquivalenceLibrary -A [`EquivalenceLibrary`](qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary") that stores of all Qiskit’s built-in standard gate relationships. You should not mutate this, but instead either create your own [`EquivalenceLibrary`](qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary") using this one as its `base`, or modify the global-state [`SessionEquivalenceLibrary`](#qiskit.circuit.SessionEquivalenceLibrary "qiskit.circuit.SessionEquivalenceLibrary"). + + A [`EquivalenceLibrary`](qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary") that stores of all Qiskit’s built-in standard gate relationships. You should not mutate this, but instead either create your own [`EquivalenceLibrary`](qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary") using this one as its `base`, or modify the global-state [`SessionEquivalenceLibrary`](#qiskit.circuit.SessionEquivalenceLibrary "qiskit.circuit.SessionEquivalenceLibrary"). + Qiskit also defines a shared global-state object, [`SessionEquivalenceLibrary`](#qiskit.circuit.SessionEquivalenceLibrary "qiskit.circuit.SessionEquivalenceLibrary"), which is the default equivalences used by various places in Qiskit, most notably the [`BasisTranslator`](qiskit.transpiler.passes.BasisTranslator "qiskit.transpiler.passes.BasisTranslator") transpiler pass. You should feel free to add your own equivalences to this using its [`add_equivalence()`](qiskit.circuit.EquivalenceLibrary#add_equivalence "qiskit.circuit.EquivalenceLibrary.add_equivalence") method, and they will be automatically picked up by default instances of the [`BasisTranslator`](qiskit.transpiler.passes.BasisTranslator "qiskit.transpiler.passes.BasisTranslator"). -**qiskit.circuit.SessionEquivalenceLibrary** +#### qiskit.circuit.SessionEquivalenceLibrary -The default instance of [`EquivalenceLibrary`](qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary"), which will be used by most Qiskit objects if no library is manually specified. You can feel free to add equivalences to this using [`add_equivalence()`](qiskit.circuit.EquivalenceLibrary#add_equivalence "qiskit.circuit.EquivalenceLibrary.add_equivalence"). It inherits all the built-in rules of [`StandardEquivalenceLibrary`](#qiskit.circuit.StandardEquivalenceLibrary "qiskit.circuit.StandardEquivalenceLibrary"). + + The default instance of [`EquivalenceLibrary`](qiskit.circuit.EquivalenceLibrary "qiskit.circuit.EquivalenceLibrary"), which will be used by most Qiskit objects if no library is manually specified. You can feel free to add equivalences to this using [`add_equivalence()`](qiskit.circuit.EquivalenceLibrary#add_equivalence "qiskit.circuit.EquivalenceLibrary.add_equivalence"). It inherits all the built-in rules of [`StandardEquivalenceLibrary`](#qiskit.circuit.StandardEquivalenceLibrary "qiskit.circuit.StandardEquivalenceLibrary"). + ### Generating random circuits diff --git a/docs/api/qiskit/dev/qasm2.mdx b/docs/api/qiskit/dev/qasm2.mdx index 1358e2a182f..be59243ed4a 100644 --- a/docs/api/qiskit/dev/qasm2.mdx +++ b/docs/api/qiskit/dev/qasm2.mdx @@ -482,17 +482,23 @@ In particular, in the legacy importers: You can emulate this behavior in [`load()`](#qiskit.qasm2.load "qiskit.qasm2.load") and [`loads()`](#qiskit.qasm2.loads "qiskit.qasm2.loads") by setting include\_path appropriately (try inspecting the variable `qiskit.__file__` to find the installed location), and by passing a list of [`CustomInstruction`](#qiskit.qasm2.CustomInstruction "qiskit.qasm2.CustomInstruction") instances for each of the custom gates you care about. To make things easier we make three tuples available, which each contain one component of a configuration that is equivalent to Qiskit’s legacy converter behavior. -**qiskit.qasm2.LEGACY\_CUSTOM\_INSTRUCTIONS** +### qiskit.qasm2.LEGACY\_CUSTOM\_INSTRUCTIONS -A tuple containing the extra custom\_instructions that Qiskit’s legacy built-in converters used if `qelib1.inc` is included, and there is any definition of a `delay` instruction. The gates in the paper version of `qelib1.inc` and `delay` all require a compatible declaration statement to be present within the OpenQASM 2 program, but Qiskit’s legacy additions are all marked as builtins since they are not actually present in any include file this parser sees. + + A tuple containing the extra custom\_instructions that Qiskit’s legacy built-in converters used if `qelib1.inc` is included, and there is any definition of a `delay` instruction. The gates in the paper version of `qelib1.inc` and `delay` all require a compatible declaration statement to be present within the OpenQASM 2 program, but Qiskit’s legacy additions are all marked as builtins since they are not actually present in any include file this parser sees. + -**qiskit.qasm2.LEGACY\_CUSTOM\_CLASSICAL** +### qiskit.qasm2.LEGACY\_CUSTOM\_CLASSICAL -A tuple containing the extra custom\_classical functions that Qiskit’s legacy built-in converters use beyond those specified by the paper. This is the three basic inverse trigonometric functions: $\asin$, $\acos$ and $\atan$. + + A tuple containing the extra custom\_classical functions that Qiskit’s legacy built-in converters use beyond those specified by the paper. This is the three basic inverse trigonometric functions: $\asin$, $\acos$ and $\atan$. + -**qiskit.qasm2.LEGACY\_INCLUDE\_PATH** +### qiskit.qasm2.LEGACY\_INCLUDE\_PATH -A tuple containing the exact include\_path used by the legacy Qiskit converter. + + A tuple containing the exact include\_path used by the legacy Qiskit converter. + On *all* the gates defined in Qiskit’s legacy version of `qelib1.inc` and the `delay` instruction, it does not matter how the gates are actually defined and used, the legacy importer will always attempt to output its custom objects for them. This can result in errors during the circuit construction, even after a successful parse. There is no way to emulate this buggy behavior with [`qiskit.qasm2`](#module-qiskit.qasm2 "qiskit.qasm2"); only an `include "qelib1.inc";` statement or the custom\_instructions argument can cause built-in Qiskit instructions to be used, and the signatures of these match each other. diff --git a/docs/api/qiskit/dev/qasm3.mdx b/docs/api/qiskit/dev/qasm3.mdx index 4b88cfe530c..95711c453fe 100644 --- a/docs/api/qiskit/dev/qasm3.mdx +++ b/docs/api/qiskit/dev/qasm3.mdx @@ -399,7 +399,9 @@ These two functions allow for specifying include paths as an iterable of paths, In `custom_gates` is not given, Qiskit will attempt to use its standard-library gate objects for the gates defined in OpenQASM 3 standard library file `stdgates.inc`. This sequence of gates is available on this module, if you wish to build on top of it: -**qiskit.qasm3.STDGATES\_INC\_GATES** +#### qiskit.qasm3.STDGATES\_INC\_GATES -A tuple of [`CustomGate`](#qiskit.qasm3.CustomGate "qiskit.qasm3.CustomGate") objects specifying the Qiskit constructors to use for the `stdgates.inc` include file. + + A tuple of [`CustomGate`](#qiskit.qasm3.CustomGate "qiskit.qasm3.CustomGate") objects specifying the Qiskit constructors to use for the `stdgates.inc` include file. +