165 lines
7.1 KiB
Plaintext
165 lines
7.1 KiB
Plaintext
---
|
||
title: OrGate (latest version)
|
||
description: API reference for qiskit.circuit.library.OrGate in the latest version of qiskit
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.circuit.library.OrGate
|
||
---
|
||
|
||
# OrGate
|
||
|
||
<Class id="qiskit.circuit.library.OrGate" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit/tree/stable/1.3/qiskit/circuit/library/boolean_logic/quantum_or.py#L110-L206" signature="qiskit.circuit.library.OrGate(num_variable_qubits, flags=None)" modifiers="class">
|
||
Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate")
|
||
|
||
A gate representing the logical OR operation on a number of qubits.
|
||
|
||
For the OR operation the state $|1\rangle$ is interpreted as `True`. The result qubit is flipped, if the state of any variable qubit is `True`. The OR is implemented using a multi-open-controlled X gate (i.e. flips if the state is $|0\rangle$) and applying an X gate on the result qubit. Using a list of flags, qubits can be skipped or negated.
|
||
|
||
The OrGate gate without special flags:
|
||
|
||
|
||
|
||
Using flags we can negate qubits or skip them. For instance, if we have 5 qubits and want to return `True` if the first qubit is `False` or one of the last two are `True` we use the flags `[-1, 0, 0, 1, 1]`.
|
||
|
||
|
||
|
||
**Parameters**
|
||
|
||
* **num\_variable\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – The qubits of which the AND is computed. The result will be written into an additional result qubit.
|
||
* **flags** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.13)")*\[*[*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")*] | None*) – A list of +1/0/-1 marking negations or omissions of qubits.
|
||
|
||
## Attributes
|
||
|
||
### base\_class
|
||
|
||
<Attribute id="qiskit.circuit.library.OrGate.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.OrGate.base_class "qiskit.circuit.library.OrGate.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.OrGate.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.OrGate.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.OrGate.decompositions">
|
||
Get the decompositions of the instruction from the SessionEquivalenceLibrary.
|
||
</Attribute>
|
||
|
||
### definition
|
||
|
||
<Attribute id="qiskit.circuit.library.OrGate.definition">
|
||
Return definition in terms of other basic gates.
|
||
</Attribute>
|
||
|
||
### duration
|
||
|
||
<Attribute id="qiskit.circuit.library.OrGate.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.OrGate.label">
|
||
Return instruction label
|
||
</Attribute>
|
||
|
||
### mutable
|
||
|
||
<Attribute id="qiskit.circuit.library.OrGate.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.OrGate.name">
|
||
Return the name.
|
||
</Attribute>
|
||
|
||
### num\_clbits
|
||
|
||
<Attribute id="qiskit.circuit.library.OrGate.num_clbits">
|
||
Return the number of clbits.
|
||
</Attribute>
|
||
|
||
### num\_qubits
|
||
|
||
<Attribute id="qiskit.circuit.library.OrGate.num_qubits">
|
||
Return the number of qubits.
|
||
</Attribute>
|
||
|
||
### params
|
||
|
||
<Attribute id="qiskit.circuit.library.OrGate.params">
|
||
The parameters of this `Instruction`. Ideally these will be gate angles.
|
||
</Attribute>
|
||
|
||
### unit
|
||
|
||
<Attribute id="qiskit.circuit.library.OrGate.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
|
||
|
||
### inverse
|
||
|
||
<Function id="qiskit.circuit.library.OrGate.inverse" github="https://github.com/Qiskit/qiskit/tree/stable/1.3/qiskit/circuit/library/boolean_logic/quantum_or.py#L187-L199" signature="inverse(annotated=False)">
|
||
Return inverted OR gate (itself).
|
||
|
||
**Parameters**
|
||
|
||
**annotated** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.13)")) – when set to `True`, this is typically used to return an [`AnnotatedOperation`](qiskit.circuit.AnnotatedOperation "qiskit.circuit.AnnotatedOperation") with an inverse modifier set instead of a concrete [`Gate`](qiskit.circuit.Gate "qiskit.circuit.Gate"). However, for this class this argument is ignored as this gate is self-inverse.
|
||
|
||
**Returns**
|
||
|
||
inverse gate (self-inverse).
|
||
|
||
**Return type**
|
||
|
||
[OrGate](#qiskit.circuit.library.OrGate "qiskit.circuit.library.OrGate")
|
||
</Function>
|
||
</Class>
|
||
|