152 lines
4.3 KiB
Plaintext
152 lines
4.3 KiB
Plaintext
---
|
||
title: GRZ (v0.31)
|
||
description: API reference for qiskit.circuit.library.GRZ in qiskit v0.31
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.circuit.library.GRZ
|
||
---
|
||
|
||
# GRZ
|
||
|
||
<Class id="qiskit.circuit.library.GRZ" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.18/qiskit/circuit/library/generalized_gates/gr.py" signature="GRZ(num_qubits, phi)" modifiers="class">
|
||
Bases: `qiskit.circuit.quantumcircuit.QuantumCircuit`
|
||
|
||
Global RZ gate.
|
||
|
||
**Circuit symbol:**
|
||
|
||
```python
|
||
┌──────────┐
|
||
q_0: ┤0 ├
|
||
│ │
|
||
q_1: ┤1 GRZ(φ) ├
|
||
│ │
|
||
q_2: ┤2 ├
|
||
└──────────┘
|
||
```
|
||
|
||
The global RZ gate is native to atomic systems (ion traps, cold neutrals). The global RZ can be applied to multiple qubits simultaneously.
|
||
|
||
In the one-qubit case, this is equivalent to an RZ(phi) operation, and is thus reduced to the RZGate. The global RZ gate is a direct sum of RZ operations on all individual qubits.
|
||
|
||
$$
|
||
GRZ(\phi) = \exp(-i \sum_{i=1}^{n} Z_i \phi)
|
||
$$
|
||
|
||
**Expanded Circuit:**
|
||
|
||
Create a new Global RZ (GRZ) gate.
|
||
|
||
**Parameters**
|
||
|
||
* **num\_qubits** (`int`) – number of qubits.
|
||
* **phi** (`float`) – rotation angle about z-axis
|
||
|
||
## Attributes
|
||
|
||
### ancillas
|
||
|
||
<Attribute id="qiskit.circuit.library.GRZ.ancillas">
|
||
Returns a list of ancilla bits in the order that the registers were added.
|
||
</Attribute>
|
||
|
||
### calibrations
|
||
|
||
<Attribute id="qiskit.circuit.library.GRZ.calibrations">
|
||
Return calibration dictionary.
|
||
|
||
**The custom pulse definition of a given gate is of the form**
|
||
|
||
\{‘gate\_name’: \{(qubits, params): schedule}}
|
||
</Attribute>
|
||
|
||
### clbits
|
||
|
||
<Attribute id="qiskit.circuit.library.GRZ.clbits">
|
||
Returns a list of classical bits in the order that the registers were added.
|
||
</Attribute>
|
||
|
||
### data
|
||
|
||
<Attribute id="qiskit.circuit.library.GRZ.data">
|
||
Return the circuit data (instructions and context).
|
||
|
||
**Returns**
|
||
|
||
a list-like object containing the tuples for the circuit’s data.
|
||
|
||
Each tuple is in the format `(instruction, qargs, cargs)`, where instruction is an Instruction (or subclass) object, qargs is a list of Qubit objects, and cargs is a list of Clbit objects.
|
||
|
||
**Return type**
|
||
|
||
QuantumCircuitData
|
||
</Attribute>
|
||
|
||
### extension\_lib
|
||
|
||
<Attribute id="qiskit.circuit.library.GRZ.extension_lib" attributeValue="'include "qelib1.inc";'" />
|
||
|
||
### global\_phase
|
||
|
||
<Attribute id="qiskit.circuit.library.GRZ.global_phase">
|
||
Return the global phase of the circuit in radians.
|
||
</Attribute>
|
||
|
||
### header
|
||
|
||
<Attribute id="qiskit.circuit.library.GRZ.header" attributeValue="'OPENQASM 2.0;'" />
|
||
|
||
### instances
|
||
|
||
<Attribute id="qiskit.circuit.library.GRZ.instances" attributeValue="16" />
|
||
|
||
### metadata
|
||
|
||
<Attribute id="qiskit.circuit.library.GRZ.metadata">
|
||
The user provided metadata associated with the circuit
|
||
|
||
The metadata for the circuit is a user provided `dict` of metadata for the circuit. It will not be used to influence the execution or operation of the circuit, but it is expected to be passed between all transforms of the circuit (ie transpilation) and that providers will associate any circuit metadata with the results it returns from execution of that circuit.
|
||
</Attribute>
|
||
|
||
### num\_ancillas
|
||
|
||
<Attribute id="qiskit.circuit.library.GRZ.num_ancillas">
|
||
Return the number of ancilla qubits.
|
||
</Attribute>
|
||
|
||
### num\_clbits
|
||
|
||
<Attribute id="qiskit.circuit.library.GRZ.num_clbits">
|
||
Return number of classical bits.
|
||
</Attribute>
|
||
|
||
### num\_parameters
|
||
|
||
<Attribute id="qiskit.circuit.library.GRZ.num_parameters">
|
||
Convenience function to get the number of parameter objects in the circuit.
|
||
</Attribute>
|
||
|
||
### num\_qubits
|
||
|
||
<Attribute id="qiskit.circuit.library.GRZ.num_qubits">
|
||
Return number of qubits.
|
||
</Attribute>
|
||
|
||
### parameters
|
||
|
||
<Attribute id="qiskit.circuit.library.GRZ.parameters">
|
||
Convenience function to get the parameters defined in the parameter table.
|
||
</Attribute>
|
||
|
||
### prefix
|
||
|
||
<Attribute id="qiskit.circuit.library.GRZ.prefix" attributeValue="'circuit'" />
|
||
|
||
### qubits
|
||
|
||
<Attribute id="qiskit.circuit.library.GRZ.qubits">
|
||
Returns a list of quantum bits in the order that the registers were added.
|
||
</Attribute>
|
||
</Class>
|
||
|