z i@&~SrSSKJr SSKrSSKJrJr SSKJr SSK J r SSK J r SS K Jr SS KJr "S S \5rg) Controlled unitary gate.) annotationsN)OptionalUnion) CircuitError)QuantumRegister)QuantumCircuit)Gate)_ctrl_state_to_intc^\rSrSrSrSSS.SU4Sjjjjr\SU4Sjj5r\RSSj5r\SSj5r \ RS 5r \S 5r \ RS 5r \SS j5r \ RSS j5r \S5r \ RS5r SSjr SSjrSSU4SjjjrSrU=r$)ControlledGaterN) _base_labelc >UcSOUR5Ul[T U] XX4S9 SUlXPl[R "U5UlSUlSUl Xpl Xl g)aCreate a new ControlledGate. In the new gate the first ``num_ctrl_qubits`` of the gate are the controls. Args: name: The name of the gate. num_qubits: The number of qubits the gate acts on. params: A list of parameters for the gate. label: An optional label for the gate. num_ctrl_qubits: Number of control qubits. definition: A list of gate rules for implementing this gate. The elements of the list are tuples of (:meth:`~qiskit.circuit.Gate`, [qubit_list], [clbit_list]). ctrl_state: The control state in decimal or as a bitstring (e.g. '111'). If specified as a bitstring the length must equal num_ctrl_qubits, MSB on left. If None, use 2**num_ctrl_qubits-1. base_gate: Gate object to be controlled. Raises: CircuitError: If ``num_ctrl_qubits`` >= ``num_qubits``. CircuitError: ctrl_state < 0 or ctrl_state > 2**num_ctrl_qubits. Examples: Create a controlled standard gate and apply it to a circuit. .. plot:: :alt: Circuit diagram output by the previous code. :include-source: from qiskit import QuantumCircuit, QuantumRegister from qiskit.circuit.library.standard_gates import HGate qr = QuantumRegister(3) qc = QuantumCircuit(qr) c3h_gate = HGate().control(2) qc.append(c3h_gate, qr) qc.draw('mpl') Create a controlled custom gate and apply it to a circuit. .. plot:: :alt: Circuit diagram output by the previous code. :include-source: from qiskit import QuantumCircuit, QuantumRegister from qiskit.circuit.library.standard_gates import HGate qc1 = QuantumCircuit(2) qc1.x(0) qc1.h(1) custom = qc1.to_gate().control(2) qc2 = QuantumCircuit(4) qc2.append(custom, [0, 3, 1, 2]) qc2.draw('mpl') N)labelr) copy base_gatesuper__init___num_ctrl_qubitsnum_ctrl_qubitsdeepcopy definition _ctrl_state _open_ctrl ctrl_state_name) selfname num_qubitsparamsrrrrrr __class__s W/home/james-whalen/.local/lib/python3.13/site-packages/qiskit/circuit/controlledgate.pyrControlledGate.__init__sdL"+!2 8H 6? !.-- 3$ c>UR(aUR5nSUl[UR5SSR UR 5n[ URS5n[U5n[USSS25HupVUS:XdM URU5 M URXSSS9 [USSS25HupVUS:XdM URU5 M U$[TU]4$)zReturn definition in terms of other basic gates. If the gate has open controls, as determined from :attr:`ctrl_state`, the returned definition is conjugated with X without changing the internal ``_definition``. Nq0)qargs)r to_mutablerbinzfillrr r!r enumeratexappendrr)r closed_gatebit_ctrl_stateqreg qc_open_ctrlqindvalr#s r$rControlledGate.definitionos ??//+K%)K " 1!"5;;D where is the gate name for the default case of closed control qubits and is the integer value of the control state for the gate. _o)rrrrs r$r ControlledGate.names/ ??jj\DOO#45 5:: r&cXlg)zmSet the name of the gate. Note the reported name may differ from the set name if the gate has open controls. N)r)rname_strs r$r r@s  r&cUR$)z\Get number of control qubits. Returns: int: The number of control qubits for the gate. )rr?s r$rControlledGate.num_ctrl_qubitss$$$r&cU[U5:wa [S5e[U5nUR[URSS5- nUS:dX:a URcSOSn[SUS35eXlg) zSet the number of control qubits. Args: num_ctrl_qubits (int): The number of control qubits. Raises: CircuitError: ``num_ctrl_qubits`` is not an integer in ``[1, num_qubits]``. z0The number of control qubits must be an integer.r!rrNz!num_qubits - base_gate.num_qubitsz-The number of control qubits must be in `[1, z]`.)intrr!getattrrr)rr upper_limitlimits r$rrDs~ c/2 2QR Ro.oo a(PP Q /"?$(NN$:L@cE!NugUXYZ Z /r&cUR$)z:Return the control state of the gate as a decimal integer.)rr?s r$rControlledGate.ctrl_statesr&c[XR5UlURSUR-S- :Ulg)zSet the control state of this gate. Args: ctrl_state: The control state of the gate. Raises: CircuitError: ctrl_state is invalid. r(rN)r rrrr)rrs r$rrKs7.j:N:NO//At/C/C,Ca,GGr&cfUR(aURR$[S5e)zGet parameters from base_gate. Returns: list: List of gate parameters. Raises: CircuitError: Controlled gate does not define a base gate ?Controlled gate does not define base gate for extracting params)rr"rr?s r$r"ControlledGate.paramss' >>>>(( (`a ar&cUR(a?URR(aXRlgU(a [S5eg[S5e)zSet base gate parameters. Args: parameters (list): The list of parameters to set. Raises: CircuitError: If controlled gate does not define a base gate. z,cannot set parameters on immutable base gaterNN)rmutabler"r)r parameterss r$r"rOsD >>~~%%(2%"#QRR`a ar&c[R"U5nURR5UlUR(a&[R"URU5UlU$N)rrr;r)rmemocpys r$ __deepcopy__ControlledGate.__deepcopy__sIiio++-   "mmD,<,U(d>URR5RURURS9nU$[ TU]US9nU$)z5Invert this gate by calling inverse on the base gate.)r) annotated)rinversecontrolrrr)rr` inverse_gater#s r$raControlledGate.inverse sW>>113;;$$<L !7?Y??Lr&) rr;rrrrrrr)NrNNN)r strr!rFr"listrz Optional[str]rz Optional[int]rzOptional['QuantumCircuit']rzOptional[Union[int, str]]rzOptional[Gate])returnr )r<z'QuantumCircuit')rgre)rgrF)rzUnion[int, str, None]rT)rgbool)F)r`rhrgz''ControlledGate' | 'AnnotatedOperation')__name__ __module__ __qualname____firstlineno____doc__rpropertyrsetterr rrr"rWr]ra__static_attributes__ __classcell__)r#s@r$rrs" $)*1504$(NNNN N  N ' N/N.N"NN`&&.''   [[ %%00(   H H b b ]]bb"  r&r)rm __future__rrtypingrrqiskit.circuit.exceptionsrr quantumcircuitr gater _utilsr rr&r$rzs2" "2*&vTvr&