308 lines
14 KiB
Plaintext
308 lines
14 KiB
Plaintext
---
|
||
title: Initialize
|
||
description: API reference for qiskit.extensions.Initialize
|
||
in_page_toc_min_heading_level: 1
|
||
python_api_type: class
|
||
python_api_name: qiskit.extensions.Initialize
|
||
---
|
||
|
||
# qiskit.extensions.Initialize
|
||
|
||
<Class id="qiskit.extensions.Initialize" isDedicatedPage={true} github="https://github.com/qiskit/qiskit/tree/stable/0.17/qiskit/extensions/quantum_initializer/initializer.py" signature="Initialize(params, num_qubits=None)" modifiers="class">
|
||
Complex amplitude initialization.
|
||
|
||
Class that implements the (complex amplitude) initialization of some flexible collection of qubit registers. Note that Initialize is an Instruction and not a Gate since it contains a reset instruction, which is not unitary.
|
||
|
||
Create new initialize composite.
|
||
|
||
**params (str, list, int or Statevector):**
|
||
|
||
* Statevector: Statevector to initialize to.
|
||
|
||
* list: vector of complex amplitudes to initialize to.
|
||
|
||
* **string: labels of basis states of the Pauli eigenstates Z, X, Y. See**
|
||
|
||
`from_label()`. Notice the order of the labels is reversed with respect to the qubit index to be applied to. Example label ‘01’ initializes the qubit zero to |1> and the qubit one to |0>.
|
||
|
||
* **int: an integer that is used as a bitmap indicating which qubits to initialize**
|
||
|
||
to |1>. Example: setting params to 5 would initialize qubit 0 and qubit 2 to |1> and qubit 1 to |0>.
|
||
|
||
**num\_qubits (int): This parameter is only used if params is an int. Indicates the total**
|
||
|
||
number of qubits in the initialize call. Example: initialize covers 5 qubits and params is 3. This allows qubits 0 and 1 to be initialized to |1> and the remaining 3 qubits to be initialized to |0>.
|
||
|
||
### \_\_init\_\_
|
||
|
||
<Function id="qiskit.extensions.Initialize.__init__" signature="__init__(params, num_qubits=None)">
|
||
Create new initialize composite.
|
||
|
||
**params (str, list, int or Statevector):**
|
||
|
||
* Statevector: Statevector to initialize to.
|
||
|
||
* list: vector of complex amplitudes to initialize to.
|
||
|
||
* **string: labels of basis states of the Pauli eigenstates Z, X, Y. See**
|
||
|
||
`from_label()`. Notice the order of the labels is reversed with respect to the qubit index to be applied to. Example label ‘01’ initializes the qubit zero to |1> and the qubit one to |0>.
|
||
|
||
* **int: an integer that is used as a bitmap indicating which qubits to initialize**
|
||
|
||
to |1>. Example: setting params to 5 would initialize qubit 0 and qubit 2 to |1> and qubit 1 to |0>.
|
||
|
||
**num\_qubits (int): This parameter is only used if params is an int. Indicates the total**
|
||
|
||
number of qubits in the initialize call. Example: initialize covers 5 qubits and params is 3. This allows qubits 0 and 1 to be initialized to |1> and the remaining 3 qubits to be initialized to |0>.
|
||
</Function>
|
||
|
||
## Methods
|
||
|
||
| | |
|
||
| ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
|
||
| [`__init__`](#qiskit.extensions.Initialize.__init__ "qiskit.extensions.Initialize.__init__")(params\[, num\_qubits]) | Create new initialize composite. |
|
||
| [`add_decomposition`](#qiskit.extensions.Initialize.add_decomposition "qiskit.extensions.Initialize.add_decomposition")(decomposition) | Add a decomposition of the instruction to the SessionEquivalenceLibrary. |
|
||
| [`assemble`](#qiskit.extensions.Initialize.assemble "qiskit.extensions.Initialize.assemble")() | Assemble a QasmQobjInstruction |
|
||
| [`broadcast_arguments`](#qiskit.extensions.Initialize.broadcast_arguments "qiskit.extensions.Initialize.broadcast_arguments")(qargs, cargs) | Validation of the arguments. |
|
||
| [`c_if`](#qiskit.extensions.Initialize.c_if "qiskit.extensions.Initialize.c_if")(classical, val) | Add classical condition on register classical and value val. |
|
||
| [`copy`](#qiskit.extensions.Initialize.copy "qiskit.extensions.Initialize.copy")(\[name]) | Copy of the instruction. |
|
||
| [`gates_to_uncompute`](#qiskit.extensions.Initialize.gates_to_uncompute "qiskit.extensions.Initialize.gates_to_uncompute")() | Call to create a circuit with gates that take the desired vector to zero. |
|
||
| [`inverse`](#qiskit.extensions.Initialize.inverse "qiskit.extensions.Initialize.inverse")() | Invert this instruction. |
|
||
| [`is_parameterized`](#qiskit.extensions.Initialize.is_parameterized "qiskit.extensions.Initialize.is_parameterized")() | Return True .IFF. |
|
||
| [`mirror`](#qiskit.extensions.Initialize.mirror "qiskit.extensions.Initialize.mirror")() | DEPRECATED: use instruction.reverse\_ops(). |
|
||
| [`qasm`](#qiskit.extensions.Initialize.qasm "qiskit.extensions.Initialize.qasm")() | Return a default OpenQASM string for the instruction. |
|
||
| [`repeat`](#qiskit.extensions.Initialize.repeat "qiskit.extensions.Initialize.repeat")(n) | Creates an instruction with gate repeated n amount of times. |
|
||
| [`reverse_ops`](#qiskit.extensions.Initialize.reverse_ops "qiskit.extensions.Initialize.reverse_ops")() | For a composite instruction, reverse the order of sub-instructions. |
|
||
| [`soft_compare`](#qiskit.extensions.Initialize.soft_compare "qiskit.extensions.Initialize.soft_compare")(other) | Soft comparison between gates. |
|
||
| [`validate_parameter`](#qiskit.extensions.Initialize.validate_parameter "qiskit.extensions.Initialize.validate_parameter")(parameter) | Initialize instruction parameter can be str, int, float, and complex. |
|
||
|
||
## Attributes
|
||
|
||
| | |
|
||
| -------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||
| [`decompositions`](#qiskit.extensions.Initialize.decompositions "qiskit.extensions.Initialize.decompositions") | Get the decompositions of the instruction from the SessionEquivalenceLibrary. |
|
||
| [`definition`](#qiskit.extensions.Initialize.definition "qiskit.extensions.Initialize.definition") | Return definition in terms of other basic gates. |
|
||
| [`duration`](#qiskit.extensions.Initialize.duration "qiskit.extensions.Initialize.duration") | Get the duration. |
|
||
| [`params`](#qiskit.extensions.Initialize.params "qiskit.extensions.Initialize.params") | return instruction params. |
|
||
| [`unit`](#qiskit.extensions.Initialize.unit "qiskit.extensions.Initialize.unit") | Get the time unit of duration. |
|
||
|
||
### add\_decomposition
|
||
|
||
<Function id="qiskit.extensions.Initialize.add_decomposition" signature="add_decomposition(decomposition)">
|
||
Add a decomposition of the instruction to the SessionEquivalenceLibrary.
|
||
</Function>
|
||
|
||
### assemble
|
||
|
||
<Function id="qiskit.extensions.Initialize.assemble" signature="assemble()">
|
||
Assemble a QasmQobjInstruction
|
||
</Function>
|
||
|
||
### broadcast\_arguments
|
||
|
||
<Function id="qiskit.extensions.Initialize.broadcast_arguments" signature="broadcast_arguments(qargs, cargs)">
|
||
Validation of the arguments.
|
||
|
||
**Parameters**
|
||
|
||
* **qargs** (*List*) – List of quantum bit arguments.
|
||
* **cargs** (*List*) – List of classical bit arguments.
|
||
|
||
**Yields**
|
||
|
||
*Tuple(List, List)* – A tuple with single arguments.
|
||
|
||
**Raises**
|
||
|
||
**CircuitError** – If the input is not valid. For example, the number of arguments does not match the gate expectation.
|
||
</Function>
|
||
|
||
### c\_if
|
||
|
||
<Function id="qiskit.extensions.Initialize.c_if" signature="c_if(classical, val)">
|
||
Add classical condition on register classical and value val.
|
||
</Function>
|
||
|
||
### copy
|
||
|
||
<Function id="qiskit.extensions.Initialize.copy" signature="copy(name=None)">
|
||
Copy of the instruction.
|
||
|
||
**Parameters**
|
||
|
||
**name** (*str*) – 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>
|
||
|
||
### decompositions
|
||
|
||
<Attribute id="qiskit.extensions.Initialize.decompositions">
|
||
Get the decompositions of the instruction from the SessionEquivalenceLibrary.
|
||
</Attribute>
|
||
|
||
### definition
|
||
|
||
<Attribute id="qiskit.extensions.Initialize.definition">
|
||
Return definition in terms of other basic gates.
|
||
</Attribute>
|
||
|
||
### duration
|
||
|
||
<Attribute id="qiskit.extensions.Initialize.duration">
|
||
Get the duration.
|
||
</Attribute>
|
||
|
||
### gates\_to\_uncompute
|
||
|
||
<Function id="qiskit.extensions.Initialize.gates_to_uncompute" signature="gates_to_uncompute()">
|
||
Call to create a circuit with gates that take the desired vector to zero.
|
||
|
||
**Returns**
|
||
|
||
circuit to take self.params vector to $|{00\ldots0}\rangle$
|
||
|
||
**Return type**
|
||
|
||
[QuantumCircuit](qiskit.circuit.QuantumCircuit "qiskit.circuit.QuantumCircuit")
|
||
</Function>
|
||
|
||
### inverse
|
||
|
||
<Function id="qiskit.extensions.Initialize.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** – if the instruction is not composite and an inverse has not been implemented for it.
|
||
</Function>
|
||
|
||
### is\_parameterized
|
||
|
||
<Function id="qiskit.extensions.Initialize.is_parameterized" signature="is_parameterized()">
|
||
Return True .IFF. instruction is parameterized else False
|
||
</Function>
|
||
|
||
### mirror
|
||
|
||
<Function id="qiskit.extensions.Initialize.mirror" signature="mirror()">
|
||
DEPRECATED: use instruction.reverse\_ops().
|
||
|
||
**Returns**
|
||
|
||
**a new instruction with sub-instructions**
|
||
|
||
reversed.
|
||
|
||
**Return type**
|
||
|
||
[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction")
|
||
</Function>
|
||
|
||
### params
|
||
|
||
<Attribute id="qiskit.extensions.Initialize.params">
|
||
return instruction params.
|
||
</Attribute>
|
||
|
||
### qasm
|
||
|
||
<Function id="qiskit.extensions.Initialize.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];).
|
||
</Function>
|
||
|
||
### repeat
|
||
|
||
<Function id="qiskit.extensions.Initialize.repeat" signature="repeat(n)">
|
||
Creates an instruction with gate repeated n amount of times.
|
||
|
||
**Parameters**
|
||
|
||
**n** (*int*) – Number of times to repeat the instruction
|
||
|
||
**Returns**
|
||
|
||
Containing the definition.
|
||
|
||
**Return type**
|
||
|
||
[qiskit.circuit.Instruction](qiskit.circuit.Instruction "qiskit.circuit.Instruction")
|
||
|
||
**Raises**
|
||
|
||
**CircuitError** – If n \< 1.
|
||
</Function>
|
||
|
||
### reverse\_ops
|
||
|
||
<Function id="qiskit.extensions.Initialize.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>
|
||
|
||
### soft\_compare
|
||
|
||
<Function id="qiskit.extensions.Initialize.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
|
||
</Function>
|
||
|
||
### unit
|
||
|
||
<Attribute id="qiskit.extensions.Initialize.unit">
|
||
Get the time unit of duration.
|
||
</Attribute>
|
||
|
||
### validate\_parameter
|
||
|
||
<Function id="qiskit.extensions.Initialize.validate_parameter" signature="validate_parameter(parameter)">
|
||
Initialize instruction parameter can be str, int, float, and complex.
|
||
</Function>
|
||
</Class>
|
||
|