Circuit.get_unitary

Circuit.get_unitary(params=[])[source]

Return the unitary matrix of the circuit.

Parameters:: params (RealVector) – Optionally specify parameters overriding the ones stored in the circuit. (Default: use parameters already in circuit.)
Returns:: The UnitaryMatrix object that the circuit implements.
Raises:: ValueError – If parameters are specified and invalid.
Return type:: UnitaryMatrix

Examples

>>> from bqskit.ir.gates import HGate
>>> circ = Circuit(1)
>>> op = Operation(HGate(), [0])
>>> circ.append(op)
>>> circ.get_unitary() == HGate().get_unitary()
True