-
Notifications
You must be signed in to change notification settings - Fork 81
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
An action recently synced the latest dev docs. This PR updates all dev APIs that changed. > [!NOTE] > This pull request was created by a GitHub action. Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
- Loading branch information
1 parent
9d98cb0
commit 551868e
Showing
108 changed files
with
921 additions
and
144 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
188 changes: 188 additions & 0 deletions
188
docs/api/qiskit/dev/qiskit.circuit.library.GraphStateGate.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,188 @@ | ||
| --- | ||
| title: GraphStateGate | ||
| description: API reference for qiskit.circuit.library.GraphStateGate | ||
| in_page_toc_min_heading_level: 1 | ||
| python_api_type: class | ||
| python_api_name: qiskit.circuit.library.GraphStateGate | ||
| --- | ||
|
|
||
| # GraphStateGate | ||
|
|
||
| <Class id="qiskit.circuit.library.GraphStateGate" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit/tree/main/qiskit/circuit/library/graph_state.py#L87-L169" signature="qiskit.circuit.library.GraphStateGate(adjacency_matrix)" modifiers="class"> | ||
| Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate") | ||
|
|
||
| A gate representing a graph state. | ||
|
|
||
| Given a graph G = (V, E), with the set of vertices V and the set of edges E, the corresponding graph state is defined as | ||
|
|
||
| $$ | ||
| |G\rangle = \prod_{(a,b) \in E} CZ_{(a,b)} {|+\rangle}^{\otimes V} | ||
| $$ | ||
|
|
||
| Such a state can be prepared by first preparing all qubits in the $+$ state, then applying a $CZ$ gate for each corresponding graph edge. | ||
|
|
||
| Graph state preparation circuits are Clifford circuits, and thus easy to simulate classically. However, by adding a layer of measurements in a product basis at the end, there is evidence that the circuit becomes hard to simulate \[2]. | ||
|
|
||
| **Reference Circuit:** | ||
|
|
||
| ```python | ||
| from qiskit.circuit import QuantumCircuit | ||
| from qiskit.circuit.library import GraphStateGate | ||
| import rustworkx as rx | ||
|
|
||
| G = rx.generators.cycle_graph(5) | ||
| circuit = QuantumCircuit(5) | ||
| circuit.append(GraphStateGate(rx.adjacency_matrix(G)), [0, 1, 2, 3, 4]) | ||
| circuit.decompose().draw('mpl') | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
| **References:** | ||
|
|
||
| **\[1] M. Hein, J. Eisert, H.J. Briegel, Multi-party Entanglement in Graph States,** | ||
|
|
||
| [arXiv:0307130](https://arxiv.org/pdf/quant-ph/0307130.pdf) | ||
|
|
||
| **\[2] D. Koh, Further Extensions of Clifford Circuits & their Classical Simulation Complexities.** | ||
|
|
||
| [arXiv:1512.07892](https://arxiv.org/pdf/1512.07892.pdf) | ||
|
|
||
| **Parameters** | ||
|
|
||
| **adjacency\_matrix** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)") *| np.ndarray*) – input graph as n-by-n list of 0-1 lists | ||
|
|
||
| **Raises** | ||
|
|
||
| [**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – If adjacency\_matrix is not symmetric. | ||
|
|
||
| The gate represents a graph state with the given adjacency matrix. | ||
|
|
||
| ## Attributes | ||
|
|
||
| ### adjacency\_matrix | ||
|
|
||
| <Attribute id="qiskit.circuit.library.GraphStateGate.adjacency_matrix"> | ||
| Returns the adjacency matrix. | ||
| </Attribute> | ||
|
|
||
| ### base\_class | ||
|
|
||
| <Attribute id="qiskit.circuit.library.GraphStateGate.base_class"> | ||
| Get the base class of this instruction. This is guaranteed to be in the inheritance tree of `self`. | ||
|
|
||
| The “base class” of an instruction is the lowest class in its inheritance tree that the object should be considered entirely compatible with for \_all\_ circuit applications. This typically means that the subclass is defined purely to offer some sort of programmer convenience over the base class, and the base class is the “true” class for a behavioral perspective. In particular, you should *not* override [`base_class`](#qiskit.circuit.library.GraphStateGate.base_class "qiskit.circuit.library.GraphStateGate.base_class") if you are defining a custom version of an instruction that will be implemented differently by hardware, such as an alternative measurement strategy, or a version of a parametrized gate with a particular set of parameters for the purposes of distinguishing it in a [`Target`](qiskit.transpiler.Target "qiskit.transpiler.Target") from the full parametrized gate. | ||
|
|
||
| This is often exactly equivalent to `type(obj)`, except in the case of singleton instances of standard-library instructions. These singleton instances are special subclasses of their base class, and this property will return that base. For example: | ||
|
|
||
| ```python | ||
| >>> isinstance(XGate(), XGate) | ||
| True | ||
| >>> type(XGate()) is XGate | ||
| False | ||
| >>> XGate().base_class is XGate | ||
| True | ||
| ``` | ||
|
|
||
| In general, you should not rely on the precise class of an instruction; within a given circuit, it is expected that `Instruction.name` should be a more suitable discriminator in most situations. | ||
| </Attribute> | ||
|
|
||
| ### condition | ||
|
|
||
| <Attribute id="qiskit.circuit.library.GraphStateGate.condition"> | ||
| The classical condition on the instruction. | ||
|
|
||
| <Admonition title="Deprecated since version 1.3.0" type="danger"> | ||
| The property `qiskit.circuit.instruction.Instruction.condition` is deprecated as of qiskit 1.3.0. It will be removed in 2.0.0. | ||
| </Admonition> | ||
| </Attribute> | ||
|
|
||
| ### condition\_bits | ||
|
|
||
| <Attribute id="qiskit.circuit.library.GraphStateGate.condition_bits"> | ||
| Get Clbits in condition. | ||
|
|
||
| <Admonition title="Deprecated since version 1.3.0" type="danger"> | ||
| The property `qiskit.circuit.instruction.Instruction.condition_bits` is deprecated as of qiskit 1.3.0. It will be removed in 2.0.0. | ||
| </Admonition> | ||
| </Attribute> | ||
|
|
||
| ### decompositions | ||
|
|
||
| <Attribute id="qiskit.circuit.library.GraphStateGate.decompositions"> | ||
| Get the decompositions of the instruction from the SessionEquivalenceLibrary. | ||
| </Attribute> | ||
|
|
||
| ### definition | ||
|
|
||
| <Attribute id="qiskit.circuit.library.GraphStateGate.definition"> | ||
| Return definition in terms of other basic gates. | ||
| </Attribute> | ||
|
|
||
| ### duration | ||
|
|
||
| <Attribute id="qiskit.circuit.library.GraphStateGate.duration"> | ||
| Get the duration. | ||
|
|
||
| <Admonition title="Deprecated since version 1.3.0" type="danger"> | ||
| The property `qiskit.circuit.instruction.Instruction.duration` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. | ||
| </Admonition> | ||
| </Attribute> | ||
|
|
||
| ### label | ||
|
|
||
| <Attribute id="qiskit.circuit.library.GraphStateGate.label"> | ||
| Return instruction label | ||
| </Attribute> | ||
|
|
||
| ### mutable | ||
|
|
||
| <Attribute id="qiskit.circuit.library.GraphStateGate.mutable"> | ||
| Is this instance is a mutable unique instance or not. | ||
|
|
||
| If this attribute is `False` the gate instance is a shared singleton and is not mutable. | ||
| </Attribute> | ||
|
|
||
| ### name | ||
|
|
||
| <Attribute id="qiskit.circuit.library.GraphStateGate.name"> | ||
| Return the name. | ||
| </Attribute> | ||
|
|
||
| ### num\_clbits | ||
|
|
||
| <Attribute id="qiskit.circuit.library.GraphStateGate.num_clbits"> | ||
| Return the number of clbits. | ||
| </Attribute> | ||
|
|
||
| ### num\_qubits | ||
|
|
||
| <Attribute id="qiskit.circuit.library.GraphStateGate.num_qubits"> | ||
| Return the number of qubits. | ||
| </Attribute> | ||
|
|
||
| ### params | ||
|
|
||
| <Attribute id="qiskit.circuit.library.GraphStateGate.params"> | ||
| The parameters of this `Instruction`. Ideally these will be gate angles. | ||
| </Attribute> | ||
|
|
||
| ### unit | ||
|
|
||
| <Attribute id="qiskit.circuit.library.GraphStateGate.unit"> | ||
| Get the time unit of duration. | ||
|
|
||
| <Admonition title="Deprecated since version 1.3.0" type="danger"> | ||
| The property `qiskit.circuit.instruction.Instruction.unit` is deprecated as of qiskit 1.3.0. It will be removed in Qiskit 2.0.0. | ||
| </Admonition> | ||
| </Attribute> | ||
|
|
||
| ## Methods | ||
|
|
||
| ### validate\_parameter | ||
|
|
||
| <Function id="qiskit.circuit.library.GraphStateGate.validate_parameter" github="https://github.com/Qiskit/qiskit/tree/main/qiskit/circuit/library/graph_state.py#L155-L157" signature="validate_parameter(parameter)"> | ||
| Parameter validation | ||
| </Function> | ||
| </Class> | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.