165 lines
6.3 KiB
Plaintext
165 lines
6.3 KiB
Plaintext
---
|
||
title: InnerProductGate (latest version)
|
||
description: API reference for qiskit.circuit.library.InnerProductGate in the latest version of qiskit
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.circuit.library.InnerProductGate
|
||
---
|
||
|
||
# InnerProductGate
|
||
|
||
<Class id="qiskit.circuit.library.InnerProductGate" isDedicatedPage={true} github="https://github.com/Qiskit/qiskit/tree/stable/1.3/qiskit/circuit/library/boolean_logic/inner_product.py#L88-L157" signature="qiskit.circuit.library.InnerProductGate(num_qubits)" modifiers="class">
|
||
Bases: [`Gate`](qiskit.circuit.Gate "qiskit.circuit.gate.Gate")
|
||
|
||
A 2n-qubit Boolean function that computes the inner product of two n-qubit vectors over $F_2$.
|
||
|
||
This implementation is a phase oracle which computes the following transform.
|
||
|
||
$$
|
||
\mathcal{IP}_{2n} : F_2^{2n} \rightarrow {-1, 1}
|
||
\mathcal{IP}_{2n}(x_1, \cdots, x_n, y_1, \cdots, y_n) = (-1)^{x.y}
|
||
$$
|
||
|
||
The corresponding unitary is a diagonal, which induces a -1 phase on any inputs where the inner product of the top and bottom registers is 1. Otherwise, it keeps the input intact.
|
||
|
||
```python
|
||
q0_0: ─■──────────
|
||
│
|
||
q0_1: ─┼──■───────
|
||
│ │
|
||
q0_2: ─┼──┼──■────
|
||
│ │ │
|
||
q0_3: ─┼──┼──┼──■─
|
||
│ │ │ │
|
||
q1_0: ─■──┼──┼──┼─
|
||
│ │ │
|
||
q1_1: ────■──┼──┼─
|
||
│ │
|
||
q1_2: ───────■──┼─
|
||
│
|
||
q1_3: ──────────■─
|
||
```
|
||
|
||
**Reference Circuit:**
|
||
|
||
|
||
|
||
**Parameters**
|
||
|
||
**num\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.13)")) – width of top and bottom registers (half total number of qubits).
|
||
|
||
## Attributes
|
||
|
||
### base\_class
|
||
|
||
<Attribute id="qiskit.circuit.library.InnerProductGate.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.InnerProductGate.base_class "qiskit.circuit.library.InnerProductGate.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.InnerProductGate.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.InnerProductGate.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.InnerProductGate.decompositions">
|
||
Get the decompositions of the instruction from the SessionEquivalenceLibrary.
|
||
</Attribute>
|
||
|
||
### definition
|
||
|
||
<Attribute id="qiskit.circuit.library.InnerProductGate.definition">
|
||
Return definition in terms of other basic gates.
|
||
</Attribute>
|
||
|
||
### duration
|
||
|
||
<Attribute id="qiskit.circuit.library.InnerProductGate.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.InnerProductGate.label">
|
||
Return instruction label
|
||
</Attribute>
|
||
|
||
### mutable
|
||
|
||
<Attribute id="qiskit.circuit.library.InnerProductGate.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.InnerProductGate.name">
|
||
Return the name.
|
||
</Attribute>
|
||
|
||
### num\_clbits
|
||
|
||
<Attribute id="qiskit.circuit.library.InnerProductGate.num_clbits">
|
||
Return the number of clbits.
|
||
</Attribute>
|
||
|
||
### num\_qubits
|
||
|
||
<Attribute id="qiskit.circuit.library.InnerProductGate.num_qubits">
|
||
Return the number of qubits.
|
||
</Attribute>
|
||
|
||
### params
|
||
|
||
<Attribute id="qiskit.circuit.library.InnerProductGate.params">
|
||
The parameters of this `Instruction`. Ideally these will be gate angles.
|
||
</Attribute>
|
||
|
||
### unit
|
||
|
||
<Attribute id="qiskit.circuit.library.InnerProductGate.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>
|
||
</Class>
|
||
|