503 lines
18 KiB
Plaintext
503 lines
18 KiB
Plaintext
---
|
||
title: ClassicalFunction
|
||
description: API reference for qiskit.circuit.classicalfunction.ClassicalFunction
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.circuit.classicalfunction.ClassicalFunction
|
||
---
|
||
|
||
# ClassicalFunction
|
||
|
||
<Class id="qiskit.circuit.classicalfunction.ClassicalFunction" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.45/qiskit/circuit/classicalfunction/classicalfunction.py" signature="qiskit.circuit.classicalfunction.ClassicalFunction(source, name=None)" modifiers="class">
|
||
Bases: `ClassicalElement`
|
||
|
||
Represent a classical function and its logic network.
|
||
|
||
Creates a `ClassicalFunction` from Python source code in `source`.
|
||
|
||
The code should be a single function with types.
|
||
|
||
**Parameters**
|
||
|
||
* **source** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – Python code with type hints.
|
||
* **name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – Optional. Default: “*classicalfunction*”. ClassicalFunction name.
|
||
|
||
**Raises**
|
||
|
||
[**QiskitError**](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") – If source is not a string.
|
||
|
||
## Attributes
|
||
|
||
### args
|
||
|
||
<Attribute id="qiskit.circuit.classicalfunction.ClassicalFunction.args">
|
||
Returns the classicalfunction arguments
|
||
</Attribute>
|
||
|
||
### base\_class
|
||
|
||
<Attribute id="qiskit.circuit.classicalfunction.ClassicalFunction.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 behavioural perspective. In particular, you should *not* override [`base_class`](#qiskit.circuit.classicalfunction.ClassicalFunction.base_class "qiskit.circuit.classicalfunction.ClassicalFunction.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 parametrised 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 parametrised 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.classicalfunction.ClassicalFunction.condition">
|
||
The classical condition on the instruction.
|
||
</Attribute>
|
||
|
||
### condition\_bits
|
||
|
||
<Attribute id="qiskit.circuit.classicalfunction.ClassicalFunction.condition_bits">
|
||
Get Clbits in condition.
|
||
</Attribute>
|
||
|
||
### decompositions
|
||
|
||
<Attribute id="qiskit.circuit.classicalfunction.ClassicalFunction.decompositions">
|
||
Get the decompositions of the instruction from the SessionEquivalenceLibrary.
|
||
</Attribute>
|
||
|
||
### definition
|
||
|
||
<Attribute id="qiskit.circuit.classicalfunction.ClassicalFunction.definition">
|
||
Return definition in terms of other basic gates.
|
||
</Attribute>
|
||
|
||
### duration
|
||
|
||
<Attribute id="qiskit.circuit.classicalfunction.ClassicalFunction.duration">
|
||
Get the duration.
|
||
</Attribute>
|
||
|
||
### label
|
||
|
||
<Attribute id="qiskit.circuit.classicalfunction.ClassicalFunction.label">
|
||
Return instruction label
|
||
</Attribute>
|
||
|
||
### mutable
|
||
|
||
<Attribute id="qiskit.circuit.classicalfunction.ClassicalFunction.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.classicalfunction.ClassicalFunction.name">
|
||
Return the name.
|
||
</Attribute>
|
||
|
||
### network
|
||
|
||
<Attribute id="qiskit.circuit.classicalfunction.ClassicalFunction.network">
|
||
Returns the logical network
|
||
</Attribute>
|
||
|
||
### num\_clbits
|
||
|
||
<Attribute id="qiskit.circuit.classicalfunction.ClassicalFunction.num_clbits">
|
||
Return the number of clbits.
|
||
</Attribute>
|
||
|
||
### num\_qubits
|
||
|
||
<Attribute id="qiskit.circuit.classicalfunction.ClassicalFunction.num_qubits">
|
||
Return the number of qubits.
|
||
</Attribute>
|
||
|
||
### params
|
||
|
||
<Attribute id="qiskit.circuit.classicalfunction.ClassicalFunction.params">
|
||
return instruction params.
|
||
</Attribute>
|
||
|
||
### qregs
|
||
|
||
<Attribute id="qiskit.circuit.classicalfunction.ClassicalFunction.qregs">
|
||
The list of qregs used by the classicalfunction
|
||
</Attribute>
|
||
|
||
### scopes
|
||
|
||
<Attribute id="qiskit.circuit.classicalfunction.ClassicalFunction.scopes">
|
||
Returns the scope dict
|
||
</Attribute>
|
||
|
||
### truth\_table
|
||
|
||
<Attribute id="qiskit.circuit.classicalfunction.ClassicalFunction.truth_table">
|
||
Returns (and computes) the truth table
|
||
</Attribute>
|
||
|
||
### types
|
||
|
||
<Attribute id="qiskit.circuit.classicalfunction.ClassicalFunction.types">
|
||
Dumps a list of scopes with their variables and types.
|
||
|
||
**Returns**
|
||
|
||
A list of scopes as dicts, where key is the variable name and value is its type.
|
||
|
||
**Return type**
|
||
|
||
[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")([dict](https://docs.python.org/3/library/stdtypes.html#dict "(in Python v3.12)"))
|
||
</Attribute>
|
||
|
||
### unit
|
||
|
||
<Attribute id="qiskit.circuit.classicalfunction.ClassicalFunction.unit">
|
||
Get the time unit of duration.
|
||
</Attribute>
|
||
|
||
## Methods
|
||
|
||
### add\_decomposition
|
||
|
||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.add_decomposition" signature="add_decomposition(decomposition)">
|
||
Add a decomposition of the instruction to the SessionEquivalenceLibrary.
|
||
</Function>
|
||
|
||
### assemble
|
||
|
||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.assemble" signature="assemble()">
|
||
Assemble a QasmQobjInstruction
|
||
</Function>
|
||
|
||
### broadcast\_arguments
|
||
|
||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.broadcast_arguments" signature="broadcast_arguments(qargs, cargs)">
|
||
Validation and handling of the arguments and its relationship.
|
||
|
||
For example, `cx([q[0],q[1]], q[2])` means `cx(q[0], q[2]); cx(q[1], q[2])`. This method yields the arguments in the right grouping. In the given example:
|
||
|
||
```python
|
||
in: [[q[0],q[1]], q[2]],[]
|
||
outs: [q[0], q[2]], []
|
||
[q[1], q[2]], []
|
||
```
|
||
|
||
The general broadcasting rules are:
|
||
|
||
> * If len(qargs) == 1:
|
||
>
|
||
> ```python
|
||
> [q[0], q[1]] -> [q[0]],[q[1]]
|
||
> ```
|
||
>
|
||
> * If len(qargs) == 2:
|
||
>
|
||
> ```python
|
||
> [[q[0], q[1]], [r[0], r[1]]] -> [q[0], r[0]], [q[1], r[1]]
|
||
> [[q[0]], [r[0], r[1]]] -> [q[0], r[0]], [q[0], r[1]]
|
||
> [[q[0], q[1]], [r[0]]] -> [q[0], r[0]], [q[1], r[0]]
|
||
> ```
|
||
>
|
||
> * If len(qargs) >= 3:
|
||
>
|
||
> ```python
|
||
> [q[0], q[1]], [r[0], r[1]], ...] -> [q[0], r[0], ...], [q[1], r[1], ...]
|
||
> ```
|
||
|
||
**Parameters**
|
||
|
||
* **qargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")) – List of quantum bit arguments.
|
||
* **cargs** ([*list*](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")) – List of classical bit arguments.
|
||
|
||
**Returns**
|
||
|
||
A tuple with single arguments.
|
||
|
||
**Raises**
|
||
|
||
[**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – If the input is not valid. For example, the number of arguments does not match the gate expectation.
|
||
|
||
**Return type**
|
||
|
||
[*Iterable*](https://docs.python.org/3/library/typing.html#typing.Iterable "(in Python v3.12)")\[[tuple](https://docs.python.org/3/library/stdtypes.html#tuple "(in Python v3.12)")\[[list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)"), [list](https://docs.python.org/3/library/stdtypes.html#list "(in Python v3.12)")]]
|
||
</Function>
|
||
|
||
### c\_if
|
||
|
||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.c_if" signature="c_if(classical, val)">
|
||
Set a classical equality condition on this instruction between the register or cbit `classical` and value `val`.
|
||
|
||
<Admonition title="Note" type="note">
|
||
This is a setter method, not an additive one. Calling this multiple times will silently override any previously set condition; it does not stack.
|
||
</Admonition>
|
||
</Function>
|
||
|
||
### compile
|
||
|
||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.compile" signature="compile()">
|
||
Parses and creates the logical circuit
|
||
</Function>
|
||
|
||
### control
|
||
|
||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.control" signature="control(num_ctrl_qubits=1, label=None, ctrl_state=None)">
|
||
Return controlled version of gate. See [`ControlledGate`](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate") for usage.
|
||
|
||
**Parameters**
|
||
|
||
* **num\_ctrl\_qubits** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – number of controls to add to gate (default: `1`)
|
||
* **label** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – optional gate label
|
||
* **ctrl\_state** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)") *|*[*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)") *| None*) – The control state in decimal or as a bitstring (e.g. `'111'`). If `None`, use `2**num_ctrl_qubits-1`.
|
||
|
||
**Returns**
|
||
|
||
Controlled version of gate. This default algorithm uses `num_ctrl_qubits-1` ancilla qubits so returns a gate of size `num_qubits + 2*num_ctrl_qubits - 1`.
|
||
|
||
**Return type**
|
||
|
||
[qiskit.circuit.ControlledGate](qiskit.circuit.ControlledGate "qiskit.circuit.ControlledGate")
|
||
|
||
**Raises**
|
||
|
||
[**QiskitError**](exceptions#qiskit.exceptions.QiskitError "qiskit.exceptions.QiskitError") – unrecognized mode or invalid ctrl\_state
|
||
</Function>
|
||
|
||
### copy
|
||
|
||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.copy" signature="copy(name=None)">
|
||
Copy of the instruction.
|
||
|
||
**Parameters**
|
||
|
||
**name** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – name to be given to the copied circuit, if `None` then the name stays the same.
|
||
|
||
**Returns**
|
||
|
||
a copy of the current instruction, with the name updated if it was provided
|
||
|
||
**Return type**
|
||
|
||
[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction")
|
||
</Function>
|
||
|
||
### inverse
|
||
|
||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.inverse" signature="inverse()">
|
||
Invert this instruction.
|
||
|
||
If the instruction is composite (i.e. has a definition), then its definition will be recursively inverted.
|
||
|
||
Special instructions inheriting from Instruction can implement their own inverse (e.g. T and Tdg, Barrier, etc.)
|
||
|
||
**Returns**
|
||
|
||
a fresh instruction for the inverse
|
||
|
||
**Return type**
|
||
|
||
[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction")
|
||
|
||
**Raises**
|
||
|
||
[**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – if the instruction is not composite and an inverse has not been implemented for it.
|
||
</Function>
|
||
|
||
### is\_parameterized
|
||
|
||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.is_parameterized" signature="is_parameterized()">
|
||
Return True .IFF. instruction is parameterized else False
|
||
</Function>
|
||
|
||
### power
|
||
|
||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.power" signature="power(exponent)">
|
||
Creates a unitary gate as gate^exponent.
|
||
|
||
**Parameters**
|
||
|
||
**exponent** ([*float*](https://docs.python.org/3/library/functions.html#float "(in Python v3.12)")) – Gate^exponent
|
||
|
||
**Returns**
|
||
|
||
To which to\_matrix is self.to\_matrix^exponent.
|
||
|
||
**Return type**
|
||
|
||
.library.UnitaryGate
|
||
|
||
**Raises**
|
||
|
||
[**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – If Gate is not unitary
|
||
</Function>
|
||
|
||
### qasm
|
||
|
||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.qasm" signature="qasm()">
|
||
Return a default OpenQASM string for the instruction.
|
||
|
||
Derived instructions may override this to print in a different format (e.g. `measure q[0] -> c[0];`).
|
||
|
||
<Admonition title="Deprecated since version 0.25.0" type="danger">
|
||
The method `qiskit.circuit.instruction.Instruction.qasm()` is deprecated as of qiskit-terra 0.25.0. It will be removed no earlier than 3 months after the release date. Correct exporting to OpenQASM 2 is the responsibility of a larger exporter; it cannot safely be done on an object-by-object basis without context. No replacement will be provided, because the premise is wrong.
|
||
</Admonition>
|
||
</Function>
|
||
|
||
### repeat
|
||
|
||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.repeat" signature="repeat(n)">
|
||
Creates an instruction with gate repeated n amount of times.
|
||
|
||
**Parameters**
|
||
|
||
**n** ([*int*](https://docs.python.org/3/library/functions.html#int "(in Python v3.12)")) – Number of times to repeat the instruction
|
||
|
||
**Returns**
|
||
|
||
Containing the definition.
|
||
|
||
**Return type**
|
||
|
||
[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction")
|
||
|
||
**Raises**
|
||
|
||
[**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – If n \< 1.
|
||
</Function>
|
||
|
||
### reverse\_ops
|
||
|
||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.reverse_ops" signature="reverse_ops()">
|
||
For a composite instruction, reverse the order of sub-instructions.
|
||
|
||
This is done by recursively reversing all sub-instructions. It does not invert any gate.
|
||
|
||
**Returns**
|
||
|
||
**a new instruction with**
|
||
|
||
sub-instructions reversed.
|
||
|
||
**Return type**
|
||
|
||
[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction")
|
||
</Function>
|
||
|
||
### simulate
|
||
|
||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.simulate" signature="simulate(bitstring)">
|
||
Evaluate the expression on a bitstring.
|
||
|
||
This evaluation is done classically.
|
||
|
||
**Parameters**
|
||
|
||
**bitstring** ([*str*](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")) – The bitstring for which to evaluate.
|
||
|
||
**Returns**
|
||
|
||
result of the evaluation.
|
||
|
||
**Return type**
|
||
|
||
[bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")
|
||
</Function>
|
||
|
||
### simulate\_all
|
||
|
||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.simulate_all" signature="simulate_all()">
|
||
Returns a truth table.
|
||
|
||
**Returns**
|
||
|
||
a bitstring with a truth table
|
||
|
||
**Return type**
|
||
|
||
[str](https://docs.python.org/3/library/stdtypes.html#str "(in Python v3.12)")
|
||
</Function>
|
||
|
||
### soft\_compare
|
||
|
||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.soft_compare" signature="soft_compare(other)">
|
||
Soft comparison between gates. Their names, number of qubits, and classical bit numbers must match. The number of parameters must match. Each parameter is compared. If one is a ParameterExpression then it is not taken into account.
|
||
|
||
**Parameters**
|
||
|
||
**other** (*instruction*) – other instruction.
|
||
|
||
**Returns**
|
||
|
||
are self and other equal up to parameter expressions.
|
||
|
||
**Return type**
|
||
|
||
[bool](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")
|
||
</Function>
|
||
|
||
### synth
|
||
|
||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.synth" signature="synth(registerless=True, synthesizer=None)">
|
||
Synthesis the logic network into a [`QuantumCircuit`](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit").
|
||
|
||
**Parameters**
|
||
|
||
* **registerless** ([*bool*](https://docs.python.org/3/library/functions.html#bool "(in Python v3.12)")) – Default `True`. If `False` uses the parameter names to create
|
||
* **Otherwise** (*registers with those names.*) –
|
||
* **register.** (*creates a circuit with a flat quantum*) –
|
||
* **synthesizer** ([*Callable*](https://docs.python.org/3/library/typing.html#typing.Callable "(in Python v3.12)")*\[\[ClassicalElement],* [*QuantumCircuit*](qiskit.circuit.QuantumCircuit "qiskit.circuit.quantumcircuit.QuantumCircuit")*] | None*) – Optional. If None tweedledum’s pkrm\_synth is used.
|
||
|
||
**Returns**
|
||
|
||
A circuit implementing the logic network.
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
</Function>
|
||
|
||
### to\_matrix
|
||
|
||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.to_matrix" signature="to_matrix()">
|
||
Return a Numpy.array for the gate unitary matrix.
|
||
|
||
**Returns**
|
||
|
||
if the Gate subclass has a matrix definition.
|
||
|
||
**Return type**
|
||
|
||
np.ndarray
|
||
|
||
**Raises**
|
||
|
||
[**CircuitError**](circuit#qiskit.circuit.CircuitError "qiskit.circuit.CircuitError") – If a Gate subclass does not implement this method an exception will be raised when this base class method is called.
|
||
</Function>
|
||
|
||
### to\_mutable
|
||
|
||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.to_mutable" signature="to_mutable()">
|
||
Return a mutable copy of this gate.
|
||
|
||
This method will return a new mutable copy of this gate instance. If a singleton instance is being used this will be a new unique instance that can be mutated. If the instance is already mutable it will be a deepcopy of that instance.
|
||
</Function>
|
||
|
||
### validate\_parameter
|
||
|
||
<Function id="qiskit.circuit.classicalfunction.ClassicalFunction.validate_parameter" signature="validate_parameter(parameter)">
|
||
Gate parameters should be int, float, or ParameterExpression
|
||
</Function>
|
||
</Class>
|
||
|