UnitaryGate
UnitaryGate(data, label=None)
Class for representing unitary gates
Create a gate from a numeric unitary matrix.
Parameters
- data (matrix or Operator) – unitary operator.
- label (str) – unitary name for backend [Default: None].
Raises
ExtensionError – if input data is not an N-qubit unitary operator.
Attributes
decompositions
Get the decompositions of the instruction from the SessionEquivalenceLibrary.
definition
Return definition in terms of other basic gates.
label
str
Return gate label
Return type
str
params
return instruction params.
Methods
add_decomposition
UnitaryGate.add_decomposition(decomposition)
Add a decomposition of the instruction to the SessionEquivalenceLibrary.
adjoint
UnitaryGate.adjoint()
Return the adjoint of the unitary.
assemble
UnitaryGate.assemble()
broadcast_arguments
UnitaryGate.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:
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:
[q[0], q[1]] -> [q[0]],[q[1]]
If len(qargs) == 2:
[[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:
[q[0], q[1]], [r[0], r[1]], ...] -> [q[0], r[0], ...], [q[1], r[1], ...]
Parameters
- qargs (
List
) – List of quantum bit arguments. - cargs (
List
) – List of classical bit arguments.
Return type
Tuple
[List
, List
]
Returns
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.
c_if
UnitaryGate.c_if(classical, val)
Add classical condition on register classical and value val.
conjugate
UnitaryGate.conjugate()
Return the conjugate of the unitary.
control
UnitaryGate.control(num_ctrl_qubits=1, label=None, ctrl_state=None)
Return controlled version of gate
Parameters
- num_ctrl_qubits (int) – number of controls to add to gate (default=1)
- label (str) – optional gate label
- ctrl_state (int or str or None) – The control state in decimal or as a bit string (e.g. ‘1011’). If None, use 2**num_ctrl_qubits-1.
Returns
controlled version of gate.
Return type
Raises
QiskitError – invalid ctrl_state
copy
UnitaryGate.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
inverse
UnitaryGate.inverse()
Return the adjoint of the unitary.
is_parameterized
UnitaryGate.is_parameterized()
Return True .IFF. instruction is parameterized else False
mirror
UnitaryGate.mirror()
For a composite instruction, reverse the order of sub-gates.
This is done by recursively mirroring all sub-instructions. It does not invert any gate.
Returns
a fresh gate with sub-gates reversed
Return type
power
UnitaryGate.power(exponent)
Creates a unitary gate as gate^exponent.
Parameters
exponent (float) – Gate^exponent
Returns
To which to_matrix is self.to_matrix^exponent.
Return type
Raises
CircuitError – If Gate is not unitary
qasm
UnitaryGate.qasm()
The qasm for a custom unitary gate This is achieved by adding a custom gate that corresponds to the definition of this gate. It gives the gate a random name if one hasn’t been given to it.
repeat
UnitaryGate.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
Raises
CircuitError – If n < 1.
to_matrix
UnitaryGate.to_matrix()
Return matrix for the unitary.
transpose
UnitaryGate.transpose()
Return the transpose of the unitary.